CAknFileNamePromptDialog Class Reference

API published in: S60 2nd Ed

Link against: commondialogs.lib

Capability Information

Required Capabilities

None

#include <caknfilenamepromptdialog.h>

Inherits CAknCommonDialogsBase.

Detailed Description

A class that launches a pop-up dialog for filename prompting.

Public Member Functions
IMPORT_C  ~CAknFileNamePromptDialog ()
IMPORT_C void  SetPathL (const TDesC &aPath)
  Sets path from which is checked if a file already exists.
IMPORT_C void  SetObserver (MAknFileSelectionObserver *aObserver)
  Sets an observer which is asked if the selected item can be selected.
IMPORT_C void  SetTitleL (const TDesC &aText)
  Sets prompt text (title) for dialog.
IMPORT_C void  SetLeftSoftkeyL (const TDesC &aText)
  Sets the text used for left softkey.
IMPORT_C void  SetRightSoftkeyL (const TDesC &aText)
  Sets the text used for right softkey.
IMPORT_C TBool  ExecuteL (TDes &aFileName)
  Executes the filename prompt dialog.
IMPORT_C TBool  RenameL (TDes &aFileName)
  A method for use this dialog for renaming file.

Static Public Member Functions
static IMPORT_C CAknFileNamePromptDialog *  NewL ()
  Static constructor.
static IMPORT_C CAknFileNamePromptDialog *  NewL (TInt aResourceId)
  Static constructor.
static IMPORT_C TBool  RunDlgLD (TDes &aFileName, const TDesC &aPath, MAknFileSelectionObserver *aObserver=NULL)
  A static method for launching a filename prompt dialog.
static IMPORT_C TBool  RunDlgLD (TDes &aFileName, const TDesC &aPath, const TDesC &aTitle, MAknFileSelectionObserver *aObserver=NULL)
  A static method for launching a filename prompt dialog.
static IMPORT_C TBool  RunDlgLD (TDes &aFileName, const TDesC &aPath, TInt aResourceId, MAknFileSelectionObserver *aObserver=NULL)
  A static method for launching a filename prompt dialog.

Protected Attributes
MAknFileSelectionObserver *  iObserver
HBufC *  iDefaultFileName
HBufC *  iPath
HBufC *  iTitle
HBufC *  iLeftSoftkey
HBufC *  iRightSoftkey

Constructor & Destructor Documentation

IMPORT_C CAknFileNamePromptDialog::~CAknFileNamePromptDialog (   ) 
 

Member Function Documentation

IMPORT_C TBool CAknFileNamePromptDialog::ExecuteL (  TDes &  aFileName  ) 
 

Executes the filename prompt dialog.

Parameters:
aFileName  A reference to filename. If parameter is set, it is used as default filename.
Returns:
Returns true if user has selected an item and false if user hits cancel.
static IMPORT_C CAknFileNamePromptDialog* CAknFileNamePromptDialog::NewL (  TInt  aResourceId  )  [static]
 

Static constructor.

Parameters:
aResourceId  A resource id (FILENAMEPROMPTDIALOG).
Returns:
Returns a pointer to an instance of itself.
static IMPORT_C CAknFileNamePromptDialog* CAknFileNamePromptDialog::NewL (   )  [static]
 

Static constructor.

Creates Filename Prompt Dialog with default values.

Returns:
Returns a pointer to an instance of itself.
IMPORT_C TBool CAknFileNamePromptDialog::RenameL (  TDes &  aFileName  ) 
 

A method for use this dialog for renaming file.

Parameters:
aFileName  File name user input
Returns:
Returns true if user has selected an item and false if user hits cancel.
static IMPORT_C TBool CAknFileNamePromptDialog::RunDlgLD (  TDes &  aFileName,
const TDesC &  aPath,
TInt  aResourceId,
MAknFileSelectionObserver *  aObserver = NULL
)  [static]
 

A static method for launching a filename prompt dialog.

Parameters are described in method RunL

static IMPORT_C TBool CAknFileNamePromptDialog::RunDlgLD (  TDes &  aFileName,
const TDesC &  aPath,
const TDesC &  aTitle,
MAknFileSelectionObserver *  aObserver = NULL
)  [static]
 

A static method for launching a filename prompt dialog.

Parameters are described in method RunL

static IMPORT_C TBool CAknFileNamePromptDialog::RunDlgLD (  TDes &  aFileName,
const TDesC &  aPath,
MAknFileSelectionObserver *  aObserver = NULL
)  [static]
 

A static method for launching a filename prompt dialog.

Parameters are described in method RunL

IMPORT_C void CAknFileNamePromptDialog::SetLeftSoftkeyL (  const TDesC &  aText  ) 
 

Sets the text used for left softkey.

Parameters:
aText  The text used for left softkey.
IMPORT_C void CAknFileNamePromptDialog::SetObserver (  MAknFileSelectionObserver *  aObserver  ) 
 

Sets an observer which is asked if the selected item can be selected.

Parameters:
aObserver  A pointer to an observer (implemented in an application).
IMPORT_C void CAknFileNamePromptDialog::SetPathL (  const TDesC &  aPath  ) 
 

Sets path from which is checked if a file already exists.

Parameters:
aPath  Full path with trailing backslash.
IMPORT_C void CAknFileNamePromptDialog::SetRightSoftkeyL (  const TDesC &  aText  ) 
 

Sets the text used for right softkey.

Parameters:
aText  The text used for right softkey.
IMPORT_C void CAknFileNamePromptDialog::SetTitleL (  const TDesC &  aText  ) 
 

Sets prompt text (title) for dialog.

Parameters:
aText  Title text.

Field Documentation

HBufC* CAknFileNamePromptDialog::iDefaultFileName [protected]
 
HBufC* CAknFileNamePromptDialog::iLeftSoftkey [protected]
 
MAknFileSelectionObserver* CAknFileNamePromptDialog::iObserver [protected]
 
HBufC* CAknFileNamePromptDialog::iPath [protected]
 
HBufC* CAknFileNamePromptDialog::iRightSoftkey [protected]
 
HBufC* CAknFileNamePromptDialog::iTitle [protected]
 
The documentation for this class was generated from the following file:
Copyright © Nokia Corporation 2001-2008
Back to top