Loading...
Searching...
No Matches
cgv::gui::text_editor Class Referenceabstract
abstract base class for text editors More...
#include <text_editor.h>
Inheritance diagram for cgv::gui::text_editor:
Public Member Functions | |
| text_editor (const std::string &name, text_editor_callback_handler *_handler=0) | |
| construct from callback handler | |
| void | set_callback_handler (text_editor_callback_handler *_handler) |
| set a new callback handler | |
| const text_editor_callback_handler * | get_callback_handler () const |
| return current callback handler | |
| virtual | ~text_editor () |
| virtual destructor | |
| virtual void | set_base_path (const std::string &path)=0 |
| set a different base path used for the file open and save dialog | |
| virtual void | set_filter (const std::string &filter)=0 |
| set a file filter for the file open and save dialog, default is "*" | |
| virtual bool | read (const std::string &file_name)=0 |
| read a new text file | |
| virtual bool | is_modified () const =0 |
| check if the current file is modified | |
| virtual bool | save ()=0 |
| save the current file | |
| virtual void | show ()=0 |
| show editor | |
| virtual void | hide ()=0 |
| hide editor | |
| virtual bool | is_visible () const =0 |
| return whether editor is visible | |
| virtual const char * | get_text () const =0 |
| return pointer to text buffer | |
| virtual void | set_text (const std::string &new_text)=0 |
| replace the complete text | |
| virtual const char * | get_style () const =0 |
| return pointer to style buffer | |
| virtual void | set_style (int text_pos, int length, const char *style)=0 |
| set the style of a given text portion | |
| virtual unsigned int | get_length () const =0 |
| return length of text and style buffer | |
| virtual void | set_text_styles (const text_style *table, int nr_styles)=0 |
| set text styles from a table, where the first style is labeled with the character A, the snd by B, etc. | |
 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 | |
| std::string | get_type_name () const |
| overload to return the type name of this object | |
| 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< node, true > | get_node () |
| perform downcast to node | |
| virtual data::ref_ptr< group, true > | get_group () |
| perform downcast to group | |
| 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 | |
Protected Attributes | |
| text_editor_callback_handler * | handler |
| store a callback handler | |
| Protected Attributes inherited from cgv::base::named | |
| std::string | name |
| store the name as a string | |
Additional Inherited Members | |
| 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::base::base | |
| template<class T > | |
| static data::ref_ptr< T, true > | cast_dynamic (base *b) |
| use dynamic cast for upcast to given class | |
Detailed Description
abstract base class for text editors
Definition at line 41 of file text_editor.h.
Constructor & Destructor Documentation
◆ text_editor()
| cgv::gui::text_editor::text_editor | ( | const std::string & | name, |
| text_editor_callback_handler * | _handler = 0 |
||
| ) |
construct from callback handler
Definition at line 49 of file text_editor.cxx.
◆ ~text_editor()
|
virtual |
virtual destructor
Definition at line 65 of file text_editor.cxx.
Member Function Documentation
◆ get_callback_handler()
| const text_editor_callback_handler * cgv::gui::text_editor::get_callback_handler | ( | ) | const |
◆ set_callback_handler()
| void cgv::gui::text_editor::set_callback_handler | ( | text_editor_callback_handler * | _handler | ) |
Member Data Documentation
◆ handler
|
protected |
store a callback handler
Definition at line 45 of file text_editor.h.
Referenced by get_callback_handler(), and set_callback_handler().
The documentation for this class was generated from the following files:
- cgv/gui/text_editor.h
- cgv/gui/text_editor.cxx
