boost::ui::button Class Reference

Widget with label that generate event when clicked on. More...

Inheritance diagram for boost::ui::button:

Public Member Functions
template<class F , class ... Args>
button &	on_press (F &&f, Args &&... args)
	Connects button press handler.
	button (widget &parent, const uistring &label)
	Creates button with text label with mnemonics. More...
button &	create (widget &parent, const uistring &label)
	Creates button with text label with mnemonics. More...
Public Member Functions inherited from boost::ui::widget
ui::layout::item	layout ()
	Returns layout::item with this widget.
widget &	resize (coord_type width, coord_type height)
	Changes widget size to specified values.
coord_type	x () const
	Returns x coordinate relative to the parent widget client area.
coord_type	y () const
	Returns y coordinate relative to the parent widget client area.
coord_type	width () const
	Returns widget width.
coord_type	height () const
	Returns widget height.
point	pos () const
	Returns widget position relative to the parent widget client area.
size	dimensions () const
	Returns widget size.
rect	bounds () const
	Returns widget bounds in client coordinates.
widget &	enable (bool do_enable=true)
	Enables widget if do_enable is true, disables otherwise.
widget &	disable ()
	Disables widget.
bool	is_enabled () const
	Returns true if widget is enabled, false otherwise.
widget &	show (bool do_show=true)
	Shows widget if do_show is true, hides otherwise.
widget &	hide ()
	Hides widget.
bool	is_shown () const
	Returns true if widget is shown on screen, false otherwise.
widget &	tooltip (const uistring &text)
	Sets tooltip text. More...
uistring	tooltip () const
	Returns tooltip text.
widget &	font (const ui::font &f)
	Sets font.
ui::font	font () const
	Returns font.
bool	native_valid () const noexcept
	Returns true only if native widget was created.
widget &	append (const widget &w)
	Creates native widget and appends it to this widget.
widget &	operator<< (const widget &w)
	Creates native widget and appends it to this widget.
widget &	move (coord_type x, coord_type y)
	Moves widget to specified position.
widget &	move (const point &pos)
	Moves widget to specified position.
template<class F , class ... Args>
widget &	on_resize (F &&f, Args &&... args)
	Connects widget resize handler.
template<class F , class ... Args>
widget &	on_key_press (F &&f, Args &&... args)
	Connects keyboard event handler.
template<class F , class ... Args>
widget &	on_key_press_event (F &&f, Args &&... args)
	Connects keyboard event handler.
template<class F , class ... Args>
widget &	on_key_down (F &&f, Args &&... args)
	Connects keyboard event handler.
template<class F , class ... Args>
widget &	on_key_down_event (F &&f, Args &&... args)
	Connects keyboard event handler.
template<class F , class ... Args>
widget &	on_key_up (F &&f, Args &&... args)
	Connects keyboard event handler.
template<class F , class ... Args>
widget &	on_key_up_event (F &&f, Args &&... args)
	Connects keyboard event handler.
template<class F , class ... Args>
widget &	on_left_mouse_down (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_left_mouse_down_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_left_mouse_up (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_left_mouse_up_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_right_mouse_down (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_right_mouse_down_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_right_mouse_up (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_right_mouse_up_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_middle_mouse_down (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_middle_mouse_down_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_middle_mouse_up (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_middle_mouse_up_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_left_mouse_double_click (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_left_mouse_double_click_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_right_mouse_double_click (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_right_mouse_double_click_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_middle_mouse_double_click (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_middle_mouse_double_click_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_move (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_move_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_drag (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_drag_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_enter (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_enter_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_leave (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_leave_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_context_menu (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_context_menu_event (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_wheel (F &&f, Args &&... args)
	Connects mouse event handler.
template<class F , class ... Args>
widget &	on_mouse_wheel_event (F &&f, Args &&... args)
	Connects mouse event handler.
native_handle_type	native_handle ()
	Returns the implementation-defined underlying widget handle.
const native_handle_type	native_handle () const
	Returns the implementation-defined underlying widget handle.

Additional Inherited Members
Public Types inherited from boost::ui::widget
typedef void *	native_handle_type
	Implementation-defined widget type.

Detailed Description

Widget with label that generate event when clicked on.

Usage example:

class button_dialog : public ui::dialog
{
public:
    button_dialog() : ui::dialog("Button usage dialog")
    {
        ui::button(*this, "&Press me")
            .on_press(&button_dialog::on_press_me, this);
 
        show_modal();
    }
 
private:
    void on_press_me()
    {
        ui::info_dialog("Hello");
    }
};

See also

Button (Wikipedia)

Constructor & Destructor Documentation

button()

boost::ui::button::button ( widget &  parent, const uistring &  label  )

inlineexplicit

Creates button with text label with mnemonics.

See also

Mnemonics (Wikipedia)

Member Function Documentation

create()

button& boost::ui::button::create	(	widget &	parent,
		const uistring &	label
	)

Creates button with text label with mnemonics.

See also

Mnemonics (Wikipedia)

---

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

• boost/ui/button.hpp