mobilemessaging/smilui/playerinc/SmilPlayerIndicatorController.h
author hgs
Wed, 03 Nov 2010 09:52:46 +0530
changeset 79 2981cb3aa489
permissions -rw-r--r--
201041
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
79
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2005 Nokia Corporation and/or its subsidiary(-ies).
hgs
parents:
diff changeset
     3
* All rights reserved.
hgs
parents:
diff changeset
     4
* This component and the accompanying materials are made available
hgs
parents:
diff changeset
     5
* under the terms of "Eclipse Public License v1.0"
hgs
parents:
diff changeset
     6
* which accompanies this distribution, and is available
hgs
parents:
diff changeset
     7
* at the URL "http://www.eclipse.org/legal/epl-v10.html".
hgs
parents:
diff changeset
     8
*
hgs
parents:
diff changeset
     9
* Initial Contributors:
hgs
parents:
diff changeset
    10
* Nokia Corporation - initial contribution.
hgs
parents:
diff changeset
    11
*
hgs
parents:
diff changeset
    12
* Contributors:
hgs
parents:
diff changeset
    13
*
hgs
parents:
diff changeset
    14
* Description: SmilPlayerIndicatorController  declaration
hgs
parents:
diff changeset
    15
*
hgs
parents:
diff changeset
    16
*/
hgs
parents:
diff changeset
    17
hgs
parents:
diff changeset
    18
hgs
parents:
diff changeset
    19
#ifndef SMILPLAYERINDICATORCONTROLLER_H
hgs
parents:
diff changeset
    20
#define SMILPLAYERINDICATORCONTROLLER_H
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
// INCLUDES
hgs
parents:
diff changeset
    23
#include <coecntrl.h>
hgs
parents:
diff changeset
    24
#include <coecobs.h>
hgs
parents:
diff changeset
    25
#include "SmilPlayerTimeObserver.h"
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    28
class CSmilPlayerPresentationController;
hgs
parents:
diff changeset
    29
class CSmilPlayerVolumeIndicatorController;
hgs
parents:
diff changeset
    30
class CSmilPlayerTimeIndicatorTimer;
hgs
parents:
diff changeset
    31
class CSmilPlayerPauseIndicatorTimer;
hgs
parents:
diff changeset
    32
class CEikLabel;
hgs
parents:
diff changeset
    33
class CEikImage;
hgs
parents:
diff changeset
    34
class CCoeBrushAndPenContext;
hgs
parents:
diff changeset
    35
class TAknsItemID;
hgs
parents:
diff changeset
    36
hgs
parents:
diff changeset
    37
// CLASS DECLARATION
hgs
parents:
diff changeset
    38
/**
hgs
parents:
diff changeset
    39
*  Controller class of the indicators.
hgs
parents:
diff changeset
    40
*/
hgs
parents:
diff changeset
    41
NONSHARABLE_CLASS(CSmilPlayerIndicatorController) : public CCoeControl,
hgs
parents:
diff changeset
    42
                                                    public MCoeForegroundObserver,
hgs
parents:
diff changeset
    43
                                                    public MCoeControlObserver,
hgs
parents:
diff changeset
    44
                                                    public MSmilPlayerTimeObserver
hgs
parents:
diff changeset
    45
    {
hgs
parents:
diff changeset
    46
    public: // Constructors and destructor
hgs
parents:
diff changeset
    47
hgs
parents:
diff changeset
    48
        /**
hgs
parents:
diff changeset
    49
        * Constructor.
hgs
parents:
diff changeset
    50
        *
hgs
parents:
diff changeset
    51
        * @param aParent         Parent control.
hgs
parents:
diff changeset
    52
        * @param aPresController Presentation controller.
hgs
parents:
diff changeset
    53
        * @param aVolumeEnabled  Specifies whether volume is enabled.
hgs
parents:
diff changeset
    54
        *
hgs
parents:
diff changeset
    55
        * @return pointer to the object
hgs
parents:
diff changeset
    56
        */
hgs
parents:
diff changeset
    57
        static CSmilPlayerIndicatorController * NewL( const CCoeControl* aParent, 
hgs
parents:
diff changeset
    58
                                                      CSmilPlayerPresentationController* aPresController,
hgs
parents:
diff changeset
    59
                                                      TBool aVolumeEnabled );
hgs
parents:
diff changeset
    60
hgs
parents:
diff changeset
    61
        /**
hgs
parents:
diff changeset
    62
        * Destructor.
hgs
parents:
diff changeset
    63
        */
hgs
parents:
diff changeset
    64
        virtual ~CSmilPlayerIndicatorController();
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
    public: // Functions from base classes
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
        /**
hgs
parents:
diff changeset
    69
        * From CoeControl
hgs
parents:
diff changeset
    70
        * See the documentation from the coecntrl.h
hgs
parents:
diff changeset
    71
        */
hgs
parents:
diff changeset
    72
        TInt CountComponentControls() const;
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
        /**
hgs
parents:
diff changeset
    75
        * From CCoeControl
hgs
parents:
diff changeset
    76
        * See the documentation from the coecntrl.h
hgs
parents:
diff changeset
    77
        */
hgs
parents:
diff changeset
    78
        CCoeControl* ComponentControl(TInt aIndex) const;
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
        /**
hgs
parents:
diff changeset
    81
        * From CCoeControl
hgs
parents:
diff changeset
    82
        * See the documentation from the coecntrl.h
hgs
parents:
diff changeset
    83
        */
hgs
parents:
diff changeset
    84
        TKeyResponse OfferKeyEventL( const TKeyEvent& aKeyEvent,
hgs
parents:
diff changeset
    85
                                     TEventCode aType );
hgs
parents:
diff changeset
    86
                                  
hgs
parents:
diff changeset
    87
        /**
hgs
parents:
diff changeset
    88
        * From MSmilPlayerTimeObserver
hgs
parents:
diff changeset
    89
        * See the documentation from the SmilPlayerTimeObserver.h
hgs
parents:
diff changeset
    90
        */
hgs
parents:
diff changeset
    91
        void TimeChangedL( const TDesC& aTimeString );
hgs
parents:
diff changeset
    92
        
hgs
parents:
diff changeset
    93
        /**
hgs
parents:
diff changeset
    94
        * From MSmilPlayerTimeObserver
hgs
parents:
diff changeset
    95
        * See the documentation from the SmilPlayerTimeObserver.h
hgs
parents:
diff changeset
    96
        */
hgs
parents:
diff changeset
    97
        TInt CurrentTime() const;
hgs
parents:
diff changeset
    98
        
hgs
parents:
diff changeset
    99
        /**
hgs
parents:
diff changeset
   100
        * From MSmilPlayerTimeObserver
hgs
parents:
diff changeset
   101
        * See the documentation from the SmilPlayerTimeObserver.h
hgs
parents:
diff changeset
   102
        */
hgs
parents:
diff changeset
   103
        TInt PresentationDuration() const;
hgs
parents:
diff changeset
   104
        
hgs
parents:
diff changeset
   105
        /**
hgs
parents:
diff changeset
   106
        * From MSmilPlayerTimeObserver
hgs
parents:
diff changeset
   107
        * See the documentation from the SmilPlayerTimeObserver.h
hgs
parents:
diff changeset
   108
        */
hgs
parents:
diff changeset
   109
        TBool IsDurationFinite() const;
hgs
parents:
diff changeset
   110
        
hgs
parents:
diff changeset
   111
        /**
hgs
parents:
diff changeset
   112
        * From MCoeForegroundObserver 
hgs
parents:
diff changeset
   113
        * See the documentation from the coemain.h
hgs
parents:
diff changeset
   114
        */   
hgs
parents:
diff changeset
   115
        void HandleGainingForeground();
hgs
parents:
diff changeset
   116
hgs
parents:
diff changeset
   117
        /**
hgs
parents:
diff changeset
   118
        * From MCoeForegroundObserver 
hgs
parents:
diff changeset
   119
        * See the documentation from the coemain.h
hgs
parents:
diff changeset
   120
        */   
hgs
parents:
diff changeset
   121
        void HandleLosingForeground();
hgs
parents:
diff changeset
   122
        
hgs
parents:
diff changeset
   123
        /** 
hgs
parents:
diff changeset
   124
        * From MCoeControlObserver 
hgs
parents:
diff changeset
   125
        * See the documentation from the coecobs.h
hgs
parents:
diff changeset
   126
        */
hgs
parents:
diff changeset
   127
	    void HandleControlEventL( CCoeControl* aControl, TCoeEvent aEventType );
hgs
parents:
diff changeset
   128
        
hgs
parents:
diff changeset
   129
        /** 
hgs
parents:
diff changeset
   130
        * From CCoeControl 
hgs
parents:
diff changeset
   131
        * See the documentation from the coecntrl.h
hgs
parents:
diff changeset
   132
        */
hgs
parents:
diff changeset
   133
        void HandlePointerEventL( const TPointerEvent& aPointerEvent );
hgs
parents:
diff changeset
   134
        
hgs
parents:
diff changeset
   135
        /** 
hgs
parents:
diff changeset
   136
        * From CCoeControl 
hgs
parents:
diff changeset
   137
        * See the documentation from the coecntrl.h
hgs
parents:
diff changeset
   138
        */
hgs
parents:
diff changeset
   139
        void HandleResourceChange( TInt aType );
hgs
parents:
diff changeset
   140
        
hgs
parents:
diff changeset
   141
    public: // new functions
hgs
parents:
diff changeset
   142
        
hgs
parents:
diff changeset
   143
        /**
hgs
parents:
diff changeset
   144
        * Performs approriate tasks when presentation has been stopped.
hgs
parents:
diff changeset
   145
        *
hgs
parents:
diff changeset
   146
        * @since 3.0
hgs
parents:
diff changeset
   147
        */
hgs
parents:
diff changeset
   148
        void Stop();
hgs
parents:
diff changeset
   149
        
hgs
parents:
diff changeset
   150
        /**
hgs
parents:
diff changeset
   151
        * Performs approriate tasks when presentation has been started.
hgs
parents:
diff changeset
   152
        *
hgs
parents:
diff changeset
   153
        * @since 3.0
hgs
parents:
diff changeset
   154
        */
hgs
parents:
diff changeset
   155
        void Start();
hgs
parents:
diff changeset
   156
        
hgs
parents:
diff changeset
   157
        /**
hgs
parents:
diff changeset
   158
        * Performs approriate tasks when presentation has been resumed.
hgs
parents:
diff changeset
   159
        *
hgs
parents:
diff changeset
   160
        * @since 3.0
hgs
parents:
diff changeset
   161
        */
hgs
parents:
diff changeset
   162
        void Resume();
hgs
parents:
diff changeset
   163
        
hgs
parents:
diff changeset
   164
        /**
hgs
parents:
diff changeset
   165
        * Performs approriate tasks when presentation has been paused.
hgs
parents:
diff changeset
   166
        *
hgs
parents:
diff changeset
   167
        * @since 3.0
hgs
parents:
diff changeset
   168
        */
hgs
parents:
diff changeset
   169
        void Pause();
hgs
parents:
diff changeset
   170
        
hgs
parents:
diff changeset
   171
        /**
hgs
parents:
diff changeset
   172
        * Performs approriate tasks when presentation end has been reached.
hgs
parents:
diff changeset
   173
        *
hgs
parents:
diff changeset
   174
        * @since 3.0
hgs
parents:
diff changeset
   175
        */
hgs
parents:
diff changeset
   176
        void EndReached();
hgs
parents:
diff changeset
   177
hgs
parents:
diff changeset
   178
        /**
hgs
parents:
diff changeset
   179
        * Returns current volume value.
hgs
parents:
diff changeset
   180
        *
hgs
parents:
diff changeset
   181
        * @since 3.0
hgs
parents:
diff changeset
   182
        *
hgs
parents:
diff changeset
   183
        * @return Current volume level.
hgs
parents:
diff changeset
   184
        */
hgs
parents:
diff changeset
   185
        TInt VolumeValue() const;
hgs
parents:
diff changeset
   186
        
hgs
parents:
diff changeset
   187
        /**
hgs
parents:
diff changeset
   188
        * Sets correct layout for indicator.
hgs
parents:
diff changeset
   189
        *
hgs
parents:
diff changeset
   190
        * @since 3.0
hgs
parents:
diff changeset
   191
        */
hgs
parents:
diff changeset
   192
        void LayoutIndicators();
hgs
parents:
diff changeset
   193
        
hgs
parents:
diff changeset
   194
    private:
hgs
parents:
diff changeset
   195
hgs
parents:
diff changeset
   196
        /**
hgs
parents:
diff changeset
   197
        * C++ constructor.
hgs
parents:
diff changeset
   198
        */
hgs
parents:
diff changeset
   199
        CSmilPlayerIndicatorController ( CSmilPlayerPresentationController* aPresController );
hgs
parents:
diff changeset
   200
hgs
parents:
diff changeset
   201
        /**
hgs
parents:
diff changeset
   202
        * By default Symbian 2nd phase constructor is private.
hgs
parents:
diff changeset
   203
        */
hgs
parents:
diff changeset
   204
        void ConstructL( const CCoeControl* aParent, 
hgs
parents:
diff changeset
   205
                         TBool aVolumeEnabled );
hgs
parents:
diff changeset
   206
        
hgs
parents:
diff changeset
   207
        /**
hgs
parents:
diff changeset
   208
        * Initializes indicator.
hgs
parents:
diff changeset
   209
        */
hgs
parents:
diff changeset
   210
        void InitializeIconIndicatorL( CEikImage*& aIndicator, 
hgs
parents:
diff changeset
   211
                                      const TAknsItemID& aItem, 
hgs
parents:
diff changeset
   212
                                      const TInt aBitmapIndex,
hgs
parents:
diff changeset
   213
                                      const TInt aMaskIndex ) const;
hgs
parents:
diff changeset
   214
                                      
hgs
parents:
diff changeset
   215
        
hgs
parents:
diff changeset
   216
        /**
hgs
parents:
diff changeset
   217
        * Handles skin change event.
hgs
parents:
diff changeset
   218
        */
hgs
parents:
diff changeset
   219
        void DoHandleSkinChangeL();
hgs
parents:
diff changeset
   220
        
hgs
parents:
diff changeset
   221
        /**
hgs
parents:
diff changeset
   222
        * Updates the text color from currently used skin.
hgs
parents:
diff changeset
   223
        */
hgs
parents:
diff changeset
   224
        void UpdateTextColorL();
hgs
parents:
diff changeset
   225
        
hgs
parents:
diff changeset
   226
        /**
hgs
parents:
diff changeset
   227
        * Sets correct bitmap for icon indicator.
hgs
parents:
diff changeset
   228
        */
hgs
parents:
diff changeset
   229
        void SetIconIndicatorBitmapL( CEikImage*& aIndicator, 
hgs
parents:
diff changeset
   230
                                      const TAknsItemID& aItem, 
hgs
parents:
diff changeset
   231
                                      const TInt aBitmapIndex,
hgs
parents:
diff changeset
   232
                                      const TInt aMaskIndex ) const;
hgs
parents:
diff changeset
   233
        
hgs
parents:
diff changeset
   234
        /**
hgs
parents:
diff changeset
   235
        * Sets specified icons extent to given one.
hgs
parents:
diff changeset
   236
        */
hgs
parents:
diff changeset
   237
        void SetIconIndicatorExtent( CEikImage* aIconIndicator,
hgs
parents:
diff changeset
   238
                                     TRect aExtent ) const;
hgs
parents:
diff changeset
   239
        
hgs
parents:
diff changeset
   240
    private: // data
hgs
parents:
diff changeset
   241
hgs
parents:
diff changeset
   242
        /** Controller class for this class */
hgs
parents:
diff changeset
   243
        CSmilPlayerPresentationController* iPresController;
hgs
parents:
diff changeset
   244
        
hgs
parents:
diff changeset
   245
        /** Controller class for volume indicator */
hgs
parents:
diff changeset
   246
        CSmilPlayerVolumeIndicatorController* iVolumeController;
hgs
parents:
diff changeset
   247
        
hgs
parents:
diff changeset
   248
        /** Model class for time control. */
hgs
parents:
diff changeset
   249
        CSmilPlayerTimeIndicatorTimer* iTimeModel;
hgs
parents:
diff changeset
   250
        
hgs
parents:
diff changeset
   251
        /** View class for time control*/
hgs
parents:
diff changeset
   252
        CEikLabel* iTimeIndicator;
hgs
parents:
diff changeset
   253
        
hgs
parents:
diff changeset
   254
        /** View class for pause indicator. */
hgs
parents:
diff changeset
   255
        CEikImage* iPauseIndicator;
hgs
parents:
diff changeset
   256
        
hgs
parents:
diff changeset
   257
        /** View class for play indicator. */
hgs
parents:
diff changeset
   258
        CEikImage* iPlayIndicator;
hgs
parents:
diff changeset
   259
        
hgs
parents:
diff changeset
   260
        /** Specifies whether time indicator should be shown. */
hgs
parents:
diff changeset
   261
        TBool iShowTimeIndicator;
hgs
parents:
diff changeset
   262
    };
hgs
parents:
diff changeset
   263
hgs
parents:
diff changeset
   264
#endif // SMILPLAYERINDICATORCONTROLLER_H
hgs
parents:
diff changeset
   265
hgs
parents:
diff changeset
   266
// End of File