|
The Battle for Wesnoth
1.17.12+dev
|
|
|
The Battle for Wesnoth
1.17.12+dev
|
|
Clock to test the draw events. More...
#include <debug_clock.hpp>
Classes | |
| struct | time |
| Helper struct to keep track of the time. More... | |
Public Member Functions | |
| debug_clock () | |
 Public Member Functions inherited from gui2::dialogs::modeless_dialog | |
| modeless_dialog (const std::string &window_id) | |
| virtual | ~modeless_dialog () |
| void | show (const bool allow_interaction=false, const unsigned auto_close_time=0) |
| Shows the window. More... | |
| Public Member Functions inherited from gui2::window | |
| window (const builder_window::window_resolution &definition) | |
| < Needs to be initialized in show. More... | |
| virtual | ~window () |
| void | finish_build (const builder_window::window_resolution &) |
| int | show (unsigned auto_close_timeout=0) |
| Shows the window, running an event loop until it should close. More... | |
| void | show_tooltip () |
| Shows the window as a tooltip. More... | |
| void | show_non_modal () |
| Shows the window non modal. More... | |
| void | draw () |
| Draws the window. More... | |
| void | hide () |
| Hides the window. More... | |
| virtual void | layout () override |
| Lays out the window. More... | |
| virtual bool | expose (const rect ®ion) override |
| Called by draw_manager when it believes a redraw is necessary. More... | |
| virtual rect | screen_location () override |
| The current draw location of the window, on the screen. More... | |
| void | close () |
| Requests to close the window. More... | |
| bool | invalidate_layout_blocked () const |
| Is invalidate_layout blocked, see invalidate_layout_blocker. More... | |
| void | invalidate_layout () |
| Updates the size of the window. 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... | |
| dialogs::modal_dialog * | dialog () |
| Inherited from widget. 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 | does_click_dismiss () const |
| Does the window close easily? More... | |
| void | set_enter_disabled (const bool enter_disabled) |
| Disable the enter key. More... | |
| void | set_escape_disabled (const bool escape_disabled) |
| Disable the escape key. More... | |
| void | init_linked_size_group (const std::string &id, const bool fixed_width, const bool fixed_height) |
| Initializes a linked size group. More... | |
| bool | has_linked_size_group (const std::string &id) |
| Is the linked size group defined for this window? More... | |
| void | add_linked_widget (const std::string &id, widget *widget) |
| Adds a widget to a linked size group. More... | |
| void | remove_linked_widget (const std::string &id, const widget *widget) |
| Removes a widget from a linked size group. More... | |
| void | set_retval (const int retval, const bool close_window=true) |
| Sets there return value of the window. More... | |
| int | get_retval () |
| void | set_owner (dialogs::modal_dialog *owner) |
| void | set_click_dismiss (const bool click_dismiss) |
| bool | get_need_layout () const |
| void | set_variable (const std::string &key, const wfl::variant &value) |
| point | get_linked_size (const std::string &linked_group_id) const |
| void | set_exit_hook (exit_hook mode, std::function< bool(window &)> func) |
| Sets the window's exit hook. More... | |
| const event::distributor & | get_distributor () const |
| Gets a reference to the window's distributor to allow some state peeking. More... | |
| show_mode | mode () const |
| Returns the dialog mode for this window. More... | |
| void | mouse_capture (const bool capture=true) |
| void | keyboard_capture (widget *widget) |
| void | add_to_keyboard_chain (widget *widget) |
| Adds the widget to the keyboard chain. More... | |
| void | remove_from_keyboard_chain (widget *widget) |
| Remove the widget from the keyboard chain. More... | |
| void | add_to_tab_order (widget *widget, int at=-1) |
| Add the widget to the tabbing order. More... | |
| Public Member Functions inherited from gui2::panel | |
| panel (const implementation::builder_styled_widget &builder, const std::string &control_type="") | |
| Constructor. More... | |
| virtual SDL_Rect | get_client_rect () const override |
| See container_base::get_client_rect. 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 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 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 grid & | get_grid () const |
| grid & | get_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... | |
| 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... | |
| Public Member Functions inherited from gui2::widget | |
| 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 () |
| 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... | |
| void | draw_background () |
| Draws the background of a widget. More... | |
| void | draw_children () |
| Draws the children of a widget. More... | |
| void | 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 ®ion) |
| 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_executor & | set_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 ¢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... | |
| Public Member Functions inherited from enable_lua_ptr< widget > | |
| enable_lua_ptr (widget *tp) | |
| Public Member Functions inherited from gui2::top_level_drawable | |
| virtual void | render () |
| Perform any internal rendering necessary to prepare the drawable. More... | |
Private Member Functions | |
| virtual const std::string & | window_id () const override |
| The type of window this is. More... | |
| void | update_time (const bool force) |
| The callback for the drawing routine. More... | |
| virtual void | update () override |
| Update state and any parameters that may effect layout, or any of the later stages. More... | |
Private Attributes | |
| progress_bar * | hour_percentage_ |
| Progress bar for displaying the hours as a percentage. More... | |
| progress_bar * | minute_percentage_ |
| Progress bar for displaying the minutes as a percentage. More... | |
| progress_bar * | second_percentage_ |
| Progress bar for displaying the seconds as a percentage. More... | |
| integer_selector * | hour_ |
| An integer selector to display the total seconds. More... | |
| integer_selector * | minute_ |
| An integer selector to display the total seconds this hour. More... | |
| integer_selector * | second_ |
| An integer selector to display the seconds this minute. More... | |
| pane * | pane_ |
| styled_widget * | clock_ |
| A widget that can display the time. More... | |
| event::signal | signal_ |
| The signal patched in the drawing routine. More... | |
| time | time_ |
| The `current' time. More... | |
Additional Inherited Members | |
| Public Types inherited from gui2::window | |
| enum | status { status::NEW, status::SHOWING, status::REQUEST_CLOSE, status::CLOSED } |
| The status of the window. More... | |
| enum | exit_hook { exit_hook::on_all, exit_hook::on_ok } |
| enum | show_mode { show_mode::none, show_mode::modal, show_mode::modeless, show_mode::tooltip } |
| Public Types inherited from gui2::widget | |
| 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 } |
| 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 | mouse_behavior { mouse_behavior::all, mouse_behavior::hit, mouse_behavior::none } |
| The behavior of the mouse events. More... | |
| Static Public Member Functions inherited from gui2::window | |
| static window * | window_instance (const unsigned handle) |
| Returns the instance of a window. More... | |
| static retval | get_retval_by_id (const std::string &id) |
| Gets the retval for the default buttons. More... | |
| static const std::string & | type () |
| Static type getter that does not rely on the widget being constructed. More... | |
| Static Public Member Functions inherited from gui2::panel | |
| static const std::string & | type () |
| Static type getter that does not rely on the widget being constructed. 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... | |
| 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 |
| Protected Member Functions inherited from gui2::widget | |
| void | set_layout_size (const point &size) |
| const point & | layout_size () const |
| void | clear_layout_size () |
| Throws away layout_size_. More... | |
| Protected Member Functions inherited from gui2::top_level_drawable | |
| top_level_drawable () | |
| virtual | ~top_level_drawable () |
| top_level_drawable (const top_level_drawable &) | |
| top_level_drawable & | operator= (const top_level_drawable &) |
| top_level_drawable (top_level_drawable &&) | |
| top_level_drawable & | operator= (top_level_drawable &&) |
Clock to test the draw events.
This shows the dialog for keeping track of the drawing events related to the current time. (This window is used for debug purposes only.)
| Key | Type | Mandatory | Description |
|---|---|---|---|
| hour_percentage | progress_bar | no | This shows the hours as a percentage, where 24 hours is 100%. |
| minute_percentage | progress_bar | no | This shows the minutes as a percentage, where 60 minutes is 100%. |
| second_percentage | progress_bar | no | This shows the seconds as a percentage, where 60 seconds is 100%. |
| hour | integer_selector | no | This shows the seconds since the beginning of the day. The control should have a minimum_value of 0 and a maximum_value of 86399 (246060 - 1). |
| minute | integer_selector | no | This shows the seconds since the beginning of the current hour. The control should have a minimum_value of 0 and a maximum_value of 3599 (6060 - 1). |
| second | integer_selector | no | This shows the seconds since the beginning of the current minute. The control should have a minimum_value of 0 and a maximum_value of 59. |
| clock | control | no | A control which will have set three variables in its canvas:
|
Definition at line 50 of file debug_clock.hpp.
| gui2::dialogs::debug_clock::debug_clock | ( | ) |
Definition at line 37 of file debug_clock.cpp.
References gui2::container_base::set_active().
|
overrideprivatevirtual |
Update state and any parameters that may effect layout, or any of the later stages.
In general this should be used to make changes to things that will affect the visible state of the drawable. This can include changing the drawable's size or position, or updating animation frames to show the appropriate image for the current time. Exact usage is up to the drawable to decide.
This interface is optional.
Reimplemented from gui2::top_level_drawable.
Definition at line 70 of file debug_clock.cpp.
References gui2::top_level_drawable::update(), and update_time().
|
private |
The callback for the drawing routine.
It updates the `time' in the various controls.
| force | Force an update even it the time didn't change? (This is used to set the clock initially.) |
Definition at line 76 of file debug_clock.cpp.
References clock_, gui2::pane::create_item(), gui2::styled_widget::get_canvases(), gui2::dialogs::debug_clock::time::hour, hour_, hour_percentage_, gui2::dialogs::debug_clock::time::minute, minute_, minute_percentage_, pane_, gui2::widget::queue_redraw(), gui2::dialogs::debug_clock::time::second, second_, second_percentage_, gui2::progress_bar::set_percentage(), gui2::integer_selector::set_value(), gui2::canvas::set_variable(), gui2::dialogs::debug_clock::time::step(), and time_.
Referenced by update().
|
overrideprivatevirtual |
The type of window this is.
Reimplemented from gui2::dialogs::modeless_dialog.
|
private |
A widget that can display the time.
Definition at line 77 of file debug_clock.hpp.
Referenced by update_time().
|
private |
An integer selector to display the total seconds.
Definition at line 66 of file debug_clock.hpp.
Referenced by update_time().
|
private |
Progress bar for displaying the hours as a percentage.
Definition at line 57 of file debug_clock.hpp.
Referenced by update_time().
|
private |
An integer selector to display the total seconds this hour.
Definition at line 69 of file debug_clock.hpp.
Referenced by update_time().
|
private |
Progress bar for displaying the minutes as a percentage.
Definition at line 60 of file debug_clock.hpp.
Referenced by update_time().
|
private |
Definition at line 74 of file debug_clock.hpp.
Referenced by update_time().
|
private |
An integer selector to display the seconds this minute.
Definition at line 72 of file debug_clock.hpp.
Referenced by update_time().
|
private |
Progress bar for displaying the seconds as a percentage.
Definition at line 63 of file debug_clock.hpp.
Referenced by update_time().
|
private |
The signal patched in the drawing routine.
Definition at line 80 of file debug_clock.hpp.
|
private |
The `current' time.
Definition at line 127 of file debug_clock.hpp.
Referenced by update_time().
1.8.13