idlehomescreen/examples/carouselwidgetexample/publisher/inc/carouselpluginwatcher.h
author jake
Mon, 02 Aug 2010 12:02:47 +0300
branchRCL_3
changeset 70 d12a7ea0f775
permissions -rw-r--r--
Example applications for various Homescreen APIs.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
70
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     1
/*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies).
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     3
* All rights reserved.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     4
* This component and the accompanying materials are made available
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     6
* which accompanies this distribution, and is available
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     8
*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
     9
* Initial Contributors:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    11
*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    12
* Contributors:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    13
*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    14
* Description:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    15
*
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    16
*/
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    17
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    18
#ifndef __MCSPLUGINWATCHER_H
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    19
#define __MCSPLUGINWATCHER_H
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    20
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    21
#include <e32base.h>
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    22
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    23
class CMenuOperation;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    24
class CCarouselPluginEngine;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    25
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    26
/**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    27
 *  @ingroup group_mcsplugin
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    28
 *
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    29
 *  MCS Plugin Watcher Observer
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    30
 *
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    31
 *  @since S60 9.1
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    32
 */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    33
class MCarouselPluginWatcherObserver
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    34
    {
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    35
    public:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    36
    /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    37
     * HandleNotifyL
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    38
     */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    39
    virtual void HandleNotifyL() = 0;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    40
    };
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    41
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    42
/**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    43
 *  @ingroup group_mcsplugin
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    44
 *
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    45
 *  This class implements MCS menu action watcher for async calls.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    46
 * 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    47
 *  @since S60 9.1
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    48
 */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    49
class CCarouselPluginWatcher: public CActive
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    50
    {
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    51
    public:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    52
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    53
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    54
         * enum Type
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    55
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    56
        enum Type
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    57
            {
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    58
            EOperation,
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    59
            ENotify
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    60
            };
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    61
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    62
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    63
         * Two-phased constructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    64
         * 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    65
         * @param aType
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    66
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    67
        static CCarouselPluginWatcher* NewL( const Type& aType );
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    68
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    69
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    70
         * Destructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    71
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    72
        virtual ~CCarouselPluginWatcher();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    73
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    74
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    75
         * Watch menu operation or notification.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    76
         * 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    77
         * @param aOperation
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    78
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    79
        void Watch( CMenuOperation* aOperation = NULL );
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    80
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    81
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    82
         * WatchNotify
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    83
         * 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    84
         * @param aObserver
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    85
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    86
        void WatchNotify( MCarouselPluginWatcherObserver* aObserver );
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    87
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    88
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    89
         * StopAndWatch
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    90
         * 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    91
         * @param aOperation
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    92
         * @param aWaitScheduler
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    93
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    94
        void StopAndWatch( CMenuOperation* aOperation, 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    95
                           CActiveSchedulerWait* aWaitScheduler );
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    96
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    97
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    98
         * GetStatus 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
    99
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   100
        TInt GetStatus();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   101
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   102
    private:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   103
    
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   104
        /** 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   105
         * Default constructor.
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   106
         * 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   107
         * @param aType
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   108
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   109
        CCarouselPluginWatcher( const Type& aType );
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   110
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   111
        /** 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   112
         * ConstructL
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   113
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   114
        void ConstructL();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   115
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   116
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   117
        * Inherited from CActive class 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   118
        */ 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   119
        void RunL();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   120
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   121
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   122
        * Inherited from CActive class 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   123
        */ 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   124
        void DoCancel();
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   125
    
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   126
    private:
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   127
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   128
        /** 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   129
         * Menu operation
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   130
         * Owned
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   131
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   132
        CMenuOperation* iOperation; 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   133
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   134
        /**
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   135
         * Wait scheduler
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   136
         * Not owned
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   137
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   138
        CActiveSchedulerWait* iWaitScheduler;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   139
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   140
        /** 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   141
         * Observer reference
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   142
         * Not owned
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   143
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   144
        MCarouselPluginWatcherObserver* iObserver;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   145
        
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   146
        /** 
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   147
         * iType
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   148
         */
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   149
        Type iType;
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   150
    };
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   151
d12a7ea0f775 Example applications for various Homescreen APIs.
jake
parents:
diff changeset
   152
#endif /*__MCSPLUGINWATCHER_H*/