1.1 --- a/epoc32/include/mw/eikspace.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/eikspace.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,130 @@
     1.4 -eikspace.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 spacer control.
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#ifndef __EIKSPACE_H__
    1.24 +#define __EIKSPACE_H__
    1.25 +
    1.26 +#include <akncontrol.h>
    1.27 +#include <gdi.h>
    1.28 +
    1.29 +// Forward declarations
    1.30 +class TResourceReader;
    1.31 +
    1.32 +/**
    1.33 + * An invisible control that is used to provide a space between
    1.34 + * visible controls. It has a width, a height and a color.
    1.35 + * The spacer is normally drawn using the background color
    1.36 + * so that it is invisible.
    1.37 + *
    1.38 + * Its associated resource struct is @c SPACER and its control
    1.39 + * factory identifier is @c EEikCtSpacer.
    1.40 + *
    1.41 + * @lib eikctl.lib
    1.42 + * @since S60 0.9
    1.43 + */
    1.44 +class CEikSpacer : public CAknControl
    1.45 +    {
    1.46 +public:
    1.47 +
    1.48 +    /**
    1.49 +     * Default C++ constructor.
    1.50 +     * The spacer's color is initialised to white.
    1.51 +     */
    1.52 +    IMPORT_C CEikSpacer();
    1.53 +    
    1.54 +    /**
    1.55 +     * C++ constructor with a width, height and color.
    1.56 +     *
    1.57 +     * @param aWidth  The spacer's width.
    1.58 +     * @param aHeight The spacer's height.
    1.59 +     * @param aColor  The spacer's color.
    1.60 +     */
    1.61 +	IMPORT_C CEikSpacer(TInt aWidth,TInt aHeight,TRgb aColor);
    1.62 +	
    1.63 +	/**
    1.64 +     * Destructor.
    1.65 +     */
    1.66 +    IMPORT_C ~CEikSpacer();
    1.67 +    
    1.68 +    /**
    1.69 +     * Sets the spacer's width.
    1.70 +     *
    1.71 +     * @param aWidth The spacer's width.
    1.72 +     */
    1.73 +	IMPORT_C void SetWidth(TInt aWidth);
    1.74 +	
    1.75 +	/**
    1.76 +     * Sets the spacer's height.
    1.77 +     *
    1.78 +     * @param aHeight The spacer's height.
    1.79 +     */
    1.80 +	IMPORT_C void SetHeight(TInt aHeight);
    1.81 +	
    1.82 +	/**
    1.83 +     * Sets the spacer's color.
    1.84 +     *
    1.85 +     * @param aColor The spacer's color.
    1.86 +     */
    1.87 +	IMPORT_C void SetColor(TRgb aColor);
    1.88 +	
    1.89 +	/**
    1.90 +     * Specifies whether the spacer is drawn using the standard brush color.
    1.91 +     *
    1.92 +     * If the "Is clear" flag is set, the spacer's color value is ignored,
    1.93 +     * and it is drawn using the brush color defined in the system's
    1.94 +     * standard graphics context. By default, the "Is clear" flag is unset.
    1.95 +     *
    1.96 +     * @param aClear @c ETrue to set the "Is clear" flag,
    1.97 +     *               @c EFalse to unset it.
    1.98 +     */
    1.99 +	IMPORT_C void SetClear(TBool aClear);
   1.100 +	
   1.101 +public: // From @c CCoeControl.
   1.102 +
   1.103 +    /**
   1.104 +     * Handles pointer events.
   1.105 +     *
   1.106 +     * This function gets called whenever a pointer event occurs in the 
   1.107 +     * control, i.e. when the pointer is within the control's extent, or when 
   1.108 +     * the control has grabbed the pointer.
   1.109 +     * 
   1.110 +     * If overriding this method, the implementation must 
   1.111 +     * include a base call to this method.
   1.112 +     *
   1.113 +     * From @c CCoeControl.
   1.114 +     *
   1.115 +     * @param aPointerEvent The pointer event.
   1.116 +     */
   1.117 +    IMPORT_C void HandlePointerEventL(const TPointerEvent& aPointerEvent);
   1.118 +    
   1.119 +private: /** From @c CCoeControl. */
   1.120 +
   1.121 +    void ConstructFromResourceL(TResourceReader& aReader);
   1.122 +
   1.123 +	void Draw(const TRect& aRect) const;
   1.124 +	
   1.125 +private: /** From @c CAknControl. */
   1.126 +
   1.127 +    IMPORT_C void* ExtensionInterface( TUid aInterface );
   1.128 +    
   1.129 +private:
   1.130 +	TRgb iColor;
   1.131 +	TBool iClear;
   1.132 +    };
   1.133 +
   1.134 +#endif // __EIKSPACE_H__