AknCommonDialogs Class Reference
DEPRECATED: Use AknCommonDialogsDynMem instead. This class is only used as a proxy to the new implementation class to maintain backwards compatibility.
A class that consists of static functions that launch UI components in a sequence. First, memory selection component is launched and then file/directory selection component. In save and move dialogs directory selection may not be shown if there are no subdirectories to choose from. In save dialog, finally filename prompt component is launched.
All methods have an obligatory resource ID parameter for memory selection because it contains the paths for both memories (Phone&MMC) (LOCATION structs). If set, an observer is queried just before exiting the dialog. At this point the application can either reject or accept user's selection. Every dialog returns a boolean value which tells if user has selected something or not.
CommonDialogs.lib
- Since
- 1.2
| Public Member Functions |
|---|
| IMPORT_C TBool | RunCopyDlgLD(TDes &, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunCopyDlgLD(TDes &, TInt, MAknFileFilter *, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunCopyDlgLD(TDes &, TInt, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunFolderSelectDlgLD(TDes &, const TDesC &, TInt, TInt, const TDesC &, MAknFileFilter *, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunMoveDlgLD(TDes &, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunMoveDlgLD(TDes &, TInt, MAknFileFilter *, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunMoveDlgLD(TDes &, TInt, const TDesC &, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunMoveDlgLD(TDes &, TInt, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSaveDlgLD(TDes &, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSaveDlgLD(TDes &, TInt, MAknFileFilter *, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSaveDlgLD(TDes &, TInt, const TDesC &, const TDesC &, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSaveDlgLD(TDes &, TInt, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSaveDlgLD(TDes &, TInt, TInt, const TDesC &, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSaveDlgLD(TDes &, const TDesC &, TInt, TInt, const TDesC &, MAknFileFilter *, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSaveDlgNoDirectorySelectionLD(TDes &, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSaveDlgNoDirectorySelectionLD(TDes &, TInt, const TDesC &, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSelectDlgLD(TDes &, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSelectDlgLD(TDes &, TInt, MAknFileFilter *, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSelectDlgLD(TDes &, TInt, const TDesC &, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSelectDlgLD(TDes &, TInt, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSelectDlgLD(TDes &, const TDesC &, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSelectDlgLD(TDes &, const TDesC &, TInt, MAknFileFilter *, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSelectDlgLD(TDes &, const TDesC &, TInt, const TDesC &, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSelectDlgLD(TDes &, const TDesC &, TInt, TInt, MAknFileSelectionObserver *) |
| IMPORT_C TBool | RunSelectDlgLD(TDes &, const TDesC &, TInt, TInt, const TDesC &, MAknFileFilter *, MAknFileSelectionObserver *) |
Member Functions Documentation
RunCopyDlgLD(TDes &, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches copy dialog.
Parameters
| TDes & aDirectory | Full path of the folder that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunCopyDlgLD(TDes &, TInt, MAknFileFilter *, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches copy dialog.
Parameters
| TDes & aDirectory | Full path of the folder that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileFilter * aFilter | Filter is asked if a directory entry can be shown in list. Ownership is not transferred. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunCopyDlgLD(TDes &, TInt, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches copy dialog.
Parameters
| TDes & aDirectory | Full path of the folder that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog |
| TInt aFileSelectionResourceId | A resource id for file selection dialog |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunFolderSelectDlgLD(TDes &, const TDesC &, TInt, TInt, const TDesC &, MAknFileFilter *, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches folder selection dialog.
- Since
- 3.1
Parameters
| TDes & aFolder | Full path of the folder that user selects is stored to this descriptor. |
| const TDesC & aStartFolder | User defined folder to start browsing in file selection. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| TInt aFileSelectionResourceId | A resource id for file selection dialog. |
| const TDesC & aFileSelectionTitle | Custom title for file selection dialog. |
| MAknFileFilter * aFilter = NULL | Filter is asked if a directory entry can be shown in list. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked to verify user's selection. |
RunMoveDlgLD(TDes &, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches move dialog.
Parameters
| TDes & aDirectory | Full path of the folder that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunMoveDlgLD(TDes &, TInt, MAknFileFilter *, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches move dialog.
Parameters
| TDes & aDirectory | Full path of the folder that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileFilter * aFilter | Filter is asked if a directory entry can be shown in list. Ownership is not transferred. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunMoveDlgLD(TDes &, TInt, const TDesC &, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches move dialog.
Parameters
| TDes & aDirectory | Full path of the folder that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| const TDesC & aFileSelectionTitle | A custom title for directory selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunMoveDlgLD(TDes &, TInt, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches move dialog.
Parameters
| TDes & aDirectory | Full path of the folder that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog |
| TInt aFileSelectionResourceId | A resource id for file selection dialog |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunSaveDlgLD(TDes &, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches save dialog which does not run folder selection dialog at all. Instead the resulting path will be constructed from the root and default folder read from resources and from the file name given by the user.
Parameters
| TDes & aDefaultFileName | Full path + the filename that user enters is stored to this descriptor. The descriptor may contain text that is used as default filename, for example "Attachment". |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify the filename that user types. |
RunSaveDlgLD(TDes &, TInt, MAknFileFilter *, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches save dialog.
Parameters
| TDes & aDefaultFileName | Full path + the filename that user enters is stored to this descriptor. The descriptor may contain text that is used as default filename, for example "Attachment". |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileFilter * aFilter | Filter is asked if a directory entry can be shown in list. Ownership is not transferred. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify the filename that user types. |
RunSaveDlgLD(TDes &, TInt, const TDesC &, const TDesC &, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches save dialog.
Parameters
| TDes & aDefaultFileName | Full path + the filename that user enters is stored to this descriptor. The descriptor may contain text that is used as default filename, for example "Attachment". |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| const TDesC & aFileSelectionTitle | Custom title for file selection dialog. |
| const TDesC & aFileNamePromptTitle | Custom title for filename prompt dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify the filename that user types. |
RunSaveDlgLD(TDes &, TInt, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches save dialog.
Parameters
| TDes & aDefaultFileName | Full path + the filename that user enters is stored to this descriptor. The descriptor may contain text that is used as default filename, for example "Attachment". |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| TInt aFileSelectionResourceId | A resource id for file selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify the filename that user types. |
RunSaveDlgLD(TDes &, TInt, TInt, const TDesC &, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches save dialog.
Parameters
| TDes & aDefaultFileName | Full path + the filename that user enters is stored to this descriptor. The descriptor may contain text that is used as default filename, for example "Attachment". |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| TInt aFileSelectionResourceId | A resource id for file selection dialog. |
| const TDesC & aFileNamePromptTitle | Custom title for filename prompt dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify the filename that user types. |
RunSaveDlgLD(TDes &, const TDesC &, TInt, TInt, const TDesC &, MAknFileFilter *, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches save dialog.
- Since
- 3.1
Parameters
| TDes & aDefaultFileName | Full path + the filename that user enters is stored to this descriptor. The descriptor may contain text that is used as default filename, for example "Attachment". |
| const TDesC & aStartFolder | User defined folder to start browsing in file selection. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| TInt aFileSelectionResourceId | A resource id for file selection dialog. |
| const TDesC & aFileSelectionTitle | Custom title for file selection dialog. |
| MAknFileFilter * aFilter = NULL | Filter asked if a directory entry can be shown in list. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify the filename that user types. |
RunSaveDlgNoDirectorySelectionLD(TDes &, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches save dialog. No file selection dialog for directory selection is displayed.
Parameters
| TDes & aDefaultFileName | Full path + the filename that user enters is stored to this descriptor. The descriptor may contain text that is used as default filename, for example "Attachment". |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. The folders in which the file will be saved should be given in this resource. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify the filename that user types. |
RunSaveDlgNoDirectorySelectionLD(TDes &, TInt, const TDesC &, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches save dialog. No file selection dialog for directory selection is displayed.
Parameters
| TDes & aDefaultFileName | Full path + the filename that user enters is stored to this descriptor. The descriptor may contain text that is used as default filename, for example "Attachment". |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. The folders in which the file will be saved should be given in this resource. |
| const TDesC & aFileNamePromptTitle | Custom title for filename prompt dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify the filename that user types. |
RunSelectDlgLD(TDes &, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches file selection dialog.
Parameters
| TDes & aFileName | Full path and filename of the file that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunSelectDlgLD(TDes &, TInt, MAknFileFilter *, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches file selection dialog.
Parameters
| TDes & aFileName | Full path and filename of the file that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileFilter * aFilter | Filter is asked if a directory entry can be shown in list. Ownership is not transferred. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunSelectDlgLD(TDes &, TInt, const TDesC &, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches file selection dialog.
Parameters
| TDes & aFileName | Full path and filename of the file that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| const TDesC & aFileSelectionTitle | A custom title for file selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunSelectDlgLD(TDes &, TInt, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches file selection dialog.
Parameters
| TDes & aFileName | Full path and filename of the file that user selects is stored to this descriptor. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| TInt aFileSelectionResourceId | A resource id for file selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunSelectDlgLD(TDes &, const TDesC &, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches file selection dialog.
- Since
- 2.6
Parameters
| TDes & aFileName | Full path and filename of the file that user selects is stored to this descriptor. |
| const TDesC & aStartFolder | User defined folder to start browsing in file selection |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunSelectDlgLD(TDes &, const TDesC &, TInt, MAknFileFilter *, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches file selection dialog.
- Since
- 2.6
Parameters
| TDes & aFileName | Full path and filename of the file that user selects is stored to this descriptor. |
| const TDesC & aStartFolder | User defined folder to start browsing in file selection |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| MAknFileFilter * aFilter | Filter is asked if a directory entry can be shown in list. Ownership is not transferred. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunSelectDlgLD(TDes &, const TDesC &, TInt, const TDesC &, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches file selection dialog.
- Since
- 2.6
Parameters
| TDes & aFileName | Full path and filename of the file that user selects is stored to this descriptor. |
| const TDesC & aStartFolder | User defined folder to start browsing in file selection |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| const TDesC & aFileSelectionTitle | A custom title for file selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunSelectDlgLD(TDes &, const TDesC &, TInt, TInt, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches file selection dialog.
- Since
- 2.6
Parameters
| TDes & aFileName | Full path and filename of the file that user selects is stored to this descriptor. |
| const TDesC & aStartFolder | User defined folder to start browsing in file selection |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| TInt aFileSelectionResourceId | A resource id for file selection dialog. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked, if set, to verify user's selection. |
RunSelectDlgLD(TDes &, const TDesC &, TInt, TInt, const TDesC &, MAknFileFilter *, MAknFileSelectionObserver *)
DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
A static method that launches file selection dialog.
- Since
- 3.1
Parameters
| TDes & aFileName | Full path and filename of the file that user selects is stored to this descriptor. |
| const TDesC & aStartFolder | User defined folder to start browsing in file selection. |
| TInt aMemorySelectionResourceId | A resource id for memory selection dialog. |
| TInt aFileSelectionResourceId | A resource id for file selection dialog. |
| const TDesC & aFileSelectionTitle | Custom title for file selection dialog. |
| MAknFileFilter * aFilter = NULL | Filter asked if a directory entry can be shown in list. |
| MAknFileSelectionObserver * aObserver = NULL | An observer which is asked to verify user's selection. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.