The Battle for Wesnoth  1.19.0-dev
Public Member Functions | Static Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
gui2::multi_page Class Reference

A multi page is a control that contains several 'pages' of which only one is visible. More...

#include <multi_page.hpp>

Inheritance diagram for gui2::multi_page:

Public Member Functions

 multi_page (const implementation::builder_multi_page &builder)
 
gridadd_page (const widget_item &item)
 Adds single page to the grid. More...
 
gridadd_page (const std::string &type, int insert_pos, const widget_item &item)
 Adds single page to the grid. More...
 
gridadd_page (const widget_data &data)
 Adds single page to the grid. More...
 
gridadd_page (const std::string &type, int insert_pos, const widget_data &data)
 Adds single page to the grid. More...
 
void remove_page (const unsigned page, unsigned count=1)
 Removes a page in the multi page. More...
 
void clear ()
 Removes all pages in the multi page, clearing it. More...
 
unsigned get_page_count () const
 Returns the number of pages. More...
 
void select_page (const unsigned page, const bool select=true)
 Selects a page. More...
 
int get_selected_page () const
 Returns the selected page. More...
 
const gridpage_grid (const unsigned page) const
 Returns the grid for the page. More...
 
gridpage_grid (const unsigned page)
 Returns the grid for the page. More...
 
virtual bool get_active () const override
 See styled_widget::get_active. More...
 
virtual unsigned get_state () const override
 See styled_widget::get_state. More...
 
- Public Member Functions inherited from gui2::container_base
 container_base (const implementation::builder_styled_widget &builder, const std::string &control_type)
 
virtual SDL_Rect get_client_rect () const
 Returns the client rect. More...
 
virtual void layout_initialize (const bool full_initialization) override
 See widget::layout_initialize. More...
 
void reduce_width (const unsigned maximum_width)
 Tries to reduce the width of a container. More...
 
virtual void request_reduce_width (const unsigned maximum_width) override
 See widget::request_reduce_width. More...
 
virtual void demand_reduce_width (const unsigned maximum_width) override
 See widget::demand_reduce_width. More...
 
void reduce_height (const unsigned maximum_height)
 Tries to reduce the height of a container. More...
 
virtual void request_reduce_height (const unsigned maximum_height) override
 See widget::request_reduce_height. More...
 
virtual void demand_reduce_height (const unsigned maximum_height) override
 See widget::demand_reduce_height. More...
 
virtual bool can_wrap () const override
 See widget::can_wrap. More...
 
virtual void place (const point &origin, const point &size) override
 See widget::place. More...
 
virtual bool has_widget (const widget &widget) const override
 See widget::has_widget. More...
 
virtual void set_origin (const point &origin) override
 See widget::set_origin. More...
 
virtual void set_visible_rectangle (const SDL_Rect &rectangle) override
 See widget::set_visible_rectangle. More...
 
virtual void impl_draw_children () override
 See widget::impl_draw_children. 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...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (const std::string &id, const bool must_be_active) const override
 See widget::find. More...
 
virtual void set_active (const bool active) override
 See styled_widget::set_active. 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...
 
void init_grid (const builder_grid &grid_builder)
 Initializes and builds the grid. More...
 
grid::iterator begin ()
 
grid::iterator end ()
 
unsigned add_row (const unsigned count=1)
 
void set_rows (const unsigned rows)
 
unsigned int get_rows () const
 
void set_cols (const unsigned cols)
 
unsigned int get_cols () const
 
void set_rows_cols (const unsigned rows, const unsigned cols)
 
void set_child (std::unique_ptr< widget > widget, const unsigned row, const unsigned col, const unsigned flags, const unsigned border_size)
 
void set_row_grow_factor (const unsigned row, const unsigned factor)
 
void set_column_grow_factor (const unsigned column, const unsigned factor)
 
const gridget_grid () const
 
gridget_grid ()
 
- Public Member Functions inherited from gui2::styled_widget
 styled_widget (const implementation::builder_styled_widget &builder, const std::string &control_type)
 Constructor. More...
 
virtual void set_members (const widget_item &data)
 Sets the members of the styled_widget. More...
 
bool disable_click_dismiss () const override
 See widget::disable_click_dismiss. More...
 
point get_config_minimum_size () const
 Gets the minimum size as defined in the config. More...
 
point get_config_default_size () const
 Gets the default size as defined in the config. More...
 
point get_config_maximum_size () const
 Gets the best size as defined in the config. More...
 
virtual unsigned get_characters_per_line () const
 Returns the number of characters per line. More...
 
virtual bool get_link_aware () const
 Returns whether the label should be link_aware, in in rendering and in searching for links with get_link. More...
 
virtual color_t get_link_color () const
 Returns the color string to be used with links. More...
 
widgetfind (const std::string &id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (const std::string &id, const bool must_be_active) const override
 See widget::find. More...
 
bool get_use_tooltip_on_label_overflow () const
 
void set_use_tooltip_on_label_overflow (const bool use_tooltip=true)
 
const t_stringget_label () const
 
virtual void set_label (const t_string &text)
 
virtual void set_use_markup (bool use_markup)
 
bool get_use_markup () const
 
const t_stringtooltip () const
 
void set_tooltip (const t_string &tooltip)
 
const t_stringhelp_message () const
 
void set_help_message (const t_string &help_message)
 
std::vector< canvas > & get_canvases ()
 
canvasget_canvas (const unsigned index)
 
virtual void set_text_alignment (const PangoAlignment text_alignment)
 
PangoAlignment get_text_alignment () const
 
void set_text_ellipse_mode (const PangoEllipsizeMode ellipse_mode)
 
PangoEllipsizeMode get_text_ellipse_mode () const
 Get the text's ellipsize mode. 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...
 
void set_parent (widget *parent)
 
widgetparent ()
 
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 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...
 
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)
 
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)
 
- 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...
 
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 const std::string & type ()
 Static type getter that does not rely on the widget being constructed. More...
 

Private Member Functions

void set_page_builders (const builder_grid_map &page_builders)
 
void finalize (std::unique_ptr< generator_base > generator, const std::vector< widget_item > &page_data)
 Finishes the building initialization of the widget. More...
 
virtual bool impl_draw_background () override
 See widget::impl_draw_background. More...
 
virtual const std::string & get_control_type () const override
 Inherited from styled_widget, implemented by REGISTER_WIDGET. More...
 
virtual void set_self_active (const bool active) override
 See container_base::set_self_active. More...
 

Private Attributes

generator_basegenerator_
 Contains a pointer to the generator. More...
 
builder_grid_map page_builders_
 Contains the builder for the new items. More...
 

Friends

struct implementation::builder_multi_page
 
class debug_layout_graph
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from gui2::container_base
virtual point calculate_best_size () const override
 See widget::calculate_best_size. More...
 
virtual void layout_children () override
 See widget::layout_children. More...
 
- Protected Member Functions inherited from gui2::styled_widget
resolution_definition_ptr get_config ()
 
resolution_definition_const_ptr get_config () const
 
template<typename T >
std::shared_ptr< const typename T::resolution > cast_config_to () const
 Casts the current resolution definition config to the respective type of a derived widget. More...
 
void set_config (resolution_definition_ptr config)
 
virtual void update_canvas ()
 Updates the canvas(ses). More...
 
unsigned int get_text_font_size () const
 Resolves and returns the text_font_size. More...
 
int get_text_maximum_width () const
 Returns the maximum width available for the text. More...
 
int get_text_maximum_height () const
 Returns the maximum height available for the text. More...
 
virtual bool impl_draw_foreground () override
 See widget::impl_draw_foreground. More...
 
std::string get_label_token (const point &position, const char *delimiters=" \n\r\t") const
 Exposes font::pango_text::get_token, for the text label of this styled_widget. More...
 
std::string get_label_link (const point &position) const
 
- 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

A multi page is a control that contains several 'pages' of which only one is visible.

The pages can contain the same widgets containing the same 'kind' of data or look completely different.

Key Type Default Description
grid grid mandatory Defines the grid with the widgets to place on the page.

A multipage has no states. List with the multi page specific variables:

Key Type Default Description
page_definition section mandatory This defines how a multi page item looks. It must contain the grid definition for at least one page.
page_data section [] A grid alike section which stores the initial data for the multi page. Every row must have the same number of columns as the 'page_definition'.

Definition at line 49 of file multi_page.hpp.

Constructor & Destructor Documentation

◆ multi_page()

gui2::multi_page::multi_page ( const implementation::builder_multi_page builder)
explicit

Definition at line 36 of file multi_page.cpp.

Member Function Documentation

◆ add_page() [1/4]

grid & gui2::multi_page::add_page ( const std::string &  type,
int  insert_pos,
const widget_data data 
)

Adds single page to the grid.

This function expect a page to have multiple widgets (either multiple columns or one column with multiple widgets).

Parameters
dataThe data to send to the set_members of the widgets. If the member id is not an empty string it is only send to the widget that has the wanted id (if any). If the member id is an empty string, it is send to all members. Having both empty and non-empty id's gives undefined behavior.
typethe id of the [page_definition] that should be used
insert_posthe position where th new page is inserted, usually -1 for 'at end'
Returns
The grid of the newly added page.

Definition at line 67 of file multi_page.cpp.

References gui2::generator_base::create_item(), data, generator_, page_builders_, type(), and VALIDATE.

◆ add_page() [2/4]

grid & gui2::multi_page::add_page ( const std::string &  type,
int  insert_pos,
const widget_item item 
)

Adds single page to the grid.

This function expect a page to one multiple widget.

Parameters
itemThe data to send to the set_members of the widget.
typethe id of the [page_definition] that shoduol be used
insert_posthe position where th new page is inserted, usually -1 for 'at end'
Returns
The grid of the newly added page.

Definition at line 51 of file multi_page.cpp.

References gui2::generator_base::create_item(), generator_, page_builders_, type(), and VALIDATE.

◆ add_page() [3/4]

grid & gui2::multi_page::add_page ( const widget_data data)

Adds single page to the grid.

This function expect a page to have multiple widgets (either multiple columns or one column with multiple widgets).

Parameters
dataThe data to send to the set_members of the widgets. If the member id is not an empty string it is only send to the widget that has the wanted id (if any). If the member id is an empty string, it is send to all members. Having both empty and non-empty id's gives undefined behavior.
Returns
The grid of the newly added page.

Definition at line 59 of file multi_page.cpp.

References gui2::generator_base::create_item(), data, generator_, and page_builders_.

◆ add_page() [4/4]

grid & gui2::multi_page::add_page ( const widget_item item)

Adds single page to the grid.

This function expect a page to one multiple widget.

Parameters
itemThe data to send to the set_members of the widget.
Returns
The grid of the newly added page.

Definition at line 43 of file multi_page.cpp.

References gui2::generator_base::create_item(), generator_, and page_builders_.

Referenced by gui2::chatbox::find_or_create_window(), gui2::dialogs::title_screen::init_callbacks(), gui2::dialogs::campaign_selection::pre_show(), gui2::dialogs::core_selection::pre_show(), and gui2::dialogs::help_browser::pre_show().

◆ clear()

void gui2::multi_page::clear ( )

Removes all pages in the multi page, clearing it.

Definition at line 92 of file multi_page.cpp.

References gui2::generator_base::clear(), and generator_.

◆ finalize()

void gui2::multi_page::finalize ( std::unique_ptr< generator_base generator,
const std::vector< widget_item > &  page_data 
)
private

Finishes the building initialization of the widget.

Parameters
generatorGenerator for the list
page_dataThe initial data to fill the widget with.

Definition at line 141 of file multi_page.cpp.

References gui2::generator< minimum_selection, maximum_selection, my_placement, select_action >::create_items(), generator_, gui2::container_base::get_grid(), page_builders_, and gui2::swap_grid().

◆ get_active()

bool gui2::multi_page::get_active ( ) const
overridevirtual

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 131 of file multi_page.cpp.

◆ get_control_type()

virtual const std::string& gui2::multi_page::get_control_type ( ) const
overrideprivatevirtual

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

◆ get_page_count()

unsigned gui2::multi_page::get_page_count ( ) const

Returns the number of pages.

Definition at line 98 of file multi_page.cpp.

References generator_, and gui2::generator_base::get_item_count().

Referenced by remove_page(), select_page(), and gui2::dialogs::title_screen::update_tip().

◆ get_selected_page()

int gui2::multi_page::get_selected_page ( ) const

Returns the selected page.

Returns
The selected page.
Return values
-1No page selected.

Definition at line 113 of file multi_page.cpp.

References generator_, and gui2::generator_base::get_selected_item().

Referenced by gui2::dialogs::title_screen::update_tip().

◆ get_state()

unsigned gui2::multi_page::get_state ( ) const
overridevirtual

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 136 of file multi_page.cpp.

◆ impl_draw_background()

bool gui2::multi_page::impl_draw_background ( )
overrideprivatevirtual

See widget::impl_draw_background.

Reimplemented from gui2::styled_widget.

Definition at line 151 of file multi_page.cpp.

◆ page_grid() [1/2]

grid & gui2::multi_page::page_grid ( const unsigned  page)

Returns the grid for the page.

Parameters
pageThe page to get the grid from, the caller has to make sure the page is a valid page.
Returns
The grid of the wanted page.

Definition at line 125 of file multi_page.cpp.

References generator_, and gui2::generator_base::item().

◆ page_grid() [2/2]

const grid & gui2::multi_page::page_grid ( const unsigned  page) const

Returns the grid for the page.

Parameters
pageThe page to get the grid from, the caller has to make sure the page is a valid page.
Returns
The grid of the wanted page.

Definition at line 119 of file multi_page.cpp.

References generator_, and gui2::generator_base::item().

Referenced by gui2::chatbox::append_to_chatbox(), and gui2::chatbox::clear_messages().

◆ remove_page()

void gui2::multi_page::remove_page ( const unsigned  page,
unsigned  count = 1 
)

Removes a page in the multi page.

Parameters
pageThe page to remove, when not in range the function is ignored.
countThe number of pages to remove, 0 means all pages (starting from page).

Definition at line 75 of file multi_page.cpp.

References gui2::generator_base::delete_item(), generator_, and get_page_count().

Referenced by gui2::chatbox::close_window().

◆ select_page()

void gui2::multi_page::select_page ( const unsigned  page,
const bool  select = true 
)

◆ set_page_builders()

void gui2::multi_page::set_page_builders ( const builder_grid_map page_builders)
inlineprivate

Definition at line 194 of file multi_page.hpp.

References page_builders_.

◆ set_self_active()

void gui2::multi_page::set_self_active ( const bool  active)
overrideprivatevirtual

See container_base::set_self_active.

Implements gui2::container_base.

Definition at line 157 of file multi_page.cpp.

◆ type()

static const std::string& gui2::multi_page::type ( )
static

Static type getter that does not rely on the widget being constructed.

Referenced by add_page().

Friends And Related Function Documentation

◆ debug_layout_graph

friend class debug_layout_graph
friend

Definition at line 52 of file multi_page.hpp.

◆ implementation::builder_multi_page

friend struct implementation::builder_multi_page
friend

Definition at line 51 of file multi_page.hpp.

Member Data Documentation

◆ generator_

generator_base* gui2::multi_page::generator_
private

Contains a pointer to the generator.

The pointer is not owned by this class, it's stored in the content_grid_ of the scrollbar_container super class and freed when it's grid is freed.

Definition at line 214 of file multi_page.hpp.

Referenced by add_page(), clear(), finalize(), get_page_count(), get_selected_page(), page_grid(), remove_page(), and select_page().

◆ page_builders_

builder_grid_map gui2::multi_page::page_builders_
private

Contains the builder for the new items.

Definition at line 217 of file multi_page.hpp.

Referenced by add_page(), finalize(), and set_page_builders().


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