PM Library classes

class PMFileDialog

? ^ 
    extends PMNonCopyable as public

File dialog class.

The file dialog class creates a file dialog object for the user to choose a file. Once the user has chosen a file, you can use member functions of this class to retrieve information about the chosen file.

You can construct and destruct objects of this class.

Source:
pm_filedialog.h:31
Author:
Dmitry A.Steklenev
Version:
$Revision: 1.12 $

Contents

^ 
EntityInherited FromTypeScopeShort Description
PMFileDialogconstructor public Constructs the file dialog object.
~PMFileDialogdestructor public Destructs the file dialog object.
show_modallymethod public Displays the file dialog.
add_filetypemethod public Adds the specified type to the drop-down list box.
filetypemethod public Returns a selected file type to assign to the file name returned.
handlemethod publicReturns the presentation window handle.
iteratorclass public Iterator class used to iterate through chosen files.
selectedmethod public Returns a pointer to the iterator object.

constructor PMFileDialog

? ^  > 
Constructs the file dialog object.

This constructor create file dialog object. You must use show_modally to activate it.

Source:
pm_filedialog.h:67
Params:
caption The dialog window title
howner Specifies the owner-window handle.
filename The file name to use as the default. If you want to specify global (or wildcard) characters or path information for the dialog defaults, include this information in this parameter's string. If you do not specify the path with the file name, the current directory is used.
style Specifies the dialog style:

FDS_CENTER
The dialog is positioned in the center of its owner window.
FDS_ENABLEFILELB
When this flag is set, the Files list box on a Save As dialog is enabled.
FDS_MULTIPLESEL
When this flag is set, the Files list box for the dialog is a multiple selection list box. When this flag is not set, the default is a single-selection list box.
FDS_OPEN_DIALOG
The dialog is an "Open" dialog when this flag is set.
FDS_SAVEAS_DIALOG
The dialog is a "Save As" dialog when this flag is set.
FDS_TRANSLATE
Translates the dialog texts using for this purpose the current instance of the messages management object.
Code:
public PMFileDialog ( const char * caption ,
HWND howner ,
const char * filename ,
ULONG style )

destructor ~PMFileDialog

? ^  < > 
Destructs the file dialog object.

Cleans up as this dialog object and destroying the associated presentation window for this object.

Source:
pm_filedialog.h:76
Code:
public virtual ~ PMFileDialog ( )

method show_modally

? ^  < > 
Displays the file dialog.

While the dialog window is being shown modally, its parent or owner or both windows are disabled. Other top level windows belonging to the application are not disabled.

Source:
pm_filedialog.h:91
Returns:
Result code from dialog dismissal. This field contains the ID of the push button pressed to dismiss the dialog, DID_OK or DID_CANCEL. If an error occurs on dialog invocation, this value is set to zero.
Code:
public virtual ULONG show_modally ( )

method add_filetype

? ^  < > 
Adds the specified type to the drop-down list box.

Source:
pm_filedialog.h:102
Params:
filetype The file type description.
filter The file filter for the type description. If multiple wildcards are specified, then they must be separated by a semicolon.
initial The file filter is applied to the initial dialog screen.
Code:
public virtual void add_filetype ( const char * filetype ,
const char * filter ,
BOOL initial = FALSE )

method filetype

? ^  < > 
Returns a selected file type to assign to the file name returned.

Source:
pm_filedialog.h:111
Returns:
A zero-based index of selected type. A -1 value is returned when <All Files> filter is used.
Code:
public virtual int filetype ( ) const

method handle

? ^  < > 
Returns the presentation window handle.
Source:
pm_filedialog.h:114
Code:
public HWND handle ( ) const

class iterator

? ^  < > 
Iterator class used to iterate through chosen files.

Source:
pm_filedialog.h:124
Author:
Dmitry A.Steklenev
Version:
$Revision: 1.12 $
Code:
public class iterator : public PMNonCopyable

method selected

? ^  < > 
Returns a pointer to the iterator object.

This object can be used to iterate through chosen files and must be deleted after usage.

Source:
pm_filedialog.h:162
Code:
public virtual iterator * selected ( )

Created Fri Aug 3 09:13:16 2012.
This documentation was generated automatically by
ccdoc v08r39 2003/02/27 bin_opt_emx_os2-2.30.
Click here to submit a bug report or feature request for ccdoc.
Click here to return to the top of the page.