The Battle for Wesnoth  1.19.7+dev
Public Member Functions | Private Member Functions | Private Attributes | Friends | List of all members
gui2::viewport Class Reference

#include <viewport.hpp>

Inheritance diagram for gui2::viewport:

Public Member Functions

 viewport (const implementation::builder_viewport &builder, const builder_widget::replacements_map &replacements)
 
 ~viewport ()
 
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 () override
 See widget::impl_draw_children. 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...
 
widgetfind (const std::string_view id, const bool must_be_active) override
 See widget::find. More...
 
const widgetfind (const std::string_view 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...
 
- 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...
 
const gridget_parent_grid () const
 
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...
 
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)
 
std::string get_linked_group () const
 
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...
 
virtual void set_visible_rectangle (const SDL_Rect &rectangle)
 Sets the visible rectangle for a 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
 
void set_visible (bool visible)
 Sets widget to visible if visible is true, else invisible. More...
 
void set_hidden (bool hidden)
 Sets widget to visible if hidden is true, else hidden. More...
 
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)
 
virtual bool has_widget (const widget &widget) const
 Does the widget contain the widget. More...
 
template<class T >
T * find_widget (const std::string_view id, const bool must_be_active, const bool must_exist)
 Gets a widget with the wanted id. More...
 
template<class T >
const T * find_widget (const std::string_view id, const bool must_be_active, const bool must_exist) const
 
template<class T >
T & find_widget (const std::string_view id, const bool must_be_active=false)
 Gets a widget with the wanted id. More...
 
template<class T >
const T & find_widget (const std::string_view id, const bool must_be_active=false) const
 
- 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)
 

Private Member Functions

virtual point calculate_best_size () const override
 See widget::calculate_best_size. More...
 

Private Attributes

std::unique_ptr< widgetwidget_
 

Friends

struct viewport_implementation
 

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::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 31 of file viewport.hpp.

Constructor & Destructor Documentation

◆ viewport()

gui2::viewport::viewport ( const implementation::builder_viewport builder,
const builder_widget::replacements_map replacements 
)

Definition at line 82 of file viewport.cpp.

References widget_.

◆ ~viewport()

gui2::viewport::~viewport ( )

Definition at line 90 of file viewport.cpp.

Member Function Documentation

◆ calculate_best_size()

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

See widget::calculate_best_size.

Implements gui2::widget.

Definition at line 144 of file viewport.cpp.

References widget_.

◆ create_walker()

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

See widget::create_walker.

Todo:
Implement properly.

Implements gui2::widget.

Definition at line 154 of file viewport.cpp.

◆ disable_click_dismiss()

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

See widget::disable_click_dismiss.

Implements gui2::widget.

Definition at line 149 of file viewport.cpp.

◆ find() [1/2]

const widget * gui2::viewport::find ( const std::string_view  id,
const bool  must_be_active 
) const
overridevirtual

See widget::find.

Reimplemented from gui2::widget.

Definition at line 139 of file viewport.cpp.

References gui2::viewport_implementation::find().

◆ find() [2/2]

widget * gui2::viewport::find ( const std::string_view  id,
const bool  must_be_active 
)
overridevirtual

See widget::find.

Reimplemented from gui2::widget.

Definition at line 134 of file viewport.cpp.

References gui2::viewport_implementation::find().

◆ find_at() [1/2]

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

See widget::find_at.

Reimplemented from gui2::widget.

Definition at line 128 of file viewport.cpp.

References gui2::viewport_implementation::find_at().

◆ find_at() [2/2]

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

See widget::find_at.

Reimplemented from gui2::widget.

Definition at line 123 of file viewport.cpp.

References gui2::viewport_implementation::find_at().

◆ impl_draw_children()

void gui2::viewport::impl_draw_children ( )
overridevirtual

See widget::impl_draw_children.

Reimplemented from gui2::widget.

Definition at line 110 of file viewport.cpp.

References gui2::widget::invisible, and widget_.

◆ layout_initialize()

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

See widget::layout_initialize.

Reimplemented from gui2::widget.

Definition at line 101 of file viewport.cpp.

References gui2::widget::invisible, gui2::widget::layout_initialize(), and widget_.

◆ place()

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

See widget::place.

Reimplemented from gui2::widget.

Definition at line 94 of file viewport.cpp.

References gui2::widget::place(), draw::point(), utf8::size(), and widget_.

◆ request_reduce_width()

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

See widget::request_reduce_width.

Implements gui2::widget.

Definition at line 119 of file viewport.cpp.

Friends And Related Function Documentation

◆ viewport_implementation

friend struct viewport_implementation
friend

Definition at line 33 of file viewport.hpp.

Member Data Documentation

◆ widget_

std::unique_ptr<widget> gui2::viewport::widget_
private

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