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

#include <stacked_widget.hpp>

Inheritance diagram for gui2::tstacked_widget:
Inheritance graph

Public Member Functions

 tstacked_widget ()
 
virtual bool get_active () const override
 See tcontrol::get_active. More...
 
virtual unsigned get_state () const override
 See tcontrol::get_state. More...
 
virtual void layout_children () override
 See twidget::layout_children. More...
 
int current_layer () const
 Gets the current visible layer number. More...
 
void select_layer (const int layer)
 Selects and displays a particular layer. More...
 
unsigned int get_layer_count () const
 Gets the total number of layers. More...
 
tgridget_layer_grid (unsigned int i)
 
- Public Member Functions inherited from gui2::tcontainer_
 tcontainer_ (const unsigned canvas_count)
 
virtual SDL_Rect get_client_rect () const
 Returns the client rect. More...
 
virtual void layout_initialise (const bool full_initialisation) override
 See twidget::layout_initialise. 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 twidget::request_reduce_width. More...
 
virtual void demand_reduce_width (const unsigned maximum_width) override
 See twidget::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 twidget::request_reduce_height. More...
 
virtual void demand_reduce_height (const unsigned maximum_height) override
 See twidget::demand_reduce_height. More...
 
virtual bool can_wrap () const override
 See twidget::can_wrap. More...
 
virtual void place (const tpoint &origin, const tpoint &size) override
 See twidget::place. More...
 
virtual bool has_widget (const twidget &widget) const override
 See twidget::has_widget. More...
 
virtual void set_origin (const tpoint &origin) override
 See twidget::set_origin. More...
 
virtual void set_visible_rectangle (const SDL_Rect &rectangle) override
 See twidget::set_visible_rectangle. More...
 
virtual void impl_draw_children (surface &frame_buffer, int x_offset, int y_offset) override
 See twidget::impl_draw_children. More...
 
virtual twidgetfind_at (const tpoint &coordinate, const bool must_be_active) override
 See twidget::find_at. More...
 
virtual const twidgetfind_at (const tpoint &coordinate, const bool must_be_active) const override
 See twidget::find_at. More...
 
twidgetfind (const std::string &id, const bool must_be_active) override
 See twidget::find. More...
 
const twidgetfind (const std::string &id, const bool must_be_active) const override
 See twidget::find. More...
 
virtual void set_active (const bool active) override
 See tcontrol::set_active. More...
 
bool disable_click_dismiss () const override
 See twidget::disable_click_dismiss. More...
 
virtual iterator::twalker_create_walker () override
 See twidget::create_walker. More...
 
void init_grid (const boost::intrusive_ptr< tbuilder_grid > &grid_builder)
 Initializes and builds the grid. More...
 
tgrid::iterator begin ()
 
tgrid::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 (twidget *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 tgridgrid () const
 
tgridgrid ()
 
- Public Member Functions inherited from gui2::tcontrol
 tcontrol (const unsigned canvas_count)
 
 tcontrol (const implementation::tbuilder_control &builder, const unsigned canvas_count, const std::string &control_type)
 Constructor. More...
 
virtual void set_members (const string_map &data)
 Sets the members of the control. More...
 
bool disable_click_dismiss () const override
 See twidget::disable_click_dismiss. More...
 
tpoint get_config_minimum_size () const
 Gets the minimum size as defined in the config. More...
 
tpoint get_config_default_size () const
 Gets the default size as defined in the config. More...
 
tpoint 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 std::string get_link_color () const
 Returns the color string to be used with links. More...
 
twidgetfind (const std::string &id, const bool must_be_active) override
 See twidget::find. More...
 
const twidgetfind (const std::string &id, const bool must_be_active) const override
 See twidget::find. More...
 
void set_definition (const std::string &definition)
 Sets the definition. More...
 
bool get_use_tooltip_on_label_overflow () const
 
void set_use_tooltip_on_label_overflow (const bool use_tooltip=true)
 
const t_stringlabel () const
 
virtual void set_label (const t_string &label)
 
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< tcanvas > & canvas ()
 
tcanvascanvas (const unsigned index)
 
void set_text_alignment (const PangoAlignment text_alignment)
 
PangoAlignment get_text_alignment () const
 
- 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::stringid () const
 
twindowget_window ()
 Get the parent window. More...
 
const twindowget_window () const
 The constant version of get_window. More...
 
tdialogdialog ()
 Returns the top-level dialogue. More...
 
void set_parent (twidget *parent)
 
twidgetparent ()
 
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 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...
 
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...
 
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)
 
- 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_executorset_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...
 

Private Member Functions

void finalize (std::vector< tbuilder_grid_const_ptr > widget_builder)
 Finishes the building initialization of the widget. More...
 
void select_layer_internal (const unsigned int layer, const bool select) const
 Helper to ensure the correct state is set when selecting a layer. More...
 
virtual const std::stringget_control_type () const override
 See tcontrol::get_control_type. More...
 
virtual void set_self_active (const bool active) override
 See tcontainer_::set_self_active. More...
 

Private Attributes

tgenerator_generator_
 Contains a pointer to the generator. More...
 
int selected_layer_
 The number of the current selected layer. More...
 

Friends

struct implementation::tbuilder_stacked_widget
 
class tdebug_layout_graph
 

Additional Inherited Members

- 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...
 
- Protected Member Functions inherited from gui2::tcontainer_
virtual void child_populate_dirty_list (twindow &caller, const std::vector< twidget * > &call_stack) override
 See twidget::child_populate_dirty_list. More...
 
- Protected Member Functions inherited from gui2::tcontrol
tresolution_definition_ptr config ()
 
tresolution_definition_const_ptr config () const
 
void set_config (tresolution_definition_ptr config)
 
virtual void update_canvas ()
 Updates the canvas(ses). 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 void impl_draw_background (surface &frame_buffer, int x_offset, int y_offset) override
 See twidget::impl_draw_background. More...
 
virtual void impl_draw_foreground (surface &frame_buffer, int x_offset, int y_offset) override
 See twidget::impl_draw_foreground. More...
 
std::string get_label_token (const gui2::tpoint &position, const char *delimiters=" \n\r\t") const
 Exposes font::ttext::get_token, for the text label of this control. More...
 
std::string get_label_link (const gui2::tpoint &position) const
 
- Protected Member Functions inherited from gui2::twidget
void set_layout_size (const tpoint &size)
 
const tpointlayout_size () const
 

Detailed Description

Definition at line 35 of file stacked_widget.hpp.

Constructor & Destructor Documentation

gui2::tstacked_widget::tstacked_widget ( )

Definition at line 34 of file stacked_widget.cpp.

Member Function Documentation

int gui2::tstacked_widget::current_layer ( ) const
inline

Gets the current visible layer number.

The current layer number will be -1 if all layers are currently visible. In this case, only the topmost (highest-numbered) layer will receive events.

Definition at line 61 of file stacked_widget.hpp.

References selected_layer_.

void gui2::tstacked_widget::finalize ( std::vector< tbuilder_grid_const_ptr widget_builder)
private

Finishes the building initialization of the widget.

Parameters
widget_builderThe builder to build the contents of the widget.

Definition at line 97 of file stacked_widget.cpp.

References gui2::tgenerator_::create_item(), generator_, gui2::tcontainer_::grid(), and select_layer().

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

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

See tcontrol::get_active.

Implements gui2::tcontrol.

Definition at line 42 of file stacked_widget.cpp.

const std::string & gui2::tstacked_widget::get_control_type ( ) const
overrideprivatevirtual

See tcontrol::get_control_type.

Implements gui2::tcontrol.

Definition at line 110 of file stacked_widget.cpp.

unsigned int gui2::tstacked_widget::get_layer_count ( ) const

Gets the total number of layers.

Definition at line 151 of file stacked_widget.cpp.

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

Referenced by gui2::index_in_pager_range(), and gui2::tgame_version::pre_show().

tgrid * gui2::tstacked_widget::get_layer_grid ( unsigned int  i)

Definition at line 156 of file stacked_widget.cpp.

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

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

See tcontrol::get_state.

Implements gui2::tcontrol.

Definition at line 47 of file stacked_widget.cpp.

void gui2::tstacked_widget::layout_children ( )
overridevirtual
void gui2::tstacked_widget::select_layer ( const int  layer)

Selects and displays a particular layer.

If layer -1 is selected, all layers will be displayed but only the topmost (highest-numbered) layer will receive events.

Definition at line 130 of file stacked_widget.cpp.

References generator_, gui2::tgenerator_::get_item_count(), gui2::twidget::tvisible::hidden, i, gui2::tgenerator_::item(), select_layer_internal(), game_config::images::selected, selected_layer_, gui2::twidget::set_visible(), and gui2::twidget::tvisible::visible.

Referenced by finalize(), gui2::taddon_list::pre_show(), gui2::tgame_version::pre_show(), and gui2::tgame_version::tab_switch_callback().

void gui2::tstacked_widget::select_layer_internal ( const unsigned int  layer,
const bool  select 
) const
private

Helper to ensure the correct state is set when selecting a layer.

Definition at line 121 of file stacked_widget.cpp.

References generator_, gui2::tgenerator_::is_selected(), and gui2::tgenerator_::select_item().

Referenced by select_layer().

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

See tcontainer_::set_self_active.

Implements gui2::tcontainer_.

Definition at line 116 of file stacked_widget.cpp.

Friends And Related Function Documentation

Definition at line 37 of file stacked_widget.hpp.

friend class tdebug_layout_graph
friend

Definition at line 38 of file stacked_widget.hpp.

Member Data Documentation

tgenerator_* gui2::tstacked_widget::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 tscrollbar_container super class and freed when it's grid is freed.

Definition at line 94 of file stacked_widget.hpp.

Referenced by finalize(), get_layer_count(), get_layer_grid(), layout_children(), select_layer(), and select_layer_internal().

int gui2::tstacked_widget::selected_layer_
private

The number of the current selected layer.

Definition at line 99 of file stacked_widget.hpp.

Referenced by current_layer(), and select_layer().


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