A pane is a container where new members can be added and removed during run-time. More...

#include <pane.hpp>

Inheritance diagram for gui2::pane:

Classes
struct	item

Public Types
typedef std::function< bool(const item &, const item &)>	compare_functor_t

typedef std::function< bool(const item &)>	filter_functor_t

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
	pane (const implementation::builder_pane &builder)

unsigned	create_item (const widget_data &item_data, const std::map< std::string, std::string > &tags)
	Creates a new item. More...

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

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

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

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

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

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

void	sort (const compare_functor_t &compare_functor)
	Sorts the contents of the pane. More...

void	filter (const filter_functor_t &filter_functor)
	Filters the contents of the pane. More...

bool	disable_click_dismiss () const override
	See widget::disable_click_dismiss. More...

virtual iteration::walker_ptr	create_walker () override
	See widget::create_walker. More...

grid *	get_grid (const unsigned id)
	Returns a grid in the pane. More...

const grid *	get_grid (const unsigned id) const
	Returns a grid in the pane. 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	request_reduce_height (const unsigned maximum_height)
	Tries to reduce the height 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_origin (const point &origin)
	Sets the origin of the widget. 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...

virtual void	set_visible_rectangle (const SDL_Rect &rectangle)
	Sets the visible rectangle for a 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

void	set_visible (bool visible)
	Sets widget to visible if visible is true, else invisible. More...

void	set_hidden (bool hidden)
	Sets widget to visible if hidden is true, else hidden. More...

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_view id, const bool must_be_active)
	Returns a widget with the wanted id. More...

virtual const widget *	find (const std::string_view 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 >
T *	find_widget (const std::string_view id, const bool must_be_active, const bool must_exist)
	Gets a widget with the wanted id. More...

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

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

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

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)

Private Member Functions
virtual point	calculate_best_size () const override
	See widget::calculate_best_size. More...

void	place_children ()
	Places the children on the pane. More...

void	set_origin_children ()
	Moves the children on the pane. More...

void	place_or_set_origin_children ()
	Places or moves the children on the pane. More...

void	prepare_placement () const
	Updates the placement for the child items. More...

void	signal_handler_request_placement (dispatcher &dispatcher, const event::ui_event event, bool &handled)

Private Attributes
std::list< item >	items_
	The items in the pane. More...

builder_grid_ptr	item_builder_
	The builer for the items in the list. More...

unsigned	item_id_generator_
	The id generator for the items. More...

std::unique_ptr< placer_base >	placer_
	Helper to do the placement. More...

Friends
struct	pane_implementation

Additional Inherited Members
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...

Detailed Description

A pane is a container where new members can be added and removed during run-time.

Definition at line 40 of file pane.hpp.

Member Typedef Documentation

◆ compare_functor_t

typedef std::function<bool(const item&, const item&)> gui2::pane::compare_functor_t

Definition at line 53 of file pane.hpp.

◆ filter_functor_t

typedef std::function<bool(const item&)> gui2::pane::filter_functor_t

Definition at line 55 of file pane.hpp.

Constructor & Destructor Documentation

◆ pane()

gui2::pane::pane ( const implementation::builder_pane & builder )

explicit

Definition at line 104 of file pane.cpp.

References gui2::event::dispatcher::back_pre_child, and signal_handler_request_placement().

Member Function Documentation

◆ calculate_best_size()

point gui2::pane::calculate_best_size ( ) const

overrideprivatevirtual

See widget::calculate_best_size.

Implements gui2::widget.

Definition at line 210 of file pane.cpp.

References placer_, and prepare_placement().

◆ create_item()

unsigned gui2::pane::create_item	(	const widget_data &	item_data,
		const std::map< std::string, std::string > &	tags
	)

Creates a new item.

Definition at line 117 of file pane.cpp.

References data, gui2::event::dispatcher::fire(), gui2::pane::item::id, item_builder_, gui2::pane::item::item_grid, item_id_generator_, items_, gui2::event::REQUEST_PLACEMENT, and gui2::styled_widget::set_members().

Referenced by gui2::matrix::create_item(), and gui2::dialogs::debug_clock::update_time().

◆ create_walker()

iteration::walker_ptr gui2::pane::create_walker ( )

overridevirtual

See widget::create_walker.

Todo:: Implement properly.

Implements gui2::widget.

Definition at line 221 of file pane.cpp.

◆ disable_click_dismiss()

bool gui2::pane::disable_click_dismiss ( ) const

overridevirtual

See widget::disable_click_dismiss.

Implements gui2::widget.

Definition at line 216 of file pane.cpp.

◆ filter()

void gui2::pane::filter ( const filter_functor_t & filter_functor )

Filters the contents of the pane.

if the filter_functor returns true the item shown, else it's hidden.

Parameters

filter_functor The functor to determine whether an item should be shown or hidden.

Definition at line 185 of file pane.cpp.

References gui2::pane::item::item_grid, items_, and set_origin_children().

Referenced by gui2::matrix::filter().

◆ find_at() [1/2]

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

overridevirtual

See widget::find_at.

Reimplemented from gui2::widget.

Definition at line 204 of file pane.cpp.

References gui2::pane_implementation::find_at().

◆ find_at() [2/2]

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

overridevirtual

See widget::find_at.

Reimplemented from gui2::widget.

Definition at line 199 of file pane.cpp.

References gui2::pane_implementation::find_at().

◆ get_grid() [1/2]

grid * gui2::pane::get_grid ( const unsigned id )

Returns a grid in the pane.

Parameters

id	The id of the item whose grid to return. The id is the value returned by create_item().

Returns: The wanted grid.

Return values

nullptr The id isn't associated with an item.

Definition at line 229 of file pane.cpp.

References gui2::pane_implementation::get_grid().

◆ get_grid() [2/2]

const grid * gui2::pane::get_grid ( const unsigned id ) const

Returns a grid in the pane.

Parameters

id	The id of the item whose grid to return. The id is the value returned by create_item().

Returns: The wanted grid.

Return values

nullptr The id isn't associated with an item.

Definition at line 234 of file pane.cpp.

References gui2::pane_implementation::get_grid().

◆ impl_draw_children()

void gui2::pane::impl_draw_children ( )

overridevirtual

See widget::impl_draw_children.

Reimplemented from gui2::widget.

Definition at line 166 of file pane.cpp.

References DBG_GUI_D, gui2::widget::invisible, gui2::pane::item::item_grid, items_, and LOG_HEADER.

◆ layout_initialize()

void gui2::pane::layout_initialize ( const bool full_initialization )

overridevirtual

See widget::layout_initialize.

Reimplemented from gui2::widget.

Definition at line 152 of file pane.cpp.

References DBG_GUI_D, gui2::widget::invisible, gui2::pane::item::item_grid, items_, gui2::widget::layout_initialize(), and LOG_HEADER.

◆ place()

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

overridevirtual

See widget::place.

Reimplemented from gui2::widget.

Definition at line 141 of file pane.cpp.

References DBG_GUI_L, LOG_HEADER, gui2::widget::place(), place_children(), and utf8::size().

◆ place_children()

void gui2::pane::place_children ( )

private

Places the children on the pane.

Definition at line 239 of file pane.cpp.

References utf8::index(), gui2::widget::invisible, gui2::pane::item::item_grid, items_, placer_, and prepare_placement().

Referenced by place().

◆ place_or_set_origin_children()

void gui2::pane::place_or_set_origin_children ( )

private

Places or moves the children on the pane.

If the child has its best size it's move else placed.

Note: It would probably be possible to merge all three placement routines into one and using a flag for what to do: place, set_origin or place_or_set_origin.

Definition at line 271 of file pane.cpp.

References utf8::index(), gui2::widget::invisible, gui2::pane::item::item_grid, items_, placer_, and prepare_placement().

Referenced by signal_handler_request_placement().

◆ prepare_placement()

void gui2::pane::prepare_placement ( ) const

private

Updates the placement for the child items.

Definition at line 291 of file pane.cpp.

References gui2::widget::invisible, gui2::pane::item::item_grid, items_, and placer_.

Referenced by calculate_best_size(), place_children(), place_or_set_origin_children(), and set_origin_children().

◆ request_reduce_width()

void gui2::pane::request_reduce_width ( const unsigned maximum_width )

overridevirtual

See widget::request_reduce_width.

Implements gui2::widget.

Definition at line 195 of file pane.cpp.

◆ set_origin_children()

void gui2::pane::set_origin_children ( )

private

Moves the children on the pane.

After certain operations, e.g. sorting the child widgets need to be placed again. This function does so, but avoids dirtying the widget so redrawing doesn't involve re-rendering the entire widget.

Definition at line 255 of file pane.cpp.

References utf8::index(), gui2::widget::invisible, gui2::pane::item::item_grid, items_, placer_, and prepare_placement().

Referenced by filter(), and sort().

◆ signal_handler_request_placement()

void gui2::pane::signal_handler_request_placement	(	dispatcher &	dispatcher,
		const event::ui_event	event,
		bool &	handled
	)

private

Definition at line 306 of file pane.cpp.

References DBG_GUI_E, gui2::event::dispatcher::dispatcher(), gui2::widget::get_window(), gui2::widget::invisible, gui2::pane::item::item_grid, items_, gui2::window::layout_linked_widgets(), LOG_HEADER, place_or_set_origin_children(), and draw::point().

Referenced by pane().

◆ sort()

void gui2::pane::sort ( const compare_functor_t & compare_functor )

Sorts the contents of the pane.

Parameters

compare_functor The functor to use to sort the items.

Definition at line 178 of file pane.cpp.

References items_, and set_origin_children().

Referenced by gui2::matrix::sort().

Friends And Related Function Documentation

◆ pane_implementation

friend struct pane_implementation

friend

Definition at line 42 of file pane.hpp.

Member Data Documentation

◆ item_builder_

builder_grid_ptr gui2::pane::item_builder_

private

The builer for the items in the list.

Definition at line 144 of file pane.hpp.

Referenced by create_item().

◆ item_id_generator_

unsigned gui2::pane::item_id_generator_

private

The id generator for the items.

Definition at line 147 of file pane.hpp.

Referenced by create_item().

◆ items_

std::list<item> gui2::pane::items_

private

The items in the pane.

Definition at line 141 of file pane.hpp.

Referenced by create_item(), filter(), gui2::pane_implementation::find_at(), gui2::pane_implementation::get_grid(), impl_draw_children(), layout_initialize(), place_children(), place_or_set_origin_children(), prepare_placement(), set_origin_children(), signal_handler_request_placement(), and sort().

◆ placer_

std::unique_ptr<placer_base> gui2::pane::placer_

private

Helper to do the placement.

Definition at line 150 of file pane.hpp.

Referenced by calculate_best_size(), place_children(), place_or_set_origin_children(), prepare_placement(), and set_origin_children().

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

gui/widgets/pane.hpp
gui/widgets/pane.cpp

Classes

Public Types

Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ compare_functor_t

◆ filter_functor_t

Constructor & Destructor Documentation

◆ pane()

Member Function Documentation

◆ calculate_best_size()

◆ create_item()

◆ create_walker()

◆ disable_click_dismiss()

◆ filter()

◆ find_at() [1/2]

◆ find_at() [2/2]

◆ get_grid() [1/2]

◆ get_grid() [2/2]

◆ impl_draw_children()

◆ layout_initialize()

◆ place()

◆ place_children()

◆ place_or_set_origin_children()

◆ prepare_placement()

◆ request_reduce_width()

◆ set_origin_children()

◆ signal_handler_request_placement()

◆ sort()

Friends And Related Function Documentation

◆ pane_implementation

Member Data Documentation

◆ item_builder_

◆ item_id_generator_

◆ items_

◆ placer_