Loading...
Searching...
No Matches
cgv::gui::window Class Referenceabstract
gui independent window class More...
#include <window.h>
Inheritance diagram for cgv::gui::window:
Public Member Functions | |
| window (const std::string &name) | |
| construct from name | |
| std::string | get_type_name () const |
| overload to return the type name of this object | |
| virtual gui_group_ptr | get_inner_group () |
| return the group that is managing the content of the window | |
| virtual void | show (bool modal=false)=0 |
| show the window. This needs to be called after creation to make the window visible | |
| virtual void | hide ()=0 |
| hide the window | |
| virtual bool | dispatch_event (event &e) |
| dispatch a cgv event | |
 Public Member Functions inherited from cgv::gui::gui_group | |
| void | register_object (cgv::base::base_ptr object, const std::string &options) |
| interface of adding an object | |
| void | unregister_object (cgv::base::base_ptr object, const std::string &options) |
| overload to handle unregistration events | |
| gui_group (const std::string &name="") | |
| construct from name | |
| void | add_managed_objects (cgv::base::base_ptr object) |
| add the passed object as an managed object. | |
| void | release_all_managed_objects () |
| release all managed objects | |
| void | release_managed_objects (cgv::base::base_ptr object) |
| release a specific managed object | |
| bool | is_managed_object (cgv::base::base_ptr object) |
| check whether an object is managed by this gui group | |
| virtual void | align (const std::string &_align) |
| send pure alignment information | |
| virtual gui_group_ptr | add_group (const std::string &label, const std::string &group_type, const std::string &options, const std::string &align) |
| add a new group to the given parent group | |
| virtual cgv::base::base_ptr | add_decorator (const std::string &label, const std::string &decorator_type, const std::string &options, const std::string &align) |
| add a newly created decorator to the group | |
| virtual button_ptr | add_button (const std::string &label, const std::string &options, const std::string &align) |
| add a newly created button to the group | |
| virtual view_ptr | add_view_void (const std::string &label, const void *value_ptr, const std::string &value_type, const std::string &gui_type, const std::string &options, const std::string &align) |
| add a newly created view to the group | |
| virtual control_ptr | add_control_void (const std::string &label, void *value_ptr, abst_control_provider *acp, const std::string &value_type, const std::string &gui_type, const std::string &options, const std::string &align, void *user_data) |
| add a newly created control to the group | |
| template<typename T > | |
| data::ref_ptr< view< T > > | add_view (const std::string &label, const T &value, const std::string &gui_type="", const std::string &options="", const std::string &align="\n") |
| add a newly created view to the group for the given value with the given gui type, init and align options | |
| template<typename T > | |
| data::ref_ptr< control< T > > | add_control (const std::string &label, T &value, const std::string &gui_type="", const std::string &options="", const std::string &align="\n") |
| add a newly created control to the group for the given value with the given gui type, init and align options | |
| template<typename T > | |
| data::ref_ptr< control< T > > | add_control (const std::string &label, control_provider< T > *provider, const std::string &gui_type="", const std::string &options="", const std::string &align="\n", void *user_data=0) |
| add a newly created control to the group which is controlled by a control_provider | |
| cgv::base::base_ptr | find_element (const std::string &name) |
| find a gui element by name, return empty pointer if not found | |
| view_ptr | find_view_void (const void *value_ptr, int *idx_ptr) |
| find a view in the group based on a const void pointer | |
| control_ptr | find_control_void (void *value_ptr, int *idx_ptr) |
| find a control in the group based on a const void pointer | |
| template<typename T > | |
| data::ref_ptr< view< T > > | find_view (const T &value, int *idx_ptr=0) |
| find the next view of the given value in the current group. | |
| template<typename T > | |
| data::ref_ptr< control< T > > | find_control (T &value, int *idx_ptr=0) |
| find the next control of the given value in the current group. | |
| virtual bool | multiple_selection () const |
| return whether several children of the group can be selected at the same time | |
| virtual void | select_child (unsigned ci, bool exclusive=false) |
| select the ci-th child of the group. | |
| virtual void | select_child (cgv::base::base_ptr ci, bool exclusive=false) |
| same as version with child index | |
| virtual bool | unselect_child (unsigned ci) |
| unselect the ci-th child. | |
| virtual bool | unselect_child (cgv::base::base_ptr ci) |
| same as version with child index | |
| virtual int | get_selected_child_index () const |
| return the index of the currently selected child. | |
| virtual cgv::base::base_ptr | get_selected_child () const |
| return the currently selected child. | |
| virtual bool | is_selected (cgv::base::base_ptr c) const |
| return whether the given child is selected | |
| bool | is_selected (unsigned ci) const |
| return whether the given child is selected. | |
| virtual bool | can_open_and_close () const |
| returns whether open and close of sub groups is allowed | |
| virtual bool | is_open_child_group (gui_group_ptr g) const |
| return whether the given child is open | |
| bool | is_open_child_group (unsigned ci) const |
| return whether the ci-th child is an open gui group | |
| virtual bool | open_child_group (gui_group_ptr g) |
| try to open given child group and return whether this was successful | |
| virtual bool | close_child_group (gui_group_ptr g) |
| try to close given child group and return whether this was successful | |
| Public Member Functions inherited from cgv::base::group | |
| group (const std::string &name="") | |
| construct from name | |
| unsigned int | get_nr_children () const |
| return the number of children | |
| base_ptr | get_child (unsigned int i) const |
| return the i-th child | |
| template<typename T > | |
| data::ref_ptr< T > | create_and_append_child (const std::string &name="", unsigned int *index=nullptr) |
| create and append an instance of a child node and return pointer to appended child; optionally set name and get index | |
| virtual unsigned int | append_child (base_ptr child) |
| append child and return index of appended child | |
| virtual unsigned int | remove_child (base_ptr child) |
| remove all elements of the vector that point to child, return the number of removed children | |
| virtual void | remove_all_children () |
| remove all children | |
| virtual void | insert_child (unsigned int i, base_ptr child) |
| insert a child at the given position | |
| group_ptr | get_group () |
| cast upward to group | |
| const_group_ptr | get_group_const () |
| cast upward to const group | |
| Public Member Functions inherited from cgv::base::node | |
| node (const std::string &name="") | |
| construct from name | |
| node_ptr | get_parent () const |
| return the parent node | |
| base_ptr | get_root () const |
| return the root node by traversing parents until no more parent is available | |
| void | set_parent (node_ptr _parent) |
| set a new parent node | |
| node_ptr | get_node () |
| cast upward to node | |
| const_node_ptr | get_node_const () |
| cast upward to const node | |
| Public Member Functions inherited from cgv::base::named | |
| named (const std::string &name="") | |
| construct from name | |
| const std::string & | get_name () const |
| return the parent node | |
| void | set_name (const std::string &_name) |
| set a new parent node | |
| named_ptr | get_named () |
| cast upward to named | |
| const_named_ptr | get_named_const () |
| cast upward to const named | |
| Public Member Functions inherited from cgv::base::base | |
| virtual std::string | get_default_options () const |
| overload to provide default options for registration | |
| std::string | get_name_or_type_name () const |
| determine name of instance by checking cgv::base::named interface and in failure fallback to get_type_name() | |
| virtual void | on_register () |
| overload to handle register events that is sent after the instance has been registered | |
| virtual void | unregister () |
| overload to handle unregistration of instances | |
| virtual bool | on_exit_request () |
| overload to handle the appication exit request, return true if exiting is allowed and false otherwise | |
| virtual void | stream_stats (std::ostream &) |
| overload to show the content of this object | |
| virtual data::ref_ptr< const named, true > | get_named_const () const |
| perform downcast to const named | |
| virtual data::ref_ptr< const node, true > | get_node_const () const |
| perform downcast to const node | |
| virtual data::ref_ptr< const group, true > | get_group_const () const |
| perform downcast to const group | |
| template<class T > | |
| data::ref_ptr< T, true > | cast () |
| cast to arbitrary class, but use the casts to named, node and group from the interface | |
| template<class T > | |
| data::ref_ptr< const T, true > | cast_const () |
| const cast to arbitrary class, but use the casts to named, node and group from the interface | |
| template<class T > | |
| T * | get_interface () |
| use dynamic type cast to check for the given interface | |
| template<class T > | |
| const T * | get_const_interface () const |
| use dynamic type cast to check for the given interface | |
| virtual void | update () |
| this virtual update allows for example to ask a view to update the viewed value. The default implementation is empty. | |
| virtual void * | get_user_data () const |
| this virtual method allows to pass application specific data for internal purposes | |
| virtual bool | self_reflect (cgv::reflect::reflection_handler &) |
| used for simple self reflection | |
| virtual std::string | get_property_declarations () |
| return a semicolon separated list of property declarations | |
| virtual bool | set_void (const std::string &property, const std::string &value_type, const void *value_ptr) |
| abstract interface for the setter of a dynamic property. | |
| virtual void | on_set (void *member_ptr) |
| this callback is called when the set_void method has changed a member and can be overloaded in derived class | |
| virtual bool | get_void (const std::string &property, const std::string &value_type, void *value_ptr) |
| abstract interface for the getter of a dynamic property. | |
| virtual bool | call_void (const std::string &method, const std::vector< std::string > ¶m_value_types, const std::vector< const void * > ¶m_value_ptrs, const std::string &result_type="", void *result_value_ptr=0) |
| abstract interface to call an action | |
| void | set (const std::string &property, const char *value) |
| specialization of set method to support const char* as strings | |
| template<typename T > | |
| void | set (const std::string &property, const T &value) |
| set a property of the element to the given value and perform standard conversions if necessary. | |
| template<typename T > | |
| T | get (const std::string &property) |
| query a property of the element and perform standard conversions if necessary. | |
| void | multi_set (const std::string &property_assignments, bool report_error=true) |
| set several properties | |
| bool | is_property (const std::string &property_name, std::string *type_name=0) |
| check if the given name specifies a property. | |
| void * | find_member_ptr (const std::string &property_name, std::string *type_name=0) |
| find a member pointer by name. | |
| Public Member Functions inherited from cgv::data::ref_counted | |
| int | get_ref_count () const |
| read access to current count | |
Additional Inherited Members | |
| Public Attributes inherited from cgv::gui::gui_group | |
| cgv::signal::signal< cgv::base::base_ptr, bool > | on_selection_change |
| This signal is emitted for every change of the selection of a child. | |
| cgv::signal::signal< gui_group_ptr, bool > | on_open_state_change |
| this signal is emitted, when a child group is opened or closed | |
| Protected Member Functions inherited from cgv::base::group | |
| void | link (base_ptr b) |
| check if the base class is a node and set the parent of the node | |
| void | unlink (base_ptr b) |
| check if the base class is a node and clear the parent of the node | |
| Protected Member Functions inherited from cgv::base::base | |
| virtual | ~base () |
| make destructor virtual and not accessible from outside | |
| Protected Member Functions inherited from cgv::data::ref_counted | |
| ref_counted () | |
| constructor initializes the count to 0 | |
| void | set_ref_count (int c) const |
| write access is also const to allow ref counted pointers to const instances | |
| Static Protected Member Functions inherited from cgv::gui::gui_group | |
| static void | set_provider_parent (provider *p, gui_group_ptr g) |
| access to protected provider method | |
| static gui_group_ptr | get_provider_parent (const provider *p) |
| driver specific handle for the group gui element managing the gui built in the provider | |
| Static Protected Member Functions inherited from cgv::base::base | |
| template<class T > | |
| static data::ref_ptr< T, true > | cast_dynamic (base *b) |
| use dynamic cast for upcast to given class | |
| Protected Attributes inherited from cgv::gui::gui_group | |
| std::vector< cgv::base::base_ptr > | managed_objects |
| managed objects can be add to the group such that | |
| Protected Attributes inherited from cgv::base::group | |
| std::vector< base_ptr > | children |
| store a list of children | |
| Protected Attributes inherited from cgv::base::node | |
| node_ptr | parent |
| store a pointer to the parent node | |
| Protected Attributes inherited from cgv::base::named | |
| std::string | name |
| store the name as a string | |
Detailed Description
Constructor & Destructor Documentation
◆ window()
| cgv::gui::window::window | ( | const std::string & | name | ) |
construct from name
Definition at line 6 of file window.cxx.
Member Function Documentation
◆ dispatch_event()
|
virtual |
dispatch a cgv event
Definition at line 20 of file window.cxx.
◆ get_inner_group()
|
virtual |
return the group that is managing the content of the window
Definition at line 14 of file window.cxx.
◆ get_type_name()
|
virtual |
overload to return the type name of this object
Reimplemented from cgv::gui::gui_group.
Definition at line 8 of file window.cxx.
The documentation for this class was generated from the following files:
- cgv/gui/window.h
- cgv/gui/window.cxx
