Label showing a text. More...
#include <label.hpp>
Public Member Functions | |
tlabel () | |
virtual bool | can_wrap () const override |
See twidget::can_wrap. More... | |
virtual unsigned | get_characters_per_line () const override |
See tcontrol::get_characters_per_line. More... | |
virtual bool | get_link_aware () const override |
See tcontrol::get_link_aware. More... | |
virtual std::string | get_link_color () const override |
See tcontrol::get_link_aware. More... | |
virtual void | set_active (const bool active) override |
See tcontrol::set_active. More... | |
virtual bool | get_active () const override |
See tcontrol::get_active. More... | |
virtual unsigned | get_state () const override |
See tcontrol::get_state. More... | |
bool | disable_click_dismiss () const override |
See twidget::disable_click_dismiss. More... | |
void | set_can_wrap (const bool wrap) |
void | set_characters_per_line (const unsigned set_characters_per_line) |
void | set_link_aware (bool l) |
void | set_link_color (const std::string &color) |
virtual bool | can_mouse_focus () const override |
Whether the mouse move/click event go 'through' this widget. More... | |
![]() | |
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... | |
virtual iterator::twalker_ * | create_walker () override |
See twidget::create_walker. 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 void | layout_initialise (const bool full_initialisation) override |
See twidget::layout_initialise. More... | |
virtual void | request_reduce_width (const unsigned maximum_width) override |
See twidget::request_reduce_width. More... | |
virtual void | place (const tpoint &origin, const tpoint &size) override |
See twidget::place. More... | |
virtual twidget * | find_at (const tpoint &coordinate, const bool must_be_active) override |
See twidget::find_at. More... | |
virtual const twidget * | find_at (const tpoint &coordinate, const bool must_be_active) const override |
See twidget::find_at. More... | |
twidget * | find (const std::string &id, const bool must_be_active) override |
See twidget::find. More... | |
const twidget * | find (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_string & | 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< tcanvas > & | canvas () |
tcanvas & | canvas (const unsigned index) |
void | set_text_alignment (const PangoAlignment text_alignment) |
PangoAlignment | get_text_alignment () const |
![]() | |
twidget () | |
twidget (const tbuilder_widget &builder) | |
Constructor. More... | |
virtual | ~twidget () override |
void | set_id (const std::string &id) |
const std::string & | id () const |
twindow * | get_window () |
Get the parent window. More... | |
const twindow * | get_window () const |
The constant version of get_window. More... | |
tdialog * | dialog () |
Returns the top-level dialogue. More... | |
void | set_parent (twidget *parent) |
twidget * | parent () |
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... | |
tpoint | get_best_size () const |
Gets the best size for the widget. More... | |
virtual void | set_origin (const tpoint &origin) |
Sets the origin of the 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... | |
virtual void | layout_children () |
Allows a widget to update its children. 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... | |
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 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) |
virtual bool | has_widget (const twidget &widget) const |
Does the widget contain the widget. More... | |
![]() | |
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_executor & | set_wants_mouse_right_double_click (const bool click=true) |
bool | wants_mouse_right_double_click () const |
![]() | |
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 Types | |
enum | tstate { ENABLED, DISABLED, COUNT } |
Possible states of the widget. More... | |
Private Member Functions | |
void | set_state (const tstate state) |
virtual const std::string & | get_control_type () const override |
See tcontrol::get_control_type. More... | |
void | load_config_extra () |
Inherited from tcontrol. More... | |
void | signal_handler_left_button_click (const event::tevent event, bool &handled) |
Left click signal handler: checks if we clicked on a hyperlink. More... | |
void | signal_handler_right_button_click (const event::tevent event, bool &handled) |
Right click signal handler: checks if we clicked on a hyperlink, copied to clipboard. More... | |
Private Attributes | |
tstate | state_ |
Current state of the widget. More... | |
bool | can_wrap_ |
Holds the label can wrap or not. More... | |
unsigned | characters_per_line_ |
The maximum number of characters per line. More... | |
bool | link_aware_ |
Whether the label is link aware, rendering links with special formatting and handling click events. More... | |
std::string | link_color_ |
What color links will be rendered in. More... | |
Additional Inherited Members | |
![]() | |
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... | |
![]() | |
virtual tpoint | calculate_best_size () const override |
See twidget::calculate_best_size. More... | |
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 |
![]() | |
void | set_layout_size (const tpoint &size) |
const tpoint & | layout_size () const |
|
private |
gui2::tlabel::tlabel | ( | ) |
Definition at line 43 of file label.cpp.
References signal_handler_left_button_click(), and signal_handler_right_button_click().
|
inlineoverridevirtual |
Whether the mouse move/click event go 'through' this widget.
Reimplemented from gui2::twidget.
|
overridevirtual |
See twidget::can_wrap.
Reimplemented from gui2::twidget.
Definition at line 55 of file label.cpp.
References can_wrap_.
|
overridevirtual |
See twidget::disable_click_dismiss.
Reimplemented from gui2::tcontrol.
|
overridevirtual |
See tcontrol::get_active.
Implements gui2::tcontrol.
Definition at line 82 of file label.cpp.
References DISABLED, and state_.
Referenced by set_active().
|
overridevirtual |
See tcontrol::get_characters_per_line.
Reimplemented from gui2::tcontrol.
Definition at line 60 of file label.cpp.
References characters_per_line_.
|
overrideprivatevirtual |
See tcontrol::get_control_type.
Implements gui2::tcontrol.
|
overridevirtual |
Reimplemented from gui2::tcontrol.
Definition at line 65 of file label.cpp.
References link_aware_.
Referenced by signal_handler_left_button_click(), and signal_handler_right_button_click().
|
overridevirtual |
|
overridevirtual |
See tcontrol::get_state.
Implements gui2::tcontrol.
Definition at line 87 of file label.cpp.
References state_.
|
privatevirtual |
Inherited from tcontrol.
Reimplemented from gui2::tcontrol.
Definition at line 137 of file label.cpp.
References gui2::tcontrol::config(), set_link_aware(), and set_link_color().
|
overridevirtual |
See tcontrol::set_active.
Implements gui2::tcontrol.
Definition at line 75 of file label.cpp.
References DISABLED, get_active(), and set_state().
|
inline |
Definition at line 60 of file label.hpp.
References can_wrap_.
Referenced by gui2::implementation::tbuilder_label::build(), gui2::tscroll_label::finalize_subclass(), gui2::twml_message_::pre_show(), and gui2::tscroll_label::set_can_wrap().
void gui2::tlabel::set_characters_per_line | ( | const unsigned | set_characters_per_line | ) |
Definition at line 97 of file label.cpp.
Referenced by gui2::implementation::tbuilder_label::build().
void gui2::tlabel::set_link_aware | ( | bool | l | ) |
Definition at line 102 of file label.cpp.
References link_aware_, gui2::twidget::set_is_dirty(), and gui2::tcontrol::update_canvas().
Referenced by load_config_extra().
void gui2::tlabel::set_link_color | ( | const std::string & | color | ) |
Definition at line 113 of file label.cpp.
References link_color_, gui2::twidget::set_is_dirty(), and gui2::tcontrol::update_canvas().
Referenced by load_config_extra().
Definition at line 123 of file label.cpp.
References gui2::twidget::set_is_dirty(), and state_.
Referenced by set_active().
|
private |
Left click signal handler: checks if we clicked on a hyperlink.
Definition at line 152 of file label.cpp.
References _(), gui2::tmessage::auto_close, DBG_GUI_E, gui2::tcontrol::get_label_link(), get_link_aware(), gui2::get_mouse_position(), gui2::twidget::get_window(), gui2::twidget::get_x(), gui2::twidget::get_y(), gui2::twindow::OK, desktop::open_object(), desktop::open_object_is_supported(), gui2::show_message(), gui2::tpoint::x, gui2::tpoint::y, and gui2::tmessage::yes_no_buttons.
Referenced by tlabel().
|
private |
Right click signal handler: checks if we clicked on a hyperlink, copied to clipboard.
Definition at line 188 of file label.cpp.
References _(), gui2::tmessage::auto_close, desktop::clipboard::copy_to_clipboard(), DBG_GUI_E, gui2::tcontrol::get_label_link(), get_link_aware(), gui2::get_mouse_position(), gui2::twidget::get_window(), gui2::twidget::get_x(), gui2::twidget::get_y(), gui2::show_message(), gui2::tpoint::x, and gui2::tpoint::y.
Referenced by tlabel().
|
private |
Holds the label can wrap or not.
Definition at line 95 of file label.hpp.
Referenced by can_wrap(), and set_can_wrap().
|
private |
The maximum number of characters per line.
The maximum is not an exact maximum, it uses the average character width.
Definition at line 102 of file label.hpp.
Referenced by get_characters_per_line().
|
private |
Whether the label is link aware, rendering links with special formatting and handling click events.
Definition at line 108 of file label.hpp.
Referenced by get_link_aware(), and set_link_aware().
|
private |
What color links will be rendered in.
Definition at line 113 of file label.hpp.
Referenced by get_link_color(), and set_link_color().
|
private |
Current state of the widget.
The state of the widget determines what to render and how the widget reacts to certain 'events'.
Definition at line 92 of file label.hpp.
Referenced by get_active(), get_state(), and set_state().