The Battle for Wesnoth  1.13.10+dev
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Modules Pages
Classes | Public Types | Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
gui2::pane Class Reference

#include <pane.hpp>

Inheritance diagram for gui2::pane:
Inheritance graph

Classes

struct  item
 

Public Types

typedef std::function< bool(const
item &, const item &)> 
tcompare_functor
 
typedef std::function< bool(const
item &)> 
tfilter_functor
 
- Public Types inherited from gui2::widget
enum  visibility { visibility::visible, visibility::hidden, visibility::invisible }
 Visibility settings done by the user. More...
 
enum  redraw_action { redraw_action::full, redraw_action::partly, redraw_action::none }
 Visibility set by the engine. More...
 
- 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  mouse_behavior { all, hit, none }
 The behavior of the mouse events. More...
 

Public Member Functions

 pane (const builder_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 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 (surface &frame_buffer, int x_offset, int y_offset) override
 See widget::impl_draw_children. More...
 
virtual void child_populate_dirty_list (window &caller, const std::vector< widget * > &call_stack) override
 See widget::child_populate_dirty_list. More...
 
virtual void request_reduce_width (const unsigned maximum_width) override
 See widget::request_reduce_width. More...
 
virtual widgetfind_at (const point &coordinate, const bool must_be_active) override
 See widget::find_at. More...
 
virtual const widgetfind_at (const point &coordinate, const bool must_be_active) const override
 See widget::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 widget::disable_click_dismiss. More...
 
virtual iteration::walker_basecreate_walker () override
 See widget::create_walker. More...
 
gridget_grid (const unsigned id)
 Returns a grid in the pane. More...
 
const gridget_grid (const unsigned id) const
 Returns a grid in the pane. More...
 
- Public Member Functions inherited from gui2::widget
 widget (const widget &)=delete
 
widgetoperator= (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
 
windowget_window ()
 Get the parent window. More...
 
const windowget_window () const
 The constant version of get_window. More...
 
gridget_parent_grid ()
 Get the parent grid. More...
 
dialogs::modal_dialogdialog ()
 Returns the top-level dialog. More...
 
void set_parent (widget *parent)
 
widgetparent ()
 
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...
 
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 (window &caller, std::vector< widget * > &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 visibility visible)
 
visibility get_visible () const
 
redraw_action get_drawing_action () const
 
void set_debug_border_mode (const unsigned debug_border_mode)
 
void set_debug_border_color (const color_t debug_border_color)
 
virtual widgetfind (const std::string &id, const bool must_be_active)
 Returns a widget with the wanted id. More...
 
virtual const widgetfind (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...
 
- 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_executorset_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...
 
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 utf8::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 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, 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>
utils::enable_if_t< has_key
< set_event, E >::value > 
connect_signal (const signal_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event, E >::value > 
disconnect_signal (const signal_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
connect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_mouse, E >::value > 
disconnect_signal (const signal_mouse_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_mouse. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
connect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_keyboard, E >
::value > 
disconnect_signal (const signal_keyboard_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_keyboard. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
connect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_touch, E >::value > 
disconnect_signal (const signal_touch_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_touch. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
connect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_notification, E >
::value > 
disconnect_signal (const signal_notification_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_notification. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
connect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_message, E >
::value > 
disconnect_signal (const signal_message_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_event_message. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
connect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_raw_event, E >
::value > 
disconnect_signal (const signal_raw_event_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_raw_event. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
connect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Connect a signal for callback in set_text_input. More...
 
template<ui_event E>
utils::enable_if_t< has_key
< set_event_text_input, E >
::value > 
disconnect_signal (const signal_text_input_function &signal, const queue_position position=back_child)
 Disconnect a signal for callback in set_text_input. 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...
 

Static Public Member Functions

static panebuild (const implementation::builder_pane &builder)
 

Private Member Functions

 pane (const implementation::builder_pane &builder)
 
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< itemitems_
 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_baseplacer_
 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 pointlayout_size () const
 
void clear_layout_size ()
 Throws away layout_size_. More...
 

Detailed Description

Definition at line 37 of file pane.hpp.

Member Typedef Documentation

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

Definition at line 51 of file pane.hpp.

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

Definition at line 53 of file pane.hpp.

Constructor & Destructor Documentation

gui2::pane::pane ( const builder_grid_ptr  item_builder)
explicit
Deprecated:
Use the second overload.

Definition at line 110 of file pane.cpp.

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

Referenced by build().

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

Member Function Documentation

pane * gui2::pane::build ( const implementation::builder_pane builder)
static

Definition at line 136 of file pane.cpp.

References pane().

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

point gui2::pane::calculate_best_size ( ) const
overrideprivatevirtual

See widget::calculate_best_size.

Implements gui2::widget.

Definition at line 248 of file pane.cpp.

References placer_, and prepare_placement().

void gui2::pane::child_populate_dirty_list ( window caller,
const std::vector< widget * > &  call_stack 
)
overridevirtual
unsigned gui2::pane::create_item ( const std::map< std::string, string_map > &  item_data,
const std::map< std::string, std::string > &  tags 
)
iteration::walker_base * gui2::pane::create_walker ( )
overridevirtual

See widget::create_walker.

Todo:
Implement properly.

Implements gui2::widget.

Definition at line 259 of file pane.cpp.

bool gui2::pane::disable_click_dismiss ( ) const
overridevirtual

See widget::disable_click_dismiss.

Implements gui2::widget.

Definition at line 254 of file pane.cpp.

void gui2::pane::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_functorThe functor to determine whether an item should be shown or hidden.

Definition at line 221 of file pane.cpp.

References gui2::widget::invisible, gui2::pane::item::item_grid, items_, set_origin_children(), gui2::widget::set_visible(), and gui2::widget::visible.

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

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 237 of file pane.cpp.

References gui2::pane_implementation::find_at().

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 242 of file pane.cpp.

References gui2::pane_implementation::find_at().

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

Returns a grid in the pane.

Parameters
idThe id of the item whose grid to return. The id is the value returned by create_item().
Returns
The wanted grid.
Return values
nullptrThe id isn't associated with an item.

Definition at line 267 of file pane.cpp.

References gui2::pane_implementation::get_grid().

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

Returns a grid in the pane.

Parameters
idThe id of the item whose grid to return. The id is the value returned by create_item().
Returns
The wanted grid.
Return values
nullptrThe id isn't associated with an item.

Definition at line 272 of file pane.cpp.

References gui2::pane_implementation::get_grid().

void gui2::pane::impl_draw_children ( surface frame_buffer,
int  x_offset,
int  y_offset 
)
overridevirtual
void gui2::pane::layout_initialize ( const bool  full_initialization)
overridevirtual
void gui2::pane::place ( const point origin,
const point size 
)
overridevirtual

See widget::place.

Reimplemented from gui2::widget.

Definition at line 166 of file pane.cpp.

References DBG_GUI_L, LOG_HEADER, gui2::widget::place(), place_children(), gui2::point::x, and gui2::point::y.

void gui2::pane::place_children ( )
private
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 309 of file pane.cpp.

References gui2::widget::get_best_size(), gui2::widget::get_size(), gui2::widget::get_visible(), utf8::index(), gui2::widget::invisible, gui2::pane::item::item_grid, items_, gui2::grid::place(), placer_, prepare_placement(), and gui2::grid::set_origin().

Referenced by signal_handler_request_placement().

void gui2::pane::prepare_placement ( ) const
private
void gui2::pane::request_reduce_width ( const unsigned  maximum_width)
overridevirtual

See widget::request_reduce_width.

Implements gui2::widget.

Definition at line 233 of file pane.cpp.

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 293 of file pane.cpp.

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

Referenced by filter(), and sort().

void gui2::pane::signal_handler_request_placement ( dispatcher dispatcher,
const event::ui_event  event,
bool &  handled 
)
private
void gui2::pane::sort ( const tcompare_functor compare_functor)

Sorts the contents of the pane.

Parameters
compare_functorThe functor to use to sort the items.

Definition at line 214 of file pane.cpp.

References items_, and set_origin_children().

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

Friends And Related Function Documentation

friend struct pane_implementation
friend

Definition at line 39 of file pane.hpp.

Member Data Documentation

builder_grid_ptr gui2::pane::item_builder_
private

The builer for the items in the list.

Definition at line 155 of file pane.hpp.

Referenced by create_item().

unsigned gui2::pane::item_id_generator_
private

The id generator for the items.

Definition at line 158 of file pane.hpp.

Referenced by create_item().

std::list<item> gui2::pane::items_
private
std::unique_ptr<placer_base> gui2::pane::placer_
private

Helper to do the placement.

Definition at line 161 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: