button Class Reference

Allows a user to click on a button. More...

#include <button.hpp>

Inheritance diagram for button:

Public Types
enum	style { STYLE_FLAT = (1 << 0), STYLE_SHADOW = (1 << 1), STYLE_BOX = (1 << 2) }
	indicator of the type of box that should be drawn around the button More...
typedef void(*	signal_clicked_t) (button const *i_button, void *io_user_data)
	function prototype to receive signal More...
Public Types inherited from widget
enum	damage {   DAMAGE_NONE = 0, DAMAGE_ALL = (1<<0), DAMAGE_LABEL = (1<<1), DAMAGE_VALUE = (1<<2),   DAMAGE_SCROLL = (1<<3), DAMAGE_MOVED = (1<<4), DAMAGE_RESERVED1 = (1<<5), DAMAGE_RESERVED2 = (1<<6),   DAMAGE_RESERVED3 = (1<<7) }
	bit mask indicating what needs to be redrawn More...

Public Member Functions
	button (int const i_pos_x, int const i_pos_y, unsigned int const i_len_x, unsigned int const i_len_y)
	constructor More...
virtual	~button ()
	destructor More...
virtual void	draw () const
	draws the widget More...
virtual enum event_response	event_key (struct event_key const &i_event)
	handle key event More...
virtual enum event_response	event_mouse (struct event_mouse const &i_event)
	handle mouse event More...
virtual void	focus_enter ()
	handle entering focus More...
virtual void	focus_leave ()
	handle leaving focus More...
void	set_response (int const i_response)
	sets response generated when button is clicked More...
void	set_style (unsigned int const i_style)
	set button style (no box, flat or box or box and shadow More...
void	set_text (unsigned char const *i_str)
void	set_signal_clicked (signal_clicked_t i_signal)
	set callback More...
Public Member Functions inherited from widget
	widget (int const i_pos_x, int const i_pos_y, unsigned int const i_len_x, unsigned int const i_len_y)
	constructor More...
virtual	~widget ()
	destructor More...
virtual void	set_damage (unsigned int const i_damage=DAMAGE_NONE)
	set the damage bits More...
virtual bool	close (bool const i_shutting_down)
	called when widget is about to be destroyed More...
bool	contains (int const i_pos_x, int const i_pos_y) const
	test if point is contained within the widget More...
bool	contains (struct box const &i_box) const
	test if rectangular region is contained within the widget More...
virtual enum event_response	event_key_default (enum scancodes const i_scan)
	default key event handler More...
void	get_box (struct box &o_box) const
	gets the rectangular region this widget occupies More...
bool	get_can_focus () const
	gets whether or not the widget can receive focus More...
bool	get_enabled () const
	gets whether or not the widget is enabled More...
bool	get_has_focus () const
	gets whether or not the widget has focus More...
group *const	get_parent () const
	gets the parent widget More...
void *	get_user_data () const
	gets user defined data pointer More...
bool	get_visible () const
	gets whether or not the widget is visible More...
int	get_pos_x () const
	gets the relative x position of the widget More...
int	get_pos_y () const
	gets the relative y position of the widget More...
unsigned int	get_len_x () const
	gets the horizontal length of the widget More...
unsigned int	get_len_y () const
	gets the vertical length of the widget More...
virtual void	move (int const i_pos_x, int const i_pos_y)
	move the widget to a new position More...
virtual void	resize (unsigned int const i_len_x, unsigned int const i_len_y)
	resize the widget More...
void	set_can_close (bool const i_can_close)
	set internal indicator if widget can be closed More...
void	set_disabled ()
	disable the widget More...
void	set_enabled ()
	enable the widget
void	set_hidden ()
	hide the widget More...
virtual void	set_parent (group *const i_parent)
	sets the parent group of the widget More...
void	set_user_data (void *io_user_data)
	sets the user defined data pointer More...
void	set_visible ()
	sets the widget as visible More...
void	translate_screen (int *const o_pos_x, int *const o_pos_y) const
	translate a widgets relative coordinates to screen coordinates More...

Protected Types
enum	type { TYPE_BUTTON, TYPE_CHECK, TYPE_RADIO }
Protected Types inherited from widget
enum	flags {   VISIBLE = (1 << 0), ENABLED = (1 << 1), CAN_FOCUS = (1 << 2), HAS_FOCUS = (1 << 3),   CAN_CLOSE = (1 << 4) }

Protected Member Functions
virtual void	toggled ()
	method called when button state changes

Protected Attributes
bool	m_state
	on/off state (for normal button ignored)
enum type	m_type
	button type
unsigned int	m_style
	button style (button::style bit flags)
unsigned char *	m_label
	dynamically allocated buffer to hold label
enum event_response	m_response
	response generated when user clicks on the button
signal_clicked_t	m_signal_clicked
	pointer to signal emit function
Protected Attributes inherited from widget
unsigned int	m_damage
unsigned int	m_flags
struct box	m_box
group *	m_parent
void *	m_user_data

Private Member Functions
	button (const button &)
button &	operator= (button const &)
void	emit_clicked ()

Detailed Description

Allows a user to click on a button.

Member Typedef Documentation

signal_clicked_t

void(* button::signal_clicked_t)(button const *i_button, void *io_user_data)

function prototype to receive signal

Parameters

[in]	i_button	button widget
[in,out]	io_user_data	user defined

Returns

none

Member Enumeration Documentation

style

enum button::style

indicator of the type of box that should be drawn around the button

Enumerator
STYLE_FLAT	Flat (no box)
STYLE_SHADOW	Draw a shadow around box or label
STYLE_BOX	Draw a box around label

type

enum button::type

protected

Enumerator
TYPE_BUTTON	behaves as a normal button
TYPE_CHECK	behaves as a check button
TYPE_RADIO	behaves as a radio button

Constructor & Destructor Documentation

button()

button::button	(	int const	i_pos_x,
		int const	i_pos_y,
		unsigned int const	i_len_x,
		unsigned int const	i_len_y
	)

constructor

Parameters

[in]	i_pos_x	x position to place widget
[in]	i_pos_y	y position to place widget
[in]	i_len_x	x length of widget
[in]	i_len_y	y length of widget

Returns

none

~button()

button::~button ( )

virtual

destructor

Returns

none

Member Function Documentation

draw()

void button::draw ( ) const

virtual

draws the widget

This method should not be called directly.

See also

widget::draw for details.

Implements widget.

event_key()

enum event_response button::event_key ( struct event_key const &  i_event )

virtual

handle key event

Parameters

[in]

i_event

key event to handle

Returns

response how event was handled

Reimplemented from widget.

event_mouse()

enum event_response button::event_mouse ( struct event_mouse const &  i_event )

virtual

handle mouse event

Parameters

[in]

i_event

mouse event to handle

Returns

response how event was handled

Reimplemented from widget.

focus_enter()

void button::focus_enter ( )

virtual

handle entering focus

Returns

none

Reimplemented from widget.

focus_leave()

void button::focus_leave ( )

virtual

handle leaving focus

Returns

none

Reimplemented from widget.

set_response()

void button::set_response ( int const  i_response )

inline

sets response generated when button is clicked

Parameters

[in]

i_response

custom response or one of event_response

Returns

none

set_signal_clicked()

void button::set_signal_clicked ( signal_clicked_t  i_signal )

inline

set callback

Parameters

[in]

i_signal

callback signal

Returns

none

set_style()

void button::set_style ( unsigned int const  i_style )

inline

set button style (no box, flat or box or box and shadow

Parameters

[in]

i_style

combination of button::style

Returns

none

The routine does not redraw the widget

set_text()

void button::set_text ( unsigned char const *  i_str )

inline

Parameters

[in]

i_str

text to set the button label (null terminated)

Returns

none

The routine does not redraw the widget

---

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

• button.hpp
• button.dox
• button.cpp