AknCommonDialogs Class Reference

API published in: S60 2nd Ed

Link against: commondialogs.lib

Capability Information

Required Capabilities

None

#include <akncommondialogs.h>

Detailed Description

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.


Static Public Member Functions
static IMPORT_C TBool	RunSelectDlgLD (TDes &aFileName, TInt aMemorySelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSelectDlgLD (TDes &aFileName, TInt aMemorySelectionResourceId, MAknFileFilter aFilter, MAknFileSelectionObserver aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSelectDlgLD (TDes &aFileName, TInt aMemorySelectionResourceId, const TDesC &aFileSelectionTitle, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSelectDlgLD (TDes &aFileName, TInt aMemorySelectionResourceId, TInt aFileSelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunMoveDlgLD (TDes &aDirectory, TInt aMemorySelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunMoveDlgLD (TDes &aDirectory, TInt aMemorySelectionResourceId, MAknFileFilter aFilter, MAknFileSelectionObserver aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunMoveDlgLD (TDes &aDirectory, TInt aMemorySelectionResourceId, const TDesC &aFileSelectionTitle, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunMoveDlgLD (TDes &aDirectory, TInt aMemorySelectionResourceId, TInt aFileSelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSaveDlgLD (TDes &aDefaultFileName, TInt aMemorySelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSaveDlgLD (TDes &aDefaultFileName, TInt aMemorySelectionResourceId, MAknFileFilter aFilter, MAknFileSelectionObserver aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSaveDlgLD (TDes &aDefaultFileName, TInt aMemorySelectionResourceId, const TDesC &aFileSelectionTitle, const TDesC &aFileNamePromptTitle, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSaveDlgLD (TDes &aDefaultFileName, TInt aMemorySelectionResourceId, TInt aFileSelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSaveDlgLD (TDes &aDefaultFileName, TInt aMemorySelectionResourceId, TInt aFileSelectionResourceId, const TDesC &aFileNamePromptTitle, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSaveDlgNoDirectorySelectionLD (TDes &aDefaultFileName, TInt aMemorySelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSaveDlgNoDirectorySelectionLD (TDes &aDefaultFileName, TInt aMemorySelectionResourceId, const TDesC &aFileNamePromptTitle, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunCopyDlgLD (TDes &aDirectory, TInt aMemorySelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunCopyDlgLD (TDes &aDirectory, TInt aMemorySelectionResourceId, MAknFileFilter aFilter, MAknFileSelectionObserver aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunCopyDlgLD (TDes &aDirectory, TInt aMemorySelectionResourceId, TInt aFileSelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSelectDlgLD (TDes &aFileName, const TDesC &aStartFolder, TInt aMemorySelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSelectDlgLD (TDes &aFileName, const TDesC &aStartFolder, TInt aMemorySelectionResourceId, MAknFileFilter aFilter, MAknFileSelectionObserver aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSelectDlgLD (TDes &aFileName, const TDesC &aStartFolder, TInt aMemorySelectionResourceId, const TDesC &aFileSelectionTitle, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSelectDlgLD (TDes &aFileName, const TDesC &aStartFolder, TInt aMemorySelectionResourceId, TInt aFileSelectionResourceId, MAknFileSelectionObserver *aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSelectDlgLD (TDes &aFileName, const TDesC &aStartFolder, TInt aMemorySelectionResourceId, TInt aFileSelectionResourceId, const TDesC &aFileSelectionTitle, MAknFileFilter aFilter=NULL, MAknFileSelectionObserver aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunSaveDlgLD (TDes &aDefaultFileName, const TDesC &aStartFolder, TInt aMemorySelectionResourceId, TInt aFileSelectionResourceId, const TDesC &aFileSelectionTitle, MAknFileFilter aFilter=NULL, MAknFileSelectionObserver aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.
static IMPORT_C TBool	RunFolderSelectDlgLD (TDes &aFolder, const TDesC &aStartFolder, TInt aMemorySelectionResourceId, TInt aFileSelectionResourceId, const TDesC &aFileSelectionTitle, MAknFileFilter aFilter=NULL, MAknFileSelectionObserver aObserver=NULL)
	DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

Member Function Documentation

static IMPORT_C TBool AknCommonDialogs::RunCopyDlgLD	(	TDes &	aDirectory,
		TInt	aMemorySelectionResourceId,
		TInt	aFileSelectionResourceId,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches copy dialog.

Parameters:

	aDirectory	Full path of the folder that user selects is stored to this descriptor.
	aMemorySelectionResourceId	A resource id for memory selection dialog
	aFileSelectionResourceId	A resource id for file selection dialog
	aObserver	An observer which is asked, if set, to verify user's selection.

Returns:: Returns ETrue if user selects a folder, otherwise EFalse

static IMPORT_C TBool AknCommonDialogs::RunCopyDlgLD	(	TDes &	aDirectory,
		TInt	aMemorySelectionResourceId,
		MAknFileFilter *	aFilter,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches copy dialog.

Parameters:

	aDirectory	Full path of the folder that user selects is stored to this descriptor.
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aFilter	Filter is asked if a directory entry can be shown in list. Ownership is not transferred.
	aObserver	An observer which is asked, if set, to verify user's selection.

Returns:: Returns ETrue if user selects a folder, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunCopyDlgLD	(	TDes &	aDirectory,
		TInt	aMemorySelectionResourceId,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches copy dialog.

Parameters:

	aDirectory	Full path of the folder that user selects is stored to this descriptor.
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aObserver	An observer which is asked, if set, to verify user's selection.

Returns:: Returns ETrue if user selects a folder, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunFolderSelectDlgLD	(	TDes &	aFolder,
		const TDesC &	aStartFolder,
		TInt	aMemorySelectionResourceId,
		TInt	aFileSelectionResourceId,
		const TDesC &	aFileSelectionTitle,
		MAknFileFilter *	aFilter = `NULL`,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches folder selection dialog.

Parameters:

	aFolder	Full path of the folder that user selects is stored to this descriptor.
	aStartFolder	User defined folder to start browsing in file selection.
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aFileSelectionResourceId	A resource id for file selection dialog.
	aFileSelectionTitle	Custom title for file selection dialog.
	aFilter	Filter is asked if a directory entry can be shown in list.
	aObserver	An observer which is asked to verify user's selection.

Returns:: Returns ETrue if user selects a folder, otherwise EFalse

static IMPORT_C TBool AknCommonDialogs::RunMoveDlgLD	(	TDes &	aDirectory,
		TInt	aMemorySelectionResourceId,
		TInt	aFileSelectionResourceId,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches move dialog.

Parameters:

	aDirectory	Full path of the folder that user selects is stored to this descriptor.
	aMemorySelectionResourceId	A resource id for memory selection dialog
	aFileSelectionResourceId	A resource id for file selection dialog
	aObserver	An observer which is asked, if set, to verify user's selection.

Returns:: Returns ETrue if user selects a folder, otherwise EFalse

static IMPORT_C TBool AknCommonDialogs::RunMoveDlgLD	(	TDes &	aDirectory,
		TInt	aMemorySelectionResourceId,
		const TDesC &	aFileSelectionTitle,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches move dialog.

Parameters:

	aDirectory	Full path of the folder that user selects is stored to this descriptor.
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aFileSelectionTitle	A custom title for directory selection dialog.
	aObserver	An observer which is asked, if set, to verify user's selection.

Returns:: Returns ETrue if user selects a folder, otherwise EFalse

static IMPORT_C TBool AknCommonDialogs::RunMoveDlgLD	(	TDes &	aDirectory,
		TInt	aMemorySelectionResourceId,
		MAknFileFilter *	aFilter,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches move dialog.

Parameters:

	aDirectory	Full path of the folder that user selects is stored to this descriptor.
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aFilter	Filter is asked if a directory entry can be shown in list. Ownership is not transferred.
	aObserver	An observer which is asked, if set, to verify user's selection.

Returns:: Returns ETrue if user selects a folder, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunMoveDlgLD	(	TDes &	aDirectory,
		TInt	aMemorySelectionResourceId,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches move dialog.

Parameters:

	aDirectory	Full path of the folder that user selects is stored to this descriptor.
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aObserver	An observer which is asked, if set, to verify user's selection.

Returns:: Returns ETrue if user selects a folder, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunSaveDlgLD	(	TDes &	aDefaultFileName,
		const TDesC &	aStartFolder,
		TInt	aMemorySelectionResourceId,
		TInt	aFileSelectionResourceId,
		const TDesC &	aFileSelectionTitle,
		MAknFileFilter *	aFilter = `NULL`,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches save dialog.

Parameters:

	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".
	aStartFolder	User defined folder to start browsing in file selection.
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aFileSelectionResourceId	A resource id for file selection dialog.
	aFileSelectionTitle	Custom title for file selection dialog.
	aFilter	Filter asked if a directory entry can be shown in list.
	aObserver	An observer which is asked, if set, to verify the filename that user types.

Returns:: Returns ETrue if user accepts or enters a filename, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunSaveDlgLD	(	TDes &	aDefaultFileName,
		TInt	aMemorySelectionResourceId,
		TInt	aFileSelectionResourceId,
		const TDesC &	aFileNamePromptTitle,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches save dialog.

Parameters:

	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".
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aFileSelectionResourceId	A resource id for file selection dialog.
	aFileNamePromptTitle	Custom title for filename prompt dialog.
	aObserver	An observer which is asked, if set, to verify the filename that user types.

Returns:: Returns ETrue if user accepts or enters a filename, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunSaveDlgLD	(	TDes &	aDefaultFileName,
		TInt	aMemorySelectionResourceId,
		TInt	aFileSelectionResourceId,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches save dialog.

Parameters:

	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".
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aFileSelectionResourceId	A resource id for file selection dialog.
	aObserver	An observer which is asked, if set, to verify the filename that user types.

Returns:: Returns ETrue if user accepts or enters a filename, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunSaveDlgLD	(	TDes &	aDefaultFileName,
		TInt	aMemorySelectionResourceId,
		const TDesC &	aFileSelectionTitle,
		const TDesC &	aFileNamePromptTitle,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches save dialog.

Parameters:

	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".
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aFileSelectionTitle	Custom title for file selection dialog.
	aFileNamePromptTitle	Custom title for filename prompt dialog.
	aObserver	An observer which is asked, if set, to verify the filename that user types.

Returns:: Returns ETrue if user accepts or enters a filename, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunSaveDlgLD	(	TDes &	aDefaultFileName,
		TInt	aMemorySelectionResourceId,
		MAknFileFilter *	aFilter,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches save dialog.

Parameters:

	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".
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aFilter	Filter is asked if a directory entry can be shown in list. Ownership is not transferred.
	aObserver	An observer which is asked, if set, to verify the filename that user types.

Returns:: Returns ETrue if user accepts or enters a filename, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunSaveDlgLD	(	TDes &	aDefaultFileName,
		TInt	aMemorySelectionResourceId,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

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:

	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".
	aMemorySelectionResourceId	A resource id for memory selection dialog.
	aObserver	An observer which is asked, if set, to verify the filename that user types.

Returns:: Returns ETrue if user accepts or enters a filename, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunSaveDlgNoDirectorySelectionLD	(	TDes &	aDefaultFileName,
		TInt	aMemorySelectionResourceId,
		const TDesC &	aFileNamePromptTitle,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches save dialog. No file selection dialog for directory selection is displayed.

Parameters:

	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".
	aMemorySelectionResourceId	A resource id for memory selection dialog. The folders in which the file will be saved should be given in this resource.
	aFileNamePromptTitle	Custom title for filename prompt dialog.
	aObserver	An observer which is asked, if set, to verify the filename that user types.

Returns:: Returns ETrue if user accepts or enters a filename, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunSaveDlgNoDirectorySelectionLD	(	TDes &	aDefaultFileName,
		TInt	aMemorySelectionResourceId,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.

A static method that launches save dialog. No file selection dialog for directory selection is displayed.

Parameters:

	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".
	aMemorySelectionResourceId	A resource id for memory selection dialog. The folders in which the file will be saved should be given in this resource.
	aObserver	An observer which is asked, if set, to verify the filename that user types.

Returns:: Returns ETrue if user accepts or enters a filename, otherwise EFalse.

static IMPORT_C TBool AknCommonDialogs::RunSelectDlgLD	(	TDes &	aFileName,
		const TDesC &	aStartFolder,
		TInt	aMemorySelectionResourceId,
		TInt	aFileSelectionResourceId,
		const TDesC &	aFileSelectionTitle,
		MAknFileFilter *	aFilter = `NULL`,
		MAknFileSelectionObserver *	aObserver = `NULL`
	)	`[static]`

DEPRECATED: Use AknCommonDialogsDynMem funcions instead.