Sourceforge.net - The VCF's Project Host
   The VCF Website Home   |   Online Discussion Forums   |   Sourceforge.net Project Page   

VCF::CommonFileBrowseDialog Class Reference

This class displays a common dialog used to select a directory. More...

#include <vcf/ApplicationKit/CommonFileBrowseDialog.h>

Inheritance diagram for VCF::CommonFileBrowseDialog:

VCF::CommonDialog VCF::Component VCF::ObjectWithCallbacks VCF::Object List of all members.

Public Member Functions

 CommonFileBrowseDialog ()
 CommonFileBrowseDialog (Control *owner)
 Creates a browse dialog.
virtual ~CommonFileBrowseDialog ()
virtual bool execute ()
 Call this function to display the dialog.
void setDirectory (const String &directory)
 Sets the initial directory for the dialog to be set to.
String getDirectory ()
 Returns the directory the user chose.
void setTitle (const String &title)
 Sets the title of the dialog.

Detailed Description

This class displays a common dialog used to select a directory.


Constructor & Destructor Documentation

VCF::CommonFileBrowseDialog::CommonFileBrowseDialog  ) 
 

VCF::CommonFileBrowseDialog::CommonFileBrowseDialog Control owner  ) 
 

Creates a browse dialog.

If the owner is NULL then the dialog is non modal. If the owner is not NULL then the dialog is modal relative to the control that started it. For most cases you do not want to pass in a NULL owner.

virtual VCF::CommonFileBrowseDialog::~CommonFileBrowseDialog  )  [virtual]
 


Member Function Documentation

virtual bool VCF::CommonFileBrowseDialog::execute  )  [virtual]
 

Call this function to display the dialog.

If the user selects a directory then it will return true.

Implements VCF::CommonDialog.

String VCF::CommonFileBrowseDialog::getDirectory  ) 
 

Returns the directory the user chose.

Only considered valid to call if execute returned true.

void VCF::CommonFileBrowseDialog::setDirectory const String directory  ) 
 

Sets the initial directory for the dialog to be set to.

On Win32 this will cause the dialog tree to be navigated till it finds this directory.

void VCF::CommonFileBrowseDialog::setTitle const String title  ) 
 

Sets the title of the dialog.


The documentation for this class was generated from the following file:
   Comments or Suggestions?    License Information