usbengines/usbotgwatcher/inc/cusbnotifmanager.h
changeset 35 9d8b04ca6939
child 63 ef2686f7597e
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/usbengines/usbotgwatcher/inc/cusbnotifmanager.h	Fri Jun 04 10:27:39 2010 +0100
@@ -0,0 +1,184 @@
+/*
+ * Copyright (c) 2008 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:  Manages notifiers
+ *
+ */
+
+#ifndef C_USBNOTIFMANAGER_H
+#define C_USBNOTIFMANAGER_H
+
+#include <e32base.h>
+
+// forward declaration
+class CUsbNotifier;
+class CUsbIndicatorNotifier;
+class CUsbOtgWatcher;
+
+// pause warning is visible for (ms)
+const TUint KPauseForWarnings = 1000000; // 1 sec
+
+/**
+ * Observer has to implement this interface to get feedback on user action
+ * Notification received when Whait notified completed (cancelled ot key pressed) 
+ */
+NONSHARABLE_CLASS( MWaitNotifierObserver)
+    {
+public:
+
+    /**
+     * feedback to observer
+     * @param aFeedback how notifier comleted 
+     */
+    virtual void WaitNotifierCompletedL(TInt aFeedback) = 0;
+    };
+
+/**
+ * this class contains information for wait notifier
+ * once notifier gets response from user, notif manager will send feedback data to caller
+ */
+NONSHARABLE_CLASS( CWaitNotifierInfo ) : public CBase
+    {
+public:
+
+    /**
+     * 2-phase construction
+     * @param aWaitNotifier owner
+     * aObserver will receive notification when completed 
+     */
+    static CWaitNotifierInfo* NewL(CUsbNotifier* aWaitNotifier,
+            MWaitNotifierObserver& aObserver);
+
+    /**
+     * Destructor
+     */
+    virtual ~CWaitNotifierInfo();
+
+    /**
+     * gets wait notifier
+     */
+    CUsbNotifier* WaitNotifier() const;
+
+    /**
+     * gets observer
+     */
+    MWaitNotifierObserver* Observer() const;
+
+private:
+
+    /**
+     * Default constructor
+     * @param aWaitNotifier Notifier
+     * @param aObserver Observer
+     */
+    CWaitNotifierInfo(CUsbNotifier* aWaitNotifier,
+            MWaitNotifierObserver& aObserver);
+
+    /**
+     * 2nd phase construction
+     */
+    void ConstructL();
+
+private:
+
+    /**
+     * notifier
+     * owns
+     */
+    CUsbNotifier* iWaitNotifier;
+
+    /**
+     * observer
+     * not owns
+     */
+    MWaitNotifierObserver& iObserver;
+    };
+
+/**
+ *  Function of the class is own and share RNotifier, own list of CWaitNotifier(s),
+ *	show notifiers, which are synchronous, and cancel it with a delay 
+ */
+class CUsbNotifManager : public CBase
+    {
+    friend class CUsbNotifManager;
+
+public:
+
+    /**
+     * 2phase construction
+     * @param aOtgWatcher OtgWatcher is a parent class
+     */
+    static CUsbNotifManager* NewL(CUsbOtgWatcher& aOtgWatcher);
+
+    /**
+     * Destructor
+     */
+    virtual ~CUsbNotifManager();
+
+    /**
+     * Shows notifier
+     * @param aCat Category
+     * @param aNotifId notifier id
+     * @param aObserver will receive notifications
+     */
+    void ShowNotifierL(TUid aCat, TUint aNotifId,
+            MWaitNotifierObserver* aObserver);
+
+    /**
+     * Closes and deletes all the notifiers
+     */
+    void CloseAllNotifiers();
+
+    /** 
+     * Calls back Notifier show is over
+     * @param aWaitNotifier wait notifier
+     * @param aResult result (was any errors or not)
+     * @param aFeedback user press (cancel or any other) 
+     */
+    void NotifierShowCompletedL(CUsbNotifier& aWaitNotifier, TInt aResult,
+            TInt aFeedback);
+
+private:
+
+    /**
+     * Default construction
+     * @param aOtgWatcher otg watcher (parent class)
+     */
+    CUsbNotifManager();
+
+    /**
+     * Second phase construction
+     */
+    void ConstructL(CUsbOtgWatcher& aOtgWatcher);
+
+private:
+    // data
+
+    /**
+     * RNotifier API
+     */
+    RNotifier iNotifier;
+
+    /**
+     * List of notifiers waiting for user action
+     */
+    RPointerArray<CWaitNotifierInfo> iWaitNotifiers;
+
+    /**
+     * Own
+     * USB indicator
+     */
+    CUsbIndicatorNotifier* iIndicatorNotifier;
+    };
+
+#endif // C_USBNOTIFMANAGER_H