1.1 --- a/epoc32/include/mw/eikfnlab.h Tue Nov 24 13:55:44 2009 +0000
1.2 +++ b/epoc32/include/mw/eikfnlab.h Tue Mar 16 16:12:26 2010 +0000
1.3 @@ -1,1 +1,161 @@
1.4 -eikfnlab.h
1.5 +/*
1.6 +* Copyright (c) 2002-2006 Nokia Corporation and/or its subsidiary(-ies).
1.7 +* All rights reserved.
1.8 +* This component and the accompanying materials are made available
1.9 +* under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
1.10 +* which accompanies this distribution, and is available
1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.12 +*
1.13 +* Initial Contributors:
1.14 +* Nokia Corporation - initial contribution.
1.15 +*
1.16 +* Contributors:
1.17 +*
1.18 +* Description: Class declaration for EIKON file name label control.
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +#ifndef __EIKFNLAB_H__
1.24 +#define __EIKFNLAB_H__
1.25 +
1.26 +#include <eikbctrl.h>
1.27 +
1.28 +// forward declarations
1.29 +class CEikLabel;
1.30 +
1.31 +/**
1.32 + * File name label is a bordered control that displays the application name.
1.33 + *
1.34 + * @lib eikcoctl.lib
1.35 + * @since S60 0.9
1.36 + */
1.37 +class CEikFileNameLabel : public CEikBorderedControl
1.38 + {
1.39 +public:
1.40 +
1.41 + /**
1.42 + * C++ Default Constructor.
1.43 + * Sets the default border.
1.44 + */
1.45 + IMPORT_C CEikFileNameLabel();
1.46 +
1.47 + /**
1.48 + * Destructor.
1.49 + */
1.50 + IMPORT_C ~CEikFileNameLabel();
1.51 +
1.52 + /**
1.53 + * Second phase constructor.
1.54 + * Completes the construction of a file name label control.
1.55 + */
1.56 + IMPORT_C void ConstructL();
1.57 +
1.58 + /**
1.59 + * Updates the file name label with the name of the application.
1.60 + * If the application is file-based, then the file name of the
1.61 + * main document will be shown.
1.62 + * Otherwise the label will be the application's caption.
1.63 + */
1.64 + IMPORT_C void UpdateL();
1.65 +
1.66 +public: /** From @c CCoeControl. */
1.67 +
1.68 + /**
1.69 + * <b> Not used in S60. </b>
1.70 + *
1.71 + * From @c CCoeControl
1.72 + *
1.73 + * @param aColorUseList Not used.
1.74 + */
1.75 + IMPORT_C void GetColorUseListL(CArrayFix<TCoeColorUse>& aColorUseList) const;
1.76 +
1.77 + /**
1.78 + * Handles a change to the control's resources.
1.79 + *
1.80 + * The types of resources handled are those which are shared across
1.81 + * the environment, e.g. colours or fonts. For colour scheme changes,
1.82 + * @c DrawDeferred() is called in order to redraw the control.
1.83 + *
1.84 + * If overriding this method, the implementation must
1.85 + * include a base call to this method.
1.86 + *
1.87 + * From @c CCoeControl.
1.88 + *
1.89 + * @param aType The type of resource that has changed.
1.90 + */
1.91 + IMPORT_C void HandleResourceChange(TInt aType);
1.92 +
1.93 + /**
1.94 + * Sets the control's minimum required size.
1.95 + *
1.96 + * This function should be overridden by the concrete control class if the
1.97 + * control is to be displayed inside a dialog.
1.98 + *
1.99 + * Dialogs set the size and position of their components
1.100 + * automatically, and use this function to enquire the minimum size that
1.101 + * a control requires.
1.102 + *
1.103 + * Other container controls that automatically calculate the layout
1.104 + * of their components may also use this function.
1.105 + *
1.106 + * From @c CCoeControl.
1.107 + *
1.108 + * @return The minimum size required by the control.
1.109 + */
1.110 + IMPORT_C TSize MinimumSize();
1.111 +
1.112 + /**
1.113 + * Handles pointer events.
1.114 + *
1.115 + * This function gets called whenever a pointer event occurs in the
1.116 + * control, i.e. when the pointer is within the control's extent, or when
1.117 + * the control has grabbed the pointer.
1.118 + *
1.119 + * If the pointer event occurs within this control, the function
1.120 + * will launch the task swapper.
1.121 + *
1.122 + * If overriding this method, the implementation must
1.123 + * include a base call to this method.
1.124 + *
1.125 + * From @c CCoeControl.
1.126 + *
1.127 + * @param aPointerEvent The pointer event.
1.128 + */
1.129 + IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
1.130 +
1.131 +protected:
1.132 +
1.133 + /**
1.134 + * Draws the borders of the control.
1.135 + *
1.136 + * The screen appearance of derived classes can be changed by overriding
1.137 + * this method. By default, this draws a border of the appropriate
1.138 + * type around the control.
1.139 + *
1.140 + * From @c CCoeControl.
1.141 + *
1.142 + * @param aRect Not used.
1.143 + */
1.144 + IMPORT_C void Draw(const TRect& aRect) const;
1.145 +
1.146 +private: /** From @c CCoeControl. */
1.147 +
1.148 + IMPORT_C void ConstructFromResourceL(TResourceReader& aReader);
1.149 +
1.150 + IMPORT_C TInt CountComponentControls() const;
1.151 +
1.152 + IMPORT_C CCoeControl* ComponentControl(TInt aIndex) const;
1.153 +
1.154 + IMPORT_C void SizeChanged();
1.155 +
1.156 +private: /** From @c CAknControl. */
1.157 +
1.158 + IMPORT_C void* ExtensionInterface( TUid aInterface );
1.159 +
1.160 +private:
1.161 + CEikLabel* iLabel;
1.162 + TInt iSpare;
1.163 + };
1.164 +
1.165 +#endif // __EIKFNLAB_H__