landmarksui/uicontrols/inc/lmkwaitdlglauncher.h
branchRCL_3
changeset 18 870918037e16
parent 0 522cd55cc3d7
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/landmarksui/uicontrols/inc/lmkwaitdlglauncher.h	Wed Sep 01 12:31:27 2010 +0100
@@ -0,0 +1,141 @@
+/*
+* Copyright (c) 2006 Nokia Corporation and/or its subsidiary(-ies).
+* All rights reserved.
+* This component and the accompanying materials are made available
+* under the terms of "Eclipse Public License v1.0"
+* which accompanies this distribution, and is available
+* at the URL "http://www.eclipse.org/legal/epl-v10.html".
+*
+* Initial Contributors:
+* Nokia Corporation - initial contribution.
+*
+* Contributors:
+*
+* Description:    LandmarksUi Content File -    Encapuslates the Wait dialog in an Active Object interface
+*
+*/
+
+
+
+
+
+
+
+#ifndef CLMWAITDLGLAUNCHER_H
+#define CLMWAITDLGLAUNCHER_H
+
+// System Includes
+#include <AknWaitDialog.h>
+#include <AknProgressDialog.h>
+#include <e32base.h>
+
+// Class Declaration
+/**
+* MLmkDlgMenuObserver class
+*/
+class MLmkWaitDialogLauncherObserver
+    {
+    public: // New functions
+        virtual void HandleDialogDismissed( TInt aButtonId ) = 0;
+    };
+/**
+ * Class used to encapsulate the AknWaitDialog in an Active object interface.
+ * Provides the functionality to launch the Wait dialog in an asynchronous mode
+ * so that the current running context is not blocked.
+ */
+NONSHARABLE_CLASS ( CLmkWaitDialogLauncher ) : public CActive,
+                                               public MProgressDialogCallback
+    {
+    public:
+        /**
+         * Two phased constructor for creating the Wait dialog launcher.
+         *
+         * @return CLmkWaitDialogLauncher* Pointer to the created object.
+         */
+        static CLmkWaitDialogLauncher* NewL();
+
+        /**
+         * Destructor.
+         */
+        ~CLmkWaitDialogLauncher();
+
+        /**
+         * Issues an asynchronous request to start the Wait dialog. The termination
+         * of the dialog either when User terminated or when terminated using the
+         * StopWaitingDialog call will be notified using the MProgressDialogCallback
+         * observer object.
+         */
+        void StartWaitDialogL();
+
+        /**
+         * Issues an asynchronous request to the stop the running Wait dialog. The
+         * actual dismissal of the dialog will be communicated using the
+         * MProgressDialogCallback observer object.
+         *
+         * @return TInt The Button ID with which the dialog was dismissed
+         */
+        TInt StopWaitDialogL();
+
+        /**
+         * Sets an observer, so that, client can be notified about the
+         * button id, after the dialog dismissal.
+         */
+        void SetObserver( MLmkWaitDialogLauncherObserver* aObserver);
+
+    private:
+        /**
+         * Inherited from MProgressDialogCallback. The scope of the function is
+         * made private since, this should be called only from the
+         * MProgressDialogCallback interface and from the Wait dialog alone.
+         */
+        void DialogDismissedL( TInt aButtonId );
+
+    private:
+        /**
+         * Overloaded C++ constructor
+         */
+        CLmkWaitDialogLauncher();
+
+        /**
+         * Second phase constructor
+         */
+        void ConstructL();
+
+    protected:
+        /**
+         * Inherited from CActive
+         */
+        void RunL();
+
+        /**
+         * Inherited from CActive
+         */
+        void DoCancel();
+
+    private:
+
+        /**
+         * Button ID with which the dialog was cancelled
+         */
+        TInt                        iButtonId;
+
+        /**
+         * Wait Note
+         * Owns
+         */
+        CAknWaitDialog*             iWaitNote;
+
+        /**
+         * Active Scheduler re-loop to make Stop synchronous
+         */
+        CActiveSchedulerWait*       iSchedWait;
+        /**
+         * ref
+         * Observer for callback, when the dialog is dissmissed.
+         */
+        MLmkWaitDialogLauncherObserver*       iObserver;
+    };
+
+#endif // CLMWAITDLGLAUNCHER_H
+
+// End of File