classicui_plat/navigation_pane_api/inc/aknnavilabel.h
author hgs
Tue, 31 Aug 2010 21:12:01 +0800
changeset 54 4e76f14a5917
parent 45 667edd0b8678
permissions -rw-r--r--
201035
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45
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: 
hgs
parents:
diff changeset
    15
*   Label control to the status pane's navigation pane.
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
hgs
parents:
diff changeset
    21
#ifndef AKNNAVILABEL_H
hgs
parents:
diff changeset
    22
#define AKNNAVILABEL_H
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
#include <AknControl.h>
hgs
parents:
diff changeset
    25
hgs
parents:
diff changeset
    26
class CAknNaviLabelExtension;
hgs
parents:
diff changeset
    27
class TAknLayoutText;
hgs
parents:
diff changeset
    28
hgs
parents:
diff changeset
    29
/**
hgs
parents:
diff changeset
    30
 * Label control to the status pane's navigation pane.
hgs
parents:
diff changeset
    31
 */
hgs
parents:
diff changeset
    32
class CAknNaviLabel : public CAknControl
hgs
parents:
diff changeset
    33
	{
hgs
parents:
diff changeset
    34
public:
hgs
parents:
diff changeset
    35
    enum TNaviLabelType
hgs
parents:
diff changeset
    36
        {
hgs
parents:
diff changeset
    37
        ENavigationLabel,
hgs
parents:
diff changeset
    38
        EAdditionalInfoLabel,
hgs
parents:
diff changeset
    39
        EHintText
hgs
parents:
diff changeset
    40
        };
hgs
parents:
diff changeset
    41
hgs
parents:
diff changeset
    42
public:  // new functions
hgs
parents:
diff changeset
    43
hgs
parents:
diff changeset
    44
    /**
hgs
parents:
diff changeset
    45
    * Constructor.
hgs
parents:
diff changeset
    46
    */
hgs
parents:
diff changeset
    47
    IMPORT_C CAknNaviLabel();
hgs
parents:
diff changeset
    48
hgs
parents:
diff changeset
    49
    /**
hgs
parents:
diff changeset
    50
    * Destructor.
hgs
parents:
diff changeset
    51
    */
hgs
parents:
diff changeset
    52
    IMPORT_C ~CAknNaviLabel();
hgs
parents:
diff changeset
    53
hgs
parents:
diff changeset
    54
    /**
hgs
parents:
diff changeset
    55
     * Set type of the label.
hgs
parents:
diff changeset
    56
     * @param aNaviLabelType navigation label type.
hgs
parents:
diff changeset
    57
     */
hgs
parents:
diff changeset
    58
    IMPORT_C void SetNaviLabelType(TNaviLabelType aNaviLabelType);
hgs
parents:
diff changeset
    59
hgs
parents:
diff changeset
    60
    /**
hgs
parents:
diff changeset
    61
     * Returns type of the label.
hgs
parents:
diff changeset
    62
     * @return navigation label type.
hgs
parents:
diff changeset
    63
     */
hgs
parents:
diff changeset
    64
    IMPORT_C TNaviLabelType NaviLabelType();
hgs
parents:
diff changeset
    65
hgs
parents:
diff changeset
    66
    /**
hgs
parents:
diff changeset
    67
     * Sets navigation label text.
hgs
parents:
diff changeset
    68
     * @param aText reference to the navigation text.
hgs
parents:
diff changeset
    69
     */
hgs
parents:
diff changeset
    70
    IMPORT_C void SetTextL(const TDesC& aText);
hgs
parents:
diff changeset
    71
hgs
parents:
diff changeset
    72
    /**
hgs
parents:
diff changeset
    73
     * Returns the current label text.
hgs
parents:
diff changeset
    74
     * @return label text. Ownership of the text is not transfered.
hgs
parents:
diff changeset
    75
     */
hgs
parents:
diff changeset
    76
    inline const TDesC* Text() const;
hgs
parents:
diff changeset
    77
hgs
parents:
diff changeset
    78
public: 
hgs
parents:
diff changeset
    79
hgs
parents:
diff changeset
    80
    /**
hgs
parents:
diff changeset
    81
    * From CCoeControl. Handles pointer event.
hgs
parents:
diff changeset
    82
    * @param aPointerEvent Pointer event to be handled.
hgs
parents:
diff changeset
    83
    */
hgs
parents:
diff changeset
    84
	IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent); 
hgs
parents:
diff changeset
    85
hgs
parents:
diff changeset
    86
protected: // from CCoeControl
hgs
parents:
diff changeset
    87
hgs
parents:
diff changeset
    88
    /**
hgs
parents:
diff changeset
    89
    * From CCoeControl. Handle the size change events.
hgs
parents:
diff changeset
    90
    */
hgs
parents:
diff changeset
    91
    IMPORT_C virtual void SizeChanged();
hgs
parents:
diff changeset
    92
hgs
parents:
diff changeset
    93
    /**
hgs
parents:
diff changeset
    94
    * From CCoeControl.  Draw a control.  
hgs
parents:
diff changeset
    95
    *
hgs
parents:
diff changeset
    96
    * @param aRect The region of the control to be redrawn.   
hgs
parents:
diff changeset
    97
    */
hgs
parents:
diff changeset
    98
    IMPORT_C void Draw(const TRect& aRect) const;
hgs
parents:
diff changeset
    99
private:
hgs
parents:
diff changeset
   100
    /**
hgs
parents:
diff changeset
   101
    * From CAknControl
hgs
parents:
diff changeset
   102
    */
hgs
parents:
diff changeset
   103
    IMPORT_C void* ExtensionInterface( TUid aInterface );
hgs
parents:
diff changeset
   104
hgs
parents:
diff changeset
   105
private:
hgs
parents:
diff changeset
   106
    /**
hgs
parents:
diff changeset
   107
     * Calculates width using margins.
hgs
parents:
diff changeset
   108
     * @return width.
hgs
parents:
diff changeset
   109
     */
hgs
parents:
diff changeset
   110
    TInt WidthInsideMargins() const;
hgs
parents:
diff changeset
   111
hgs
parents:
diff changeset
   112
    /**
hgs
parents:
diff changeset
   113
     * Reads the text layout from Aknlayout system.
hgs
parents:
diff changeset
   114
     * @return Text layout.
hgs
parents:
diff changeset
   115
     */
hgs
parents:
diff changeset
   116
    TAknLayoutText LayoutText() const;    
hgs
parents:
diff changeset
   117
hgs
parents:
diff changeset
   118
private:
hgs
parents:
diff changeset
   119
	HBufC* iText;
hgs
parents:
diff changeset
   120
	CAknNaviLabelExtension* iExtension;
hgs
parents:
diff changeset
   121
    const CFont* iFont;
hgs
parents:
diff changeset
   122
    TInt iLeftMargin;
hgs
parents:
diff changeset
   123
    TInt iRightMargin;
hgs
parents:
diff changeset
   124
    TInt iSpare;
hgs
parents:
diff changeset
   125
    TInt iRightOffset;
hgs
parents:
diff changeset
   126
    TRgb iColor; 
hgs
parents:
diff changeset
   127
hgs
parents:
diff changeset
   128
    TNaviLabelType iLabelType;
hgs
parents:
diff changeset
   129
	};
hgs
parents:
diff changeset
   130
hgs
parents:
diff changeset
   131
hgs
parents:
diff changeset
   132
inline const TDesC* CAknNaviLabel::Text() const
hgs
parents:
diff changeset
   133
	{ return(iText); }
hgs
parents:
diff changeset
   134
hgs
parents:
diff changeset
   135
hgs
parents:
diff changeset
   136
#endif // AKNNAVILABEL_H