1 // Copyright (c) 2011 The Chromium Authors. All rights reserved.
2 // Use of this source code is governed by a BSD-style license that can be
3 // found in the LICENSE file.
5 #ifndef UI_VIEWS_CONTROLS_BUTTON_BUTTON_H_
6 #define UI_VIEWS_CONTROLS_BUTTON_BUTTON_H_
8 #include "ui/views/view.h"
15 // An interface implemented by an object to let it know that a button was
17 class VIEWS_EXPORT ButtonListener {
19 virtual void ButtonPressed(Button* sender, const ui::Event& event) = 0;
22 virtual ~ButtonListener() {}
25 // A View representing a button. Depending on the specific type, the button
26 // could be implemented by a native control or custom rendered.
27 class VIEWS_EXPORT Button : public View {
31 // Button states for various button sub-types.
40 // Button styles with associated images and border painters.
41 // TODO(msw): Add Menu, ComboBox, etc.
45 STYLE_NATIVE_TEXTBUTTON,
49 void SetTooltipText(const string16& tooltip_text);
51 int tag() const { return tag_; }
52 void set_tag(int tag) { tag_ = tag; }
54 void SetAccessibleName(const string16& name);
56 // Overridden from View:
57 virtual bool GetTooltipText(const gfx::Point& p,
58 string16* tooltip) const OVERRIDE;
59 virtual void GetAccessibleState(ui::AccessibleViewState* state) OVERRIDE;
62 // Construct the Button with a Listener. The listener can be NULL. This can be
63 // true of buttons that don't have a listener - e.g. menubuttons where there's
64 // no default action and checkboxes.
65 explicit Button(ButtonListener* listener);
67 // Cause the button to notify the listener that a click occurred.
68 virtual void NotifyClick(const ui::Event& event);
70 // The button's listener. Notified when clicked.
71 ButtonListener* listener_;
74 // The text shown in a tooltip.
75 string16 tooltip_text_;
77 // Accessibility data.
78 string16 accessible_name_;
80 // The id tag associated with this button. Used to disambiguate buttons in
81 // the ButtonListener implementation.
84 DISALLOW_COPY_AND_ASSIGN(Button);
89 #endif // UI_VIEWS_CONTROLS_BUTTON_BUTTON_H_