classicui_plat/labels_api/inc/eikfnlab.h
author hgs
Fri, 23 Jul 2010 17:08:56 +0800
changeset 45 667edd0b8678
permissions -rw-r--r--
201029
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
45
hgs
parents:
diff changeset
     1
/*
hgs
parents:
diff changeset
     2
* Copyright (c) 2002-2006 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:  Class declaration for EIKON file name label control.
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 __EIKFNLAB_H__
hgs
parents:
diff changeset
    20
#define __EIKFNLAB_H__
hgs
parents:
diff changeset
    21
hgs
parents:
diff changeset
    22
#include <eikbctrl.h>
hgs
parents:
diff changeset
    23
hgs
parents:
diff changeset
    24
// forward declarations
hgs
parents:
diff changeset
    25
class CEikLabel;
hgs
parents:
diff changeset
    26
hgs
parents:
diff changeset
    27
/**
hgs
parents:
diff changeset
    28
 * File name label is a bordered control that displays the application name.
hgs
parents:
diff changeset
    29
 *
hgs
parents:
diff changeset
    30
 * @lib eikcoctl.lib
hgs
parents:
diff changeset
    31
 * @since S60 0.9
hgs
parents:
diff changeset
    32
 */
hgs
parents:
diff changeset
    33
class CEikFileNameLabel : public CEikBorderedControl
hgs
parents:
diff changeset
    34
	{
hgs
parents:
diff changeset
    35
public:
hgs
parents:
diff changeset
    36
    
hgs
parents:
diff changeset
    37
    /**
hgs
parents:
diff changeset
    38
     * C++ Default Constructor.
hgs
parents:
diff changeset
    39
     * Sets the default border.
hgs
parents:
diff changeset
    40
     */
hgs
parents:
diff changeset
    41
	IMPORT_C CEikFileNameLabel();
hgs
parents:
diff changeset
    42
	
hgs
parents:
diff changeset
    43
	/**
hgs
parents:
diff changeset
    44
	 * Destructor.
hgs
parents:
diff changeset
    45
	 */
hgs
parents:
diff changeset
    46
	IMPORT_C ~CEikFileNameLabel();
hgs
parents:
diff changeset
    47
	
hgs
parents:
diff changeset
    48
	/**
hgs
parents:
diff changeset
    49
	 * Second phase constructor.
hgs
parents:
diff changeset
    50
	 * Completes the construction of a file name label control.
hgs
parents:
diff changeset
    51
	 */
hgs
parents:
diff changeset
    52
	IMPORT_C void ConstructL();
hgs
parents:
diff changeset
    53
	
hgs
parents:
diff changeset
    54
	/**
hgs
parents:
diff changeset
    55
	 * Updates the file name label with the name of the application.
hgs
parents:
diff changeset
    56
	 * If the application is file-based, then the file name of the
hgs
parents:
diff changeset
    57
	 * main document will be shown.
hgs
parents:
diff changeset
    58
	 * Otherwise the label will be the application's caption.
hgs
parents:
diff changeset
    59
	 */
hgs
parents:
diff changeset
    60
	IMPORT_C void UpdateL();
hgs
parents:
diff changeset
    61
	
hgs
parents:
diff changeset
    62
public:	/** From @c CCoeControl. */
hgs
parents:
diff changeset
    63
hgs
parents:
diff changeset
    64
    /**
hgs
parents:
diff changeset
    65
     * <b> Not used in S60. </b>
hgs
parents:
diff changeset
    66
     *
hgs
parents:
diff changeset
    67
     * From @c CCoeControl
hgs
parents:
diff changeset
    68
     *
hgs
parents:
diff changeset
    69
     * @param aColorUseList Not used.
hgs
parents:
diff changeset
    70
     */
hgs
parents:
diff changeset
    71
	IMPORT_C void GetColorUseListL(CArrayFix<TCoeColorUse>& aColorUseList) const;
hgs
parents:
diff changeset
    72
	
hgs
parents:
diff changeset
    73
	/**
hgs
parents:
diff changeset
    74
     * Handles a change to the control's resources.
hgs
parents:
diff changeset
    75
     *
hgs
parents:
diff changeset
    76
     * The types of resources handled are those which are shared across
hgs
parents:
diff changeset
    77
     * the environment, e.g. colours or fonts. For colour scheme changes,
hgs
parents:
diff changeset
    78
     * @c DrawDeferred() is called in order to redraw the control.
hgs
parents:
diff changeset
    79
     *
hgs
parents:
diff changeset
    80
     * If overriding this method, the implementation must
hgs
parents:
diff changeset
    81
     * include a base call to this method.
hgs
parents:
diff changeset
    82
     *
hgs
parents:
diff changeset
    83
     * From @c CCoeControl.
hgs
parents:
diff changeset
    84
	 *
hgs
parents:
diff changeset
    85
     * @param aType The type of resource that has changed.
hgs
parents:
diff changeset
    86
     */
hgs
parents:
diff changeset
    87
	IMPORT_C void HandleResourceChange(TInt aType);
hgs
parents:
diff changeset
    88
	
hgs
parents:
diff changeset
    89
	/**
hgs
parents:
diff changeset
    90
	 * Sets the control's minimum required size.
hgs
parents:
diff changeset
    91
	 *
hgs
parents:
diff changeset
    92
     * This function should be overridden by the concrete control class if the
hgs
parents:
diff changeset
    93
     * control is to be displayed inside a dialog.
hgs
parents:
diff changeset
    94
     *
hgs
parents:
diff changeset
    95
     * Dialogs set the size and position of their components
hgs
parents:
diff changeset
    96
     * automatically, and use this function to enquire the minimum size that
hgs
parents:
diff changeset
    97
     * a control requires.
hgs
parents:
diff changeset
    98
     *
hgs
parents:
diff changeset
    99
     * Other container controls that automatically calculate the layout
hgs
parents:
diff changeset
   100
     * of their components may also use this function.
hgs
parents:
diff changeset
   101
     *
hgs
parents:
diff changeset
   102
     * From @c CCoeControl.
hgs
parents:
diff changeset
   103
     *
hgs
parents:
diff changeset
   104
     * @return The minimum size required by the control.
hgs
parents:
diff changeset
   105
	 */
hgs
parents:
diff changeset
   106
	IMPORT_C TSize MinimumSize();
hgs
parents:
diff changeset
   107
	
hgs
parents:
diff changeset
   108
	/**
hgs
parents:
diff changeset
   109
     * Handles pointer events.
hgs
parents:
diff changeset
   110
     *
hgs
parents:
diff changeset
   111
     * This function gets called whenever a pointer event occurs in the 
hgs
parents:
diff changeset
   112
     * control, i.e. when the pointer is within the control's extent, or when 
hgs
parents:
diff changeset
   113
     * the control has grabbed the pointer.
hgs
parents:
diff changeset
   114
     *
hgs
parents:
diff changeset
   115
     * If the pointer event occurs within this control, the function
hgs
parents:
diff changeset
   116
     * will launch the task swapper.
hgs
parents:
diff changeset
   117
     * 
hgs
parents:
diff changeset
   118
     * If overriding this method, the implementation must 
hgs
parents:
diff changeset
   119
     * include a base call to this method.
hgs
parents:
diff changeset
   120
     *
hgs
parents:
diff changeset
   121
     * From @c CCoeControl.
hgs
parents:
diff changeset
   122
     *
hgs
parents:
diff changeset
   123
     * @param aPointerEvent The pointer event.
hgs
parents:
diff changeset
   124
     */
hgs
parents:
diff changeset
   125
	IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
hgs
parents:
diff changeset
   126
	
hgs
parents:
diff changeset
   127
protected:
hgs
parents:
diff changeset
   128
hgs
parents:
diff changeset
   129
    /**
hgs
parents:
diff changeset
   130
     * Draws the borders of the control.
hgs
parents:
diff changeset
   131
     *
hgs
parents:
diff changeset
   132
     * The screen appearance of derived classes can be changed by overriding
hgs
parents:
diff changeset
   133
     * this method. By default, this draws a border of the appropriate
hgs
parents:
diff changeset
   134
     * type around the control.
hgs
parents:
diff changeset
   135
     *
hgs
parents:
diff changeset
   136
     * From @c CCoeControl.
hgs
parents:
diff changeset
   137
     *
hgs
parents:
diff changeset
   138
     * @param aRect Not used.
hgs
parents:
diff changeset
   139
     */
hgs
parents:
diff changeset
   140
	IMPORT_C void Draw(const TRect& aRect) const;
hgs
parents:
diff changeset
   141
	
hgs
parents:
diff changeset
   142
private: /** From @c CCoeControl. */
hgs
parents:
diff changeset
   143
hgs
parents:
diff changeset
   144
	IMPORT_C void ConstructFromResourceL(TResourceReader& aReader);
hgs
parents:
diff changeset
   145
	
hgs
parents:
diff changeset
   146
	IMPORT_C TInt CountComponentControls() const;
hgs
parents:
diff changeset
   147
	
hgs
parents:
diff changeset
   148
	IMPORT_C CCoeControl* ComponentControl(TInt aIndex) const;
hgs
parents:
diff changeset
   149
	
hgs
parents:
diff changeset
   150
	IMPORT_C void SizeChanged();
hgs
parents:
diff changeset
   151
	
hgs
parents:
diff changeset
   152
private: /** From @c CAknControl. */
hgs
parents:
diff changeset
   153
hgs
parents:
diff changeset
   154
    IMPORT_C void* ExtensionInterface( TUid aInterface );
hgs
parents:
diff changeset
   155
    
hgs
parents:
diff changeset
   156
private:
hgs
parents:
diff changeset
   157
	CEikLabel* iLabel;
hgs
parents:
diff changeset
   158
	TInt iSpare;
hgs
parents:
diff changeset
   159
	};
hgs
parents:
diff changeset
   160
hgs
parents:
diff changeset
   161
#endif // __EIKFNLAB_H__