OLD | NEW |
1 // Copyright 2013 The Chromium Authors. All rights reserved. | 1 // Copyright 2013 The Chromium Authors. All rights reserved. |
2 // Use of this source code is governed by a BSD-style license that can be | 2 // Use of this source code is governed by a BSD-style license that can be |
3 // found in the LICENSE file. | 3 // found in the LICENSE file. |
4 | 4 |
5 #ifndef UI_VIEWS_CONTROLS_STYLED_LABEL_H_ | 5 #ifndef UI_VIEWS_CONTROLS_STYLED_LABEL_H_ |
6 #define UI_VIEWS_CONTROLS_STYLED_LABEL_H_ | 6 #define UI_VIEWS_CONTROLS_STYLED_LABEL_H_ |
7 | 7 |
8 #include <map> | 8 #include <map> |
9 #include <queue> | 9 #include <queue> |
10 | 10 |
11 #include "base/basictypes.h" | 11 #include "base/basictypes.h" |
12 #include "base/string16.h" | 12 #include "base/string16.h" |
13 #include "ui/base/range/range.h" | 13 #include "ui/base/range/range.h" |
14 #include "ui/gfx/size.h" | 14 #include "ui/gfx/size.h" |
15 #include "ui/views/controls/link_listener.h" | 15 #include "ui/views/controls/link_listener.h" |
16 #include "ui/views/view.h" | 16 #include "ui/views/view.h" |
17 | 17 |
18 namespace views { | 18 namespace views { |
19 | 19 |
20 class Link; | 20 class Link; |
21 class StyledLabelListener; | 21 class StyledLabelListener; |
22 | 22 |
23 // A class which can apply mixed styles to a block of text. Currently, text is | 23 // A class which can apply mixed styles to a block of text. Currently, text is |
24 // always multiline, and the only style that may be applied is linkifying ranges | 24 // always multiline. Trailing whitespace in the styled label text is not |
25 // of text. | 25 // supported and will be trimmed on StyledLabel construction. Leading |
| 26 // whitespace is respected, provided not only whitespace fits in the first line. |
| 27 // In this case, leading whitespace is ignored. |
26 class VIEWS_EXPORT StyledLabel : public View, public LinkListener { | 28 class VIEWS_EXPORT StyledLabel : public View, public LinkListener { |
27 public: | 29 public: |
| 30 // Parameters that define label style for a styled label's text range. |
| 31 struct RangeStyleInfo { |
| 32 RangeStyleInfo(); |
| 33 ~RangeStyleInfo(); |
| 34 |
| 35 // Creates a range style info with default values for link. |
| 36 static RangeStyleInfo CreateForLink(); |
| 37 |
| 38 // The font style that will be applied to the range. Should be a bitmask of |
| 39 // values defined in gfx::Font::FontStyle (BOLD, ITALIC, UNDERLINE). |
| 40 int font_style; |
| 41 |
| 42 // Tooltip for the range. |
| 43 string16 tooltip; |
| 44 |
| 45 // If set, the whole range will be put on a single line. |
| 46 bool disable_line_wrapping; |
| 47 |
| 48 // If set, the range will be created as a link. |
| 49 bool is_link; |
| 50 }; |
| 51 |
| 52 // Note that any trailing whitespace in |text| will be trimmed. |
28 StyledLabel(const string16& text, StyledLabelListener* listener); | 53 StyledLabel(const string16& text, StyledLabelListener* listener); |
29 virtual ~StyledLabel(); | 54 virtual ~StyledLabel(); |
30 | 55 |
31 // Marks the given range within |text_| as a link. | 56 // Marks the given range within |text_| with style defined by |style_info|. |
32 void AddLink(const ui::Range& range); | 57 // |range| must be contained in |text_|. |
| 58 void AddStyleRange(const ui::Range& range, const RangeStyleInfo& style_info); |
33 | 59 |
34 // View implementation: | 60 // View implementation: |
35 virtual gfx::Insets GetInsets() const OVERRIDE; | 61 virtual gfx::Insets GetInsets() const OVERRIDE; |
36 virtual int GetHeightForWidth(int w) OVERRIDE; | 62 virtual int GetHeightForWidth(int w) OVERRIDE; |
37 virtual void Layout() OVERRIDE; | 63 virtual void Layout() OVERRIDE; |
38 | 64 |
39 // LinkListener implementation: | 65 // LinkListener implementation: |
40 virtual void LinkClicked(Link* source, int event_flags) OVERRIDE; | 66 virtual void LinkClicked(Link* source, int event_flags) OVERRIDE; |
41 | 67 |
42 private: | 68 private: |
43 struct LinkRange { | 69 struct StyleRange { |
44 explicit LinkRange(const ui::Range& range) : range(range) {} | 70 StyleRange(const ui::Range& range, |
45 ~LinkRange() {} | 71 const RangeStyleInfo& style_info) |
| 72 : range(range), |
| 73 style_info(style_info) { |
| 74 } |
| 75 ~StyleRange() {} |
46 | 76 |
47 bool operator<(const LinkRange& other) const; | 77 bool operator<(const StyleRange& other) const; |
48 | 78 |
49 ui::Range range; | 79 ui::Range range; |
| 80 RangeStyleInfo style_info; |
50 }; | 81 }; |
51 | 82 |
52 // Calculates how to layout child views, creates them and sets their size | 83 // Calculates how to layout child views, creates them and sets their size |
53 // and position. |width| is the horizontal space, in pixels, that the view | 84 // and position. |width| is the horizontal space, in pixels, that the view |
54 // has to work with. If |dry_run| is true, the view hierarchy is not touched. | 85 // has to work with. If |dry_run| is true, the view hierarchy is not touched. |
55 // The return value is the height in pixels. | 86 // The return value is the height in pixels. |
56 int CalculateAndDoLayout(int width, bool dry_run); | 87 int CalculateAndDoLayout(int width, bool dry_run); |
57 | 88 |
58 // The text to display. | 89 // The text to display. |
59 string16 text_; | 90 string16 text_; |
60 | 91 |
61 // The listener that will be informed of link clicks. | 92 // The listener that will be informed of link clicks. |
62 StyledLabelListener* listener_; | 93 StyledLabelListener* listener_; |
63 | 94 |
64 // The ranges that should be linkified, sorted by start position. | 95 // The ranges that should be linkified, sorted by start position. |
65 std::priority_queue<LinkRange> link_ranges_; | 96 std::priority_queue<StyleRange> style_ranges_; |
66 | 97 |
67 // A mapping from Link* control to the range it corresponds to in |text_|. | 98 // A mapping from a view to the range it corresponds to in |text_|. Only views |
68 std::map<Link*, ui::Range> link_targets_; | 99 // that correspond to ranges with is_link style set will be added to the map. |
| 100 std::map<View*, ui::Range> link_targets_; |
69 | 101 |
70 // This variable saves the result of the last GetHeightForWidth call in order | 102 // This variable saves the result of the last GetHeightForWidth call in order |
71 // to avoid repeated calculation. | 103 // to avoid repeated calculation. |
72 gfx::Size calculated_size_; | 104 gfx::Size calculated_size_; |
73 | 105 |
74 DISALLOW_COPY_AND_ASSIGN(StyledLabel); | 106 DISALLOW_COPY_AND_ASSIGN(StyledLabel); |
75 }; | 107 }; |
76 | 108 |
77 } // namespace views | 109 } // namespace views |
78 | 110 |
79 #endif // UI_VIEWS_CONTROLS_STYLED_LABEL_H_ | 111 #endif // UI_VIEWS_CONTROLS_STYLED_LABEL_H_ |
OLD | NEW |