Showing a global progress dialog using CAknGlobalProgressDialog
hamishwillee
(Talk | contribs) m (Removed protection from "CS001062 - Showing a global progress dialog using CAknGlobalProgressDialog") |
m (Lpvalente -) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
| − | + | [[Category:Symbian C++]][[Category:Code Snippet]][[Category:Files/Data]][[Category:Code Snippet]][[Category:S60 3rd Edition (initial release)]][[Category:S60 3rd Edition FP1]] | |
| − | + | {{Archived|timestamp=20120919125851|user=[[User:Lpvalente|Lpvalente]]}} | |
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | + | ||
| − | | | + | |
| − | | | + | |
| + | |||
| + | {{ArticleMetaData <!-- v1.2 --> | ||
|sourcecode= <!-- Link to example source code (e.g. [[Media:The Code Example ZIP.zip]]) --> | |sourcecode= <!-- Link to example source code (e.g. [[Media:The Code Example ZIP.zip]]) --> | ||
|installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) --> | |installfile= <!-- Link to installation file (e.g. [[Media:The Installation File.sis]]) --> | ||
| − | |sdk=<!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) --> | + | |devices= Nokia N93 |
| − | |devicecompatability=<!-- Compatible devices (e.g.: All* (must have GPS) ) --> | + | |sdk= <!-- SDK(s) built and tested against (e.g. [http://linktosdkdownload/ Nokia Qt SDK 1.1]) --> |
| − | |signing=<!-- Empty or one of Self-Signed, DevCert, Manufacturer --> | + | |platform= S60 3rd Edition, FP1 |
| − | |capabilities=<!-- Capabilities required (e.g. Location, NetworkServices. -->) | + | |devicecompatability= <!-- Compatible devices (e.g.: All* (must have GPS) ) --> |
| − | |author=[[User:Aknyman]] | + | |dependencies= <!-- Any other/external dependencies e.g.: Google Maps Api v1.0 --> |
| + | |signing= <!-- Empty or one of Self-Signed, DevCert, Manufacturer --> | ||
| + | |capabilities= <!-- Capabilities required by the article/code example (e.g. Location, NetworkServices. --> | ||
| + | |keywords= CAknGlobalProgressDialog, StringLoader, CPeriodic, CAknGlobalProgressDialog::NewL(), CAknGlobalProgressDialog::ShowProgressDialogL(), CAknGlobalProgressDialog::UpdateProgressDialog(), CAknGlobalProgressDialog::ProcessFinished(), StringLoader::LoadLC(), CPeriodic::NewL(), CPeriodic::Start() | ||
| + | |language= <!-- Language category code for non-English topics - e.g. Lang-Chinese --> | ||
| + | |translated-by= <!-- [[User:XXXX]] --> | ||
| + | |translated-from-title= <!-- Title only --> | ||
| + | |translated-from-id= <!-- Id of translated revision --> | ||
| + | |review-by= <!-- After re-review: [[User:username]] --> | ||
| + | |review-timestamp= <!-- After re-review: YYYYMMDD --> | ||
| + | |update-by= <!-- After significant update: [[User:username]]--> | ||
| + | |update-timestamp= <!-- After significant update: YYYYMMDD --> | ||
| + | |creationdate= 20080613 | ||
| + | |author= [[User:Aknyman]] | ||
| + | <!-- The following are not in current metadata --> | ||
| + | |subcategory= Files/Data | ||
| + | |id= CS001062 | ||
}} | }} | ||
==Overview== | ==Overview== | ||
| − | This code snippet shows how to create a global progress dialog | + | {{Abstract|This code snippet shows how to create a global progress dialog {{Icode|CAknGlobalProgressDialog}}. A global progress dialog is constructed by calling the {{Icode|NewL()}} method and is executed using the {{Icode|ShowProgressDialogL()}} method. An active object has to be constructed to handle the dismissal of the dialog. This example uses the generic class {{Icode|CGlobalQueryHandlerAO}} that is also used with other global query code snippets. The class {{Icode|CGlobalQueryContainer}} is used to launch the query and it is also the observer that implements the interface {{Icode|MGlobalQueryObserver}}. }} |
This snippet can be self-signed. | This snippet can be self-signed. | ||
| Line 30: | Line 39: | ||
<code> | <code> | ||
| − | LIBRARY | + | LIBRARY cone.lib //CEikonEnv, CCoeEnv |
| − | LIBRARY | + | LIBRARY avkon.lib //Avkon resources |
| − | LIBRARY | + | LIBRARY CommonEngine.lib //StringLoader |
| − | LIBRARY | + | LIBRARY euser.lib //CActive, CleanupStack, CPeriodic |
</code> | </code> | ||
| Line 135: | Line 144: | ||
CAknGlobalProgressDialog* iGlobalProgressDialog; | CAknGlobalProgressDialog* iGlobalProgressDialog; | ||
CPeriodic* iTimer; | CPeriodic* iTimer; | ||
| − | TInt | + | TInt iCurrentExampleStep; |
}; | }; | ||
#endif // GLOBALQUERYCONTAINER_H | #endif // GLOBALQUERYCONTAINER_H | ||
| Line 294: | Line 303: | ||
==See also== | ==See also== | ||
| − | * [[ | + | * [[Showing a global message query using CAknGlobalMsgQuery]] |
| − | * [[ | + | * [[Showing a global confirmation query using CAknGlobalConfirmationQuery]] |
| − | * [[ | + | * [[Showing a global list query using CAknGlobalListQuery]] |
| − | <!-- [[ | + | <!-- [[Showing a global progress dialog using CAknGlobalProgressDialog]]--> |
| − | + | ||
| − | + | ||
Latest revision as of 15:58, 19 September 2012
The article is believed to be still valid for the original topic scope.
Article Metadata
Tested with
Compatibility
Article
Contents |
Overview
This code snippet shows how to create a global progress dialog CAknGlobalProgressDialog. A global progress dialog is constructed by calling the NewL() method and is executed using the ShowProgressDialogL() method. An active object has to be constructed to handle the dismissal of the dialog. This example uses the generic class CGlobalQueryHandlerAO that is also used with other global query code snippets. The class CGlobalQueryContainer is used to launch the query and it is also the observer that implements the interface MGlobalQueryObserver.
This snippet can be self-signed.
MMP file
The following libraries are required:
LIBRARY cone.lib //CEikonEnv, CCoeEnv
LIBRARY avkon.lib //Avkon resources
LIBRARY CommonEngine.lib //StringLoader
LIBRARY euser.lib //CActive, CleanupStack, CPeriodic
Resource file
.rss
#include <eikon.rh>
#include <avkon.rsg>
#include <avkon.rh>
//...
RESOURCE TBUF r_global_query_progress_text
{
buf = "<progress dialog text here>";
}
Header files
- observer interface
#ifndef GLOBALQUERYOBSERVER_H
#define GLOBALQUERYOBSERVER_H
class MGlobalQueryObserver
{
public:
//keep these methods short running because they are called
//from within an active object
virtual void ProcessOkOptionL() = 0;
virtual void ProcessCancelOptionL() = 0;
virtual void ProcessDoneOptionL() = 0;
virtual void ProcessSelectedItemL(const TInt aItem) = 0;
};
#endif // GLOBALQUERYOBSERVER_H
- handler active object
#ifndef GLOBALQUERYHANDLERAO_H
#define GLOBALQUERYHANDLERAO_H
#include <e32base.h> //CActive
#include "GlobalQueryObserver.h"
class CGlobalQueryHandlerAO : public CActive
{
public:
~CGlobalQueryHandlerAO();
static CGlobalQueryHandlerAO* NewL(MGlobalQueryObserver& aObserver);
static CGlobalQueryHandlerAO* NewLC(MGlobalQueryObserver& aObserver);
public:
void StartHandler();
private:
CGlobalQueryHandlerAO(MGlobalQueryObserver& aObserver)
: CActive (EPriorityStandard), iObserver(aObserver){};
void ConstructL();
private: // from CActive
void RunL();
void DoCancel();
private: // data
MGlobalQueryObserver& iObserver;
};
#endif //GLOBALQUERYHANDLERAO_H
- container / observer
#ifndef GLOBALQUERYCONTAINER_H
#define GLOBALQUERYCONTAINER_H
#include <coecntrl.h> // CCoeControl
#include "GlobalQueryObserver.h"
#include <aknglobalprogressdialog.h> //CAknGlobalProgressDialog
const TInt KFinalExampleStep = 100;
class CGlobalQueryHandlerAO;
class CGlobalQueryContainer : public CCoeControl, MGlobalQueryObserver
{
public:
//...
void MakeExampleQueryL();
private:
//...
static TInt TimerCallback(TAny* aThis);
void GlobalExampleProcessTimerEvent();
public: // from MGlobalQueryObserver
void ProcessOkOptionL(); //not used
void ProcessCancelOptionL();
void ProcessDoneOptionL();
void ProcessSelectedItemL(const TInt aItem); //not used
//...
private:
CGlobalQueryHandlerAO* iQueryHandlerAO;
CAknGlobalProgressDialog* iGlobalProgressDialog;
CPeriodic* iTimer;
TInt iCurrentExampleStep;
};
#endif // GLOBALQUERYCONTAINER_H
Source files
- handler active object
#include "GlobalQueryHandlerAO.h"
#include <avkon.hrh> //EAknSoftkeyOk, EAknSoftkeyCancel, EAknSoftkeyDone
CGlobalQueryHandlerAO::~CGlobalQueryHandlerAO() { Cancel(); }
void CGlobalQueryHandlerAO::ConstructL()
{
CActiveScheduler::Add(this);
}
CGlobalQueryHandlerAO* CGlobalQueryHandlerAO::NewLC(MGlobalQueryObserver& aObserver)
{
CGlobalQueryHandlerAO* self = new (ELeave) CGlobalQueryHandlerAO(aObserver);
CleanupStack::PushL(self);
self->ConstructL();
return self;
}
CGlobalQueryHandlerAO* CGlobalQueryHandlerAO::NewL(MGlobalQueryObserver& aObserver)
{
CGlobalQueryHandlerAO* self = CGlobalQueryHandlerAO::NewLC(aObserver);
CleanupStack::Pop(self);
return self;
}
void CGlobalQueryHandlerAO::DoCancel(){}
void CGlobalQueryHandlerAO::StartHandler() { SetActive(); }
void CGlobalQueryHandlerAO::RunL()
{
if (iStatus == EAknSoftkeyOk)
iObserver.ProcessOkOptionL();
else if(iStatus == EAknSoftkeyCancel)
iObserver.ProcessCancelOptionL();
else if(iStatus == EAknSoftkeyDone)
iObserver.ProcessDoneOptionL();
else
iObserver.ProcessSelectedItemL(iStatus.Int());
Cancel();
}
- container / observer
#include "GlobalQueryContainer.h" //CGlobalQueryContainer
#include "GlobalQueryHandlerAO.h" //CGlobalQueryHandlerAO
#include <GlobalQuery_0xED0C36BE.rsg> //Resources
#include <StringLoader.h> // StringLoader
void CGlobalQueryContainer::ConstructL(const TRect& aRect)
{
CreateWindowL();
SetRect(aRect);
ActivateL();
MakeExampleQueryL();
}
void CGlobalQueryContainer::MakeExampleQueryL()
{
//start the query handler and show global progress dialog
iQueryHandlerAO = CGlobalQueryHandlerAO::NewL(*this);
iQueryHandlerAO->StartHandler();
iGlobalProgressDialog = CAknGlobalProgressDialog::NewL();
HBufC* progressText = StringLoader::LoadLC(R_GLOBAL_QUERY_PROGRESS_TEXT);
iCurrentExampleStep = 0;
iGlobalProgressDialog->ShowProgressDialogL(
iQueryHandlerAO->iStatus,
*progressText,
R_AVKON_SOFTKEYS_CANCEL);
//start example process and update the progress dialog
iTimer = CPeriodic::NewL(EPriorityLow);
iTimer->Start(1000, 1000, TCallBack(TimerCallback, this));
CleanupStack::PopAndDestroy(); //progressText
}
CGlobalQueryContainer::~CGlobalQueryContainer()
{
//...
delete iQueryHandlerAO;
delete iGlobalProgressDialog;
if(iTimer)
{
iTimer->Cancel();
delete iTimer;
}
}
TInt CGlobalQueryContainer::TimerCallback(TAny* aThis)
{
static_cast< CGlobalQueryContainer* >(aThis)->GlobalExampleProcessTimerEvent();
return 0;
}
void CGlobalQueryContainer::GlobalExampleProcessTimerEvent()
{
if (!iGlobalProgressDialog)
{
return;
}
iCurrentExampleStep++;
if (iCurrentExampleStep <= KFinalExampleStep)
{
iGlobalProgressDialog->UpdateProgressDialog(iCurrentExampleStep, KFinalExampleStep);
}
else
{
iGlobalProgressDialog->ProcessFinished();
iTimer->Cancel();
}
}
void CGlobalQueryContainer::ProcessOkOptionL()
{
//not used
}
void CGlobalQueryContainer::ProcessCancelOptionL()
{
//Cancel pressed, do something...
iEikonEnv->InfoWinL(_L("Cancel"),_L("Pressed"));
}
void CGlobalQueryContainer::ProcessDoneOptionL()
{
//Progress dialog ready, do something...
iEikonEnv->InfoWinL(_L("Progress"),_L("Done"));
}
void CGlobalQueryContainer::ProcessSelectedItemL(const TInt /*aItem*/)
{
//not used
}
Postconditions
The example code shows how to create a global progress dialog, update the progress bar, handle its dismissal, and how the active object handler informs an observer class that the dialog has been closed.

