vgui_dialog_impl is the abstract base class for dialog implementation. More...

#include <vgui_dialog_impl.h>

Inheritance diagram for vgui_dialog_impl:

Classes
struct	element
	Data associated with each field in the dialog box. More...
Public Types
enum	element_type { bool_elem, int_elem, long_elem, float_elem, double_elem, string_elem, choice_elem, text_msg, file_bsr, color_csr, inline_file_bsr, inline_color_csr, inline_tabl, dir_bsr, line_br, unknown }
	Enum of possible element types. More...
Public Member Functions
	vgui_dialog_impl (const char *dialog_name)
	Constructor - create an empty dialog with the given title.
virtual	~vgui_dialog_impl ()
	Destructor - delete this dialog box.
void	bool_field (const char *, bool &)
	Add a boolean field to the dialog box.
void	int_field (const char *, int &)
	Add an integer field to the dialog box.
void	long_field (const char *, long &)
	Add a long integer field to the dialog box.
void	float_field (const char *, float &)
	Add a float field to the dialog box.
void	double_field (const char *, double &)
	Add a double field to the dialog box.
void	string_field (const char *, vcl_string &)
	Add a vcl_string field to the dialog box.
void	choice_field (const char *, const vcl_vector< vcl_string > &, int &)
	Add a choice (selection box) to the dialog box.
void	text_message (const char *)
	Add a text message to the dialog box.
void	file_browser (const char *, vcl_string &, vcl_string &)
	Add a popup file browser to the dialog box.
void	inline_file_browser (const char *, vcl_string &, vcl_string &)
	Add an inline file browser to the dialog box.
void	color_chooser (const char *, vcl_string &)
	Add a popup colour chooser to the dialog box.
void	inline_color_chooser (const char *, vcl_string &)
	Add an inline colour chooser to the dialog box.
void	inline_tab (const vgui_tableau_sptr tab, unsigned width, unsigned height)
	Add a tableau (OpenGL area) to the dialog box.
virtual void *	bool_field_widget (const char *, bool &)
	Pointer to a GUI widget for a bool field.
virtual void *	int_field_widget (const char *, int &)
	Pointer to a GUI widget for a integer field.
virtual void *	long_field_widget (const char *, long &)
	Pointer to a GUI widget for a long integer field.
virtual void *	float_field_widget (const char *, float &)
	Pointer to a GUI widget for a float field.
virtual void *	double_field_widget (const char *, double &)
	Pointer to a GUI widget for a double field.
virtual void *	string_field_widget (const char *, vcl_string &)
	Pointer to a GUI widget for a string field.
virtual void *	choice_field_widget (const char *, const vcl_vector< vcl_string > &, int &)
	Pointer to a GUI widget for a choice field.
virtual void *	text_message_widget (const char *)
	Pointer to a GUI widget for a text message.
virtual void *	file_browser_widget (const char *, vcl_string &, vcl_string &)
	Pointer to a GUI widget for a file browser.
virtual void *	inline_file_browser_widget (const char *, vcl_string &, vcl_string &)
	Pointer to a GUI widget for an inline file browser.
virtual void *	color_chooser_widget (const char *, vcl_string &)
	Pointer to a GUI widget for a colour chooser.
virtual void *	inline_color_chooser_widget (const char *, vcl_string &)
	Pointer to a GUI widget for an inline colour chooser.
virtual void *	inline_tableau_widget (const vgui_tableau_sptr tab, unsigned width, unsigned height)
	Pointer to a GUI widget for a tableau (OpenGL area).
virtual void	modal (bool)
	Set the modality of the dialog box.
virtual void	set_cancel_button (const char *msg)
	Set the text on the cancel button.
virtual void	set_ok_button (const char *msg)
	Set the text on the OK button.
virtual bool	ask ()=0
	Display the dialog box and collect data from the user.
Protected Attributes
vcl_string	name
vcl_vector< element >	elements
vcl_string	cancel_button_text_
vcl_string	ok_button_text_

Detailed Description

vgui_dialog_impl is the abstract base class for dialog implementation.

It contains methods for adding fields corresponding to those in vgui_dialog. It also contains a vcl_vector of elements which are tuples of vgui_dialog_field and a variable indicating what type of field they are. The elements also contain void* for implementors to add any gui specific information/class to the element.

Definition at line 38 of file vgui_dialog_impl.h.

Member Enumeration Documentation

enum vgui_dialog_impl::element_type

Enum of possible element types.

Enumerator:

bool_elem
int_elem
long_elem
float_elem
double_elem
string_elem
choice_elem
text_msg
file_bsr
color_csr
inline_file_bsr
inline_color_csr
inline_tabl
dir_bsr
line_br
unknown

Definition at line 141 of file vgui_dialog_impl.h.

Constructor & Destructor Documentation

vgui_dialog_impl::vgui_dialog_impl ( const char * dialog_name )

Constructor - create an empty dialog with the given title.

Definition at line 20 of file vgui_dialog_impl.cxx.

vgui_dialog_impl::~vgui_dialog_impl ( ) [virtual]

Destructor - delete this dialog box.

Definition at line 29 of file vgui_dialog_impl.cxx.

Member Function Documentation

virtual bool vgui_dialog_impl::ask ( ) [pure virtual]

Display the dialog box and collect data from the user.

Implemented in vgui_mfc_dialog_impl, vgui_qt_dialog_impl, vgui_mfc_dialog_extensions_impl, vgui_gtk_dialog_impl, vgui_gtk2_dialog_impl, vgui_qt_dialog_impl, vgui_dialog_extensions_impl, and vgui_wx_dialog_impl.

void vgui_dialog_impl::bool_field	(	const char *	txt,
		bool &	val
	)

Add a boolean field to the dialog box.

Definition at line 40 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::bool_field_widget	(	const char *	,
		bool &
	)		`[virtual]`

Pointer to a GUI widget for a bool field.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 216 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::choice_field	(	const char *	txt,
		const vcl_vector< vcl_string > &	labels,
		int &	val
	)

Add a choice (selection box) to the dialog box.

Add a choice field to the dialog box.

Definition at line 124 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::choice_field_widget	(	const char *	,
		const vcl_vector< vcl_string > &	,
		int &
	)		`[virtual]`

Pointer to a GUI widget for a choice field.

Create a choice widget.

Reimplemented in vgui_mfc_dialog_impl, vgui_wx_dialog_impl, vgui_qt_dialog_impl, vgui_mfc_dialog_extensions_impl, vgui_gtk_dialog_impl, vgui_gtk2_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 248 of file vgui_wx_dialog_impl.cxx.

void vgui_dialog_impl::color_chooser	(	const char *	txt,
		vcl_string &	val
	)

Add a popup colour chooser to the dialog box.

Definition at line 162 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::color_chooser_widget	(	const char *	txt,
		vcl_string &	val
	)		`[virtual]`

Pointer to a GUI widget for a colour chooser.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 226 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::double_field	(	const char *	txt,
		double &	val
	)

Add a double field to the dialog box.

Definition at line 96 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::double_field_widget	(	const char *	,
		double &
	)		`[virtual]`

Pointer to a GUI widget for a double field.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 220 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::file_browser	(	const char *	txt,
		vcl_string &	regexp,
		vcl_string &	val
	)

Add a popup file browser to the dialog box.

Definition at line 137 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::file_browser_widget	(	const char *	,
		vcl_string &	,
		vcl_string &
	)		`[virtual]`

Pointer to a GUI widget for a file browser.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 224 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::float_field	(	const char *	txt,
		float &	val
	)

Add a float field to the dialog box.

Definition at line 82 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::float_field_widget	(	const char *	,
		float &
	)		`[virtual]`

Pointer to a GUI widget for a float field.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 219 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::inline_color_chooser	(	const char *	txt,
		vcl_string &	val
	)

Add an inline colour chooser to the dialog box.

Definition at line 174 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::inline_color_chooser_widget	(	const char *	txt,
		vcl_string &	val
	)		`[virtual]`

Pointer to a GUI widget for an inline colour chooser.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 227 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::inline_file_browser	(	const char *	txt,
		vcl_string &	regexp,
		vcl_string &	val
	)

Add an inline file browser to the dialog box.

Definition at line 149 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::inline_file_browser_widget	(	const char *	,
		vcl_string &	,
		vcl_string &
	)		`[virtual]`

Pointer to a GUI widget for an inline file browser.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 225 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::inline_tab	(	const vgui_tableau_sptr	tab,
		unsigned	width,
		unsigned	height
	)

Add a tableau (OpenGL area) to the dialog box.

Definition at line 186 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::inline_tableau_widget	(	const vgui_tableau_sptr	tab,
		unsigned	width,
		unsigned	height
	)		`[virtual]`

Pointer to a GUI widget for a tableau (OpenGL area).

Create the inline_tableau_widget (OpenGL area).

Reimplemented in vgui_mfc_dialog_impl, vgui_mfc_dialog_extensions_impl, vgui_gtk_dialog_impl, and vgui_gtk2_dialog_impl.

Definition at line 267 of file vgui_wx_dialog_impl.cxx.

void vgui_dialog_impl::int_field	(	const char *	txt,
		int &	val
	)

Add an integer field to the dialog box.

Definition at line 54 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::int_field_widget	(	const char *	,
		int &
	)		`[virtual]`

Pointer to a GUI widget for a integer field.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 217 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::long_field	(	const char *	txt,
		long &	val
	)

Add a long integer field to the dialog box.

Add a long field to the dialog box.

Definition at line 68 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::long_field_widget	(	const char *	,
		long &
	)		`[virtual]`

Pointer to a GUI widget for a long integer field.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 218 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::modal ( bool ) [virtual]

Set the modality of the dialog box.

Changes the modality of the dialog. True makes the dialog modal.

True makes the dialog modal (i.e. the dialog 'grabs' all events) and this is the default. WARNING: It is dangerous to make a dialog that changes data non-modal, only messages should be non-modal.

(i.e. the dialog 'grabs' all events), this is the default. False makes the dialog non-modal.

Reimplemented in vgui_mfc_dialog_impl, vgui_wx_dialog_impl, vgui_qt_dialog_impl, vgui_mfc_dialog_extensions_impl, vgui_qt_dialog_impl, vgui_gtk_dialog_impl, and vgui_gtk2_dialog_impl.

Definition at line 234 of file vgui_dialog_impl.cxx.

virtual void vgui_dialog_impl::set_cancel_button ( const char * msg ) [inline, virtual]

Set the text on the cancel button.

Reimplemented in vgui_gtk_dialog_impl, and vgui_gtk2_dialog_impl.

Definition at line 132 of file vgui_dialog_impl.h.

virtual void vgui_dialog_impl::set_ok_button ( const char * msg ) [inline, virtual]

Set the text on the OK button.

Reimplemented in vgui_gtk_dialog_impl, and vgui_gtk2_dialog_impl.

Definition at line 135 of file vgui_dialog_impl.h.