A drawing is widget with a fixed size and gives access to the canvas of the widget in the window instance. More...
#include <drawing.hpp>
Public Member Functions | |
drawing (const implementation::builder_drawing &builder) | |
canvas & | get_drawing_canvas () |
void | set_drawing_data (const ::config &cfg) |
void | append_drawing_data (const ::config &cfg) |
virtual void | request_reduce_width (const unsigned maximum_width) override |
See widget::request_reduce_width. More... | |
virtual void | request_reduce_height (const unsigned maximum_height) override |
See widget::request_reduce_height. 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... | |
bool | disable_click_dismiss () const override |
See widget::disable_click_dismiss. More... | |
void | set_best_size (const point &best_size) |
![]() | |
styled_widget (const implementation::builder_styled_widget &builder, const std::string &control_type) | |
Constructor. More... | |
virtual void | set_members (const string_map &data) |
Sets the members of the styled_widget. 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... | |
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... | |
virtual void | layout_initialize (const bool full_initialization) override |
See widget::layout_initialize. More... | |
virtual void | place (const point &origin, const point &size) override |
See widget::place. More... | |
virtual widget * | find_at (const point &coordinate, const bool must_be_active) override |
See widget::find_at. More... | |
virtual const widget * | find_at (const point &coordinate, const bool must_be_active) const override |
See widget::find_at. More... | |
widget * | find (const std::string &id, const bool must_be_active) override |
See widget::find. More... | |
const widget * | find (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_string & | get_label () const |
virtual void | set_label (const t_string &label) |
virtual void | set_use_markup (bool use_markup) |
bool | get_use_markup () const |
const t_string & | tooltip () const |
void | set_tooltip (const t_string &tooltip) |
const t_string & | help_message () const |
void | set_help_message (const t_string &help_message) |
std::vector< canvas > & | get_canvases () |
canvas & | get_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... | |
![]() | |
widget (const widget &)=delete | |
widget & | operator= (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 |
window * | get_window () |
Get the parent window. More... | |
const window * | get_window () const |
The constant version of get_window. More... | |
grid * | get_parent_grid () |
Get the parent grid. More... | |
void | set_parent (widget *parent) |
widget * | parent () |
virtual void | demand_reduce_width (const unsigned maximum_width) |
Tries to reduce the width 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... | |
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 (int x_offset, int y_offset) |
Draws the background of a widget. More... | |
void | draw_children (int x_offset, int y_offset) |
Draws the children of a widget. More... | |
void | draw_foreground (int x_offset, int y_offset) |
Draws the foreground of the widget. More... | |
void | populate_dirty_list (window &caller, std::vector< widget *> &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... | |
virtual void | set_visible_rectangle (const SDL_Rect &rectangle) |
Sets the visible rectangle for a widget. More... | |
void | set_is_dirty (const bool is_dirty) |
bool | get_is_dirty () const |
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) |
virtual bool | has_widget (const widget &widget) const |
Does the widget contain the widget. More... | |
![]() | |
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_executor & | set_wants_mouse_right_double_click (const bool click=true) |
bool | wants_mouse_right_double_click () const |
![]() | |
dispatcher () | |
virtual | ~dispatcher () |
void | connect () |
Connects the dispatcher to the event handler. 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 ¢er, 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... | |
![]() | |
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 Types | |
enum | state_t { ENABLED } |
Possible states of the widget. More... | |
Private Member Functions | |
virtual point | calculate_best_size () const override |
See widget::calculate_best_size. More... | |
virtual const std::string & | get_control_type () const override |
Inherited from styled_widget, implemented by REGISTER_WIDGET. More... | |
Private Attributes | |
point | best_size_ |
When we're used as a fixed size item, this holds the best size. More... | |
Additional Inherited Members | |
![]() | |
enum | visibility { visibility::visible, visibility::hidden, visibility::invisible } |
Visibility settings done by the user. More... | |
enum | redraw_action { redraw_action::full, redraw_action::partly, redraw_action::none } |
Visibility set by the engine. More... | |
enum | debug_border { debug_border::none, debug_border::outline, debug_border::fill } |
![]() | |
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 | mouse_behavior { mouse_behavior::all, mouse_behavior::hit, mouse_behavior::none } |
The behavior of the mouse events. More... | |
![]() | |
resolution_definition_ptr | config () |
resolution_definition_const_ptr | 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 void | impl_draw_background (int x_offset, int y_offset) override |
See widget::impl_draw_background. More... | |
virtual void | impl_draw_foreground (int x_offset, int y_offset) override |
See widget::impl_draw_foreground. More... | |
std::string | get_label_token (const point &position, const char *delimiters=" \\) 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 |
![]() | |
void | set_layout_size (const point &size) |
const point & | layout_size () const |
void | clear_layout_size () |
Throws away layout_size_. More... | |
A drawing is widget with a fixed size and gives access to the canvas of the widget in the window instance.
It has a fixed size like the spacer, but allows the user to manually draw items. This widget is display only.
The widget normally has no event interaction so only one state is defined:
If either the width or the height is not zero the drawing functions as a fixed size drawing.
Key | Type | Default | Description |
---|---|---|---|
width | f_unsigned | 0 | The width of the drawing. |
height | f_unsigned | 0 | The height of the drawing. |
draw | config | mandatory | The config containing the drawing. |
The variables available are the same as for the window resolution see builder_window::window_resolution for the list of items.
Definition at line 52 of file drawing.hpp.
|
private |
Possible states of the widget.
Note the order of the states must be the same as defined in settings.hpp.
Enumerator | |
---|---|
ENABLED |
Definition at line 113 of file drawing.hpp.
|
explicit |
Definition at line 35 of file drawing.cpp.
|
inline |
Definition at line 67 of file drawing.hpp.
Referenced by gui2::dialogs::attack_predictions::draw_hp_graph().
|
overrideprivatevirtual |
See widget::calculate_best_size.
Reimplemented from gui2::styled_widget.
Definition at line 41 of file drawing.cpp.
References best_size_, and gui2::styled_widget::calculate_best_size().
|
overridevirtual |
See widget::disable_click_dismiss.
Implements gui2::widget.
Definition at line 80 of file drawing.cpp.
|
overridevirtual |
See styled_widget::get_active.
Implements gui2::styled_widget.
Definition at line 70 of file drawing.cpp.
|
overrideprivatevirtual |
Inherited from styled_widget, implemented by REGISTER_WIDGET.
Implements gui2::styled_widget.
|
inline |
Definition at line 57 of file drawing.hpp.
Referenced by gui2::dialogs::loading_screen::draw_callback(), and gui2::dialogs::attack_predictions::draw_hp_graph().
|
overridevirtual |
Implements gui2::styled_widget.
Definition at line 75 of file drawing.cpp.
|
overridevirtual |
See widget::request_reduce_height.
Reimplemented from gui2::styled_widget.
Definition at line 56 of file drawing.cpp.
References best_size_, and gui2::styled_widget::request_reduce_height().
|
overridevirtual |
See widget::request_reduce_width.
Reimplemented from gui2::styled_widget.
Definition at line 47 of file drawing.cpp.
References best_size_, and gui2::styled_widget::request_reduce_width().
|
overridevirtual |
See styled_widget::set_active.
Implements gui2::styled_widget.
Definition at line 65 of file drawing.cpp.
|
inline |
Definition at line 101 of file drawing.hpp.
|
inline |
Definition at line 62 of file drawing.hpp.
|
static |
Static type getter that does not rely on the widget being constructed.
|
private |
When we're used as a fixed size item, this holds the best size.
Definition at line 118 of file drawing.hpp.
Referenced by calculate_best_size(), request_reduce_height(), and request_reduce_width().