#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 (CVideo &video, 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="")

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 SDL_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	set_volatile (bool val=true)

void	set_dirty (bool dirty=true)

bool	dirty () const

const std::string &	id () const

void	set_id (const std::string &id)

void	set_help_string (const std::string &str)

void	set_tooltip_string (const std::string &str)

virtual void	process_help_string (int mousex, int mousey)

virtual void	process_tooltip_string (int mousex, int mousey)

virtual void	draw ()

Public Member Functions inherited from events::sdl_handler
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

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 (CVideo &video, const bool auto_join=true)

virtual	~widget ()

void	bg_register (const SDL_Rect &rect)

void	bg_restore () const

void	bg_restore (const SDL_Rect &rect) const

void	bg_update ()

void	bg_cancel ()

CVideo &	video () const

virtual void	update_location (const SDL_Rect &rect)

const SDL_Rect *	clip_rect () const

virtual sdl_handler_vector	member_handlers ()

virtual void	handle_window_event (const SDL_Event &event)

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 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_

surface	image_

surface	pressedImage_

surface	activeImage_

surface	pressedActiveImage_

surface	touchedImage_

surface	disabledImage_

surface	pressedDisabledImage_

surface	overlayImage_

surface	overlayPressedImage_

surface	overlayPressedDisabledImage_

surface	overlayDisabledImage_

surface	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_

Detailed Description

Definition at line 24 of file button.hpp.

Member Enumeration Documentation

◆ SPACE_CONSUMPTION

enum gui::button::SPACE_CONSUMPTION

Enumerator
DEFAULT_SPACE
MINIMUM_SPACE

Definition at line 36 of file button.hpp.

◆ STATE

enum gui::button::STATE

private

Enumerator
UNINIT
NORMAL
ACTIVE
PRESSED
PRESSED_ACTIVE
TOUCHED_NORMAL
TOUCHED_PRESSED

Definition at line 82 of file button.hpp.

◆ TYPE

enum gui::button::TYPE

Enumerator
TYPE_PRESS
TYPE_CHECK
TYPE_TURBO
TYPE_IMAGE
TYPE_RADIO

Definition at line 33 of file button.hpp.

Constructor & Destructor Documentation

◆ button()

gui::button::button	(	CVideo &	video,
		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 = `""`
	)