Symbian^3 Product Developer Library >

CBrowserDialogsProvider Class Reference

class CBrowserDialogsProvider : public CBase

Provide dialogs needed for browser operation

BrowserDialogsProvider.lib
Since
2.8

Inherits from

  • CBrowserDialogsProvider
Public Member Functions
~CBrowserDialogsProvider()
IMPORT_C voidCancelAll()
TInt ConfirmQueryDialogL(const TInt, TInt, TInt)
TInt ConfirmQueryDialogL(const TDesC &, TInt, TInt)
IMPORT_C voidDialogAlertL(const TDesC &, const TDesC &)
IMPORT_C TBoolDialogConfirmL(const TDesC &, const TDesC &, const TDesC &, const TDesC &)
IMPORT_C voidDialogDisplayPageImagesL(CArrayFixFlat< TBrCtlImageCarrier > &)
IMPORT_C TBoolDialogDownloadObjectL(CBrCtlObjectInfo *)
IMPORT_C TBoolDialogFileSelectLC(const TDesC &, const TDesC &, HBufC *&)
voidDialogFindL()
IMPORT_C TBoolDialogMimeFileSelectLC(HBufC *&, const TDesC &)
IMPORT_C voidDialogNoteL(const TDesC &)
IMPORT_C voidDialogNotifyErrorL(TInt)
IMPORT_C voidDialogNotifyHttpErrorL(TInt, const TDesC &)
IMPORT_C TBoolDialogPromptLC(const TDesC &, const TDesC &, const TDesC &, HBufC *&)
IMPORT_C TBoolDialogSelectOptionL(const TDesC &, TBrCtlSelectOptionType, CArrayFix< TBrCtlSelectOptionData > &)
IMPORT_C TBoolDialogUserAuthenticationLC(const TDesC &, const TDesC &, const TDesC &, HBufC *&, HBufC *&, TBool)
TInt DriveReady(TDriveNumber)
TInt GetUserPasswordL(TDes &, TDes &)
TBool IsDialogLaunched()
IMPORT_C CBrowserDialogsProvider *NewL(MBrowserDialogsProviderObserver *)
voidSetObserver(MBrowserDialogsProviderObserver *)
IMPORT_C voidShowTooltipL(const TDesC &, TInt, TInt)
IMPORT_C voidUploadProgressNoteL(TInt32, TInt32, TBool, MBrowserDialogsProviderObserver *)
Protected Member Functions
CBrowserDialogsProvider(MBrowserDialogsProviderObserver *)
voidAssureResourceL()
voidConstructL()
Private Member Functions
voidRemoveDialogFromArray()
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
enumTPanicReason { EInvalidSizeValue }
Private Attributes
CCoeEnv &iCoeEnv
RPointerArray< CCoeControl >iDialogs
TBool iErrResourceOpened
MBrowserDialogsProviderObserver *iObserver
RConeResourceLoaderiResourceLoader
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()

voidAssureResourceL()[protected]

CancelAll()

IMPORT_C voidCancelAll()[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 TIntaPromptResourceId,
TIntaResId = 0,
TIntaAnimation = 0
)
Display an confirmation query with given dialog resource
Since
Series 60 2.8

Parameters

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

ConfirmQueryDialogL(const TDesC &, TInt, TInt)

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

Parameters

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

ConstructL()

voidConstructL()[protected]

DialogAlertL(const TDesC &, const TDesC &)

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

Parameters

const TDesC & aTitleThe title, could be empty
const TDesC & aMessageThe message to display

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

IMPORT_C TBoolDialogConfirmL(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 & aTitleThe title, could be empty
const TDesC & aMessageThe message to display
const TDesC & aYesMessageThe text to display on left softkey
const TDesC & aNoMessageThe text to display on right softkey

DialogDisplayPageImagesL(CArrayFixFlat< TBrCtlImageCarrier > &)

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

Parameters

CArrayFixFlat< TBrCtlImageCarrier > & aPageImagesThe images that appear in this page

DialogDownloadObjectL(CBrCtlObjectInfo *)

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

Parameters

CBrCtlObjectInfo * aBrCtlObjectInfoThe object info

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

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

Parameters

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

DialogFindL()

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

DialogMimeFileSelectLC(HBufC *&, const TDesC &)

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

Parameters

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

DialogNoteL(const TDesC &)

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

Parameters

const TDesC & aMessageThe message to display

DialogNotifyErrorL(TInt)

IMPORT_C voidDialogNotifyErrorL(TIntaErrCode)[virtual]
Notify the user of an error
Since
2.8

Parameters

TInt aErrCodeThe error that occured

DialogNotifyHttpErrorL(TInt, const TDesC &)

IMPORT_C voidDialogNotifyHttpErrorL(TIntaErrCode,
const TDesC &aUri
)[virtual]
Notify the user of an http error
Since
2.8

Parameters

TInt aErrCodeThe error that occured
const TDesC & aUriThe uri of the request that failed

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

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

Parameters

const TDesC & aTitleThe title, could be empty
const TDesC & aMessageThe message to display
const TDesC & aDefaultInputThe default input if available
HBufC *& aReturnedInputThe input entered by the user Returned on the cleanup stack, owned by the calling application

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

IMPORT_C TBoolDialogSelectOptionL(const TDesC &aTitle,
TBrCtlSelectOptionTypeaBrowserSelectOptionType,
CArrayFix< TBrCtlSelectOptionData > &aOptions
)[virtual]
List selection dialog
Since
2.8

Parameters

const TDesC & aTitleThe title, could be empty
TBrCtlSelectOptionType aBrowserSelectOptionTypeThe type of the list box
CArrayFix< TBrCtlSelectOptionData > & aOptionsA list of options to display

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

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

Parameters

const TDesC & aUrlThe url requiring authentication
const TDesC & aRealmThe realm requiring authentication
const TDesC & aDefaultUserName
HBufC *& aReturnedUserNameThe user name entered by the user
HBufC *& aReturnedPasswdThe password entered by the user
TBool aBasicAuthentication = EFalseA flag if basic authentication was used

DriveReady(TDriveNumber)

TInt DriveReady(TDriveNumberaDrive)

Checks if the drive is ready

Parameters

TDriveNumber aDriveenumerated drive number

GetUserPasswordL(TDes &, TDes &)

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

Parameters

TDes & aUsernameentered username
TDes & aPasswordentered password

IsDialogLaunched()

TBool IsDialogLaunched()[inline]

NewL(MBrowserDialogsProviderObserver *)

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

Parameters

MBrowserDialogsProviderObserver * aObserver

RemoveDialogFromArray()

voidRemoveDialogFromArray()[private]

SetObserver(MBrowserDialogsProviderObserver *)

voidSetObserver(MBrowserDialogsProviderObserver *aDialogsObserver)[inline]

Parameters

MBrowserDialogsProviderObserver * aDialogsObserver

ShowTooltipL(const TDesC &, TInt, TInt)

IMPORT_C voidShowTooltipL(const TDesC &aText,
TIntaDuration =  KDefaultTooltipDuration ,
TIntaDelay =  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 voidUploadProgressNoteL(TInt32aTotalSize,
TInt32aChunkSize,
TBoolaIsLastChunk,
MBrowserDialogsProviderObserver *aObserver
)
Display a dialog which tracks upload progress
Since
3.0

Parameters

TInt32 aTotalSizethe total size of a file being uploaded
TInt32 aChunkSizethe size of the current chunk being uploaded
TBool aIsLastChunkboolean value indicating whether the current
MBrowserDialogsProviderObserver * aObserveran 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

RConeResourceLoaderiResourceLoader[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.