#include <pane.hpp>

Inheritance diagram for gui2::tpane:

Classes
struct	titem

Public Types
typedef std::function< bool(const titem &, const titem &)>	tcompare_functor

typedef std::function< bool(const titem &)>	tfilter_functor

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

enum	tposition { 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	tmouse_behavior { all, hit, none }
	The behavior of the mouse events. More...

Public Member Functions
	tpane (const tbuilder_grid_ptr item_builder)

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

virtual void	place (const tpoint &origin, const tpoint &size) override
	See twidget::place. More...

virtual void	layout_initialise (const bool full_initialisation) override
	See twidget::layout_initialise. More...

virtual void	impl_draw_children (surface &frame_buffer, int x_offset, int y_offset) override
	See twidget::impl_draw_children. More...

virtual void	child_populate_dirty_list (twindow &caller, const std::vector< twidget * > &call_stack) override
	See twidget::child_populate_dirty_list. More...

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

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

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

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

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

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

virtual iterator::twalker_ *	create_walker () override
	See twidget::create_walker. More...

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

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

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

	twidget (const tbuilder_widget &builder)
	Constructor. More...

virtual	~twidget () override

void	set_id (const std::string &id)

const std::string &	id () const

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

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

tdialog *	dialog ()
	Returns the top-level dialogue. More...

void	set_parent (twidget *parent)

twidget *	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...

tpoint	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 tpoint &origin)
	Sets the origin of the widget. More...

virtual void	set_size (const tpoint &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	layout_children ()
	Allows a widget to update its children. More...

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

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

SDL_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)

SDL_Rect	calculate_blitting_rectangle (const int x_offset, const int y_offset)
	Calculates the blitting rectangle of the widget. More...

SDL_Rect	calculate_clipping_rectangle (const int x_offset, const int y_offset)
	Calculates the clipping rectangle of the widget. More...

void	draw_background (surface &frame_buffer, int x_offset, int y_offset)
	Draws the background of a widget. More...

void	draw_children (surface &frame_buffer, int x_offset, int y_offset)
	Draws the children of a widget. More...

void	draw_foreground (surface &frame_buffer, int x_offset, int y_offset)
	Draws the foreground of the widget. More...

void	populate_dirty_list (twindow &caller, std::vector< twidget * > &call_stack)
	Adds a widget to the dirty list if it is dirty. 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	set_is_dirty (const bool is_dirty)

bool	get_is_dirty () const

void	set_visible (const tvisible::scoped_enum visible)

tvisible::scoped_enum	get_visible () const

tredraw_action::scoped_enum	get_drawing_action () const

void	set_debug_border_mode (const unsigned debug_border_mode)

void	set_debug_border_colour (const unsigned debug_border_colour)

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

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

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

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

virtual	~tevent_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

tevent_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::tdispatcher
	tdispatcher ()

virtual	~tdispatcher ()

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

bool	has_event (const tevent event, const tevent_type event_type)

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

bool	fire (const tevent event, twidget &target, const tpoint &coordinate)
	Fires an event which takes a coordinate parameter. More...

bool	fire (const tevent event, twidget &target, const SDLKey key, const SDLMod modifier, const utf8::string &unicode)
	Fires an event which takes keyboard parameters. More...

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

bool	fire (const tevent event, twidget &target, tmessage &message)
	Fires an event which takes message parameters. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event, boost::mpl::int_ < E > > >::type	connect_signal (const tsignal_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event, boost::mpl::int_ < E > > >::type	disconnect_signal (const tsignal_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_mouse, boost::mpl::int_< E > > >::type	connect_signal (const tsignal_mouse_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event_mouse. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_mouse, boost::mpl::int_< E > > >::type	disconnect_signal (const tsignal_mouse_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event_mouse. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_keyboard, boost::mpl::int_< E > > >::type	connect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event_keyboard. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_keyboard, boost::mpl::int_< E > > >::type	disconnect_signal (const tsignal_keyboard_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event_keyboard. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_notification, boost::mpl::int_< E > > >::type	connect_signal (const tsignal_notification_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event_notification. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_notification, boost::mpl::int_< E > > >::type	disconnect_signal (const tsignal_notification_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event_notification. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_message, boost::mpl::int_< E > > >::type	connect_signal (const tsignal_message_function &signal, const tposition position=back_child)
	Connect a signal for callback in tset_event_message. More...

template<tevent E>
boost::enable_if < boost::mpl::has_key < tset_event_message, boost::mpl::int_< E > > >::type	disconnect_signal (const tsignal_message_function &signal, const tposition position=back_child)
	Disconnect a signal for callback in tset_event_message. More...

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

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

void	set_mouse_behavior (const tmouse_behavior mouse_behavior)

tmouse_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 thotkey_function &function)
	Registers a hotkey. More...

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

Static Public Member Functions
static tpane *	build (const implementation::tbuilder_pane &builder)

Private Member Functions
	tpane (const implementation::tbuilder_pane &builder)

virtual tpoint	calculate_best_size () const override
	See twidget::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 (tdispatcher &dispatcher, const event::tevent event, bool &handled)

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

tbuilder_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< tplacer_ >	placer_
	Helper to do the placement. More...

Friends
struct	tpane_implementation

Additional Inherited Members
Protected Member Functions inherited from gui2::twidget
void	set_layout_size (const tpoint &size)

const tpoint &	layout_size () const

Detailed Description

Definition at line 40 of file pane.hpp.

Member Typedef Documentation

typedef std::function<bool(const titem&, const titem&)> gui2::tpane::tcompare_functor

Definition at line 54 of file pane.hpp.

typedef std::function<bool(const titem&)> gui2::tpane::tfilter_functor

Definition at line 56 of file pane.hpp.

Constructor & Destructor Documentation

gui2::tpane::tpane ( const tbuilder_grid_ptr item_builder )

explicit

Deprecated:: Use the second overload.

Definition at line 111 of file pane.cpp.

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

Referenced by build().

gui2::tpane::tpane ( const implementation::tbuilder_pane & builder )

explicitprivate

Definition at line 124 of file pane.cpp.

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

Member Function Documentation

tpane * gui2::tpane::build ( const implementation::tbuilder_pane & builder )

static

Definition at line 137 of file pane.cpp.

References tpane().

Referenced by gui2::implementation::tbuilder_pane::build().

tpoint gui2::tpane::calculate_best_size ( ) const

overrideprivatevirtual

See twidget::calculate_best_size.

Implements gui2::twidget.

Definition at line 249 of file pane.cpp.

References placer_, and prepare_placement().

void gui2::tpane::child_populate_dirty_list	(	twindow &	caller,
		const std::vector< twidget * > &	call_stack
	)

overridevirtual

See twidget::child_populate_dirty_list.

Reimplemented from gui2::twidget.

Definition at line 205 of file pane.cpp.

References items_.

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

Creates a new item.

Definition at line 142 of file pane.cpp.

References gui2::event::tdispatcher::fire(), gui2::tpane::titem::grid, gui2::tpane::titem::id, item_builder_, item_id_generator_, items_, gui2::event::REQUEST_PLACEMENT, gui2::tcontrol::set_members(), and gui2::twidget::set_parent().

Referenced by gui2::tmatrix::create_item(), and gui2::tdebug_clock::update_time().

iterator::twalker_ * gui2::tpane::create_walker ( )

overridevirtual

See twidget::create_walker.

Todo:: Implement properly.

Implements gui2::twidget.

Definition at line 260 of file pane.cpp.

bool gui2::tpane::disable_click_dismiss ( ) const

overridevirtual

See twidget::disable_click_dismiss.

Implements gui2::twidget.

Definition at line 255 of file pane.cpp.

void gui2::tpane::filter ( const tfilter_functor & 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 222 of file pane.cpp.

References gui2::twidget::tvisible::invisible, items_, set_origin_children(), and gui2::twidget::tvisible::visible.

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

twidget * gui2::tpane::find_at	(	const tpoint &	coordinate,
		const bool	must_be_active
	)

overridevirtual

See twidget::find_at.

Reimplemented from gui2::twidget.

Definition at line 238 of file pane.cpp.

References gui2::tpane_implementation::find_at().

const twidget * gui2::tpane::find_at	(	const tpoint &	coordinate,
		const bool	must_be_active
	)		const

overridevirtual

See twidget::find_at.

Reimplemented from gui2::twidget.

Definition at line 243 of file pane.cpp.

References gui2::tpane_implementation::find_at().

tgrid * gui2::tpane::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 268 of file pane.cpp.

References gui2::tpane_implementation::grid().

const tgrid * gui2::tpane::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 273 of file pane.cpp.

References gui2::tpane_implementation::grid().

void gui2::tpane::impl_draw_children	(	surface &	frame_buffer,
		int	x_offset,
		int	y_offset
	)

overridevirtual

See twidget::impl_draw_children.

Reimplemented from gui2::twidget.

Definition at line 193 of file pane.cpp.

References DBG_GUI_D, gui2::twidget::tvisible::invisible, items_, and LOG_HEADER.

void gui2::tpane::layout_initialise ( const bool full_initialisation )

overridevirtual

See twidget::layout_initialise.

Reimplemented from gui2::twidget.

Definition at line 178 of file pane.cpp.

References DBG_GUI_D, gui2::twidget::tvisible::invisible, items_, gui2::twidget::layout_initialise(), and LOG_HEADER.

void gui2::tpane::place	(	const tpoint &	origin,
		const tpoint &	size
	)

overridevirtual

See twidget::place.

Reimplemented from gui2::twidget.

Definition at line 167 of file pane.cpp.

References DBG_GUI_L, LOG_HEADER, gui2::twidget::place(), place_children(), gui2::tpoint::x, and gui2::tpoint::y.

void gui2::tpane::place_children ( )

private

Places the children on the pane.

Definition at line 278 of file pane.cpp.

References gui2::twidget::tvisible::invisible, items_, placer_, and prepare_placement().

Referenced by place().

void gui2::tpane::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 310 of file pane.cpp.

References gui2::twidget::tvisible::invisible, items_, placer_, and prepare_placement().

Referenced by signal_handler_request_placement().

void gui2::tpane::prepare_placement ( ) const

private

Updates the placement for the child items.

Definition at line 330 of file pane.cpp.

References gui2::twidget::tvisible::invisible, items_, and placer_.

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

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

overridevirtual

See twidget::request_reduce_width.

Implements gui2::twidget.

Definition at line 234 of file pane.cpp.

void gui2::tpane::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 294 of file pane.cpp.

References gui2::twidget::tvisible::invisible, items_, placer_, and prepare_placement().

Referenced by filter(), and sort().

void gui2::tpane::signal_handler_request_placement	(	tdispatcher &	dispatcher,
		const event::tevent	event,
		bool &	handled
	)

private

Definition at line 345 of file pane.cpp.

References DBG_GUI_E, gui2::twidget::get_window(), gui2::twidget::tvisible::invisible, items_, gui2::twidget::layout_initialise(), gui2::twindow::layout_linked_widgets(), LOG_HEADER, and place_or_set_origin_children().

Referenced by tpane().

void gui2::tpane::sort ( const tcompare_functor & compare_functor )

Sorts the contents of the pane.

Parameters

compare_functor The functor to use to sort the items.

Definition at line 215 of file pane.cpp.

References items_, and set_origin_children().

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

Friends And Related Function Documentation

friend struct tpane_implementation

friend

Definition at line 42 of file pane.hpp.

Member Data Documentation

tbuilder_grid_ptr gui2::tpane::item_builder_

private

The builer for the items in the list.

Definition at line 158 of file pane.hpp.

Referenced by create_item().

unsigned gui2::tpane::item_id_generator_

private

The id generator for the items.

Definition at line 161 of file pane.hpp.

Referenced by create_item().

std::list<titem> gui2::tpane::items_

private

The items in the pane.

Definition at line 155 of file pane.hpp.

Referenced by child_populate_dirty_list(), create_item(), filter(), impl_draw_children(), layout_initialise(), place_children(), place_or_set_origin_children(), prepare_placement(), set_origin_children(), signal_handler_request_placement(), and sort().

std::unique_ptr<tplacer_> gui2::tpane::placer_

private

Helper to do the placement.

Definition at line 164 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

Static Public Member Functions

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

Constructor & Destructor Documentation

Member Function Documentation

Friends And Related Function Documentation

Member Data Documentation