vgui_dialog_extensions_impl Class Reference

#include <vgui_dialog_extensions_impl.h>

Inheritance diagram for vgui_dialog_extensions_impl:

vgui_dialog_impl vgui_mfc_dialog_extensions_impl List of all members.

Detailed Description

vgui_dialog_extensions_impl is the abstract base class for dialog extensions implementation.

It contains methods for adding fields corresponding to those in vgui_dialog_extensions. It has directory selection browser and line break in addition to the vgui_dialog_impl capabilities (parent class)

Definition at line 25 of file vgui_dialog_extensions_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_dialog_extensions_impl (const char *dialog_name)
 Constructor - create an empty dialog with the given title.
virtual ~vgui_dialog_extensions_impl ()
 Destructor - delete this dialog box.
void dir_browser (const char *, vcl_string &, vcl_string &)
 Add a popup directory browser to the dialog box.
void line_break ()
 Add a line break to the dialog box.
virtual void * dir_browser_widget (const char *, vcl_string &, vcl_string &)
 Pointer to a GUI widget for a directory browser.
virtual bool ask ()=0
 Display the dialog box with user added line breaks and a layout and collect data from the user.
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.

Protected Attributes

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_dialog_extensions_impl::vgui_dialog_extensions_impl ( const char *  dialog_name  ) 

Constructor - create an empty dialog with the given title.

Definition at line 14 of file vgui_dialog_extensions_impl.cxx.

vgui_dialog_extensions_impl::~vgui_dialog_extensions_impl (  )  [virtual]

Destructor - delete this dialog box.

Definition at line 19 of file vgui_dialog_extensions_impl.cxx.


Member Function Documentation

void vgui_dialog_extensions_impl::dir_browser ( const char *  ,
vcl_string &  ,
vcl_string &   
)

Add a popup directory browser to the dialog box.

Definition at line 23 of file vgui_dialog_extensions_impl.cxx.

void vgui_dialog_extensions_impl::line_break (  ) 

Add a line break to the dialog box.

Definition at line 35 of file vgui_dialog_extensions_impl.cxx.

void * vgui_dialog_extensions_impl::dir_browser_widget ( const char *  ,
vcl_string &  ,
vcl_string &   
) [virtual]

Pointer to a GUI widget for a directory browser.

Definition at line 43 of file vgui_dialog_extensions_impl.cxx.

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

Display the dialog box with user added line breaks and a layout and collect data from the user.

Dialog elements are added next to each other until a line break element is found.

Implements vgui_dialog_impl.

Implemented in vgui_mfc_dialog_extensions_impl.

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

Pointer to a GUI widget for a choice field.

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

Definition at line 222 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.

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

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

Reimplemented in vgui_gtk_dialog_impl, vgui_gtk2_dialog_impl, vgui_mfc_dialog_extensions_impl, and vgui_mfc_dialog_impl.

Definition at line 228 of file vgui_dialog_impl.cxx.

void vgui_dialog_impl::modal ( bool   )  [virtual, inherited]

Set the modality of the dialog box.

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.

Reimplemented in vgui_gtk_dialog_impl, vgui_gtk2_dialog_impl, vgui_mfc_dialog_extensions_impl, vgui_mfc_dialog_impl, vgui_qt_dialog_impl, vgui_qt_dialog_impl, and vgui_wx_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, 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

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:
Generated on Sun Nov 22 05:12:05 2009 for core/vgui by  doxygen 1.5.1