Public Types | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Attributes | Static Protected Attributes | Private Member Functions

uiFileDialog Class Reference

Dialog to get a file or directory name from user. More...

List of all members.

Public Types

enum  Mode {
  AnyFile, ExistingFile, Directory, DirectoryOnly,
  ExistingFiles
}
 

File selection mode.

More...
enum  Type { Gen, Img, Txt, Html }

Public Member Functions

 uiFileDialog (uiParent *, bool forread, const char *fname=0, const char *filter=0, const char *caption=0)
 uiFileDialog (uiParent *, Mode mode=AnyFile, const char *fname=0, const char *filter=0, const char *caption=0)
 uiFileDialog (uiParent *, Type, const char *fname=0, const char *caption=0)
 Always AnyFile.
const char * fileName () const
void getFileNames (BufferStringSet &) const
void setMode (Mode m)
Mode mode () const
void setSelectedFilter (const char *fltr)
const char * selectedFilter () const
void setDirectory (const char *dir)
void setAllowAllExts (bool yn)
void setConfirmOverwrite (bool yn)
int go ()
int processExternalFilenames (const char *dir=0, const char *filters=0)

Static Public Member Functions

static void list2String (const BufferStringSet &, BufferString &)
static void string2List (const BufferString &, BufferStringSet &)
static void setExternalFilenames (const FileMultiString &)
static const char * getExternalFilenamesErrMsg ()

Static Public Attributes

static const char * filesep_

Protected Attributes

BufferString fn
Mode mode_
BufferString fname_
BufferString filter_
BufferString caption_
uiParentparnt_
BufferStringSet filenames
BufferString selectedfilter_
BufferString currentdir_
bool addallexts_
bool forread_
bool confirmoverwrite_

Static Protected Attributes

static FileMultiStringexternalfilenames_
static BufferString extfilenameserrmsg_

Private Member Functions

int beginCmdRecEvent (const char *wintitle)
void endCmdRecEvent (int refnr, bool ok)

Detailed Description

Dialog to get a file or directory name from user.


Member Enumeration Documentation

File selection mode.

Enumerator:
AnyFile 

The name of a file, whether it exists or not.

ExistingFile 

The name of a single existing file.

Directory 

The name of a directory. Both files and directories displayed.

DirectoryOnly 

The name of a directory. The file dialog will only display directories.

ExistingFiles 

The names of zero or more existing files.

Enumerator:
Gen 
Img 
Txt 
Html 

Constructor & Destructor Documentation

uiFileDialog::uiFileDialog ( uiParent ,
bool  forread,
const char *  fname = 0,
const char *  filter = 0,
const char *  caption = 0 
)
uiFileDialog::uiFileDialog ( uiParent ,
Mode  mode = AnyFile,
const char *  fname = 0,
const char *  filter = 0,
const char *  caption = 0 
)
uiFileDialog::uiFileDialog ( uiParent ,
Type  ,
const char *  fname = 0,
const char *  caption = 0 
)

Always AnyFile.


Member Function Documentation

int uiFileDialog::beginCmdRecEvent ( const char *  wintitle  )  [private]
void uiFileDialog::endCmdRecEvent ( int  refnr,
bool  ok 
) [private]
const char* uiFileDialog::fileName (  )  const [inline]
static const char* uiFileDialog::getExternalFilenamesErrMsg (  )  [static]
void uiFileDialog::getFileNames ( BufferStringSet  )  const
int uiFileDialog::go (  ) 
static void uiFileDialog::list2String ( const BufferStringSet ,
BufferString  
) [static]
Mode uiFileDialog::mode (  )  const [inline]
int uiFileDialog::processExternalFilenames ( const char *  dir = 0,
const char *  filters = 0 
)
const char* uiFileDialog::selectedFilter (  )  const [inline]
void uiFileDialog::setAllowAllExts ( bool  yn  )  [inline]
void uiFileDialog::setConfirmOverwrite ( bool  yn  )  [inline]
void uiFileDialog::setDirectory ( const char *  dir  )  [inline]
static void uiFileDialog::setExternalFilenames ( const FileMultiString  )  [static]
void uiFileDialog::setMode ( Mode  m  )  [inline]
void uiFileDialog::setSelectedFilter ( const char *  fltr  )  [inline]
static void uiFileDialog::string2List ( const BufferString ,
BufferStringSet  
) [static]

Member Data Documentation

bool uiFileDialog::addallexts_ [protected]
const char* uiFileDialog::filesep_ [static]
bool uiFileDialog::forread_ [protected]