MySQL Workbench  6.1
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Macros Pages
mforms::Button Class Reference

A clickable button control. More...

#include <button.h>

Inheritance diagram for mforms::Button:
mforms::View mforms::CheckBox mforms::RadioButton

Public Member Functions

 Button (ButtonType type=PushButton)
void enable_internal_padding (bool flag)
 Sets whether an internal padding should be added to the button. More...
void set_text (const std::string &text)
 Sets the text to be shown in the button. More...
void set_icon (const std::string &icon)
 Sets the path to the icon to be shown in the button, if its a ToolButton. More...
boost::signals2::signal< void()> * signal_clicked ()
 Sets callback for when the button is clicked. More...
virtual void callback ()
bool is_updating ()
- Public Member Functions inherited from mforms::View
virtual ~View ()
virtual void set_managed ()
Viewfind_subview (const std::string &name)
bool contains_subview (View *subview)
void clear_subviews ()
void set_name (const std::string &name)
void set_tooltip (const std::string &text)
void set_font (const std::string &fontDescription)
std::string get_name ()
void set_parent (View *parent)
Viewget_parent () const
Formget_parent_form () const
virtual int get_width ()
virtual int get_height ()
virtual int get_preferred_width ()
virtual int get_preferred_height ()
virtual int get_x ()
virtual int get_y ()
virtual void set_position (int x, int y)
virtual void set_size (int width, int height)
std::pair< int, int > client_to_screen (int x, int y)
std::pair< int, int > screen_to_client (int x, int y)
void show (bool flag=true)
 Show/hide view. More...
bool is_shown ()
 Check whenever view is visible. More...
bool is_fully_visible ()
 Returns true if the view and all it's parents are visible. More...
void set_enabled (bool flag)
 Enable view so user can interact with it. More...
bool is_enabled ()
 Check whenever view is enabled. More...
void set_needs_repaint ()
 Mark view to be repainted with next iteration. More...
virtual void relayout ()
virtual void set_layout_dirty (bool value)
virtual bool is_layout_dirty ()
void suspend_layout ()
 Freeze gui updates for this view. More...
void resume_layout ()
 Resume gui updates for this view. More...
void set_front_color (const std::string &color)
 Set view foreground color. More...
std::string get_front_color ()
 Get view foreground color. More...
void set_back_color (const std::string &color)
 Set view background color. More...
std::string get_back_color ()
 Get view background color. More...
virtual std::string get_string_value ()
 Get string value from the view if it's holding some. More...
virtual int get_int_value ()
 Get int value from the view if it's holding some. More...
virtual bool get_bool_value ()
 Get bool value from the view if it's holding some. More...
virtual void flush_events ()
 Iterate over all events that were queuedand flush them, results in faster gui updates or faster signal calls. More...
virtual void focus ()
 Causes view to have keyboard focus. More...
void register_drop_formats (DropDelegate *target, const std::vector< std::string > &drop_formats)
 Enables or disables the ability to accept a drag/drop operation (internal or from outside) based on drop_formats. More...
DragOperation do_drag_drop (DragDetails details, const std::string &text)
 Starts an internal drag/drop operation with the given text/data and blocks until that op is finished. More...
DragOperation do_drag_drop (DragDetails details, void *data, const std::string &format)
void focus_changed ()
virtual void resize ()
 Triggered by the platform layers when the size of the view changes. More...
boost::signals2::signal< void()> * signal_resized ()

Protected Attributes

boost::signals2::signal< void()> _clicked
ButtonImplPtrs * _button_impl
bool _updating
- Protected Attributes inherited from mforms::View
ViewImplPtrs * _view_impl
std::vector< std::pair< View
*, bool > > 

Additional Inherited Members

- Protected Member Functions inherited from mforms::View
 View ()
void cache_view (View *sv)
virtual void remove_from_cache (View *sv)
int get_subview_index (View *sv)
Viewget_subview_at_index (int index)
virtual void set_back_image (const std::string &path, Alignment alignment)

Detailed Description

A clickable button control.

Definition at line 51 of file button.h.

Constructor & Destructor Documentation

mforms::Button::Button ( ButtonType  type = PushButton)

Member Function Documentation

virtual void mforms::Button::callback ( )
void mforms::Button::enable_internal_padding ( bool  flag)

Sets whether an internal padding should be added to the button.

Buttons are sized so that its content text will show up untruncated plus an additional space that is added to give them a better appearance. You can disable that extra space by calling this method with false.

bool mforms::Button::is_updating ( )

Definition at line 80 of file button.h.

80 { return _updating; }
bool _updating
Definition: button.h:85
void mforms::Button::set_icon ( const std::string &  icon)

Sets the path to the icon to be shown in the button, if its a ToolButton.

void mforms::Button::set_text ( const std::string &  text)

Sets the text to be shown in the button.

boost::signals2::signal<void ()>* mforms::Button::signal_clicked ( )

Sets callback for when the button is clicked.

In Python, use add_clicked_callback()

Definition at line 75 of file button.h.

75 { return &_clicked; }
boost::signals2::signal< void()> _clicked
Definition: button.h:83

Member Data Documentation

ButtonImplPtrs* mforms::Button::_button_impl

Definition at line 84 of file button.h.

boost::signals2::signal<void ()> mforms::Button::_clicked

Definition at line 83 of file button.h.

bool mforms::Button::_updating

Definition at line 85 of file button.h.

The documentation for this class was generated from the following file:
MySQL Workbench 6.1 documentation