mobilemessaging/postcard/postcardinc/PostcardController.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: PostcardController  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 POSTCARDCONTROLLER
hgs
parents:
diff changeset
    20
#define POSTCARDCONTROLLER
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <e32base.h>
hgs
parents:
diff changeset
    23
#include <coecntrl.h>
hgs
parents:
diff changeset
    24
#include <AknsItemID.h>
hgs
parents:
diff changeset
    25
#include "PostcardDocument.h"
hgs
parents:
diff changeset
    26
#ifdef RD_SCALABLE_UI_V2
hgs
parents:
diff changeset
    27
#include "PostcardPointerObserver.h"
hgs
parents:
diff changeset
    28
#endif
hgs
parents:
diff changeset
    29
hgs
parents:
diff changeset
    30
// FOWARD DECLARTIONS
hgs
parents:
diff changeset
    31
class CGulIcon;
hgs
parents:
diff changeset
    32
class CAknsBasicBackgroundControlContext;
hgs
parents:
diff changeset
    33
hgs
parents:
diff changeset
    34
// CLASS DECLARATION
hgs
parents:
diff changeset
    35
/**
hgs
parents:
diff changeset
    36
*  Container control class.
hgs
parents:
diff changeset
    37
*  
hgs
parents:
diff changeset
    38
*/
hgs
parents:
diff changeset
    39
class CPostcardController : public CCoeControl
hgs
parents:
diff changeset
    40
    {
hgs
parents:
diff changeset
    41
    public: // Constructors and destructor
hgs
parents:
diff changeset
    42
        /**
hgs
parents:
diff changeset
    43
        * Constructor.
hgs
parents:
diff changeset
    44
        * @return pointer to the object
hgs
parents:
diff changeset
    45
        */
hgs
parents:
diff changeset
    46
        static CPostcardController* NewL( CPostcardDocument& aDocument
hgs
parents:
diff changeset
    47
#ifdef RD_SCALABLE_UI_V2
hgs
parents:
diff changeset
    48
            , MPocaPointerEventObserver& aObserver
hgs
parents:
diff changeset
    49
#endif
hgs
parents:
diff changeset
    50
        );
hgs
parents:
diff changeset
    51
hgs
parents:
diff changeset
    52
        /**
hgs
parents:
diff changeset
    53
        * Destructor.
hgs
parents:
diff changeset
    54
        */
hgs
parents:
diff changeset
    55
        ~CPostcardController();
hgs
parents:
diff changeset
    56
hgs
parents:
diff changeset
    57
    public: // New functions
hgs
parents:
diff changeset
    58
hgs
parents:
diff changeset
    59
        /**
hgs
parents:
diff changeset
    60
        * Returns ETrue if front page is focused.
hgs
parents:
diff changeset
    61
        */
hgs
parents:
diff changeset
    62
        TBool Frontpage( );
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
        /**
hgs
parents:
diff changeset
    65
        * Returns ETrue if aPart is focused
hgs
parents:
diff changeset
    66
        */
hgs
parents:
diff changeset
    67
        TBool IsFocused( TPostcardPart& aPart );
hgs
parents:
diff changeset
    68
hgs
parents:
diff changeset
    69
        /**
hgs
parents:
diff changeset
    70
        * Returns the focused part
hgs
parents:
diff changeset
    71
        */
hgs
parents:
diff changeset
    72
        TPostcardPart Focused( );
hgs
parents:
diff changeset
    73
hgs
parents:
diff changeset
    74
        /**
hgs
parents:
diff changeset
    75
        * Sets aPart as focused item
hgs
parents:
diff changeset
    76
        */
hgs
parents:
diff changeset
    77
        void SetFocused( TPostcardPart aPart );
hgs
parents:
diff changeset
    78
hgs
parents:
diff changeset
    79
        /**
hgs
parents:
diff changeset
    80
        * Sets the bitmap of part aPart. Takes the ownership.
hgs
parents:
diff changeset
    81
        * Deletes the previous one.
hgs
parents:
diff changeset
    82
        */
hgs
parents:
diff changeset
    83
        void SetBitmap( TPostcardPart aPart, CGulIcon* aIcon );
hgs
parents:
diff changeset
    84
hgs
parents:
diff changeset
    85
        /**
hgs
parents:
diff changeset
    86
        * Removes and deletes bitmap aPart
hgs
parents:
diff changeset
    87
        */
hgs
parents:
diff changeset
    88
        void RemoveBitmap( TPostcardPart aPart );
hgs
parents:
diff changeset
    89
hgs
parents:
diff changeset
    90
        /**
hgs
parents:
diff changeset
    91
         * Reloads icons. Called from AppUi, if skin has changed.
hgs
parents:
diff changeset
    92
        */ 
hgs
parents:
diff changeset
    93
        void ReLoadIconsL();
hgs
parents:
diff changeset
    94
        
hgs
parents:
diff changeset
    95
		/**
hgs
parents:
diff changeset
    96
		* Rereads the coordinates of bitmaps from LAF
hgs
parents:
diff changeset
    97
		*/
hgs
parents:
diff changeset
    98
		void RefreshCoordinates( );
hgs
parents:
diff changeset
    99
hgs
parents:
diff changeset
   100
        /**
hgs
parents:
diff changeset
   101
        * Calls MoveHorizontally or MoveVertically according to aKeyEvent
hgs
parents:
diff changeset
   102
        */
hgs
parents:
diff changeset
   103
        void Move( TInt aScanCode );
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
        /**
hgs
parents:
diff changeset
   106
        * Changes the focus in the back side if possible
hgs
parents:
diff changeset
   107
        */
hgs
parents:
diff changeset
   108
        void MoveHorizontally( TBool aRight );
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
        /**
hgs
parents:
diff changeset
   111
        * Changes the focus from back to front or vice versa if possible
hgs
parents:
diff changeset
   112
        */
hgs
parents:
diff changeset
   113
        void MoveVertically( TBool aUp );
hgs
parents:
diff changeset
   114
hgs
parents:
diff changeset
   115
        /**
hgs
parents:
diff changeset
   116
        * Makes itself focused, visible and active.
hgs
parents:
diff changeset
   117
        */
hgs
parents:
diff changeset
   118
        void ActivateL( );
hgs
parents:
diff changeset
   119
hgs
parents:
diff changeset
   120
        /**
hgs
parents:
diff changeset
   121
        * Gets an array of TRects and sets them as greeting field lines
hgs
parents:
diff changeset
   122
        */
hgs
parents:
diff changeset
   123
        void SetGreetingLines( CArrayPtrFlat<TRect>& aGreetingLines );
hgs
parents:
diff changeset
   124
        
hgs
parents:
diff changeset
   125
        /**
hgs
parents:
diff changeset
   126
        * Gets an array of TRects and sets them as recipient field lines
hgs
parents:
diff changeset
   127
        */
hgs
parents:
diff changeset
   128
        void SetRecipientLines( CArrayPtrFlat<TRect>& aRecipientLines );
hgs
parents:
diff changeset
   129
hgs
parents:
diff changeset
   130
    private: // New functions
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
        /**
hgs
parents:
diff changeset
   133
        * Default C++ constructor.
hgs
parents:
diff changeset
   134
        */
hgs
parents:
diff changeset
   135
        CPostcardController( CPostcardDocument& aDocument
hgs
parents:
diff changeset
   136
#ifdef RD_SCALABLE_UI_V2
hgs
parents:
diff changeset
   137
            , MPocaPointerEventObserver& aObserver
hgs
parents:
diff changeset
   138
#endif
hgs
parents:
diff changeset
   139
        );
hgs
parents:
diff changeset
   140
hgs
parents:
diff changeset
   141
        /**
hgs
parents:
diff changeset
   142
        * 2nd phase Constructor.
hgs
parents:
diff changeset
   143
        */
hgs
parents:
diff changeset
   144
        void ConstructL( );
hgs
parents:
diff changeset
   145
hgs
parents:
diff changeset
   146
    private: // Functions from base classes
hgs
parents:
diff changeset
   147
hgs
parents:
diff changeset
   148
        /**
hgs
parents:
diff changeset
   149
        * From CoeControl,CountComponentControls. Returns always 0.
hgs
parents:
diff changeset
   150
        */
hgs
parents:
diff changeset
   151
        TInt CountComponentControls( ) const;
hgs
parents:
diff changeset
   152
hgs
parents:
diff changeset
   153
        /**
hgs
parents:
diff changeset
   154
        * From CCoeControl,ComponentControl. Returns always NULL.
hgs
parents:
diff changeset
   155
        */
hgs
parents:
diff changeset
   156
        CCoeControl* ComponentControl( TInt aIndex ) const;
hgs
parents:
diff changeset
   157
hgs
parents:
diff changeset
   158
        /**
hgs
parents:
diff changeset
   159
        * Calls DrawBackground.
hgs
parents:
diff changeset
   160
        * Also calls DrawIcons for the objects we have on top of the background
hgs
parents:
diff changeset
   161
        */
hgs
parents:
diff changeset
   162
        void Draw( const TRect& aRect ) const;
hgs
parents:
diff changeset
   163
        
hgs
parents:
diff changeset
   164
        /**
hgs
parents:
diff changeset
   165
        * Draws possible skin background.
hgs
parents:
diff changeset
   166
        * Draws the background icons.
hgs
parents:
diff changeset
   167
        */
hgs
parents:
diff changeset
   168
        void DrawBackground( ) const;
hgs
parents:
diff changeset
   169
        
hgs
parents:
diff changeset
   170
        /**
hgs
parents:
diff changeset
   171
        * Draws the image side.
hgs
parents:
diff changeset
   172
        */
hgs
parents:
diff changeset
   173
        void DrawImageSide( ) const;
hgs
parents:
diff changeset
   174
hgs
parents:
diff changeset
   175
        /**
hgs
parents:
diff changeset
   176
        * Draws the text side.
hgs
parents:
diff changeset
   177
        */
hgs
parents:
diff changeset
   178
        void DrawTextSide( ) const;
hgs
parents:
diff changeset
   179
        
hgs
parents:
diff changeset
   180
        /**
hgs
parents:
diff changeset
   181
        * Draws icon aIcon in rect aRect. Called by DrawImageSide or DrawTextSide.
hgs
parents:
diff changeset
   182
        */
hgs
parents:
diff changeset
   183
        void DrawIcon( const CGulIcon& aIcon, const TRect& aRect ) const;
hgs
parents:
diff changeset
   184
hgs
parents:
diff changeset
   185
        /**
hgs
parents:
diff changeset
   186
        * Draws arrow down or up icon based on the side and whether in editor or
hgs
parents:
diff changeset
   187
        * in viewer mode.
hgs
parents:
diff changeset
   188
        */
hgs
parents:
diff changeset
   189
        void DrawScrollArrows() const;
hgs
parents:
diff changeset
   190
hgs
parents:
diff changeset
   191
        /**
hgs
parents:
diff changeset
   192
        * Draws focus lines. Called by DrawTextSide.
hgs
parents:
diff changeset
   193
        */
hgs
parents:
diff changeset
   194
        void DrawFocus( ) const;
hgs
parents:
diff changeset
   195
hgs
parents:
diff changeset
   196
    protected: // From CCoeControl
hgs
parents:
diff changeset
   197
hgs
parents:
diff changeset
   198
        /**
hgs
parents:
diff changeset
   199
        * Returns the Mop supply object for skin drawing
hgs
parents:
diff changeset
   200
        */
hgs
parents:
diff changeset
   201
	    TTypeUid::Ptr MopSupplyObject(TTypeUid aId);
hgs
parents:
diff changeset
   202
hgs
parents:
diff changeset
   203
#ifdef RD_SCALABLE_UI_V2
hgs
parents:
diff changeset
   204
        /**
hgs
parents:
diff changeset
   205
        * Handle pointer event
hgs
parents:
diff changeset
   206
        */
hgs
parents:
diff changeset
   207
        void HandlePointerEventL(const TPointerEvent& aPointerEvent);
hgs
parents:
diff changeset
   208
#endif
hgs
parents:
diff changeset
   209
hgs
parents:
diff changeset
   210
    private:
hgs
parents:
diff changeset
   211
hgs
parents:
diff changeset
   212
        /**
hgs
parents:
diff changeset
   213
        *   LoadIconsL
hgs
parents:
diff changeset
   214
        *   Calls DoLoadIconL to load icons needed by controller
hgs
parents:
diff changeset
   215
        */
hgs
parents:
diff changeset
   216
        void LoadIconsL();
hgs
parents:
diff changeset
   217
hgs
parents:
diff changeset
   218
        /**
hgs
parents:
diff changeset
   219
        *   DoLoadIconL
hgs
parents:
diff changeset
   220
        *   Calls AknsUtils::CreateIconL to load icons defined by parameters.
hgs
parents:
diff changeset
   221
        *   Param IN aId - the id of the icon in AknsConstants.h
hgs
parents:
diff changeset
   222
        *            aFileName - the name of the file where icons are loaded
hgs
parents:
diff changeset
   223
        *            aFileBitmapId - the id of the bitmap file
hgs
parents:
diff changeset
   224
        *   Returns - icon created by the function
hgs
parents:
diff changeset
   225
        */
hgs
parents:
diff changeset
   226
        CGulIcon* DoLoadIconL(  const TAknsItemID& aId,
hgs
parents:
diff changeset
   227
                                const TDesC& aFileName,
hgs
parents:
diff changeset
   228
                                const TInt aFileBitmapId,
hgs
parents:
diff changeset
   229
                                const TInt aFileMaskId = -1 );
hgs
parents:
diff changeset
   230
        
hgs
parents:
diff changeset
   231
        
hgs
parents:
diff changeset
   232
hgs
parents:
diff changeset
   233
        /**
hgs
parents:
diff changeset
   234
        *   DoLoadIconforUpandDownarrowL
hgs
parents:
diff changeset
   235
        *   Calls AknsUtils::CreateColorIconLC to load icons defined by parameters.
hgs
parents:
diff changeset
   236
        *   Param IN aId - the id of the icon in AknsConstants.h
hgs
parents:
diff changeset
   237
        *            aFileName - the name of the file where icons are loaded
hgs
parents:
diff changeset
   238
        *            aFileBitmapId - the id of the bitmap file
hgs
parents:
diff changeset
   239
        *   Returns - icon created by the function
hgs
parents:
diff changeset
   240
        */
hgs
parents:
diff changeset
   241
        CGulIcon* DoLoadIconforUpandDownarrowL(  const TAknsItemID& aId,
hgs
parents:
diff changeset
   242
                                   const TDesC& aFileName,
hgs
parents:
diff changeset
   243
                                   const TInt aFileBitmapId,
hgs
parents:
diff changeset
   244
                                   const TInt aFileMaskId = -1 );
hgs
parents:
diff changeset
   245
        
hgs
parents:
diff changeset
   246
        
hgs
parents:
diff changeset
   247
                               
hgs
parents:
diff changeset
   248
    private: //Data
hgs
parents:
diff changeset
   249
hgs
parents:
diff changeset
   250
        // Reference to AppUi
hgs
parents:
diff changeset
   251
        CPostcardDocument& iDocument;
hgs
parents:
diff changeset
   252
hgs
parents:
diff changeset
   253
		// Related to frontside
hgs
parents:
diff changeset
   254
        CGulIcon* iFrontBg;
hgs
parents:
diff changeset
   255
        CGulIcon* iImage; 
hgs
parents:
diff changeset
   256
        CGulIcon* iInsertImage;
hgs
parents:
diff changeset
   257
        CGulIcon* iInsertImageBg;
hgs
parents:
diff changeset
   258
hgs
parents:
diff changeset
   259
		// Related to backside
hgs
parents:
diff changeset
   260
        CGulIcon* iBgBg;
hgs
parents:
diff changeset
   261
        CGulIcon* iStamp;
hgs
parents:
diff changeset
   262
        CGulIcon* iEmptyGreetingFocused;
hgs
parents:
diff changeset
   263
        CGulIcon* iEmptyGreeting;
hgs
parents:
diff changeset
   264
        CGulIcon* iGreeting;
hgs
parents:
diff changeset
   265
        CGulIcon* iEmptyAddressFocused;
hgs
parents:
diff changeset
   266
        CGulIcon* iEmptyAddress;
hgs
parents:
diff changeset
   267
        CGulIcon* iAddress;
hgs
parents:
diff changeset
   268
hgs
parents:
diff changeset
   269
        // Focus lines are here
hgs
parents:
diff changeset
   270
        CArrayPtrFlat<TRect>*   iGreetingLines;
hgs
parents:
diff changeset
   271
        CArrayPtrFlat<TRect>*   iRecipientLines;
hgs
parents:
diff changeset
   272
hgs
parents:
diff changeset
   273
		// Related to arrows
hgs
parents:
diff changeset
   274
        CGulIcon* iUpperArrow;
hgs
parents:
diff changeset
   275
        CGulIcon* iLowerArrow;
hgs
parents:
diff changeset
   276
hgs
parents:
diff changeset
   277
		// Related to frontside
hgs
parents:
diff changeset
   278
        TRect iFrontBgC;
hgs
parents:
diff changeset
   279
        TRect iImageC;
hgs
parents:
diff changeset
   280
        TRect iInsertImageC;
hgs
parents:
diff changeset
   281
        TRect iInsertImageBgC;
hgs
parents:
diff changeset
   282
hgs
parents:
diff changeset
   283
		// Related to backside
hgs
parents:
diff changeset
   284
        TRect iBgBgC;
hgs
parents:
diff changeset
   285
        TRect iStampC;
hgs
parents:
diff changeset
   286
        TRect iGreetingC;
hgs
parents:
diff changeset
   287
        TRect iAddressC;
hgs
parents:
diff changeset
   288
hgs
parents:
diff changeset
   289
		// Related to arrows
hgs
parents:
diff changeset
   290
        TRect iUpperArrowC;
hgs
parents:
diff changeset
   291
        TRect iLowerArrowC;
hgs
parents:
diff changeset
   292
hgs
parents:
diff changeset
   293
        TPostcardPart iFocusedItem;
hgs
parents:
diff changeset
   294
hgs
parents:
diff changeset
   295
    	CAknsBasicBackgroundControlContext* iBgContext; // Skin background control context
hgs
parents:
diff changeset
   296
hgs
parents:
diff changeset
   297
#ifdef RD_SCALABLE_UI_V2
hgs
parents:
diff changeset
   298
        TBool iPenEnabled;
hgs
parents:
diff changeset
   299
        MPocaPointerEventObserver& iEventObserver;
hgs
parents:
diff changeset
   300
#endif
hgs
parents:
diff changeset
   301
    };
hgs
parents:
diff changeset
   302
hgs
parents:
diff changeset
   303
#endif // POSTCARDCONTROLLER_H
hgs
parents:
diff changeset
   304
hgs
parents:
diff changeset
   305
// End of File