S60 3rd Edition SDK for Symbian OS
Example Applications Guide

CBrCtlSampleAppDialogsProvider Class Reference

#include <BrCtlSampleAppDialogsProvider.h>

List of all members.

Public Member Functions

 ~CBrCtlSampleAppDialogsProvider ()
virtual void DialogNotifyErrorL (TInt)
virtual void DialogNotifyHttpErrorL (TInt, const TDesC &)
virtual TBool DialogFileSelectLC (const TDesC &, const TDesC &, HBufC *&)
virtual TBool DialogSelectOptionL (const TDesC &, TBrCtlSelectOptionType, CArrayFix< TBrCtlSelectOptionData > &)
virtual TBool DialogUserAuthenticationLC (const TDesC &, const TDesC &, const TDesC &, HBufC *&, HBufC *&, TBool=EFalse)
virtual void DialogNoteL (const TDesC &)
void DialogAlertL (const TDesC &aTitle, const TDesC &aMessage)
virtual TBool DialogConfirmL (const TDesC &, const TDesC &, const TDesC &, const TDesC &)
virtual TBool DialogPromptLC (const TDesC &, const TDesC &, const TDesC &, HBufC *&)
virtual TBool DialogDownloadObjectL (CBrCtlObjectInfo *)
virtual void DialogDisplayPageImagesL (CArrayFixFlat< TBrCtlImageCarrier > &)
virtual void CancelAll ()
virtual void DialogFindL ()

Static Public Member Functions

static CBrCtlSampleAppDialogsProvider * NewL (CBrCtlSampleAppContainer *aContainer)

Private Member Functions

void ConstructL (CBrCtlSampleAppContainer *aContainer)

Private Attributes

CBrCtlSampleAppContainer * iContainer

Detailed Description

CBrCtlSampleAppDialogsProvider class. This class inherits from the MBrCtlDialogsProvider and is used to modify the default dialogs that the Browser Control provides

Definition at line 33 of file BrCtlSampleAppDialogsProvider.h.

Constructor & Destructor Documentation

CBrCtlSampleAppDialogsProvider::~CBrCtlSampleAppDialogsProvider (   ) 
 

Destructor.

Definition at line 75 of file BrCtlSampleAppDialogsProvider.cpp.

00076     {
00077     }

Member Function Documentation

CBrCtlSampleAppDialogsProvider * CBrCtlSampleAppDialogsProvider::NewL (  CBrCtlSampleAppContainer *  aContainer  )  [static]
 

Two-phased constructor.

Definition at line 83 of file BrCtlSampleAppDialogsProvider.cpp.

References ConstructL().

00084 {
00085   CBrCtlSampleAppDialogsProvider* self = new(ELeave)CBrCtlSampleAppDialogsProvider;
00086   CleanupStack::PushL(self);
00087   self->ConstructL(aContainer);
00088   CleanupStack::Pop();
00089   return self;
00090 }

virtual void CBrCtlSampleAppDialogsProvider::DialogNotifyErrorL (  TInt   )  [inline, virtual]
 

Notify the user of an error

Since:
2.8
Parameters:
aErrCode The error that occured
Returns:
void

Definition at line 53 of file BrCtlSampleAppDialogsProvider.h.

00054             {
00055             };

virtual void CBrCtlSampleAppDialogsProvider::DialogNotifyHttpErrorL (  TInt  ,
const TDesC & 
)  [inline, virtual]
 

Notify the user of an http error

Since:
2.8
Parameters:
aErrCode The error that occured
aUri The uri of the request that failed
Returns:
void

Definition at line 64 of file BrCtlSampleAppDialogsProvider.h.

00065             {
00066             };

virtual TBool CBrCtlSampleAppDialogsProvider::DialogFileSelectLC (  const TDesC &  ,
const TDesC &  ,
HBufC *& 
)  [inline, virtual]
 

File selection dialog

Since:
2.8
Parameters:
aStartPath The initial displayed directory (drive and path)
aRootPath The top most directory that the user can go up to (currently set to NULL indicating no restriction)
aSelectedFileName The selected file name. Returned on cleanup stack. Browser control will free the buffer
Returns:
ETrue if file selected; else EFalse (user canceled, etc)

Definition at line 76 of file BrCtlSampleAppDialogsProvider.h.

00079             {
00080             return EFalse;
00081             }

virtual TBool CBrCtlSampleAppDialogsProvider::DialogSelectOptionL (  const TDesC &  ,
TBrCtlSelectOptionType  ,
CArrayFix< TBrCtlSelectOptionData > & 
)  [inline, virtual]
 

List selection dialog

Since:
2.8
Parameters:
aTitle The title, could be empty
aBrCtlSelectOptionType The type of the list box
aOptions A list of options to display
Returns:
EFalse if the user canceled, ETrue otherwise

Definition at line 91 of file BrCtlSampleAppDialogsProvider.h.

00094             {
00095             return EFalse;
00096             }

virtual TBool CBrCtlSampleAppDialogsProvider::DialogUserAuthenticationLC (  const TDesC &  ,
const TDesC &  ,
const TDesC &  ,
HBufC *&  ,
HBufC *&  ,
TBool  = EFalse
)  [inline, virtual]
 

User Authentication dialog. User name and password are returned on cleanup stack

Since:
2.8
Parameters:
aUrl The url requiring authentication
aRealm The realm requiring authentication
aDefaultUserName The user name that was used before for this realm and path, if any
aReturnedUserName The user name entered by the user
aReturnedPasswd The password entered by the user
aBasicAuthentication A flag if basic authentication was used
Returns:
EFalse if the user canceled, ETrue otherwise

Definition at line 109 of file BrCtlSampleAppDialogsProvider.h.

00115             {
00116             return EFalse;
00117             }

virtual void CBrCtlSampleAppDialogsProvider::DialogNoteL (  const TDesC &   )  [inline, virtual]
 

Display a note to the user. No softkeys

Since:
2.8
Parameters:
aMessage The message to display
Returns:
void

Definition at line 126 of file BrCtlSampleAppDialogsProvider.h.

00127             {
00128             }

void CBrCtlSampleAppDialogsProvider::DialogAlertL (  const TDesC &  aTitle,
const TDesC &  aMessage
) 
 

Display a note to the user with ok softkey only

Since:
2.8
Parameters:
aTitle The title, could be empty
aMessage The message to display
Returns:
void

Definition at line 38 of file BrCtlSampleAppDialogsProvider.cpp.

00039     {
00040     _LIT(KEndMessage, "\n\n");
00041     HBufC* messagebody = HBufC::NewLC( aMessage.Length()+2 );
00042     messagebody->Des().Append( aMessage );
00043     messagebody->Des().Append(KEndMessage);
00044 
00045     HBufC* header = HBufC::NewLC( aTitle.Length() );
00046         header->Des().Append( aTitle );
00047 
00048     CAknMessageQueryDialog* dialog = 
00049                             CAknMessageQueryDialog::NewL( *messagebody );
00050 
00051     dialog->PrepareLC( R_AVKON_MESSAGE_QUERY_DIALOG );
00052     dialog->ButtonGroupContainer().MakeCommandVisible( 
00053                                                                                                         EAknSoftkeyCancel, EFalse );
00054 
00055     dialog->QueryHeading()->SetTextL( *header );
00056 
00057     dialog->RunLD();
00058 
00059     CleanupStack::PopAndDestroy( 2 );  // header , messagebody 
00060     }

virtual TBool CBrCtlSampleAppDialogsProvider::DialogConfirmL (  const TDesC &  ,
const TDesC &  ,
const TDesC &  ,
const TDesC & 
)  [inline, virtual]
 

Display confirmation message to the user

Since:
2.8
Parameters:
aTitle The title, could be empty
aMessage The message to display
aYesMessage The text to display on left softkey
aNoMessage The text to display on right softkey
Returns:
EFalse if the user canceled, ETrue otherwise

Definition at line 148 of file BrCtlSampleAppDialogsProvider.h.

00152             {
00153             return EFalse;
00154             }

virtual TBool CBrCtlSampleAppDialogsProvider::DialogPromptLC (  const TDesC &  ,
const TDesC &  ,
const TDesC &  ,
HBufC *& 
)  [inline, virtual]
 

Display input dialog to the user

Since:
2.8
Parameters:
aTitle The title, could be empty
aMessage The message to display
aDefaultInput The default input if available
aReturnedInput The input entered by the user. Returned on the cleanup stack
Returns:
EFalse if the user canceled, ETrue otherwise

Definition at line 165 of file BrCtlSampleAppDialogsProvider.h.

00169             {
00170             return EFalse;
00171             }

virtual TBool CBrCtlSampleAppDialogsProvider::DialogDownloadObjectL (  CBrCtlObjectInfo *   )  [inline, virtual]
 

Display object info and ask confirmation before download

Since:
2.8
Parameters:
aBrCtlObjectInfo The object info
Returns:
EFalse if the user canceled, ETrue otherwise

Definition at line 179 of file BrCtlSampleAppDialogsProvider.h.

00180             {
00181             return EFalse;
00182             }

virtual void CBrCtlSampleAppDialogsProvider::DialogDisplayPageImagesL (  CArrayFixFlat< TBrCtlImageCarrier > &   )  [inline, virtual]
 

DIsplay the images that appear in the current page

Since:
2.8
Parameters:
aPageImages The images that appear in this page
Returns:
vois

Definition at line 190 of file BrCtlSampleAppDialogsProvider.h.

00191             {
00192             }

virtual void CBrCtlSampleAppDialogsProvider::CancelAll (   )  [inline, virtual]
 

Cancel any dialog that is being displayed due to e.g. Browser exit or page was destroyed

Since:
2.8
Returns:
void

Definition at line 199 of file BrCtlSampleAppDialogsProvider.h.

00200             {
00201             }

virtual void CBrCtlSampleAppDialogsProvider::DialogFindL (   )  [inline, virtual]
 

Display search on page dialog

Since:
3.0
Returns:
void

Definition at line 208 of file BrCtlSampleAppDialogsProvider.h.

00209             {
00210             }

void CBrCtlSampleAppDialogsProvider::ConstructL (  CBrCtlSampleAppContainer *  aContainer  )  [private]
 

By default Symbian 2nd phase constructor is private.

Definition at line 66 of file BrCtlSampleAppDialogsProvider.cpp.

References iContainer.

00067     {
00068     iContainer = aContainer;
00069     }

© Nokia 2006

Back to top