The Battle for Wesnoth  1.19.0-dev
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
gui2::container_base Class Referenceabstract

A generic container base class. More...

#include <container_base.hpp>

Inheritance diagram for gui2::container_base:

Public Member Functions

 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...
 
virtual bool get_active () const =0
 Gets the active state 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...
 
virtual const std::string & get_control_type () const =0
 Returns the type of this styled_widget. 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)
 

Protected Member Functions

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
virtual unsigned get_state () const =0
 Returns the id of the state. More...
 
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_background () override
 See widget::impl_draw_background. 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...
 

Private Member Functions

virtual point border_space () const
 Returns the space used by the border. More...
 
virtual void set_self_active (const bool active)=0
 Helper for set_active. More...
 
void inject_linked_groups ()
 

Private Attributes

grid grid_
 The grid which holds the child objects. More...
 

Friends

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

Detailed Description

A generic container base class.

A container is a class build with multiple items either acting as one widget.

Definition at line 31 of file container_base.hpp.

Constructor & Destructor Documentation

◆ container_base()

gui2::container_base::container_base ( const implementation::builder_styled_widget builder,
const std::string &  control_type 
)
explicit

Member Function Documentation

◆ add_row()

unsigned gui2::container_base::add_row ( const unsigned  count = 1)
inline

◆ begin()

grid::iterator gui2::container_base::begin ( )
inline

Definition at line 150 of file container_base.hpp.

References gui2::grid::begin(), and grid_.

Referenced by gui2::dialogs::game_load::filter_text_changed().

◆ border_space()

point gui2::container_base::border_space ( ) const
privatevirtual

Returns the space used by the border.

Reimplemented in gui2::toggle_panel, and gui2::panel.

Definition at line 271 of file container_base.cpp.

References draw::point().

Referenced by calculate_best_size(), demand_reduce_height(), demand_reduce_width(), reduce_height(), reduce_width(), request_reduce_height(), and request_reduce_width().

◆ calculate_best_size()

point gui2::container_base::calculate_best_size ( ) const
overrideprotectedvirtual

◆ can_wrap()

bool gui2::container_base::can_wrap ( ) const
overridevirtual

◆ create_walker()

iteration::walker_ptr gui2::container_base::create_walker ( )
overridevirtual

See widget::create_walker.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::scrollbar_container.

Definition at line 257 of file container_base.cpp.

◆ demand_reduce_height()

void gui2::container_base::demand_reduce_height ( const unsigned  maximum_height)
overridevirtual

See widget::demand_reduce_height.

Reimplemented from gui2::widget.

Definition at line 125 of file container_base.cpp.

References border_space(), gui2::grid::demand_reduce_height(), and grid_.

◆ demand_reduce_width()

void gui2::container_base::demand_reduce_width ( const unsigned  maximum_width)
overridevirtual

See widget::demand_reduce_width.

Reimplemented from gui2::widget.

Definition at line 90 of file container_base.cpp.

References border_space(), gui2::grid::demand_reduce_width(), and grid_.

◆ disable_click_dismiss()

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

◆ end()

grid::iterator gui2::container_base::end ( )
inline

◆ find() [1/2]

const widget * gui2::container_base::find ( const std::string &  id,
const bool  must_be_active 
) const
overridevirtual

See widget::find.

Reimplemented from gui2::widget.

Reimplemented in gui2::window, gui2::stacked_widget, and gui2::scrollbar_container.

Definition at line 230 of file container_base.cpp.

References gui2::grid::find(), gui2::styled_widget::find(), and grid_.

◆ find() [2/2]

widget * gui2::container_base::find ( const std::string &  id,
const bool  must_be_active 
)
overridevirtual

◆ find_at() [1/2]

const widget * gui2::container_base::find_at ( const point coordinate,
const bool  must_be_active 
) const
overridevirtual

See widget::find_at.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::window, gui2::toggle_panel, and gui2::scrollbar_container.

Definition at line 218 of file container_base.cpp.

References gui2::grid::find_at(), and grid_.

◆ find_at() [2/2]

widget * gui2::container_base::find_at ( const point coordinate,
const bool  must_be_active 
)
overridevirtual

See widget::find_at.

Reimplemented from gui2::styled_widget.

Reimplemented in gui2::window, gui2::toggle_panel, and gui2::scrollbar_container.

Definition at line 212 of file container_base.cpp.

References gui2::grid::find_at(), and grid_.

Referenced by gui2::toggle_panel::find_at(), and gui2::window::find_at().

◆ get_client_rect()

SDL_Rect gui2::container_base::get_client_rect ( ) const
virtual

Returns the client rect.

The client rect is the area which is used for child items. The rest of the area of this widget is used for its own decoration.

Returns
The client rect.

Reimplemented in gui2::toggle_panel, and gui2::panel.

Definition at line 43 of file container_base.cpp.

References gui2::widget::get_rectangle().

Referenced by place(), and set_origin().

◆ get_cols()

unsigned int gui2::container_base::get_cols ( ) const
inline

Definition at line 177 of file container_base.hpp.

References gui2::grid::get_cols(), and grid_.

◆ get_grid() [1/2]

grid& gui2::container_base::get_grid ( )
inline

Definition at line 215 of file container_base.hpp.

References grid_.

◆ get_grid() [2/2]

const grid& gui2::container_base::get_grid ( ) const
inline

◆ get_rows()

unsigned int gui2::container_base::get_rows ( ) const
inline

Definition at line 168 of file container_base.hpp.

References gui2::grid::get_rows(), and grid_.

◆ has_widget()

bool gui2::container_base::has_widget ( const widget widget) const
overridevirtual

See widget::has_widget.

Reimplemented from gui2::widget.

Definition at line 145 of file container_base.cpp.

References grid_, gui2::widget::has_widget(), and gui2::grid::has_widget().

◆ impl_draw_children()

void gui2::container_base::impl_draw_children ( )
overridevirtual

◆ init_grid()

void gui2::container_base::init_grid ( const builder_grid grid_builder)

Initializes and builds the grid.

This function should only be called upon an empty grid.

Parameters
grid_builderThe builder for the grid.

Definition at line 262 of file container_base.cpp.

References gui2::builder_grid::build(), gui2::grid::get_cols(), gui2::grid::get_rows(), grid_, gui2::log_gui_general, log_scope2, and LOG_SCOPE_HEADER.

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

◆ inject_linked_groups()

void gui2::container_base::inject_linked_groups ( )
private

◆ layout_children()

void gui2::container_base::layout_children ( )
overrideprotectedvirtual

◆ layout_initialize()

void gui2::container_base::layout_initialize ( const bool  full_initialization)
overridevirtual

◆ place()

void gui2::container_base::place ( const point origin,
const point size 
)
overridevirtual

◆ reduce_height()

void gui2::container_base::reduce_height ( const unsigned  maximum_height)

Tries to reduce the height of a container.

See Layout algorithm for more information.

Parameters
maximum_heightThe wanted maximum height.

Definition at line 95 of file container_base.cpp.

References border_space(), gui2::widget::get_best_size(), grid_, gui2::grid::reduce_height(), gui2::widget::set_layout_size(), and utf8::size().

Referenced by gui2::window_implementation::layout(), and gui2::size_lock::place().

◆ reduce_width()

void gui2::container_base::reduce_width ( const unsigned  maximum_width)

Tries to reduce the width of a container.

See Layout algorithm for more information.

Parameters
maximum_widthThe wanted maximum width.

Definition at line 58 of file container_base.cpp.

References border_space(), gui2::widget::get_best_size(), grid_, gui2::grid::reduce_width(), gui2::widget::set_layout_size(), and utf8::size().

Referenced by gui2::window_implementation::layout(), and gui2::size_lock::place().

◆ request_reduce_height()

void gui2::container_base::request_reduce_height ( const unsigned  maximum_height)
overridevirtual

◆ request_reduce_width()

void gui2::container_base::request_reduce_width ( const unsigned  maximum_width)
overridevirtual

◆ set_active()

void gui2::container_base::set_active ( const bool  active)
overridevirtual

◆ set_child()

void gui2::container_base::set_child ( std::unique_ptr< widget widget,
const unsigned  row,
const unsigned  col,
const unsigned  flags,
const unsigned  border_size 
)
inline

Definition at line 187 of file container_base.hpp.

References grid_, and gui2::grid::set_child().

Referenced by gui2::size_lock::finalize().

◆ set_cols()

void gui2::container_base::set_cols ( const unsigned  cols)
inline

Definition at line 173 of file container_base.hpp.

References grid_, and gui2::grid::set_cols().

◆ set_column_grow_factor()

void gui2::container_base::set_column_grow_factor ( const unsigned  column,
const unsigned  factor 
)
inline

Definition at line 201 of file container_base.hpp.

References grid_, and gui2::grid::set_column_grow_factor().

◆ set_origin()

void gui2::container_base::set_origin ( const point origin)
overridevirtual

◆ set_row_grow_factor()

void gui2::container_base::set_row_grow_factor ( const unsigned  row,
const unsigned  factor 
)
inline

Definition at line 196 of file container_base.hpp.

References grid_, and gui2::grid::set_row_grow_factor().

◆ set_rows()

void gui2::container_base::set_rows ( const unsigned  rows)
inline

Definition at line 164 of file container_base.hpp.

References grid_, and gui2::grid::set_rows().

◆ set_rows_cols()

void gui2::container_base::set_rows_cols ( const unsigned  rows,
const unsigned  cols 
)
inline

Definition at line 182 of file container_base.hpp.

References grid_, and gui2::grid::set_rows_cols().

Referenced by gui2::size_lock::finalize().

◆ set_self_active()

virtual void gui2::container_base::set_self_active ( const bool  active)
privatepure virtual

Helper for set_active.

This function should set the styled_widget itself active. It's called by set_active if the state needs to change. The widget is set to dirty() by set_active so we only need to change the state.

Implemented in gui2::size_lock, gui2::chatbox, gui2::addon_list, gui2::unit_preview_pane, gui2::tree_view, gui2::stacked_widget, gui2::spinner, gui2::scrollbar_panel, gui2::scroll_text, gui2::scroll_label, gui2::panel, gui2::multi_page, and gui2::listbox.

Referenced by set_active().

◆ set_visible_rectangle()

void gui2::container_base::set_visible_rectangle ( const SDL_Rect &  rectangle)
overridevirtual

Friends And Related Function Documentation

◆ debug_layout_graph

friend class debug_layout_graph
friend

Definition at line 33 of file container_base.hpp.

Member Data Documentation

◆ grid_

grid gui2::container_base::grid_
private

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