calendarui/controller/inc/calenicons.h
author hgs
Wed, 03 Nov 2010 17:12:22 +0530
changeset 89 b57382753122
child 67 1539a383d7b6
permissions -rw-r--r--
201045
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
89
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002 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:  Calendar icons class 
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
hgs
parents:
diff changeset
    20
#ifndef CCALENICONS_H
hgs
parents:
diff changeset
    21
#define CCALENICONS_H
hgs
parents:
diff changeset
    22
hgs
parents:
diff changeset
    23
//  INCLUDES
hgs
parents:
diff changeset
    24
#include <e32base.h>
hgs
parents:
diff changeset
    25
#include <calenservices.h>
hgs
parents:
diff changeset
    26
// CONSTANTS
hgs
parents:
diff changeset
    27
static const TInt KDayAndWeekIconCount( 12 );
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
// FORWARD DECLARATIONS
hgs
parents:
diff changeset
    30
class CAknIconArray;
hgs
parents:
diff changeset
    31
class CEikonEnv;
hgs
parents:
diff changeset
    32
class CFbsBitmap;
hgs
parents:
diff changeset
    33
class CGulIcon;
hgs
parents:
diff changeset
    34
class TAknsItemID;
hgs
parents:
diff changeset
    35
class TRgb;
hgs
parents:
diff changeset
    36
class CCalEntry;
hgs
parents:
diff changeset
    37
hgs
parents:
diff changeset
    38
// CLASS DECLARATION
hgs
parents:
diff changeset
    39
hgs
parents:
diff changeset
    40
/**
hgs
parents:
diff changeset
    41
 *  Construct icons used by calendar. Takes care of different types
hgs
parents:
diff changeset
    42
 *  of skinning (i.e. bitmap replacement or color change).
hgs
parents:
diff changeset
    43
 *
hgs
parents:
diff changeset
    44
 *  @lib Calendar.app
hgs
parents:
diff changeset
    45
 *  @since 2.1
hgs
parents:
diff changeset
    46
 */
hgs
parents:
diff changeset
    47
NONSHARABLE_CLASS( CCalenIcons ) : public CBase
hgs
parents:
diff changeset
    48
    {
hgs
parents:
diff changeset
    49
public:  // Constructors and destructor
hgs
parents:
diff changeset
    50
    /**
hgs
parents:
diff changeset
    51
     * Gets an icon index corresponding to a note
hgs
parents:
diff changeset
    52
     * @param aEntry Agenda entry
hgs
parents:
diff changeset
    53
     * @return ENullIcon | EBirthdayIcon |
hgs
parents:
diff changeset
    54
     *         EMeetingIcon | EDaynoteIcon | EToDoIcon
hgs
parents:
diff changeset
    55
     */
hgs
parents:
diff changeset
    56
    IMPORT_C static MCalenServices::TCalenIcons IconIndexFromEntryL(CCalEntry& aEntry);
hgs
parents:
diff changeset
    57
hgs
parents:
diff changeset
    58
    /**
hgs
parents:
diff changeset
    59
     * Two-phased constructor.
hgs
parents:
diff changeset
    60
     */
hgs
parents:
diff changeset
    61
    static CCalenIcons* NewL();
hgs
parents:
diff changeset
    62
hgs
parents:
diff changeset
    63
    /**
hgs
parents:
diff changeset
    64
     * Destructor.
hgs
parents:
diff changeset
    65
     */
hgs
parents:
diff changeset
    66
    virtual ~CCalenIcons();
hgs
parents:
diff changeset
    67
hgs
parents:
diff changeset
    68
public: // New functions
hgs
parents:
diff changeset
    69
    /**
hgs
parents:
diff changeset
    70
     * Create icons that are only used by month view
hgs
parents:
diff changeset
    71
     * @return a pointer to CAknIconArray
hgs
parents:
diff changeset
    72
     */
hgs
parents:
diff changeset
    73
    IMPORT_C CAknIconArray* CreateMonthViewIconsL() const;
hgs
parents:
diff changeset
    74
    
hgs
parents:
diff changeset
    75
    /**
hgs
parents:
diff changeset
    76
     * Create icons that are shared by Day/Week/Todo views
hgs
parents:
diff changeset
    77
     * @return a pointer to CAknIconArray
hgs
parents:
diff changeset
    78
     */
hgs
parents:
diff changeset
    79
    IMPORT_C CAknIconArray* CreateDayWeekToDoViewIconsL() const;
hgs
parents:
diff changeset
    80
    
hgs
parents:
diff changeset
    81
    /**
hgs
parents:
diff changeset
    82
     * Create icons for "out of range"
hgs
parents:
diff changeset
    83
     * @return a pointer to CAknIconArray
hgs
parents:
diff changeset
    84
     */
hgs
parents:
diff changeset
    85
    IMPORT_C CAknIconArray* CreateOutOfRangeIconsL() const;
hgs
parents:
diff changeset
    86
    
hgs
parents:
diff changeset
    87
    /**
hgs
parents:
diff changeset
    88
     * Create icon for "item not shown"
hgs
parents:
diff changeset
    89
     * @return a pointer to CGulIcon
hgs
parents:
diff changeset
    90
     */
hgs
parents:
diff changeset
    91
    IMPORT_C CGulIcon* CreateItemNotShownIconL() const;
hgs
parents:
diff changeset
    92
    /**
hgs
parents:
diff changeset
    93
     * Get an icon by passing an icon type
hgs
parents:
diff changeset
    94
     * @param aIndex An index to the enum TCalenIcons
hgs
parents:
diff changeset
    95
     * @return a pointer to CGulIcon
hgs
parents:
diff changeset
    96
     */
hgs
parents:
diff changeset
    97
    IMPORT_C CGulIcon* GetIconL( MCalenServices::TCalenIcons aIndex, const TInt aViewId = 0 ) const;
hgs
parents:
diff changeset
    98
hgs
parents:
diff changeset
    99
private:
hgs
parents:
diff changeset
   100
    /**
hgs
parents:
diff changeset
   101
     * C++ default constructor.
hgs
parents:
diff changeset
   102
     */
hgs
parents:
diff changeset
   103
    CCalenIcons();
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
    /**
hgs
parents:
diff changeset
   106
     * By default Symbian 2nd phase constructor is private.
hgs
parents:
diff changeset
   107
     */
hgs
parents:
diff changeset
   108
    void ConstructL();
hgs
parents:
diff changeset
   109
hgs
parents:
diff changeset
   110
private: // New methods
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
    /* 
hgs
parents:
diff changeset
   113
     * Create bimap totally filled by aIconColor, and of size aSize.
hgs
parents:
diff changeset
   114
     * This can be used with mask to produce skinned
hgs
parents:
diff changeset
   115
     */ 
hgs
parents:
diff changeset
   116
    CFbsBitmap* CreateColorFilledRectBmpL(const TSize& aSize,
hgs
parents:
diff changeset
   117
                                          const TRgb& aIconColor) const;
hgs
parents:
diff changeset
   118
hgs
parents:
diff changeset
   119
    CGulIcon* CreateColorSkinnedIconL(TInt aBitmapId, 
hgs
parents:
diff changeset
   120
                      const TRgb& aIconColor) const;
hgs
parents:
diff changeset
   121
hgs
parents:
diff changeset
   122
    CGulIcon* CreateBitmapSkinnedIconL(const TAknsItemID& aSkinIconId,
hgs
parents:
diff changeset
   123
                       const TDesC& aFilename, 
hgs
parents:
diff changeset
   124
                       TInt aNormalIconId,
hgs
parents:
diff changeset
   125
                       TInt aNormalMaskId) const;
hgs
parents:
diff changeset
   126
hgs
parents:
diff changeset
   127
private:    // Data
hgs
parents:
diff changeset
   128
    TFileName iIconFile;
hgs
parents:
diff changeset
   129
    };
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
#endif      // CCALENICONS_H
hgs
parents:
diff changeset
   132
hgs
parents:
diff changeset
   133
// End of File