vgui_mfc_dialog_impl Class Reference

#include <vgui_mfc_dialog_impl.h>

Inheritance diagram for vgui_mfc_dialog_impl:

Detailed Description

The MFC implementation of vgui_dialog_impl.

Creates a dialog box in MFC. Based on vgui_gtk_dialog_impl.

Definition at line 44 of file vgui_mfc_dialog_impl.h.


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_mfc_dialog_impl (const char *name)
	Constructor.
	~vgui_mfc_dialog_impl ()
	Destructor.
void *	choice_field_widget (const char *, const vcl_vector< vcl_string > &, int &)
	Make a choice widget.
void *	inline_tableau_widget (const vgui_tableau_sptr tab, unsigned width, unsigned height)
	Make a tableau widget.
void	modal (bool)
	Sets the modality of the dialog box.
bool	ask ()
	Display the 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 *	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	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.
Protected Member Functions
virtual void	OnOk ()
	Called by MFC when the user clicks the OK button.
virtual void	OnCancel ()
	Called by MFC when the user clicks the cancel button.
virtual void	OnBrowse (UINT uID)
	Called by MFC when the user clicks the (file) browse button.
virtual void	OnChooseColour (UINT uID)
	Called by MFC when the user clicks the colour chooser button.
afx_msg void	OnClose ()
	Called by MFC when the application is about to terminate.
Protected Attributes
LOGFONT	m_logfont
int	nResult
int	count_fbsr
	File browser counter.
int	count_csr
	Colour chooser counter.
bool	ok_clicked
CWnd *	fbsrs [100]
	Array of MFC file browser objects.
CWnd *	csrs [100]
	Array of MFC colour chooser objects.
CWnd *	dialog_box
	MFC dialog box object.
vcl_vector< CWnd * >	wlist
vcl_vector< CWnd * >	awlist
	List of created MFC objects (so we can delete them).
CFont *	font
	Type font.
vcl_string	name
vcl_vector< element >	elements
vcl_string	cancel_button_text_
vcl_string	ok_button_text_

Member Enumeration Documentation

enum vgui_dialog_impl::element_type [inherited]

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_mfc_dialog_impl::vgui_mfc_dialog_impl ( const char * name )

Constructor.

Definition at line 38 of file vgui_mfc_dialog_impl.cxx.

vgui_mfc_dialog_impl::~vgui_mfc_dialog_impl ( )

Destructor.

Definition at line 50 of file vgui_mfc_dialog_impl.cxx.

Member Function Documentation

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

Make a choice widget.

Reimplemented from vgui_dialog_impl.

Definition at line 64 of file vgui_mfc_dialog_impl.cxx.

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

Make a tableau widget.

Reimplemented from vgui_dialog_impl.

Definition at line 84 of file vgui_mfc_dialog_impl.cxx.

void vgui_mfc_dialog_impl::modal ( bool ) [inline, virtual]

Sets the modality of the dialog box.

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

Reimplemented from vgui_dialog_impl.

Definition at line 57 of file vgui_mfc_dialog_impl.h.

bool vgui_mfc_dialog_impl::ask ( ) [virtual]

Display the dialog box.

Implements vgui_dialog_impl.

Definition at line 172 of file vgui_mfc_dialog_impl.cxx.

void vgui_mfc_dialog_impl::OnOk ( ) [protected, virtual]

Called by MFC when the user clicks the OK button.

Definition at line 108 of file vgui_mfc_dialog_impl.cxx.

void vgui_mfc_dialog_impl::OnCancel ( ) [protected, virtual]

Called by MFC when the user clicks the cancel button.

Definition at line 120 of file vgui_mfc_dialog_impl.cxx.

void vgui_mfc_dialog_impl::OnBrowse ( UINT uID ) [protected, virtual]

Called by MFC when the user clicks the (file) browse button.

Fires up File browser dialog box

Definition at line 132 of file vgui_mfc_dialog_impl.cxx.

void vgui_mfc_dialog_impl::OnChooseColour ( UINT uID ) [protected, virtual]

Called by MFC when the user clicks the colour chooser button.

Fires up Colour chooser dialog box

Definition at line 145 of file vgui_mfc_dialog_impl.cxx.

void vgui_mfc_dialog_impl::OnClose ( ) [protected]

Called by MFC when the application is about to terminate.

Definition at line 166 of file vgui_mfc_dialog_impl.cxx.

void vgui_dialog_impl::bool_field	(	const char *	,
		bool &
	)			`[inherited]`

Add a boolean field to the dialog box.

Definition at line 40 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::int_field	(	const char *	,
		int &
	)			`[inherited]`

Add an integer field to the dialog box.

Definition at line 54 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::long_field	(	const char *	,
		long &
	)			`[inherited]`

Add a long integer field to the dialog box.

Definition at line 68 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::float_field	(	const char *	,
		float &
	)			`[inherited]`

Add a float field to the dialog box.

Definition at line 82 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::double_field	(	const char *	,
		double &
	)			`[inherited]`

Add a double field to the dialog box.

Definition at line 96 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::string_field	(	const char *	,
		vcl_string &
	)			`[inherited]`

Add a vcl_string field to the dialog box.

Definition at line 110 of file vgui_dialog_impl.cxx.

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

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

Definition at line 124 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::text_message ( const char * ) [inherited]

Add a text message to the dialog box.

Definition at line 203 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::file_browser	(	const char *	,
		vcl_string &	,
		vcl_string &
	)			`[inherited]`

Add a popup file browser to the dialog box.

Definition at line 137 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::inline_file_browser	(	const char *	,
		vcl_string &	,
		vcl_string &
	)			`[inherited]`

Add an inline file browser to the dialog box.

Definition at line 149 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::color_chooser	(	const char *	,
		vcl_string &
	)			`[inherited]`

Add a popup colour chooser to the dialog box.

Definition at line 162 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::inline_color_chooser	(	const char *	,
		vcl_string &
	)			`[inherited]`

Add an inline colour chooser to the dialog box.

Definition at line 174 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::inline_tab	(	const vgui_tableau_sptr	tab,
		unsigned	width,
		unsigned	height
	)			`[inherited]`

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

Definition at line 186 of file vgui_dialog_impl.cxx.

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

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::int_field_widget	(	const char *	,
		int &
	)			`[virtual, inherited]`

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_widget	(	const char *	,
		long &
	)			`[virtual, inherited]`

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::float_field_widget	(	const char *	,
		float &
	)			`[virtual, inherited]`

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::double_field_widget	(	const char *	,
		double &
	)			`[virtual, inherited]`

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::string_field_widget	(	const char *	,
		vcl_string &
	)			`[virtual, inherited]`

Pointer to a GUI widget for a string field.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 221 of file vgui_dialog_impl.cxx.

void * vgui_dialog_impl::text_message_widget ( const char * ) [virtual, inherited]

Pointer to a GUI widget for a text message.

Reimplemented in vgui_qt_dialog_impl, and vgui_qt_dialog_impl.

Definition at line 223 of file vgui_dialog_impl.cxx.

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

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::inline_file_browser_widget	(	const char *	,
		vcl_string &	,
		vcl_string &
	)			`[virtual, inherited]`

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::color_chooser_widget	(	const char *	,
		vcl_string &
	)			`[virtual, inherited]`

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::inline_color_chooser_widget	(	const char *	,
		vcl_string &
	)			`[virtual, inherited]`

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.

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

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, inherited]

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.

Member Data Documentation

LOGFONT vgui_mfc_dialog_impl::m_logfont [protected]

Definition at line 61 of file vgui_mfc_dialog_impl.h.

int vgui_mfc_dialog_impl::nResult [protected]

Definition at line 73 of file vgui_mfc_dialog_impl.h.

int vgui_mfc_dialog_impl::count_fbsr [protected]

File browser counter.

Definition at line 75 of file vgui_mfc_dialog_impl.h.

int vgui_mfc_dialog_impl::count_csr [protected]

Colour chooser counter.

Definition at line 77 of file vgui_mfc_dialog_impl.h.

bool vgui_mfc_dialog_impl::ok_clicked [protected]

Definition at line 78 of file vgui_mfc_dialog_impl.h.

CWnd* vgui_mfc_dialog_impl::fbsrs[100] [protected]

Array of MFC file browser objects.

Definition at line 80 of file vgui_mfc_dialog_impl.h.

CWnd* vgui_mfc_dialog_impl::csrs[100] [protected]

Array of MFC colour chooser objects.

Definition at line 82 of file vgui_mfc_dialog_impl.h.

CWnd* vgui_mfc_dialog_impl::dialog_box [protected]

MFC dialog box object.

Definition at line 84 of file vgui_mfc_dialog_impl.h.

vcl_vector<CWnd *> vgui_mfc_dialog_impl::wlist [protected]

Definition at line 85 of file vgui_mfc_dialog_impl.h.

vcl_vector<CWnd *> vgui_mfc_dialog_impl::awlist [protected]

List of created MFC objects (so we can delete them).

Definition at line 87 of file vgui_mfc_dialog_impl.h.

CFont* vgui_mfc_dialog_impl::font [protected]

Type font.

Definition at line 90 of file vgui_mfc_dialog_impl.h.

vcl_string vgui_dialog_impl::name [protected, inherited]

Definition at line 169 of file vgui_dialog_impl.h.

vcl_vector<element> vgui_dialog_impl::elements [protected, inherited]

Definition at line 170 of file vgui_dialog_impl.h.

vcl_string vgui_dialog_impl::cancel_button_text_ [protected, inherited]

Definition at line 171 of file vgui_dialog_impl.h.

vcl_string vgui_dialog_impl::ok_button_text_ [protected, inherited]

Definition at line 172 of file vgui_dialog_impl.h.

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

core/vgui/impl/mfc/vgui_mfc_dialog_impl.h
core/vgui/impl/mfc/vgui_mfc_dialog_impl.cxx

Generated on Sun Nov 22 05:12:07 2009 for core/vgui by

1.5.1

vgui_mfc_dialog_impl Class Reference

Detailed Description

Public Types

Public Member Functions

Protected Member Functions

Protected Attributes

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation