CEGUI::CommonFileDialogInput Class Reference

#include <CEGUICommonFileDialog.h>

List of all members.

Public Member Functions

 CommonFileDialogInput (const uint uHandle=0, const String szFileName="", const String szFilter=EXTENSION_PRESENTATION_DEFAULT, const String szDefaultExtension=EXTENSION_ALL, const String szTitle="", bool bOpenFileDialog=true, bool bDoPrompt=true, const String szPromptText="")
virtual ~CommonFileDialogInput (void)
uint getHandle (void)
String getFileName (void)
String getFilter (void)
String getDefaultExtension (void)
String getTitle (void)
bool getOpenFileDialog (void)
bool getDoPrompt (void)
String getPromptText (void)
void setHandle (const uint)
void setFileName (const String)
void setFilter (const String)
void setDefaultExtension (const String)
void setTitle (const String)
void setOpenFileDialog (const bool)
void setDoPrompt (const bool)
void setPromptText (const String)

Private Attributes

uint _uHandle
String _szFilter
String _szDefaultExtension
String _szFileName
String _szTitle
bool _bOpenFileDialog
bool _bDoPrompt
String _szPromptText


Constructor & Destructor Documentation

CEGUI::CommonFileDialogInput::CommonFileDialogInput const uint  uHandle = 0,
const String  szFileName = "",
const String  szFilter = EXTENSION_PRESENTATION_DEFAULT,
const String  szDefaultExtension = EXTENSION_ALL,
const String  szTitle = "",
bool  bOpenFileDialog = true,
bool  bDoPrompt = true,
const String  szPromptText = ""
[inline]
 

virtual CEGUI::CommonFileDialogInput::~CommonFileDialogInput void   )  [inline, virtual]
 


Member Function Documentation

String CEGUI::CommonFileDialogInput::getDefaultExtension void   ) 
 

bool CEGUI::CommonFileDialogInput::getDoPrompt void   ) 
 

String CEGUI::CommonFileDialogInput::getFileName void   ) 
 

String CEGUI::CommonFileDialogInput::getFilter void   ) 
 

uint CEGUI::CommonFileDialogInput::getHandle void   ) 
 

bool CEGUI::CommonFileDialogInput::getOpenFileDialog void   ) 
 

String CEGUI::CommonFileDialogInput::getPromptText void   ) 
 

String CEGUI::CommonFileDialogInput::getTitle void   ) 
 

void CEGUI::CommonFileDialogInput::setDefaultExtension const   String  ) 
 

void CEGUI::CommonFileDialogInput::setDoPrompt const   bool  ) 
 

void CEGUI::CommonFileDialogInput::setFileName const   String  ) 
 

void CEGUI::CommonFileDialogInput::setFilter const   String  ) 
 

void CEGUI::CommonFileDialogInput::setHandle const   uint  ) 
 

void CEGUI::CommonFileDialogInput::setOpenFileDialog const   bool  ) 
 

void CEGUI::CommonFileDialogInput::setPromptText const   String  ) 
 

void CEGUI::CommonFileDialogInput::setTitle const   String  ) 
 


Member Data Documentation

bool CEGUI::CommonFileDialogInput::_bDoPrompt [private]
 

TRUE for FileLoad, FALSE for FileSaveAs Default: TRUE

bool CEGUI::CommonFileDialogInput::_bOpenFileDialog [private]
 

Title of the window. Default title is "Load" in case _bOpenFileDialog is TRUE Default title is "Save as" in case _bOpenFileDialog is FALSE

String CEGUI::CommonFileDialogInput::_szDefaultExtension [private]
 

Filter for allowed extensions Default: "All files|*.*|" The filter is build according to the windows common file dialog filter string. An example: The filter

"HTML Files (*.htm)|*.htm|Active Server Pages (*.asp)|*.asp|Perl Script (*.pl)|*.pl|All files|*.*|" (don't forget the last | or otherwise the last element will not be parsed)

produces a list that looks like this in the combobox:

HTML Files (*.htm) Active Server Pages (*.asp) Perl Script (*.pl) All files

String CEGUI::CommonFileDialogInput::_szFileName [private]
 

Default Extension Default: *.*

String CEGUI::CommonFileDialogInput::_szFilter [private]
 

Handle, that is supplied by the calling function. This handle serves as an identifier that determines the 'caller'. It will be added to the output object 'CommonFileDialogOutput' after the Ok button in the CommonFileDialog has been pressen, so the triggered function (registered by means of ´subscribe´) is able to identify who has originally called the dialog. Default: 0 (no handle)

String CEGUI::CommonFileDialogInput::_szPromptText [private]
 

TRUE for prompting (are you sure?), FALSE for non-prompting Default: TRUE Define text in the prompt window Default for Load: "Cannot find the requested file." Default for Save: "The file already exist. Replace it?"

String CEGUI::CommonFileDialogInput::_szTitle [private]
 

Filename Default: "" (no filename)

uint CEGUI::CommonFileDialogInput::_uHandle [private]
 


The documentation for this class was generated from the following files:
Generated on Mon May 29 01:10:34 2006 for Papagan by  doxygen 1.4.6-NO