Colors in views::StyledLabel.

ui/views/controls/styled_label.h

 // Copyright 2013 The Chromium Authors. All rights reserved.
 // Use of this source code is governed by a BSD-style license that can be
 // found in the LICENSE file.
 
 #ifndef UI_VIEWS_CONTROLS_STYLED_LABEL_H_
 #define UI_VIEWS_CONTROLS_STYLED_LABEL_H_
 
 #include <map>
 #include <queue>
 
 #include "base/basictypes.h"
 #include "base/strings/string16.h"
+#include "third_party/skia/include/core/SkColor.h"
 #include "ui/base/range/range.h"
 #include "ui/gfx/size.h"
 #include "ui/views/controls/link_listener.h"
 #include "ui/views/view.h"
 
 namespace views {
 
 class Link;
 class StyledLabelListener;
 
 // A class which can apply mixed styles to a block of text. Currently, text is
 // always multiline. Trailing whitespace in the styled label text is not
 // supported and will be trimmed on StyledLabel construction. Leading
 // whitespace is respected, provided not only whitespace fits in the first line.
 // In this case, leading whitespace is ignored.
 class VIEWS_EXPORT StyledLabel : public View, public LinkListener {
  public:
   // Parameters that define label style for a styled label's text range.
   struct VIEWS_EXPORT RangeStyleInfo {
     RangeStyleInfo();
     ~RangeStyleInfo();
 
     // Creates a range style info with default values for link.
     static RangeStyleInfo CreateForLink();
 
     // The font style that will be applied to the range. Should be a bitmask of
     // values defined in gfx::Font::FontStyle (BOLD, ITALIC, UNDERLINE).
     int font_style;
 
+    // The text color for the range.
+    SkColor color;
+
     // Tooltip for the range.
     string16 tooltip;
 
     // If set, the whole range will be put on a single line.
     bool disable_line_wrapping;
 
     // If set, the range will be created as a link.
     bool is_link;
   };
 
   // Note that any trailing whitespace in |text| will be trimmed.
   StyledLabel(const string16& text, StyledLabelListener* listener);
   virtual ~StyledLabel();
 
   // Sets the text to be displayed, and clears any previous styling.
   void SetText(const string16& text);
 
   // Marks the given range within |text_| with style defined by |style_info|.
   // |range| must be contained in |text_|.
   void AddStyleRange(const ui::Range& range, const RangeStyleInfo& style_info);
 
+  // Enables or disables auto-color-readability (enabled by default).  If this
+  // is enabled, color_utils::GetReadableColor() will be used to ensure that
+  // the foreground colors are readable over the background color. The
+  // background color must be set with SetBackgroundColor() for this to work.
+  void SetAutoColorReadabilityEnabled(bool enabled);

[Evan Stade, 2013/07/08 18:14:04]

is this used somewhere?

[fdoray, 2013/07/09 18:13:47]

No. But a method with the same name in views::Label is used. I provided this
method so that both controls have a similar interface. The bug crbug.com/244630
suggests this.

Do you prefer that I remove this unused method? Auto-color-readability would
always be enabled for views::StyledLabel.

[Evan Stade, 2013/07/09 18:35:18]

yes, remove dead code.

[fdoray, 2013/07/09 20:54:28]

Done.

+
+  // Sets the background color.  This won't be explicitly drawn, but the label
+  // will force the text color to be readable over it.
+  void SetBackgroundColor(SkColor color);

[Ben Goodger (Google), 2013/07/09 17:36:15]

This name implies the background will be drawn though... so I'd recommend coming
up with a different name.

[fdoray, 2013/07/09 18:13:47]

I chose this name because it's used in views::Label, but it's true that it's
confusing. What about SetAutoReadabilityBackgroundColor?

+  SkColor background_color() const { return background_color_; }
+
   // View implementation:
   virtual gfx::Insets GetInsets() const OVERRIDE;
   virtual int GetHeightForWidth(int w) OVERRIDE;
   virtual void Layout() OVERRIDE;
 
   // LinkListener implementation:
   virtual void LinkClicked(Link* source, int event_flags) OVERRIDE;
 
  private:
   struct StyleRange {
@@ skipping 26 matching lines @@
   std::priority_queue<StyleRange> style_ranges_;
 
   // A mapping from a view to the range it corresponds to in |text_|. Only views
   // that correspond to ranges with is_link style set will be added to the map.
   std::map<View*, ui::Range> link_targets_;
 
   // This variable saves the result of the last GetHeightForWidth call in order
   // to avoid repeated calculation.
   gfx::Size calculated_size_;
 
+  // Background color, for auto color readability.
+  SkColor background_color_;
+  bool background_color_set_;
+
+  // Indicates whether the foreground colors can be modified to be readable
+  // over the background color.
+  bool auto_color_readability_;
+
   DISALLOW_COPY_AND_ASSIGN(StyledLabel);
 };
 
 }  // namespace views
 
 #endif  // UI_VIEWS_CONTROLS_STYLED_LABEL_H_