A button is a control that can be pushed to start an action or close a dialog. More...

#include <button.hpp>

Inheritance diagram for gui::button:

Classes
struct	error

Public Types
enum	TYPE { TYPE_PRESS , TYPE_CHECK , TYPE_TURBO , TYPE_IMAGE , TYPE_RADIO }

enum	SPACE_CONSUMPTION { DEFAULT_SPACE , MINIMUM_SPACE }

Public Member Functions
TYPE	get_type () const

	button (const std::string &label, TYPE type=TYPE_PRESS, std::string button_image="", SPACE_CONSUMPTION spacing=DEFAULT_SPACE, const bool auto_join=true, std::string overlay_image="", int font_size=-1)

virtual	~button ()
	Default implementation, but defined out-of-line for efficiency reasons. More...

void	set_check (bool check)

void	set_active (bool active)

bool	checked () const

void	set_label (const std::string &val)

void	set_image (const std::string &image_file_base)

void	set_overlay (const std::string &image_file_base)

void	set_image_path_suffix (const std::string &suffix)

bool	pressed ()

bool	hit (int x, int y) const

virtual void	enable (bool new_val=true)

void	release ()

Public Member Functions inherited from gui::widget
const rect &	location () const

virtual void	set_location (const SDL_Rect &rect)

void	set_location (int x, int y)

void	set_width (int w)

void	set_height (int h)

void	set_measurements (int w, int h)

int	width () const

int	height () const

bool	focus (const SDL_Event *event)

void	set_focus (bool focus)

virtual void	hide (bool value=true)

bool	hidden () const

bool	enabled () const

void	set_clip_rect (const SDL_Rect &rect)

void	queue_redraw ()
	Indicate that the widget should be redrawn. More...

void	queue_redraw (const rect &)
	Indicate that a specific region of the screen should be redrawn. More...

void	set_dirty (bool dirty=true)

bool	dirty () const

const std::string &	id () const

void	set_id (const std::string &id)

void	set_tooltip_string (const std::string &str)

virtual void	process_tooltip_string (int mousex, int mousey) override

virtual void	layout () override
	Called by draw_manager to validate layout. More...

virtual bool	expose (const rect &region) override
	Called by draw_manager when it believes a redraw is necessary. More...

virtual rect	screen_location () override
	The current draw location of the display, on the screen. More...

Public Member Functions inherited from events::sdl_handler
virtual void	handle_window_event (const SDL_Event &)

virtual void	process_event ()

virtual bool	requires_event_focus (const SDL_Event *=nullptr) const

virtual void	join ()

virtual void	join (context &c)

virtual void	join_same (sdl_handler *parent)

virtual void	leave ()

virtual void	join_global ()

virtual void	leave_global ()

virtual bool	has_joined ()

virtual bool	has_joined_global ()

sdl_handler &	operator= (sdl_handler &&)=delete
	Moving would require two instances' context membership to be handled, it's simpler to delete these and require the two instances to be separately constructed / destructed. More...

	sdl_handler (sdl_handler &&)=delete

Public Member Functions inherited from gui2::top_level_drawable
virtual void	update ()
	Update state and any parameters that may effect layout, or any of the later stages. More...

virtual void	render ()
	Perform any internal rendering necessary to prepare the drawable. More...

Protected Member Functions
virtual void	handle_event (const SDL_Event &event)

virtual void	mouse_motion (const SDL_MouseMotionEvent &event)

virtual void	mouse_down (const SDL_MouseButtonEvent &event)

virtual void	mouse_up (const SDL_MouseButtonEvent &event)

virtual void	draw_contents ()

Protected Member Functions inherited from gui::widget
	widget (const bool auto_join=true)

virtual	~widget ()

virtual void	update_location (const SDL_Rect &)

bool	mouse_locked () const

void	aquire_mouse_lock ()

void	free_mouse_lock ()

Protected Member Functions inherited from events::sdl_handler
	sdl_handler (const bool auto_join=true)

	sdl_handler (const sdl_handler &)

sdl_handler &	operator= (const sdl_handler &)

virtual	~sdl_handler ()

virtual std::vector< sdl_handler * >	handler_members ()

Protected Member Functions inherited from gui2::top_level_drawable
	top_level_drawable ()

virtual	~top_level_drawable ()

	top_level_drawable (const top_level_drawable &)

top_level_drawable &	operator= (const top_level_drawable &)

	top_level_drawable (top_level_drawable &&)

top_level_drawable &	operator= (top_level_drawable &&)

Protected Attributes
TYPE	type_

Protected Attributes inherited from gui::widget
bool	focus_

Private Types
enum	STATE { UNINIT , NORMAL , ACTIVE , PRESSED , PRESSED_ACTIVE , TOUCHED_NORMAL , TOUCHED_PRESSED }

Private Member Functions
void	load_images ()

void	calculate_size ()

Private Attributes
std::string	label_text_

texture	image_

texture	pressedImage_

texture	activeImage_

texture	pressedActiveImage_

texture	touchedImage_

texture	disabledImage_

texture	pressedDisabledImage_

texture	overlayImage_

texture	overlayPressedImage_

texture	overlayPressedDisabledImage_

texture	overlayDisabledImage_

texture	overlayActiveImage_

SDL_Rect	textRect_

STATE	state_

bool	pressed_

SPACE_CONSUMPTION	spacing_

int	base_height_

int	base_width_

std::string	button_image_name_

std::string	button_overlay_image_name_

std::string	button_image_path_suffix_

int	font_size_

int	horizontal_padding_

int	checkbox_horizontal_padding_

int	vertical_padding_

Detailed Description

A button is a control that can be pushed to start an action or close a dialog.

When a button has a return value it sets the return value for the window. Normally this closes the window and returns this value to the caller. The return value can either be defined by the user or determined from the id of the button. The return value has a higher precedence as the one defined by the id. (Of course it's weird to give a button an id and then override its return value.)

When the button doesn't have a standard id, but you still want to use the return value of that id, use return_value_id instead. This has a higher precedence as return_value.

List with the button specific variables:

Key	Type	Default	Description
return_value_id	string	""	The return value id.
return_value	int	0	The return value.

The following states exist:

state_enabled - the button is enabled.
state_disabled - the button is disabled.
state_pressed - the left mouse button is down.
state_focussed - the mouse is over the button.

Definition at line 51 of file button.hpp.

Member Enumeration Documentation

◆ SPACE_CONSUMPTION

enum gui::button::SPACE_CONSUMPTION

Enumerator
DEFAULT_SPACE
MINIMUM_SPACE

Definition at line 63 of file button.hpp.

◆ STATE

enum gui::button::STATE

private

Enumerator
UNINIT
NORMAL
ACTIVE
PRESSED
PRESSED_ACTIVE
TOUCHED_NORMAL
TOUCHED_PRESSED

Definition at line 109 of file button.hpp.

◆ TYPE

enum gui::button::TYPE

Enumerator
TYPE_PRESS
TYPE_CHECK
TYPE_TURBO
TYPE_IMAGE
TYPE_RADIO

Definition at line 60 of file button.hpp.

Constructor & Destructor Documentation

◆ button()

gui::button::button	(	const std::string &	label,
		button::TYPE	type = `TYPE_PRESS`,
		std::string	button_image = `""`,
		SPACE_CONSUMPTION	spacing = `DEFAULT_SPACE`,
		const bool	auto_join = `true`,
		std::string	overlay_image = `""`,
		int	font_size = `-1`
	)