abstract base class for gui drivers More...

#include <gui_driver.h>

Inheritance diagram for cgv::gui::gui_driver:

Public Member Functions
virtual std::string	get_type_name () const
	overload to return the type name of this object. By default the type interface is queried over get_type. More...

virtual std::string	get_default_options () const
	overload to provide default options for registration

virtual void	on_register ()
	overload to handle register events that is sent after the instance has been registered More...

virtual void	unregister ()
	overload to handle unregistration of instances

virtual void	stream_stats (std::ostream &)
	overload to show the content of this object

virtual data::ref_ptr< named, true >	get_named ()
	cast upward to named

virtual data::ref_ptr< node, true >	get_node ()
	cast upward to node

virtual data::ref_ptr< group, true >	get_group ()
	cast upward to 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 >
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 More...

int	get_ref_count () const
	read access to current count

application management
virtual bool	enumerate_monitors (std::vector< monitor_description > &monitor_descriptions)
	fill list of monitor descriptions

virtual window_ptr	create_window (int w, int h, const std::string &title, const std::string &window_type)=0
	create a window of the given type. Currently only the types "viewer with gui", "viewer" and "gui" are supported

virtual void	remove_window (window_ptr w)=0
	remove a window that has been destroyed

virtual bool	set_focus (const_window_ptr)=0
	set the input focus to the given window

virtual unsigned int	get_nr_windows ()=0
	return the number of created windows

virtual window_ptr	get_window (unsigned int i)=0
	return the i-th created window

virtual bool	run ()=0
	run the main loop of the window system

virtual void	quit (int exit_code)=0
	quit the application by closing all windows

virtual void	copy_to_clipboard (const std::string &s)=0
	copy text to the clipboard

virtual std::string	paste_from_clipboard ()=0
	retreive text from clipboard

some basic functionality
virtual int	question (const std::string &_question, const std::vector< std::string > &answers, int default_answer=-1)=0
	ask the user with `_question` to select one of the `answers`, where `default_answer` specifies index of default answer

virtual bool	query (const std::string &question, std::string &text, bool password=false)=0
	query the user for a text, where the second parameter is the default `text` as well as the returned text. More...

virtual text_editor_ptr	create_text_editor (unsigned int w, unsigned int h, const std::string &title, int x, int y)=0
	create a text editor

virtual std::string	files_open_dialog (std::vector< std::string > &file_names, const std::string &title, const std::string &filter, const std::string &path)=0
	ask user for an open dialog that can select multiple files, return common path prefix and fill field of filenames

virtual std::string	file_open_dialog (const std::string &title, const std::string &filter, const std::string &path)=0
	ask user for a file to open

virtual std::string	file_save_dialog (const std::string &title, const std::string &filter, const std::string &path)=0
	ask user for a file to save

threading based functionality
virtual void	lock ()=0
	lock the main thread of the gui from a child thread before any gui specific call. More...

virtual void	unlock ()=0
	unlock the main thread

virtual void	wake (const std::string &message="")=0
	wake main thread. More...

virtual std::string	get_wakeup_message ()=0
	return the message send by the thread that woke up the main thread with wake()

virtual void	sleep (float time_in_seconds)=0
	let the main thread sleep for the given number of seconds

gui elements
virtual bool	process_gui_file (const std::string &file_name)=0
	process the gui declarations in the given gui file

virtual gui_group_ptr	add_group (gui_group_ptr parent, const std::string &label, const std::string &group_type, const std::string &options, const std::string &align)=0
	add a new gui group to the given parent group

virtual base_ptr	add_decorator (gui_group_ptr parent, const std::string &label, const std::string &decorator_type, const std::string &options, const std::string &align)=0
	add a newly created decorator to the parent group

virtual button_ptr	add_button (gui_group_ptr parent, const std::string &label, const std::string &options, const std::string &align)=0
	add new button to the parent group

virtual view_ptr	add_view (gui_group_ptr parent, 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)=0
	add new view to the parent group

virtual view_ptr	find_view (gui_group_ptr parent, const void value_ptr, int idx_ptr)=0
	find a view in the group

virtual control_ptr	add_control (gui_group_ptr parent, 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)=0
	add new control to the parent group

virtual control_ptr	find_control (gui_group_ptr parent, void value_ptr, int idx_ptr)=0
	find a control in a group

menu elements
virtual base_ptr	add_menu_separator (const std::string &menu_path)=0
	add a newly created decorator to the menu

virtual button_ptr	add_menu_button (const std::string &menu_path, const std::string &options)=0
	use the current gui driver to append a new button in the menu, where menu path is a '/' separated path

virtual data::ref_ptr< control< bool > >	add_menu_bool_control (const std::string &menu_path, bool &value, const std::string &options)=0
	use this to add a new control to the gui with a given value type, gui type and init options

virtual base_ptr	find_menu_element (const std::string &menu_path) const =0
	return the element of the given menu path

virtual void	remove_menu_element (base_ptr)=0
	remove a single element from the gui

Protected Member Functions
void	set_ref_count (int c) const
	write access is also const to allow ref counted pointers to const instances

Static Protected Member Functions
template<class T >
static data::ref_ptr< T, true >	cast_dynamic (base *b)
	use dynamic cast for upcast to given class

property interface
virtual bool	self_reflect (cgv::reflect::reflection_handler &)
	used for simple self reflection More...

virtual std::string	get_property_declarations ()
	return a semicolon separated list of property declarations More...

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. More...

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. More...

virtual bool	call_void (const std::string &method, const std::vector< std::string > &param_value_types, const std::vector< const void * > &param_value_ptrs, const std::string &result_type="", void *result_value_ptr=0)
	abstract interface to call an action More...

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. More...

template<typename T >
T	get (const std::string &property)
	query a property of the element and perform standard conversions if necessary. More...

void	multi_set (const std::string &property_assignments, bool report_error=true)
	set several properties More...

bool	is_property (const std::string &property_name, std::string *type_name=0)
	check if the given name specifies a property. More...

void *	find_member_ptr (const std::string &property_name, std::string *type_name=0)
	find a member pointer by name. More...

Detailed Description

abstract base class for gui drivers

Member Function Documentation

◆ call_void()

bool cgv::base::base::call_void	(	const std::string &	method,
		const std::vector< std::string > &	param_value_types,
		const std::vector< const void * > &	param_value_ptrs,
		const std::string &	result_type = `""`,
		void *	result_value_ptr = `0`
	)

virtualinherited

abstract interface to call an action

overload to implement the execution of a method based on the method name and the given parameters

, i.e. a class method based on the action name and the given parameters. The default implementation uses the self_reflect() method to dispatch this call. If not found, the get_void method returns false.

◆ find_member_ptr()

void * cgv::base::base::find_member_ptr	(	const std::string &	property_name,
		std::string *	type_name = `0`
	)

inherited

find a member pointer by name.

If not found the null pointer is returned. If the type name string pointer is provided, the type of the property is copied to the referenced string.

◆ get()

template<typename T >

T cgv::base::base::get ( const std::string & property )

inlineinherited

query a property of the element and perform standard conversions if necessary.

This templated version simply extracts the type of the value from the reference and calls the set_void() method. Note that this only works if the template cgv::type::info::type_name<T> is overloaded for the value type.

◆ get_property_declarations()

std::string cgv::base::base::get_property_declarations ( )

virtualinherited

return a semicolon separated list of property declarations

return a semicolon separated list of property declarations of the form "name:type", by default an empty list is returned

of the form "name1:type1;name2:type2;...", by default an empty list is returned. The types should by consistent with the names returned by cgv::type::info::type_name::get_name. The default implementation extracts names and types from the self_reflect() method and the meta type information provided by the get_type() method.

Reimplemented in cgv::base::factory, cgv::base::base_generator, cgv::media::image::image_reader, cgv::media::video::video_writer, cgv::media::image::image_writer, cgv::media::video::video_reader, and cgv::base::console.

◆ get_type_name()

std::string cgv::base::base::get_type_name ( ) const

virtualinherited

overload to return the type name of this object. By default the type interface is queried over get_type.

overload to return the type name of this object

Reimplemented in cgv::render::render_config, cgv::base::test, cgv::base::factory_impl_2< T, CA1, CA2 >, cgv::base::factory_impl_1< T, CA >, cgv::base::factory_impl< T >, cgv::base::object_constructor, cgv::base::base_generator, cgv::media::image::image_reader, cgv::media::video::video_writer, cgv::media::image::image_writer, cgv::media::font::font, cgv::media::image::reader_listener, cgv::media::video::video_reader, cgv::gui::gui_group, cgv::base::group, cgv::media::video::video_writer_listener, cgv::render::shader_config, cgv::media::font::font_face, cgv::base::node, cgv::base::named, cgv::base::console, cgv::media::image::bmp_reader, cgv::media::video::video_reader_listener, cgv::media::image::bmp_writer, cgv::media::image::writer_listener, cgv::gui::window, and cgv::gui::button.

◆ get_user_data()

void * cgv::base::base::get_user_data ( ) const

virtualinherited

this virtual method allows to pass application specific data for internal purposes

this virtual method allows derived classes to pass application specific data

◆ get_void()

bool cgv::base::base::get_void	(	const std::string &	property,
		const std::string &	value_type,
		void *	value_ptr
	)

virtualinherited

abstract interface for the getter of a dynamic property.

abstract interface for the getter, by default it simply returns false

The default implementation uses the self_reflect() method to find a member with the given property as name. If not found, the get_void method returns false.

Reimplemented in cgv::base::factory, cgv::base::base_generator, cgv::base::console, cgv::media::image::image_reader, cgv::media::image::image_writer, cgv::media::video::video_reader, and cgv::media::video::video_writer.

◆ is_property()

bool cgv::base::base::is_property	(	const std::string &	property_name,
		std::string *	type_name = `0`
	)

inherited

check if the given name specifies a property.

If the type name string pointer is provided, the type of the property is copied to the referenced string.

◆ lock()

virtual void cgv::gui::gui_driver::lock ( )

pure virtual

lock the main thread of the gui from a child thread before any gui specific call.

If lock is called several times, the child thread must call unlock the same number of times

◆ multi_set()

void cgv::base::base::multi_set	(	const std::string &	property_assignments,
		bool	report_error = `true`
	)

inherited

set several properties

set several properties, which are defined as colon separated assignments, where the types are derived automatically

, which are defined as colon separated assignments, where the types are derived automatically to bool, int, double or std::string.

◆ on_register()

void cgv::base::base::on_register ( )

virtualinherited

overload to handle register events that is sent after the instance has been registered

overload to return a type info structure. By default an empty pointer is returned.

◆ query()

virtual bool cgv::gui::gui_driver::query	(	const std::string &	question,
		std::string &	text,
		bool	password = `false`
	)

pure virtual

query the user for a text, where the second parameter is the default text as well as the returned text.

If password is true, the text is hidden. The function returns false if the user canceled the input of if no gui driver is available.

◆ self_reflect()

bool cgv::base::base::self_reflect ( cgv::reflect::reflection_handler & )

virtualinherited

used for simple self reflection

is used by default implementation of set_void, get_void and get_property_declarations

The overloaded implementation is used by the default implementations of set_void, get_void and get_property_declarations with corresponding reflection handlers. The default implementation of self_reflect is empty.

Reimplemented in cgv::render::render_config, and cgv::render::shader_config.

◆ set()

template<typename T >

void cgv::base::base::set	(	const std::string &	property,
		const T &	value
	)

inlineinherited

set a property of the element to the given value and perform standard conversions if necessary.

This templated version simply extracts the type of the value from the reference and calls the set_void() method. Note that this only works if the template cgv::type::info::type_name<T> is overloaded for the value type.

◆ set_void()

bool cgv::base::base::set_void	(	const std::string &	property,
		const std::string &	value_type,
		const void *	value_ptr
	)

virtualinherited

abstract interface for the setter of a dynamic property.

abstract interface for the setter, by default it simply returns false

The default implementation uses the self_reflect() method to find a member with the given property as name. If not found, the set_void method returns false.

Reimplemented in cgv::base::factory, cgv::base::base_generator, cgv::base::console, cgv::media::image::image_reader, cgv::media::image::image_writer, cgv::media::video::video_reader, and cgv::media::video::video_writer.

◆ wake()

virtual void cgv::gui::gui_driver::wake ( const std::string & message = "" )

pure virtual

wake main thread.

Ensures that main thead is not going to sleep any longer with the given message, that can be queried by the main thread with get_wakeup_message().

The documentation for this class was generated from the following files:

D:/develop/projects/git/cgv/cgv/gui/gui_driver.h
D:/develop/projects/git/cgv/cgv/gui/gui_driver.cxx

Public Member Functions

Protected Member Functions

Static Protected Member Functions

property interface

Detailed Description

Member Function Documentation

◆ call_void()

◆ find_member_ptr()

◆ get()

◆ get_property_declarations()

◆ get_type_name()

◆ get_user_data()

◆ get_void()

◆ is_property()

◆ lock()

◆ multi_set()

◆ on_register()

◆ query()

◆ self_reflect()

◆ set()

◆ set_void()

◆ wake()