Symbian^3 Application Developer Library >

CBrowserDialogsProvider Class Reference

class CBrowserDialogsProvider : public CBase

Provide dialogs needed for browser operation

BrowserDialogsProvider.lib
Since
2.8

Inherits from

Public Member Functions
~CBrowserDialogsProvider ()
IMPORT_C void CancelAll ()
TInt ConfirmQueryDialogL (const TInt , TInt , TInt )
TInt ConfirmQueryDialogL (const TDesC &, TInt , TInt )
IMPORT_C void DialogAlertL (const TDesC &, const TDesC &)
IMPORT_C TBool DialogConfirmL (const TDesC &, const TDesC &, const TDesC &, const TDesC &)
IMPORT_C void DialogDisplayPageImagesL ( CArrayFixFlat < TBrCtlImageCarrier > &)
IMPORT_C TBool DialogDownloadObjectL ( CBrCtlObjectInfo *)
IMPORT_C TBool DialogFileSelectLC (const TDesC &, const TDesC &, HBufC *&)
void DialogFindL ()
IMPORT_C TBool DialogMimeFileSelectLC ( HBufC *&, const TDesC &)
IMPORT_C void DialogNoteL (const TDesC &)
IMPORT_C void DialogNotifyErrorL ( TInt )
IMPORT_C void DialogNotifyHttpErrorL ( TInt , const TDesC &)
IMPORT_C TBool DialogPromptLC (const TDesC &, const TDesC &, const TDesC &, HBufC *&)
IMPORT_C TBool DialogSelectOptionL (const TDesC &, TBrCtlSelectOptionType , CArrayFix < TBrCtlSelectOptionData > &)
IMPORT_C TBool DialogUserAuthenticationLC (const TDesC &, const TDesC &, const TDesC &, HBufC *&, HBufC *&, TBool )
TInt DriveReady ( TDriveNumber )
TInt GetUserPasswordL ( TDes &, TDes &)
TBool IsDialogLaunched ()
IMPORT_C CBrowserDialogsProvider * NewL ( MBrowserDialogsProviderObserver *)
void SetObserver ( MBrowserDialogsProviderObserver *)
IMPORT_C void ShowTooltipL (const TDesC &, TInt , TInt )
IMPORT_C void UploadProgressNoteL ( TInt32 , TInt32 , TBool , MBrowserDialogsProviderObserver *)
Protected Member Functions
CBrowserDialogsProvider ( MBrowserDialogsProviderObserver *)
void AssureResourceL ()
void ConstructL ()
Private Member Functions
void RemoveDialogFromArray ()
TBool VerifySelectionL (const MDesCArray *)
Inherited Functions
CBase::CBase()
CBase::Delete(CBase *)
CBase::Extension_(TUint,TAny *&,TAny *)
CBase::operator new(TUint)
CBase::operator new(TUint,TAny *)
CBase::operator new(TUint,TLeave)
CBase::operator new(TUint,TLeave,TUint)
CBase::operator new(TUint,TUint)
CBase::~CBase()
Private Member Enumerations
enum TPanicReason { EInvalidSizeValue }
Private Attributes
CCoeEnv & iCoeEnv
RPointerArray < CCoeControl > iDialogs
TBool iErrResourceOpened
MBrowserDialogsProviderObserver * iObserver
RConeResourceLoader iResourceLoader
TBool iResourceOpened
CBrowserSelectElementDlg * iSelectDlg
CAknInfoPopupNoteController * iTooltip
CBrowserUploadProgressNote * iUploadProgressNote

Constructor & Destructor Documentation

CBrowserDialogsProvider(MBrowserDialogsProviderObserver *)

CBrowserDialogsProvider ( MBrowserDialogsProviderObserver * aObserver ) [protected]

Parameters

MBrowserDialogsProviderObserver * aObserver

~CBrowserDialogsProvider()

~CBrowserDialogsProvider ( ) [virtual]

Member Functions Documentation

AssureResourceL()

void AssureResourceL ( ) [protected]

CancelAll()

IMPORT_C void CancelAll ( ) [virtual]
Cancel any dialog that is being displayed due to e.g. Browser exit or page was destroyed
Since
2.8

ConfirmQueryDialogL(const TInt, TInt, TInt)

TInt ConfirmQueryDialogL ( const TInt aPromptResourceId,
TInt aResId = 0,
TInt aAnimation = 0
)
Display an confirmation query with given dialog resource
Since
Series 60 2.8

Parameters

const TInt aPromptResourceId
TInt aResId = 0 resource id of command set (aResId = 0 means R_AVKON_SOFTKEYS_YES_NO as per default )
TInt aAnimation = 0 animation overrides default one

ConfirmQueryDialogL(const TDesC &, TInt, TInt)

TInt ConfirmQueryDialogL ( const TDesC & aPrompt,
TInt aResId = 0,
TInt aAnimation = 0
)
Display an confirmation query with given dialog resource
Since
Series 60 2.8

Parameters

const TDesC & aPrompt Prompt to display.
TInt aResId = 0 resource id of dialog
TInt aAnimation = 0 animation overrides default one

ConstructL()

void ConstructL ( ) [protected]

DialogAlertL(const TDesC &, const TDesC &)

IMPORT_C void DialogAlertL ( const TDesC & aTitle,
const TDesC & aMessage
) [virtual]
Display a note to the user with ok softkey only
Since
2.8

Parameters

const TDesC & aTitle The title, could be empty
const TDesC & aMessage The message to display

DialogConfirmL(const TDesC &, const TDesC &, const TDesC &, const TDesC &)

IMPORT_C TBool DialogConfirmL ( const TDesC & aTitle,
const TDesC & aMessage,
const TDesC & aYesMessage,
const TDesC & aNoMessage
) [virtual]
Display confirmation message to the user
Since
2.8

Parameters

const TDesC & aTitle The title, could be empty
const TDesC & aMessage The message to display
const TDesC & aYesMessage The text to display on left softkey
const TDesC & aNoMessage The text to display on right softkey

DialogDisplayPageImagesL(CArrayFixFlat< TBrCtlImageCarrier > &)

IMPORT_C void DialogDisplayPageImagesL ( CArrayFixFlat < TBrCtlImageCarrier > & aPageImages ) [virtual]
DIsplay the images that appear in the current page
Since
2.8

Parameters

CArrayFixFlat < TBrCtlImageCarrier > & aPageImages The images that appear in this page

DialogDownloadObjectL(CBrCtlObjectInfo *)

IMPORT_C TBool DialogDownloadObjectL ( CBrCtlObjectInfo * aBrCtlObjectInfo ) [virtual]
Display object info and ask confirmation before download
Since
2.8

Parameters

CBrCtlObjectInfo * aBrCtlObjectInfo The object info

DialogFileSelectLC(const TDesC &, const TDesC &, HBufC *&)

IMPORT_C TBool DialogFileSelectLC ( const TDesC & aStartPath,
const TDesC & aRootPath,
HBufC *& aSelectedFileName
) [virtual]
File selection dialog
Since
2.8

Parameters

const TDesC & aStartPath The initial displayed directory
const TDesC & aRootPath The top most directory that the user can go up to
HBufC *& aSelectedFileName The selected file name. Returned on cleanup stack. Browser control will free the buffer

DialogFindL()

void DialogFindL ( ) [inline, virtual]
Display search on page dialog
Since
3.0

DialogMimeFileSelectLC(HBufC *&, const TDesC &)

IMPORT_C TBool DialogMimeFileSelectLC ( HBufC *& aSelectedFileName,
const TDesC & aMimeType
) [virtual]
Mime File selection dialog for specific mime type files
Since
3.2

Parameters

HBufC *& aSelectedFileName The selected file name.
const TDesC & aMimeType The accepted mime type Returned on cleanup stack. Browser control will free the buffer

DialogNoteL(const TDesC &)

IMPORT_C void DialogNoteL ( const TDesC & aMessage ) [virtual]
Display a note to the user. No softkeys
Since
2.8

Parameters

const TDesC & aMessage The message to display

DialogNotifyErrorL(TInt)

IMPORT_C void DialogNotifyErrorL ( TInt aErrCode ) [virtual]
Notify the user of an error
Since
2.8

Parameters

TInt aErrCode The error that occured

DialogNotifyHttpErrorL(TInt, const TDesC &)

IMPORT_C void DialogNotifyHttpErrorL ( TInt aErrCode,
const TDesC & aUri
) [virtual]
Notify the user of an http error
Since
2.8

Parameters

TInt aErrCode The error that occured
const TDesC & aUri The uri of the request that failed

DialogPromptLC(const TDesC &, const TDesC &, const TDesC &, HBufC *&)

IMPORT_C TBool DialogPromptLC ( const TDesC & aTitle,
const TDesC & aMessage,
const TDesC & aDefaultInput,
HBufC *& aReturnedInput
) [virtual]
Display input dialog to the user
Since
2.8

Parameters

const TDesC & aTitle The title, could be empty
const TDesC & aMessage The message to display
const TDesC & aDefaultInput The default input if available
HBufC *& aReturnedInput The input entered by the user Returned on the cleanup stack, owned by the calling application

DialogSelectOptionL(const TDesC &, TBrCtlSelectOptionType, CArrayFix< TBrCtlSelectOptionData > &)

IMPORT_C TBool DialogSelectOptionL ( const TDesC & aTitle,
TBrCtlSelectOptionType aBrowserSelectOptionType,
CArrayFix < TBrCtlSelectOptionData > & aOptions
) [virtual]
List selection dialog
Since
2.8

Parameters

const TDesC & aTitle The title, could be empty
TBrCtlSelectOptionType aBrowserSelectOptionType The type of the list box
CArrayFix < TBrCtlSelectOptionData > & aOptions A list of options to display

DialogUserAuthenticationLC(const TDesC &, const TDesC &, const TDesC &, HBufC *&, HBufC *&, TBool)

IMPORT_C TBool DialogUserAuthenticationLC ( const TDesC & aUrl,
const TDesC & aRealm,
const TDesC & aDefaultUserName,
HBufC *& aReturnedUserName,
HBufC *& aReturnedPasswd,
TBool aBasicAuthentication = EFalse
) [virtual]
User Authentication dialog. User name and password are returned on cleanup stack
Since
2.8

Parameters

const TDesC & aUrl The url requiring authentication
const TDesC & aRealm The realm requiring authentication
const TDesC & aDefaultUserName
HBufC *& aReturnedUserName The user name entered by the user
HBufC *& aReturnedPasswd The password entered by the user
TBool aBasicAuthentication = EFalse A flag if basic authentication was used

DriveReady(TDriveNumber)

TInt DriveReady ( TDriveNumber aDrive )

Checks if the drive is ready

Parameters

TDriveNumber aDrive enumerated drive number

GetUserPasswordL(TDes &, TDes &)

TInt GetUserPasswordL ( TDes & aUsername,
TDes & aPassword
)
User authentication dialog
Since
Series 60 2.8

Parameters

TDes & aUsername entered username
TDes & aPassword entered password

IsDialogLaunched()

TBool IsDialogLaunched ( ) [inline]

NewL(MBrowserDialogsProviderObserver *)

IMPORT_C CBrowserDialogsProvider * NewL ( MBrowserDialogsProviderObserver * aObserver ) [static]

Parameters

MBrowserDialogsProviderObserver * aObserver

RemoveDialogFromArray()

void RemoveDialogFromArray ( ) [private]

SetObserver(MBrowserDialogsProviderObserver *)

void SetObserver ( MBrowserDialogsProviderObserver * aDialogsObserver ) [inline]

Parameters

MBrowserDialogsProviderObserver * aDialogsObserver

ShowTooltipL(const TDesC &, TInt, TInt)

IMPORT_C void ShowTooltipL ( const TDesC & aText,
TInt aDuration =  KDefaultTooltipDuration ,
TInt aDelay =  KDefaultTooltipDelay
)
Display a tooltip (info popup note)
Since
3.0

Parameters

const TDesC & aText
TInt aDuration =  KDefaultTooltipDuration
TInt aDelay =  KDefaultTooltipDelay

UploadProgressNoteL(TInt32, TInt32, TBool, MBrowserDialogsProviderObserver *)

IMPORT_C void UploadProgressNoteL ( TInt32 aTotalSize,
TInt32 aChunkSize,
TBool aIsLastChunk,
MBrowserDialogsProviderObserver * aObserver
)
Display a dialog which tracks upload progress
Since
3.0

Parameters

TInt32 aTotalSize the total size of a file being uploaded
TInt32 aChunkSize the size of the current chunk being uploaded
TBool aIsLastChunk boolean value indicating whether the current
MBrowserDialogsProviderObserver * aObserver an observer for the upload progress dialog chunk is the last one in the entire download

VerifySelectionL(const MDesCArray *)

TBool VerifySelectionL ( const MDesCArray * aSelectedFiles ) [private]

Parameters

const MDesCArray * aSelectedFiles

Member Enumerations Documentation

Enum TPanicReason

Enumerators

EInvalidSizeValue

Member Data Documentation

CCoeEnv & iCoeEnv

CCoeEnv & iCoeEnv [private]

RPointerArray< CCoeControl > iDialogs

RPointerArray < CCoeControl > iDialogs [private]

TBool iErrResourceOpened

TBool iErrResourceOpened [private]

MBrowserDialogsProviderObserver * iObserver

MBrowserDialogsProviderObserver * iObserver [private]

RConeResourceLoader iResourceLoader

RConeResourceLoader iResourceLoader [private]

TBool iResourceOpened

TBool iResourceOpened [private]

CBrowserSelectElementDlg * iSelectDlg

CBrowserSelectElementDlg * iSelectDlg [private]

CAknInfoPopupNoteController * iTooltip

CAknInfoPopupNoteController * iTooltip [private]

CBrowserUploadProgressNote * iUploadProgressNote

CBrowserUploadProgressNote * iUploadProgressNote [private]

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.