libt3widget
|
Base class for widgets. More...
Public Member Functions | |
virtual bool | accepts_focus (void) |
Query whether this widget accepts focus. More... | |
virtual void | force_redraw (void) |
Request that this window_component_t be completely redrawn. More... | |
virtual void | hide (void) |
Hide the window_component_t. More... | |
virtual bool | is_enabled (void) |
Query the enabled status of this widget. More... | |
virtual bool | is_hotkey (key_t key) |
Query whether key is a hotkey for this widget. More... | |
virtual bool | is_shown (void) |
Query the visibility status of this widget. More... | |
virtual bool | process_mouse_event (mouse_event_t event) |
Process a mouse event. More... | |
virtual void | set_anchor (window_component_t *anchor, int relation) |
Set this widget's anchor. More... | |
virtual void | set_enabled (bool enable) |
Set the enabled status of this widget. More... | |
virtual void | set_focus (focus_t focus) |
Set whether this window_component_t has the input focus. More... | |
virtual void | set_position (optint top, optint left) |
Move the window_component_t to a specified position. More... | |
virtual void | show (void) |
Display the window_component_t. More... | |
![]() | |
virtual t3_window_t * | get_base_window (void) |
Retrieve the t3_window_t for this window_component_t. More... | |
virtual bool | process_key (key_t key)=0 |
Handle a key press by the user. More... | |
virtual bool | set_size (optint height, optint width)=0 |
Set the size of this window_component_t. More... | |
virtual void | update_contents (void)=0 |
Update the contents of the window. More... | |
window_component_t (void) | |
Base constructor. More... | |
virtual | ~window_component_t (void) |
Base destructor. More... | |
![]() | |
void | grab_mouse (void) |
Grab all future mouse events. More... | |
void | register_mouse_target (t3_window_t *target) |
Register a window to receive mouse events. More... | |
void | release_mouse_grab (void) |
Release a previous mouse grab. More... | |
void | unregister_mouse_target (t3_window_t *target) |
Unregister a window to receive mouse events. More... | |
Protected Member Functions | |
void | init_unbacked_window (int height, int width, bool register_as_mouse_target=false) |
Initialize the window with an unbacked t3_window_t with height and width . More... | |
void | init_window (int height, int width, bool register_as_mouse_target=true) |
Initialize the window with a t3_window_t with height and width . More... | |
widget_t (int height, int width, bool register_as_mouse_target=true) | |
Constructor which creates a default t3_window_t with height and width . More... | |
widget_t (void) | |
Constructor which does not create a default t3_window_t. More... | |
![]() | |
mouse_target_t (bool use_window=true) | |
Protected Attributes | |
bool | enabled |
Widget is enabled. More... | |
bool | redraw |
Widget requires redrawing on next update_contents call. More... | |
bool | shown |
Widget is shown. More... | |
![]() | |
cleanup_t3_window_ptr | window |
The t3_window_t used for presenting this item on screen (see libt3window). More... | |
Friends | |
class | container_t |
Additional Inherited Members | |
![]() | |
enum | focus_t { FOCUS_OUT, FOCUS_SET, FOCUS_IN_FWD, FOCUS_IN_BCK, FOCUS_REVERT } |
![]() | |
static bool | handle_mouse_event (mouse_event_t event) |
Base class for widgets.
|
protected |
Constructor which creates a default t3_window_t
with height
and width
.
|
protected |
Constructor which does not create a default t3_window_t.
This constructor should only rarely be necessary. Widgets using this constructor should call either init_window, or init_unbacked_window.
|
virtual |
Query whether this widget accepts focus.
Reimplemented in t3_widget::menu_bar_t, t3_widget::attribute_test_line_t, t3_widget::menu_separator_t, t3_widget::label_t, t3_widget::frame_t, t3_widget::smart_label_t, t3_widget::widget_group_t, t3_widget::multi_widget_t, t3_widget::scrollbar_t, and t3_widget::separator_t.
|
virtual |
Request that this window_component_t be completely redrawn.
Implements t3_widget::window_component_t.
Reimplemented in t3_widget::edit_window_t, t3_widget::split_t, t3_widget::list_pane_t, t3_widget::expander_t, t3_widget::frame_t, t3_widget::widget_group_t, and t3_widget::multi_widget_t.
|
virtual |
Hide the window_component_t.
Implements t3_widget::window_component_t.
Reimplemented in t3_widget::text_field_t, t3_widget::menu_bar_t, t3_widget::menu_separator_t, t3_widget::menu_item_t, and t3_widget::dummy_widget_t.
|
protected |
Initialize the window with an unbacked t3_window_t
with height
and width
.
|
protected |
Initialize the window with a t3_window_t
with height
and width
.
|
virtual |
Query the enabled status of this widget.
|
virtual |
Query whether key is a hotkey for this widget.
Reimplemented in t3_widget::text_field_t, t3_widget::menu_bar_t, t3_widget::expander_t, t3_widget::menu_item_t, t3_widget::frame_t, t3_widget::button_t, t3_widget::widget_group_t, t3_widget::smart_label_t, and t3_widget::checkbox_t.
|
virtual |
Query the visibility status of this widget.
|
virtual |
Process a mouse event.
Implements t3_widget::mouse_target_t.
Reimplemented in t3_widget::edit_window_t, t3_widget::text_field_t, t3_widget::file_pane_t, t3_widget::menu_bar_t, t3_widget::list_pane_t, t3_widget::expander_t, t3_widget::button_t, t3_widget::text_window_t, t3_widget::scrollbar_t, t3_widget::checkbox_t, and t3_widget::color_picker_base_t.
|
virtual |
Set this widget's anchor.
Use anchor
to position this window. See libt3window's t3_win_set_anchor for details on the relation
parameter.
Reimplemented in t3_widget::list_pane_t.
|
virtual |
Set the enabled status of this widget.
When a widget is not enabled, it will not accept focus.
Reimplemented in t3_widget::expander_t, t3_widget::frame_t, t3_widget::checkbox_t, and t3_widget::multi_widget_t.
|
virtual |
Set whether this window_component_t has the input focus.
Note that this merely notifies the window_component_t that it should change it's appearance to indicate the user that this window_component_t has the input focus. Which window_component_t actually receives the input events is handled outside of the window_component_t.
Implements t3_widget::window_component_t.
Reimplemented in t3_widget::edit_window_t, t3_widget::text_field_t, t3_widget::file_pane_t, t3_widget::menu_bar_t, t3_widget::split_t, t3_widget::list_pane_t, t3_widget::menu_separator_t, t3_widget::expander_t, t3_widget::label_t, t3_widget::button_t, t3_widget::menu_item_t, t3_widget::frame_t, t3_widget::text_window_t, t3_widget::smart_label_t, t3_widget::widget_group_t, t3_widget::bullet_t, t3_widget::scrollbar_t, t3_widget::checkbox_t, t3_widget::color_picker_base_t, t3_widget::multi_widget_t, and t3_widget::separator_t.
Move the window_component_t to a specified position.
Note that the position is relative to the anchor point.
Implements t3_widget::window_component_t.
Reimplemented in t3_widget::list_pane_t, t3_widget::dummy_widget_t, and t3_widget::menu_item_base_t.
|
virtual |
Display the window_component_t.
Implements t3_widget::window_component_t.
Reimplemented in t3_widget::text_field_t, t3_widget::menu_bar_t, t3_widget::menu_separator_t, t3_widget::menu_item_t, and t3_widget::dummy_widget_t.
|
protected |
Widget is enabled.
|
protected |
Widget requires redrawing on next update_contents call.
|
protected |
Widget is shown.