Abstract base class for the generator. More...

#include <generator.hpp>

Inheritance diagram for gui2::generator_base:

Public Types
enum	placement { horizontal_list , vertical_list , table , independent }
	Determines how the items are placed. More...

typedef std::function< bool(unsigned, unsigned)>	order_func

Public Types inherited from gui2::widget
enum class	visibility { visible , hidden , invisible }
	Visibility settings done by the user. More...

enum class	redraw_action { full , partly , none }
	Visibility set by the engine. More...

enum class	debug_border { none , outline , fill }

Public Types inherited from gui2::event::dispatcher
enum	event_queue_type { pre = 1 , child = 2 , post = 4 }

enum	queue_position { front_pre_child , back_pre_child , front_child , back_child , front_post_child , back_post_child }
	The position where to add a new callback in the signal handler. More...

enum class	mouse_behavior { all , hit , none }
	The behavior of the mouse events. More...

Public Member Functions
virtual	~generator_base ()

virtual void	delete_item (const unsigned index)=0
	Deletes an item. More...

virtual void	clear ()=0
	Deletes all items. More...

virtual void	select_item (const unsigned index, const bool select)=0
	(De)selects an item. More...

void	toggle_item (const unsigned index)
	Toggles the selection state of an item. More...

virtual bool	is_selected (const unsigned index) const =0
	Returns whether the item is selected. More...

virtual void	set_item_shown (const unsigned index, const bool show)=0
	Shows or hides an item. More...

virtual bool	get_item_shown (const unsigned index) const =0
	Returns whether the item is shown. More...

boost::dynamic_bitset	get_items_shown () const
	Returns the visibility of all the items as a bit set. More...

virtual unsigned	get_item_count () const =0
	Returns the number of items. More...

virtual unsigned	get_selected_item_count () const =0
	Returns the number of selected items. More...

virtual int	get_selected_item () const =0
	Returns the selected item. More...

virtual grid &	item (const unsigned index)=0
	Gets the grid of an item. More...

virtual const grid &	item (const unsigned index) const =0
	Gets the grid of an item. More...

virtual grid &	create_item (const int index, const builder_grid &list_builder, const widget_item &item_data, const std::function< void(widget &)> &callback)=0
	Creates a new item. More...

virtual grid &	create_item (const int index, const builder_grid &list_builder, const widget_data &data, const std::function< void(widget &)> &callback)=0
	Creates a new item. More...

virtual void	create_items (const int index, const builder_grid &list_builder, const std::vector< widget_item > &data, const std::function< void(widget &)> &callback)=0
	Creates one or more new item(s). More...

virtual void	create_items (const int index, const builder_grid &list_builder, const std::vector< widget_data > &data, const std::function< void(widget &)> &callback)=0
	Creates one or more new item(s). More...

virtual void	set_order (const order_func &order)=0

virtual void	layout_initialize (const bool full_initialization) override=0
	See widget::layout_initialize. More...

virtual void	request_reduce_width (const unsigned maximum_width) override=0
	See widget::request_reduce_width. More...

virtual void	request_reduce_height (const unsigned maximum_height) override=0
	See widget::request_reduce_height. More...

virtual point	calculate_best_size () const override=0
	See widget::calculate_best_size. More...

virtual void	place (const point &origin, const point &size) override=0
	See widget::place. More...

virtual void	set_origin (const point &origin) override=0
	See widget::set_origin. More...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle) override=0
	See widget::set_visible_rectangle. More...

virtual void	impl_draw_children () override=0
	See widget::impl_draw_children. More...

virtual widget *	find_at (const point &coordinate, const bool must_be_active) override=0
	See widget::find_at. More...

virtual const widget *	find_at (const point &coordinate, const bool must_be_active) const override=0
	See widget::find_at. More...

virtual void	handle_key_up_arrow (SDL_Keymod modifier, bool &handled)=0
	Up arrow key pressed. More...

virtual void	handle_key_down_arrow (SDL_Keymod modifier, bool &handled)=0
	Down arrow key pressed. More...

virtual void	handle_key_left_arrow (SDL_Keymod modifier, bool &handled)=0
	Left arrow key pressed. More...

virtual void	handle_key_right_arrow (SDL_Keymod modifier, bool &handled)=0
	Right arrow key pressed. More...

virtual unsigned	get_ordered_index (unsigned index) const =0
	If a sort-order is being applied, maps from unsorted to sorted indicies. More...

virtual unsigned	get_item_at_ordered (unsigned index_ordered) const =0
	If a sort-order is being applied, maps from sorted to unsorted indicies. More...

Public Member Functions inherited from gui2::widget
	widget (const widget &)=delete

widget &	operator= (const widget &)=delete

	widget ()

	widget (const builder_widget &builder)
	Constructor. More...

virtual	~widget () override

void	set_id (const std::string &id)

const std::string &	id () const

window *	get_window ()
	Get the parent window. More...

const window *	get_window () const
	The constant version of get_window. More...

grid *	get_parent_grid ()
	Get the parent grid. More...

const grid *	get_parent_grid () const

void	set_parent (widget *parent)

widget *	parent ()

virtual void	demand_reduce_width (const unsigned maximum_width)
	Tries to reduce the width of a widget. More...

virtual void	demand_reduce_height (const unsigned maximum_height)
	Tries to reduce the height of a widget. More...

point	get_best_size () const
	Gets the best size for the widget. More...

virtual bool	can_mouse_focus () const
	Whether the mouse move/click event go 'through' this widget. More...

virtual bool	can_wrap () const
	Can the widget wrap. More...

virtual void	set_size (const point &size)
	Sets the size of the widget. More...

virtual void	move (const int x_offset, const int y_offset)
	Moves a widget. More...

virtual void	set_horizontal_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

virtual void	set_vertical_alignment (const std::string &alignment)
	Sets the horizontal alignment of the widget within its parent grid. More...

virtual void	layout_children ()
	Allows a widget to update its children. More...

point	get_origin () const
	Returns the screen origin of the widget. More...

point	get_size () const
	Returns the size of the widget. More...

rect	get_rectangle () const
	Gets the bounding rectangle of the widget on the screen. More...

int	get_x () const

int	get_y () const

unsigned	get_width () const

unsigned	get_height () const

void	set_linked_group (const std::string &linked_group)

std::string	get_linked_group () const

SDL_Rect	calculate_blitting_rectangle () const
	Calculates the blitting rectangle of the widget. More...

SDL_Rect	calculate_clipping_rectangle () const
	Calculates the clipping rectangle of the widget. More...

bool	draw_background ()
	Draws the background of a widget. More...

void	draw_children ()
	Draws the children of a widget. More...

bool	draw_foreground ()
	Draws the foreground of the widget. More...

SDL_Rect	get_dirty_rectangle () const
	Gets the dirty rectangle of the widget. More...

void	queue_redraw ()
	Indicates that this widget should be redrawn. More...

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

void	set_visible (const visibility visible)

visibility	get_visible () const

redraw_action	get_drawing_action () const

void	set_debug_border_mode (const debug_border debug_border_mode)

void	set_debug_border_color (const color_t debug_border_color)

virtual widget *	find (const std::string &id, const bool must_be_active)
	Returns a widget with the wanted id. More...

virtual const widget *	find (const std::string &id, const bool must_be_active) const
	The constant version of find. More...

virtual bool	has_widget (const widget &widget) const
	Does the widget contain the widget. More...

template<class T >
NOT_DANGLING T *	find_widget (const std::string &id, const bool must_be_active, const bool must_exist)
	Gets a widget with the wanted id. More...

template<class T >
NOT_DANGLING const T *	find_widget (const std::string &id, const bool must_be_active, const bool must_exist) const

template<class T >
NOT_DANGLING T &	find_widget (const std::string &id, const bool must_be_active=false)
	Gets a widget with the wanted id. More...

template<class T >
NOT_DANGLING const T &	find_widget (const std::string &id, const bool must_be_active=false) const

virtual bool	disable_click_dismiss () const =0
	Does the widget disable easy close? More...

virtual iteration::walker_ptr	create_walker ()=0
	Creates a new walker object on the heap. More...

Public Member Functions inherited from gui2::event_executor
	event_executor ()

virtual	~event_executor ()

void	set_wants_mouse_hover (const bool hover=true)

bool	wants_mouse_hover () const

void	set_wants_mouse_left_double_click (const bool click=true)

bool	wants_mouse_left_double_click () const

void	set_wants_mouse_middle_double_click (const bool click=true)

bool	wants_mouse_middle_double_click () const

event_executor &	set_wants_mouse_right_double_click (const bool click=true)

bool	wants_mouse_right_double_click () const

Public Member Functions inherited from gui2::event::dispatcher
	dispatcher ()

virtual	~dispatcher ()

void	connect ()
	Connects the dispatcher to the event handler. More...

void	disconnect ()
	Disconnects the dispatcher from the event handler. More...

bool	is_connected () const
	Return whether the dispatcher is currently connected. More...

bool	has_event (const ui_event event, const event_queue_type event_type)

bool	fire (const ui_event event, widget &target)
	Fires an event which has no extra parameters. More...

bool	fire (const ui_event event, widget &target, const point &coordinate)
	Fires an event which takes a coordinate parameter. More...

bool	fire (const ui_event event, widget &target, const SDL_Keycode key, const SDL_Keymod modifier, const std::string &unicode)
	Fires an event which takes keyboard parameters. More...

bool	fire (const ui_event event, widget &target, const point &pos, const point &distance)
	Fires an event which takes touch-motion parameters. More...

bool	fire (const ui_event event, widget &target, const point &center, float dTheta, float dDist, uint8_t numFingers)
	Fires an event which takes touch-gesture parameters. More...

bool	fire (const ui_event event, widget &target, void *)
	Fires an event which takes notification parameters. More...

bool	fire (const ui_event event, widget &target, const message &msg)
	Fires an event which takes message parameters. More...

bool	fire (const ui_event event, widget &target, const SDL_Event &sdlevent)
	Fires an event that's a raw SDL event. More...

bool	fire (const ui_event event, widget &target, const std::string &text, int32_t start, int32_t len)
	Fires an event which takes text input parameters. More...

template<ui_event E, typename F >
void	connect_signal (const F &func, const queue_position position=back_child)
	Adds a callback to the appropriate queue based on event type. More...

template<ui_event E, typename F >
void	disconnect_signal (const F &func, const queue_position position=back_child)
	Removes a callback from the appropriate queue based on event type. More...

void	capture_mouse ()
	Captures the mouse. More...

void	release_mouse ()
	Releases the mouse capture. More...

void	set_mouse_behavior (const mouse_behavior mouse_behavior)

mouse_behavior	get_mouse_behavior () const

void	set_want_keyboard_input (const bool want_keyboard_input)

bool	get_want_keyboard_input () const

void	register_hotkey (const hotkey::HOTKEY_COMMAND id, const hotkey_function &function)
	Registers a hotkey. More...

bool	execute_hotkey (const hotkey::HOTKEY_COMMAND id)
	Executes a hotkey. More...

Public Member Functions inherited from enable_lua_ptr< widget >
	enable_lua_ptr (widget *tp)

Static Public Member Functions
static std::unique_ptr< generator_base >	build (const bool has_minimum, const bool has_maximum, const placement placement, const bool select)
	Create a new generator. More...

Protected Member Functions
virtual void	do_select_item (const unsigned index)=0
	Selects a not selected item. More...

virtual void	do_deselect_item (const unsigned index)=0
	Deselects a selected item. More...

virtual grid &	item_ordered (const unsigned index)=0
	Gets the grid of an item. More...

virtual const grid &	item_ordered (const unsigned index) const =0
	Gets the grid of an item. More...

Protected Member Functions inherited from gui2::widget
void	set_layout_size (const point &size)

const point &	layout_size () const

void	clear_layout_size ()
	Throws away layout_size_. More...

Friends
class	debug_layout_graph

Detailed Description

Abstract base class for the generator.

A generator is a class which holds multiple grids and controls their placement on the screen. The final class is policy based, more info about the possible policies is documented in the build() function. This function is the factory to generate the classes as well.

Definition at line 38 of file generator.hpp.

Member Typedef Documentation

◆ order_func

typedef std::function<bool (unsigned, unsigned)> gui2::generator_base::order_func

Definition at line 248 of file generator.hpp.

Member Enumeration Documentation

◆ placement

enum gui2::generator_base::placement

Determines how the items are placed.

Enumerator
horizontal_list
vertical_list
table
independent

Definition at line 48 of file generator.hpp.

Constructor & Destructor Documentation

◆ ~generator_base()

virtual gui2::generator_base::~generator_base ( )

inlinevirtual

Definition at line 43 of file generator.hpp.

Member Function Documentation

◆ build()

std::unique_ptr< generator_base > gui2::generator_base::build	(	const bool	has_minimum,
		const bool	has_maximum,
		const placement	placement,
		const bool	select
	)

static

Create a new generator.

Parameters

has_minimum	Does one item need to be selected?
has_maximum	Is one the maximum number of items that can be selected?
placement	The placement of the grids, see placement for more info.
select	If a grid is selected, what should happen? If true the grid is selected, if false the grid is shown.

Returns: A pointer to a new object. The caller gets ownership of the new object.

Definition at line 1160 of file generator.cpp.

References GENERATE_BODY.

Referenced by gui2::implementation::builder_listbox::build(), gui2::implementation::builder_horizontal_listbox::build(), gui2::implementation::builder_grid_listbox::build(), gui2::implementation::builder_multi_page::build(), gui2::implementation::builder_stacked_widget::build(), and gui2::implementation::builder_tab_container::build().

◆ calculate_best_size()

virtual point gui2::generator_base::calculate_best_size ( ) const

overridepure virtual

See widget::calculate_best_size.

Implements gui2::widget.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::table, gui2::policy::placement::vertical_list, and gui2::policy::placement::horizontal_list.

Referenced by gui2::listbox::set_row_shown().

◆ clear()

virtual void gui2::generator_base::clear ( )

pure virtual

Deletes all items.

Referenced by gui2::listbox::clear(), and gui2::multi_page::clear().

◆ create_item() [1/2]

virtual grid& gui2::generator_base::create_item	(	const int	index,
		const builder_grid &	list_builder,
		const widget_data &	data,
		const std::function< void(widget &)> &	callback
	)

pure virtual

Creates a new item.

The item_data is used by id, and is meant to set multiple widgets in an item.

Parameters

index	The item before which to add the new item, 0 == begin, -1 == end.
list_builder	A grid builder that's will build the contents of the new item.
data	The data to initialize the parameters of the new item.
callback	The callback function to call when an item in the grid is (de)selected.

Returns: A reference to the newly created grid.

◆ create_item() [2/2]

virtual grid& gui2::generator_base::create_item	(	const int	index,
		const builder_grid &	list_builder,
		const widget_item &	item_data,
		const std::function< void(widget &)> &	callback
	)

pure virtual

Creates a new item.

The item_data is used for the first widget found, this normally should be used when there's one widget in an item.

Parameters

index	The item before which to add the new item, 0 == begin, -1 == end.
list_builder	A grid builder that's will build the contents of the new item.
item_data	The data to initialize the parameters of the new item.
callback	The callback function to call when an item in the grid is (de)selected.

Returns: A reference to the newly created grid.

Referenced by gui2::multi_page::add_page(), and gui2::listbox::add_row().

◆ create_items() [1/2]

virtual void gui2::generator_base::create_items	(	const int	index,
		const builder_grid &	list_builder,
		const std::vector< widget_data > &	data,
		const std::function< void(widget &)> &	callback
	)

pure virtual

Creates one or more new item(s).

For every item in item_data a new item is generated. This version expects multiple widgets per item.

Parameters

index	The item before which to add the new item, 0 == begin, -1 == end.
list_builder	A grid builder that's will build the contents of the new item.
data	The data to initialize the parameters of the new item.
callback	The callback function to call when an item in the grid is (de)selected.

◆ create_items() [2/2]

virtual void gui2::generator_base::create_items	(	const int	index,
		const builder_grid &	list_builder,
		const std::vector< widget_item > &	data,
		const std::function< void(widget &)> &	callback
	)

pure virtual

Creates one or more new item(s).

For every item in item_data a new item is generated. This version expects one widget per item.

Parameters

index	The item before which to add the new item, 0 == begin, -1 == end.
list_builder	A grid builder that's will build the contents of the new item.
data	The data to initialize the parameters of the new item.
callback	The callback function to call when an item in the grid is (de)selected.

◆ delete_item()

virtual void gui2::generator_base::delete_item ( const unsigned index )

pure virtual

Deletes an item.

Implemented in gui2::policy::minimum_selection::no_item, and gui2::policy::minimum_selection::one_item.

Referenced by gui2::multi_page::remove_page(), and gui2::listbox::remove_row().

◆ do_deselect_item()

virtual void gui2::generator_base::do_deselect_item ( const unsigned index )

protectedpure virtual

Deselects a selected item.

Parameters

index The index of a selected item.

Referenced by gui2::policy::minimum_selection::no_item::delete_item(), gui2::policy::minimum_selection::one_item::deselect_item(), gui2::policy::minimum_selection::no_item::deselect_item(), gui2::policy::maximum_selection::one_item::select_item(), gui2::policy::minimum_selection::one_item::set_item_shown(), and gui2::policy::minimum_selection::no_item::set_item_shown().

◆ do_select_item()

virtual void gui2::generator_base::do_select_item ( const unsigned index )

protectedpure virtual

Selects a not selected item.

Parameters

index The index of a not selected item.

Referenced by gui2::policy::minimum_selection::one_item::create_item(), gui2::policy::maximum_selection::one_item::select_item(), gui2::policy::maximum_selection::many_items::select_item(), and gui2::policy::minimum_selection::one_item::set_item_shown().

◆ find_at() [1/2]

virtual const widget* gui2::generator_base::find_at	(	const point &	coordinate,
		const bool	must_be_active
	)		const

overridepure virtual

See widget::find_at.

Reimplemented from gui2::widget.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::vertical_list, gui2::policy::placement::horizontal_list, and gui2::policy::placement::table.

◆ find_at() [2/2]

virtual widget* gui2::generator_base::find_at	(	const point &	coordinate,
		const bool	must_be_active
	)

overridepure virtual

See widget::find_at.

Reimplemented from gui2::widget.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::vertical_list, gui2::policy::placement::horizontal_list, and gui2::policy::placement::table.

◆ get_item_at_ordered()

virtual unsigned gui2::generator_base::get_item_at_ordered ( unsigned index_ordered ) const

pure virtual

If a sort-order is being applied, maps from sorted to unsorted indicies.

This does not take account of whether each object is shown or not.

◆ get_item_count()

virtual unsigned gui2::generator_base::get_item_count ( ) const

pure virtual

Returns the number of items.

◆ get_item_shown()

virtual bool gui2::generator_base::get_item_shown ( const unsigned index ) const

pure virtual

Returns whether the item is shown.

◆ get_items_shown()

boost::dynamic_bitset gui2::generator_base::get_items_shown ( ) const

inline

Returns the visibility of all the items as a bit set.

Definition at line 120 of file generator.hpp.

References get_item_count(), get_item_shown(), and i.

Referenced by gui2::listbox::get_rows_shown(), and gui2::listbox::set_row_shown().

◆ get_ordered_index()

virtual unsigned gui2::generator_base::get_ordered_index ( unsigned index ) const

pure virtual

If a sort-order is being applied, maps from unsorted to sorted indicies.

This does not take account of whether each object is shown or not.

◆ get_selected_item()

virtual int gui2::generator_base::get_selected_item ( ) const

pure virtual

Returns the selected item.

If a list has multiple selected items it looks whether it knows the last item actually selected, if that item is selected that one is chosen. Else is goes through all selected items and returns the first one selected.

Note: stacked_widget depends on that behavior it always has all items selected and thus shown and by default the last selected item (the top one) is active.

Returns: The selected item, -1 if none selected.

◆ get_selected_item_count()

virtual unsigned gui2::generator_base::get_selected_item_count ( ) const

pure virtual

Returns the number of selected items.

◆ handle_key_down_arrow()

virtual void gui2::generator_base::handle_key_down_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

pure virtual

Down arrow key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::table, gui2::policy::placement::horizontal_list, and gui2::policy::placement::vertical_list.

Referenced by gui2::listbox::handle_key_down_arrow().

◆ handle_key_left_arrow()

virtual void gui2::generator_base::handle_key_left_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

pure virtual

Left arrow key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::table, gui2::policy::placement::vertical_list, and gui2::policy::placement::horizontal_list.

Referenced by gui2::listbox::handle_key_left_arrow().

◆ handle_key_right_arrow()

virtual void gui2::generator_base::handle_key_right_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

pure virtual

Right arrow key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::table, gui2::policy::placement::vertical_list, and gui2::policy::placement::horizontal_list.

Referenced by gui2::listbox::handle_key_right_arrow().

◆ handle_key_up_arrow()

virtual void gui2::generator_base::handle_key_up_arrow	(	SDL_Keymod	modifier,
		bool &	handled
	)

pure virtual

Up arrow key pressed.

Parameters

modifier	The SDL keyboard modifier when the key was pressed.
handled	If the function handles the key it should set handled to true else do not modify it. This is used in the keyboard event changing.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::table, gui2::policy::placement::horizontal_list, and gui2::policy::placement::vertical_list.

Referenced by gui2::listbox::handle_key_up_arrow().

◆ impl_draw_children()

virtual void gui2::generator_base::impl_draw_children ( )

overridepure virtual

See widget::impl_draw_children.

Reimplemented from gui2::widget.

◆ is_selected()

virtual bool gui2::generator_base::is_selected ( const unsigned index ) const

pure virtual

Returns whether the item is selected.

Referenced by gui2::policy::minimum_selection::no_item::delete_item(), gui2::policy::placement::independent::find(), gui2::stacked_widget::layer_selected(), gui2::listbox::row_selected(), gui2::stacked_widget::select_layer_impl(), gui2::policy::minimum_selection::one_item::set_item_shown(), gui2::policy::minimum_selection::no_item::set_item_shown(), and toggle_item().

◆ item() [1/2]

virtual const grid& gui2::generator_base::item ( const unsigned index ) const

pure virtual

Gets the grid of an item.

◆ item() [2/2]

virtual grid& gui2::generator_base::item ( const unsigned index )

pure virtual

Gets the grid of an item.

◆ item_ordered() [1/2]

virtual const grid& gui2::generator_base::item_ordered ( const unsigned index ) const

protectedpure virtual

Gets the grid of an item.

◆ item_ordered() [2/2]

virtual grid& gui2::generator_base::item_ordered ( const unsigned index )

protectedpure virtual

Gets the grid of an item.

◆ layout_initialize()

virtual void gui2::generator_base::layout_initialize ( const bool full_initialization )

overridepure virtual

See widget::layout_initialize.

Reimplemented from gui2::widget.

◆ place()

virtual void gui2::generator_base::place	(	const point &	origin,
		const point &	size
	)

overridepure virtual

See widget::place.

Reimplemented from gui2::widget.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::vertical_list, gui2::policy::placement::horizontal_list, and gui2::policy::placement::table.

Referenced by gui2::listbox::set_row_shown().

◆ request_reduce_height()

virtual void gui2::generator_base::request_reduce_height ( const unsigned maximum_height )

overridepure virtual

See widget::request_reduce_height.

Reimplemented from gui2::widget.

Implemented in gui2::policy::placement::table, gui2::policy::placement::vertical_list, gui2::policy::placement::horizontal_list, and gui2::policy::placement::independent.

◆ request_reduce_width()

virtual void gui2::generator_base::request_reduce_width ( const unsigned maximum_width )

overridepure virtual

See widget::request_reduce_width.

Implements gui2::widget.

Implemented in gui2::policy::placement::table, gui2::policy::placement::vertical_list, gui2::policy::placement::horizontal_list, and gui2::policy::placement::independent.

◆ select_item()

virtual void gui2::generator_base::select_item	(	const unsigned	index,
		const bool	select
	)

pure virtual

(De)selects an item.

Parameters

index	The item to (de)select.
select	If true selects, if false deselects.

Implemented in gui2::policy::maximum_selection::many_items, and gui2::policy::maximum_selection::one_item.

◆ set_item_shown()

virtual void gui2::generator_base::set_item_shown	(	const unsigned	index,
		const bool	show
	)

pure virtual

Shows or hides an item.

The caller is responsible for reformatting the grid. If a selected item is hidden then it will be automatically deselected; if no items are shown then no items will be selected, even if has_minimum was requested.

Parameters

index	The item to show or hide.
show	If true shows the item, else hides it.

Implemented in gui2::policy::minimum_selection::no_item, and gui2::policy::minimum_selection::one_item.

Referenced by gui2::listbox::set_row_shown().

◆ set_order()

virtual void gui2::generator_base::set_order ( const order_func & order )

pure virtual

Referenced by gui2::listbox::order_by().

◆ set_origin()

virtual void gui2::generator_base::set_origin ( const point & origin )

overridepure virtual

See widget::set_origin.

Reimplemented from gui2::widget.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::vertical_list, gui2::policy::placement::horizontal_list, and gui2::policy::placement::table.

◆ set_visible_rectangle()

virtual void gui2::generator_base::set_visible_rectangle ( const SDL_Rect & rectangle )

overridepure virtual

See widget::set_visible_rectangle.

Reimplemented from gui2::widget.

Implemented in gui2::policy::placement::independent, gui2::policy::placement::vertical_list, gui2::policy::placement::horizontal_list, and gui2::policy::placement::table.

◆ toggle_item()

void gui2::generator_base::toggle_item ( const unsigned index )

inline

Toggles the selection state of an item.

Parameters

index The item to toggle.

Definition at line 96 of file generator.hpp.

References utf8::index(), is_selected(), and select_item().

Referenced by gui2::listbox::list_item_clicked().

Friends And Related Function Documentation

◆ debug_layout_graph

friend class debug_layout_graph

friend

Definition at line 40 of file generator.hpp.

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

gui/widgets/generator.hpp
gui/widgets/generator.cpp

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Detailed Description

Member Typedef Documentation

◆ order_func

Member Enumeration Documentation

◆ placement

Constructor & Destructor Documentation

◆ ~generator_base()

Member Function Documentation

◆ build()

◆ calculate_best_size()

◆ clear()

◆ create_item() [1/2]

◆ create_item() [2/2]

◆ create_items() [1/2]

◆ create_items() [2/2]

◆ delete_item()

◆ do_deselect_item()

◆ do_select_item()

◆ find_at() [1/2]

◆ find_at() [2/2]

◆ get_item_at_ordered()

◆ get_item_count()

◆ get_item_shown()

◆ get_items_shown()

◆ get_ordered_index()

◆ get_selected_item()

◆ get_selected_item_count()

◆ handle_key_down_arrow()

◆ handle_key_left_arrow()

◆ handle_key_right_arrow()

◆ handle_key_up_arrow()

◆ impl_draw_children()

◆ is_selected()

◆ item() [1/2]

◆ item() [2/2]

◆ item_ordered() [1/2]

◆ item_ordered() [2/2]

◆ layout_initialize()

◆ place()

◆ request_reduce_height()

◆ request_reduce_width()

◆ select_item()

◆ set_item_shown()

◆ set_order()

◆ set_origin()

◆ set_visible_rectangle()

◆ toggle_item()

Friends And Related Function Documentation

◆ debug_layout_graph