Upstream version 9.38.198.0
[platform/framework/web/crosswalk.git] / src / ui / views / controls / button / label_button.h
index 0bbe7fe..b614fe2 100644 (file)
@@ -19,7 +19,7 @@ namespace views {
 class LabelButtonBorder;
 class Painter;
 
-// LabelButton is an alternative to TextButton, it's not focusable by default.
+// LabelButton is a button with text and an icon, it's not focusable by default.
 class VIEWS_EXPORT LabelButton : public CustomButton,
                                  public NativeThemeDelegate {
  public:
@@ -38,11 +38,17 @@ class VIEWS_EXPORT LabelButton : public CustomButton,
 
   // Get or set the text shown on the button.
   const base::string16& GetText() const;
-  void SetText(const base::string16& text);
+  virtual void SetText(const base::string16& text);
 
   // Set the text color shown for the specified button state.
   void SetTextColor(ButtonState for_state, SkColor color);
 
+  // Set drop shadows underneath the text.
+  void SetTextShadows(const gfx::ShadowValues& shadows);
+
+  // Sets whether subpixel rendering is used on the label.
+  void SetTextSubpixelRenderingEnabled(bool enabled);
+
   // Get or set the text's multi-line property to break on '\n', etc.
   bool GetTextMultiLine() const;
   void SetTextMultiLine(bool text_multi_line);
@@ -52,16 +58,16 @@ class VIEWS_EXPORT LabelButton : public CustomButton,
   void SetFontList(const gfx::FontList& font_list);
 
   // Set the elide behavior of this button.
-  void SetElideBehavior(Label::ElideBehavior elide_behavior);
+  void SetElideBehavior(gfx::ElideBehavior elide_behavior);
 
   // Get or set the horizontal alignment used for the button; reversed in RTL.
   // The optional image will lead the text, unless the button is right-aligned.
   gfx::HorizontalAlignment GetHorizontalAlignment() const;
   void SetHorizontalAlignment(gfx::HorizontalAlignment alignment);
 
-  // Call set_min_size(gfx::Size()) to clear the monotonically increasing size.
-  void set_min_size(const gfx::Size& min_size) { min_size_ = min_size; }
-  void set_max_size(const gfx::Size& max_size) { max_size_ = max_size; }
+  // Call SetMinSize(gfx::Size()) to clear the monotonically increasing size.
+  void SetMinSize(const gfx::Size& min_size);
+  void SetMaxSize(const gfx::Size& max_size);
 
   // Get or set the option to handle the return key; false by default.
   bool is_default() const { return is_default_; }
@@ -71,10 +77,18 @@ class VIEWS_EXPORT LabelButton : public CustomButton,
   ButtonStyle style() const { return style_; }
   void SetStyle(ButtonStyle style);
 
+  // Set the spacing between the image and the text. Shrinking the spacing
+  // will not shrink the overall button size, as it is monotonically increasing.
+  // Call SetMinSize(gfx::Size()) to clear the size if needed.
+  void SetImageLabelSpacing(int spacing);
+
   void SetFocusPainter(scoped_ptr<Painter> focus_painter);
+  Painter* focus_painter() { return focus_painter_.get(); }
 
   // View:
-  virtual gfx::Size GetPreferredSize() OVERRIDE;
+  virtual void SetBorder(scoped_ptr<Border> border) OVERRIDE;
+  virtual gfx::Size GetPreferredSize() const OVERRIDE;
+  virtual int GetHeightForWidth(int w) const OVERRIDE;
   virtual void Layout() OVERRIDE;
   virtual const char* GetClassName() const OVERRIDE;
 
@@ -82,10 +96,15 @@ class VIEWS_EXPORT LabelButton : public CustomButton,
   ImageView* image() const { return image_; }
   Label* label() const { return label_; }
 
+  // Returns the available area for the label and image. Subclasses can change
+  // these bounds if they need room to do manual painting.
+  virtual gfx::Rect GetChildAreaBounds();
+
   // View:
   virtual void OnPaint(gfx::Canvas* canvas) OVERRIDE;
   virtual void OnFocus() OVERRIDE;
   virtual void OnBlur() OVERRIDE;
+  virtual void OnNativeThemeChanged(const ui::NativeTheme* theme) OVERRIDE;
 
   // Fill |params| with information about the button.
   virtual void GetExtraParams(ui::NativeTheme::ExtraParams* params) const;
@@ -93,13 +112,16 @@ class VIEWS_EXPORT LabelButton : public CustomButton,
   // Resets colors from the NativeTheme, explicitly set colors are unchanged.
   virtual void ResetColorsFromNativeTheme();
 
+  // Creates the default border for this button. This can be overridden by
+  // subclasses or by LinuxUI.
+  virtual scoped_ptr<LabelButtonBorder> CreateDefaultBorder() const;
+
   // Updates the image view to contain the appropriate button state image.
   void UpdateImage();
 
-  // Updates our border with a specific Border instance which has different
-  // insets, etc. This may wrap the border in an object which will draw a
-  // native style border.
-  void UpdateThemedBorder(scoped_ptr<Border> border);
+  // Updates the border as per the NativeTheme, unless a different border was
+  // set with SetBorder.
+  void UpdateThemedBorder();
 
   // NativeThemeDelegate:
   virtual gfx::Rect GetThemePaintRect() const OVERRIDE;
@@ -116,7 +138,6 @@ class VIEWS_EXPORT LabelButton : public CustomButton,
 
   // View:
   virtual void ChildPreferredSizeChanged(View* child) OVERRIDE;
-  virtual void OnNativeThemeChanged(const ui::NativeTheme* theme) OVERRIDE;
 
   // NativeThemeDelegate:
   virtual ui::NativeTheme::Part GetThemePart() const OVERRIDE;
@@ -128,10 +149,18 @@ class VIEWS_EXPORT LabelButton : public CustomButton,
   virtual ui::NativeTheme::State GetForegroundThemeState(
       ui::NativeTheme::ExtraParams* params) const OVERRIDE;
 
+  // Resets |cached_preferred_size_| and marks |cached_preferred_size_valid_|
+  // as false.
+  void ResetCachedPreferredSize();
+
   // The image and label shown in the button.
   ImageView* image_;
   Label* label_;
 
+  // The cached font lists in the normal and bold style.
+  gfx::FontList cached_normal_font_list_;
+  gfx::FontList cached_bold_font_list_;
+
   // The images and colors for each button state.
   gfx::ImageSkia button_state_images_[STATE_COUNT];
   SkColor button_state_colors_[STATE_COUNT];
@@ -140,10 +169,14 @@ class VIEWS_EXPORT LabelButton : public CustomButton,
   bool explicitly_set_colors_[STATE_COUNT];
 
   // |min_size_| increases monotonically with the preferred size.
-  gfx::Size min_size_;
+  mutable gfx::Size min_size_;
   // |max_size_| may be set to clamp the preferred size.
   gfx::Size max_size_;
 
+  // Cache the last computed preferred size.
+  mutable gfx::Size cached_preferred_size_;
+  mutable bool cached_preferred_size_valid_;
+
   // Flag indicating default handling of the return key via an accelerator.
   // Whether or not the button appears or behaves as the default button in its
   // current context;
@@ -152,6 +185,12 @@ class VIEWS_EXPORT LabelButton : public CustomButton,
   // The button's overall style.
   ButtonStyle style_;
 
+  // True if current border was set by UpdateThemedBorder. Defaults to true.
+  bool border_is_themed_border_;
+
+  // Spacing between the image and the text.
+  int image_label_spacing_;
+
   scoped_ptr<Painter> focus_painter_;
 
   DISALLOW_COPY_AND_ASSIGN(LabelButton);