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

#include <unit_preview_pane.hpp>

Inheritance diagram for gui2::unit_preview_pane:

Public Member Functions

 unit_preview_pane (const implementation::builder_unit_preview_pane &builder)
 
void set_displayed_type (const unit_type &type)
 Displays the stats of a specified unit type. More...
 
void set_displayed_unit (const unit &u)
 Displays the stats of a specific unit. More...
 
void set_image_mods (const std::string &mods)
 Sets the facing of the unit image. More...
 
void profile_button_callback ()
 Callback for the profile button. More...
 
virtual void set_active (const bool active) override
 See styled_widget::set_active. 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...
 
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...
 

Protected Member Functions

void finalize_setup ()
 Initializes the internal sub-widget pointers. 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_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 Types

enum  state_t { ENABLED }
 

Private Member Functions

template<typename T >
void print_attack_details (T attacks, tree_view_node &parent_node)
 
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

utils::optional_reference< const unit_typecurrent_type_
 
drawingicon_type_
 
imageicon_race_
 
imageicon_alignment_
 
labellabel_name_
 
labellabel_level_
 
labellabel_race_
 
styled_widgetlabel_details_
 
tree_viewtree_details_
 
buttonbutton_profile_
 
std::string image_mods_
 

Friends

struct implementation::builder_unit_preview_pane
 

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

Definition at line 42 of file unit_preview_pane.hpp.

Member Enumeration Documentation

◆ state_t

Enumerator
ENABLED 

Definition at line 99 of file unit_preview_pane.hpp.

Constructor & Destructor Documentation

◆ unit_preview_pane()

gui2::unit_preview_pane::unit_preview_pane ( const implementation::builder_unit_preview_pane builder)
explicit

Definition at line 55 of file unit_preview_pane.cpp.

Member Function Documentation

◆ finalize_setup()

void gui2::unit_preview_pane::finalize_setup ( )
protected

Initializes the internal sub-widget pointers.

Should be called when building the window, so the pointers are initialized when set_displayed_type() is called.

Definition at line 71 of file unit_preview_pane.cpp.

References button_profile_, gui2::event::connect_signal_mouse_left_click(), icon_alignment_, icon_race_, icon_type_, label_details_, label_level_, label_name_, label_race_, profile_button_callback(), and tree_details_.

◆ get_active()

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

See styled_widget::get_active.

Implements gui2::styled_widget.

Definition at line 580 of file unit_preview_pane.cpp.

◆ get_control_type()

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

Inherited from styled_widget, implemented by REGISTER_WIDGET.

Implements gui2::styled_widget.

◆ get_state()

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

See styled_widget::get_state.

Implements gui2::styled_widget.

Definition at line 585 of file unit_preview_pane.cpp.

References ENABLED.

◆ print_attack_details()

template<typename T >
void gui2::unit_preview_pane::print_attack_details ( attacks,
tree_view_node parent_node 
)
private

◆ profile_button_callback()

void gui2::unit_preview_pane::profile_button_callback ( )

Callback for the profile button.

Definition at line 563 of file unit_preview_pane.cpp.

References current_type_, gui2::widget::get_window(), and help::show_unit_description().

Referenced by finalize_setup().

◆ set_active()

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

See styled_widget::set_active.

Reimplemented from gui2::container_base.

Definition at line 575 of file unit_preview_pane.cpp.

◆ set_displayed_type()

void gui2::unit_preview_pane::set_displayed_type ( const unit_type type)

◆ set_displayed_unit()

void gui2::unit_preview_pane::set_displayed_unit ( const unit u)

◆ set_image_mods()

void gui2::unit_preview_pane::set_image_mods ( const std::string &  mods)

Sets the facing of the unit image.

Definition at line 570 of file unit_preview_pane.cpp.

References image_mods_.

◆ set_self_active()

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

See container_base::set_self_active.

Implements gui2::container_base.

Definition at line 590 of file unit_preview_pane.cpp.

◆ type()

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

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

Referenced by print_attack_details(), and set_displayed_type().

Friends And Related Function Documentation

◆ implementation::builder_unit_preview_pane

Definition at line 44 of file unit_preview_pane.hpp.

Member Data Documentation

◆ button_profile_

button* gui2::unit_preview_pane::button_profile_
private

Definition at line 92 of file unit_preview_pane.hpp.

Referenced by finalize_setup().

◆ current_type_

utils::optional_reference<const unit_type> gui2::unit_preview_pane::current_type_
private

◆ icon_alignment_

image* gui2::unit_preview_pane::icon_alignment_
private

Definition at line 83 of file unit_preview_pane.hpp.

Referenced by finalize_setup(), set_displayed_type(), and set_displayed_unit().

◆ icon_race_

image* gui2::unit_preview_pane::icon_race_
private

Definition at line 82 of file unit_preview_pane.hpp.

Referenced by finalize_setup(), set_displayed_type(), and set_displayed_unit().

◆ icon_type_

drawing* gui2::unit_preview_pane::icon_type_
private

Definition at line 81 of file unit_preview_pane.hpp.

Referenced by finalize_setup(), set_displayed_type(), and set_displayed_unit().

◆ image_mods_

std::string gui2::unit_preview_pane::image_mods_
private

Definition at line 94 of file unit_preview_pane.hpp.

Referenced by set_displayed_type(), set_displayed_unit(), and set_image_mods().

◆ label_details_

styled_widget* gui2::unit_preview_pane::label_details_
private

Definition at line 89 of file unit_preview_pane.hpp.

Referenced by finalize_setup(), set_displayed_type(), and set_displayed_unit().

◆ label_level_

label* gui2::unit_preview_pane::label_level_
private

Definition at line 86 of file unit_preview_pane.hpp.

Referenced by finalize_setup(), set_displayed_type(), and set_displayed_unit().

◆ label_name_

label* gui2::unit_preview_pane::label_name_
private

Definition at line 85 of file unit_preview_pane.hpp.

Referenced by finalize_setup(), set_displayed_type(), and set_displayed_unit().

◆ label_race_

label* gui2::unit_preview_pane::label_race_
private

Definition at line 87 of file unit_preview_pane.hpp.

Referenced by finalize_setup(), set_displayed_type(), and set_displayed_unit().

◆ tree_details_

tree_view* gui2::unit_preview_pane::tree_details_
private

Definition at line 90 of file unit_preview_pane.hpp.

Referenced by finalize_setup(), set_displayed_type(), and set_displayed_unit().


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