#include <gui_container.h>
Public Member Functions | |
| gui_container () | |
| ~gui_container () | |
| child_list & | get_children () |
| void | set_sizes_dirty (bool state) |
| bool | get_sizes_dirty () |
| void | check_integrity () |
| virtual void | add_child (gui_widget *child, int alignment=GUI_ALIGN_LEFT, int weight=1, bool recalc=true) |
| virtual void | remove_child (gui_widget *child) |
| virtual void | remove_child_using_native (native_widget child) |
| virtual gui_size | get_size () |
| virtual void | set_actual_size (gui_size size) |
| virtual bool | is_container () |
| virtual void | get_sizer_padding (int &header, int &edge) |
| virtual void | recalc_sizes () |
| virtual void | recalc_min_size () |
| virtual std::string | get_self_name () |
| virtual widget_types | get_self_type () |
| virtual void | set_actual_min_size (gui_size size) |
| virtual gui_size | get_actual_min_size () |
| virtual void | __internal_set_actual_size (gui_size size, bool propagate_to_os=true) |
| virtual void | __internal_set_actual_min_size (gui_size size) |
 Public Member Functions inherited from pntk::gui_widget | |
| virtual void | init (bool visible=true) |
| virtual void | set_configuration (gui_configuration &configuration) |
| virtual gui_configuration | get_configuration () |
| virtual void | set_position (gui_point pos) |
| virtual void | set_actual_position (gui_point pos) |
| gui_point | get_position () |
| gui_point | get_actual_position () |
| gui_point | get_screen_position () |
| virtual void | set_size (gui_size size) |
| gui_size | get_actual_size () |
| virtual gui_size | get_min_size () |
| virtual void | show (bool state) |
| virtual bool | is_owned () |
| virtual void | set_border (int border) |
| virtual int | get_border () |
| virtual void | set_border_style (int style) |
| virtual int | get_border_style () |
| virtual void | set_weight (int weight) |
| virtual int | get_weight () |
| virtual void | set_alignment (int alignment) |
| virtual int | get_alignment () |
| virtual void | set_style (int style) |
| virtual int | get_style () |
| virtual void | set_font (gui_font *font) |
| virtual gui_font * | get_font () |
| virtual void | set_system_cursor (gui_system_cursors cursor) |
| virtual gui_widget * | get_parent () |
| gui_widget * | get_sibling (bool next) |
| gui_widget * | get_sequential (bool next, bool wrap=false) |
| virtual void | reparent (gui_widget *parent) |
| virtual native_widget | get_native_widget () |
| virtual void | set_bg_color (gui_color color) |
| virtual void | set_fg_color (gui_color color) |
| virtual gui_color | get_bg_color () |
| virtual gui_color | get_fg_color () |
| virtual void | set_label (const std::string &text) |
| virtual std::string | get_label () |
| virtual void | set_enabled (bool state) |
| virtual bool | get_enabled () |
| virtual bool | is_visible () |
| virtual bool | is_ok () |
| virtual void | refresh (int flags=0, const gui_rect *area=nullptr) |
| gui_extra_data & | get_extra_data () |
| virtual void | set_focus () |
| virtual bool | has_focus () |
| void | set_default () |
| gui_size | bound_by_requested (gui_size size) |
| void | feed_mouse (int base_event, int events, bool &veto, gui_point cursor, int button) |
| virtual void | set_tooltip (std::string label) |
| virtual std::string | get_tooltip () |
| virtual void | __internal_set_size (gui_size size, bool propagate_to_os=true) |
| virtual void | __internal_set_os_actual (gui_size size) |
| Public Member Functions inherited from pntk::gui_object | |
| void | set_data (void *user_data) |
| void * | get_data () |
| virtual void | connect (gui_event_listener *call_back, void *data=nullptr, bool managed=false) |
| virtual void | disconnect (gui_event_listener *call_back, void *data=nullptr) |
| pntk::gui_listener_chain * | __internal_disconnect (pntk::gui_listener_chain *matching_chain) |
Public Attributes | |
| gui_size | min_size |
| Public Attributes inherited from pntk::gui_widget | |
| gui_font * | font |
| gui_system_cursors | system_cursor |
| gui_size | requested_size |
| gui_size | extent |
| gui_extra_data | extra_data |
Additional Inherited Members | |
| Public Types inherited from pntk::gui_object | |
| typedef std::map< gui_object *, gui_listener_chain * > | event_map |
| Static Public Member Functions inherited from pntk::gui_widget | |
| static void | get_widget_geometry (int alignment, gui_point base, gui_size max, gui_point &child_pos, gui_size &child_size) |
| Static Public Attributes inherited from pntk::gui_object | |
| static event_map | windowing_events |
Detailed Description
An abstract container for all other container types to inherit.
Constructor & Destructor Documentation
◆ gui_container()
| pntk::gui_container::gui_container | ( | ) |
Creates a new container. This is a foundational class and not intended for instantiation.
◆ ~gui_container()
| pntk::gui_container::~gui_container | ( | ) |
TODO: Need to protect this
Member Function Documentation
◆ add_child()
|
virtual |
Adds a child to the container using the given alignment and weight.
Reimplemented in pntk::gui_sizer.
◆ check_integrity()
| void pntk::gui_container::check_integrity | ( | ) |
Checks the integrity of its children.
◆ get_actual_min_size()
|
virtual |
Returns minimum size of the widget (without any border padding).
Reimplemented from pntk::gui_widget.
Reimplemented in pntk::gui_graphic_listbox, pntk::gui_dataless_listbox, pntk::gui_notebook, pntk::gui_window, and pntk::gui_sizer.
◆ get_children()
| child_list& pntk::gui_container::get_children | ( | ) |
Gets a list of the children of the container.
◆ get_self_name()
|
virtual |
Returns the human readable name associated with the widget class type.
Reimplemented from pntk::gui_widget.
Reimplemented in pntk::gui_graphic_listbox, pntk::gui_dataless_listbox, pntk::gui_notebook, pntk::gui_sizer, and pntk::gui_window.
◆ get_self_type()
|
virtual |
Returns the type of widget: GUI_TYPE_CONTAINER.
Reimplemented from pntk::gui_widget.
Reimplemented in pntk::gui_graphic_listbox, pntk::gui_dataless_listbox, pntk::gui_notebook, pntk::gui_sizer, and pntk::gui_window.
◆ get_size()
|
virtual |
Returns the extent of the widget (including all border padding).
Reimplemented from pntk::gui_widget.
Reimplemented in pntk::gui_sizer.
◆ get_sizer_padding()
|
virtual |
Sets given header and edge values to ones representing any additional margins the widget needs. Primarily useful in containers like the frame.
Reimplemented in pntk::gui_frame.
◆ get_sizes_dirty()
| bool pntk::gui_container::get_sizes_dirty | ( | ) |
Returns a flag that indicates if the containers size has changed and its children need recalculated. For internal use only.
◆ is_container()
|
virtual |
Returns whether or not this widget is a container, or subclassed from container.
Reimplemented from pntk::gui_widget.
◆ recalc_min_size()
|
virtual |
Forces a recalculation of the containers minmum size.
Reimplemented in pntk::gui_sizer, and pntk::gui_window.
◆ recalc_sizes()
|
virtual |
Forces a recalculation of all the childrens sizes and positions.
Reimplemented in pntk::gui_sizer.
◆ remove_child()
|
virtual |
Removes a child from the container.
◆ remove_child_using_native()
|
virtual |
Removes a child from the container, using its native refernce.
◆ set_actual_min_size()
|
virtual |
Sets the minimum size of the widget (not counting the border padding) to the given size. Intended for internal use only.
◆ set_actual_size()
|
virtual |
Sets the extent of the widget (not counting the border padding) to the given size.
Reimplemented from pntk::gui_widget.
Reimplemented in pntk::gui_window.
◆ set_sizes_dirty()
| void pntk::gui_container::set_sizes_dirty | ( | bool | state | ) |
Sets a flag that indicates if the containers size has changed and its children need recalculated. For internal use only.
Member Data Documentation
◆ min_size
| gui_size pntk::gui_container::min_size |
Minimum size that the container can be to still hold its children. For Internal use only.
The documentation for this class was generated from the following file:
- include/gui_container.h
