libt3widget
|
Abstract base class for all items displayed on screen. More...
Public Types | |
enum | focus_t { FOCUS_OUT, FOCUS_SET, FOCUS_IN_FWD, FOCUS_IN_BCK, FOCUS_REVERT } |
Public Member Functions | |
virtual void | force_redraw (void)=0 |
Request that this window_component_t be completely redrawn. More... | |
virtual t3_window_t * | get_base_window (void) |
Retrieve the t3_window_t for this window_component_t. More... | |
virtual void | hide (void)=0 |
Hide the window_component_t. More... | |
virtual bool | process_key (key_t key)=0 |
Handle a key press by the user. More... | |
virtual void | set_focus (focus_t focus)=0 |
Set whether this window_component_t has the input focus. More... | |
virtual void | set_position (optint top, optint left)=0 |
Move the window_component_t to a specified position. More... | |
virtual bool | set_size (optint height, optint width)=0 |
Set the size of this window_component_t. More... | |
virtual void | show (void)=0 |
Display the 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... | |
Protected Attributes | |
cleanup_t3_window_ptr | window |
The t3_window_t used for presenting this item on screen (see libt3window). More... | |
Abstract base class for all items displayed on screen.
t3_widget::window_component_t::window_component_t | ( | void | ) |
Base constructor.
|
virtual |
Base destructor.
|
pure virtual |
Request that this window_component_t be completely redrawn.
Implemented in t3_widget::edit_window_t, t3_widget::dialog_base_t, t3_widget::split_t, t3_widget::list_pane_t, t3_widget::expander_t, t3_widget::widget_t, t3_widget::frame_t, t3_widget::widget_group_t, and t3_widget::multi_widget_t.
|
virtual |
Retrieve the t3_window_t for this window_component_t.
The returned pointer should be used only for setting anchor positions of other window_component_t's and similar operations.
Reimplemented in t3_widget::dummy_widget_t.
|
pure virtual |
Hide the window_component_t.
Implemented in t3_widget::text_field_t::drop_down_list_t, t3_widget::text_field_t, t3_widget::menu_bar_t, t3_widget::dialog_base_t, t3_widget::dialog_t, t3_widget::menu_separator_t, t3_widget::widget_t, t3_widget::menu_item_t, t3_widget::popup_t, and t3_widget::dummy_widget_t.
|
pure virtual |
Handle a key press by the user.
Implemented in t3_widget::edit_window_t::autocomplete_panel_t, t3_widget::edit_window_t, t3_widget::text_field_t::drop_down_list_t, t3_widget::file_pane_t::search_panel_t, t3_widget::text_field_t, t3_widget::file_pane_t, t3_widget::menu_bar_t, t3_widget::attribute_test_line_t, t3_widget::split_t, t3_widget::list_pane_t, t3_widget::dialog_t, t3_widget::menu_separator_t, t3_widget::expander_t, t3_widget::label_t, t3_widget::menu_panel_t, t3_widget::menu_item_t, t3_widget::frame_t, t3_widget::button_t, t3_widget::text_window_t, t3_widget::widget_group_t, t3_widget::input_selection_dialog_t, t3_widget::smart_label_t, t3_widget::bullet_t, t3_widget::scrollbar_t, t3_widget::multi_widget_t, t3_widget::color_picker_base_t, t3_widget::checkbox_t, t3_widget::popup_t, t3_widget::dummy_widget_t, and t3_widget::separator_t.
|
pure 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.
Implemented in t3_widget::edit_window_t, t3_widget::text_field_t::drop_down_list_t, t3_widget::text_field_t, t3_widget::file_pane_t, t3_widget::menu_bar_t, t3_widget::split_t, t3_widget::widget_t, t3_widget::dialog_base_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.
Implemented in t3_widget::edit_window_t::autocomplete_panel_t, t3_widget::text_field_t::drop_down_list_t, t3_widget::file_pane_t::search_panel_t, t3_widget::dialog_base_t, t3_widget::list_pane_t, t3_widget::menu_panel_t, t3_widget::widget_t, t3_widget::main_window_base_t, t3_widget::dummy_widget_t, and t3_widget::menu_item_base_t.
Set the size of this window_component_t.
height | The new height of the window_component_t in cells, or None if it should remain unchanged. |
width | The new width of the window_component_t in cells, or None if it should remain unchanged. |
Implemented in t3_widget::edit_window_t::autocomplete_panel_t, t3_widget::edit_window_t, t3_widget::text_field_t::drop_down_list_t, t3_widget::file_pane_t::search_panel_t, t3_widget::text_field_t, t3_widget::open_file_dialog_t, t3_widget::file_pane_t, t3_widget::menu_bar_t, t3_widget::attribute_test_line_t, t3_widget::split_t, t3_widget::dialog_base_t, t3_widget::list_pane_t, t3_widget::expander_t, t3_widget::file_dialog_t, t3_widget::find_dialog_t, t3_widget::label_t, t3_widget::menu_panel_t, t3_widget::frame_t, t3_widget::button_t, t3_widget::text_window_t, t3_widget::widget_group_t, t3_widget::main_window_base_t, t3_widget::smart_label_t, t3_widget::bullet_t, t3_widget::input_selection_dialog_t, t3_widget::scrollbar_t, t3_widget::checkbox_t, t3_widget::color_picker_base_t, t3_widget::multi_widget_t, t3_widget::dummy_widget_t, t3_widget::menu_item_base_t, t3_widget::goto_dialog_t, t3_widget::insert_char_dialog_t, and t3_widget::separator_t.
|
pure virtual |
Display the window_component_t.
Implemented in t3_widget::text_field_t::drop_down_list_t, t3_widget::file_pane_t::search_panel_t, t3_widget::text_field_t, t3_widget::menu_bar_t, t3_widget::dialog_base_t, t3_widget::dialog_t, t3_widget::menu_separator_t, t3_widget::widget_t, t3_widget::menu_item_t, t3_widget::attribute_picker_dialog_t, t3_widget::main_window_base_t, t3_widget::input_selection_dialog_t, t3_widget::popup_t, and t3_widget::dummy_widget_t.
|
pure virtual |
Update the contents of the window.
Implemented in t3_widget::edit_window_t, t3_widget::text_field_t::drop_down_list_t, t3_widget::file_pane_t::search_panel_t, t3_widget::text_field_t, t3_widget::file_pane_t, t3_widget::menu_bar_t, t3_widget::attribute_test_line_t, t3_widget::split_t, t3_widget::dialog_base_t, t3_widget::list_pane_t, t3_widget::dialog_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::main_window_base_t, t3_widget::bullet_t, t3_widget::scrollbar_t, t3_widget::checkbox_t, t3_widget::multi_widget_t, t3_widget::color_picker_base_t, t3_widget::popup_t, t3_widget::dummy_widget_t, and t3_widget::separator_t.
|
protected |
The t3_window_t used for presenting this item on screen (see libt3window).