sl@0: // Copyright (c) 1994-2009 Nokia Corporation and/or its subsidiary(-ies).
sl@0: // All rights reserved.
sl@0: // This component and the accompanying materials are made available
sl@0: // under the terms of "Eclipse Public License v1.0"
sl@0: // which accompanies this distribution, and is available
sl@0: // at the URL "http://www.eclipse.org/legal/epl-v10.html".
sl@0: //
sl@0: // Initial Contributors:
sl@0: // Nokia Corporation - initial contribution.
sl@0: //
sl@0: // Contributors:
sl@0: //
sl@0: // Description:
sl@0: // text cursor header file
sl@0: // 
sl@0: //
sl@0: 
sl@0: #ifndef TEXTCURSOR_H
sl@0: #define TEXTCURSOR_H
sl@0: 
sl@0: struct TTextCursor
sl@0: /** Text cursor parameter information.
sl@0: 
sl@0: A text cursor is a rectangular area which can be set to flash. It is normally
sl@0: only visible when the window group which owns it has the keyboard focus. This
sl@0: structure is used to define the parameters of a text cursor, which can be
sl@0: selected for use through the window group using RWindowGroup::SetTextCursor().
sl@0: 
sl@0: Custom (non-rectangular) text cursors are supported from v7.0s. They are added
sl@0: to the window server using RWsSession::SetCustomTextCursor(), after which
sl@0: they can be selected for use through the window group, in the same way as
sl@0: standard rectangular cursors. They have a unique identifier, stored in the
sl@0: iType member, which must be greater than ETypeLastBasic. Custom text cursors
sl@0: are clipped to their iHeight and iWidth values. Their iColour member is not
sl@0: used.
sl@0: 
sl@0: @publishedAll
sl@0: @released */
sl@0:     {
sl@0: 	// The different normal text cursors
sl@0: 	// A Text cursor can either be a predefined one
sl@0: 	// or a general sprite. Cursors between ETypeFirst
sl@0: 	// and ETypeLastBasic are predefined ones (even though
sl@0: 	// the ones above ETypeLast do not exist and are
sl@0: 	// for future use)
sl@0: 	/** Cursor type values.
sl@0: 
sl@0: 	The values between ETypeFirst and ETypeLastBasic are reserved for predefined
sl@0: 	cursors. Custom text cursors must have a value greater than ETypeLastBasic.
sl@0: 
sl@0: 	The values not listed below are for internal use only.
sl@0: 	
sl@0:     @publishedAll */
sl@0: 	enum ENamedCursors
sl@0: 		{
sl@0: 		ETypeNone,
sl@0: 		/** Standard filled rectangular cursor. */
sl@0: 		ETypeRectangle,
sl@0: 		/** Standard hollow rectangular cursor. */
sl@0: 		ETypeHollowRectangle,
sl@0:         /** The first predefined cursor type.
sl@0: 
sl@0:         Equivalent to ETypeRectangle. This can be used for iterating through the predefined
sl@0:         cursor types.
sl@0:         
sl@0:         WARNING: Enum for internal use ONLY. Compatibility is not guaranteed in future releases. */
sl@0:         ETypeFirst=ETypeRectangle,
sl@0:         /** The last predefined cursor type.
sl@0: 
sl@0:         Equivalent to ETypeHollowRectangle. This can be used for iterating through
sl@0:         the predefined cursor types.
sl@0:         
sl@0:         WARNING: Enum for internal use ONLY. Compatibility is not guaranteed in future releases. */        
sl@0:         ETypeLast=ETypeHollowRectangle,
sl@0:         /** Reserved for future use.
sl@0: 		
sl@0: 		/** All custom text cursors must have a type value greater than this. */
sl@0: 		ETypeLastBasic = 1000,	
sl@0: 		};
sl@0: 	/** Added for compatibility with previous releases. */
sl@0: 	typedef TInt EType;
sl@0: 	/** Cursor flash and clipping flags.
sl@0: 
sl@0: 	The flags not listed below are for internal use only. */
sl@0: 	enum EFlags
sl@0: 		{
sl@0: 		/** The text cursor should not flash. */
sl@0: 		EFlagNoFlash		= 0x00000001,
sl@0: 		/** The bitmap of each sprite member is clipped left of its x-origin and right of
sl@0: 		its x-origin plus iWidth.
sl@0: 
sl@0: 		Used for custom text cursors only. */
sl@0: 		EFlagClipHorizontal	= 0x00000002,
sl@0: 		/** The bitmap of each sprite member is clipped vertically.
sl@0: 
sl@0: 		How it is clipped depends on the text cursor's vertical alignment, see the
sl@0: 		TCustomTextCursorAlignment enum in class RWsSession.
sl@0: 
sl@0: 		Used for custom text cursors only. */
sl@0: 		EFlagClipVertical	= 0x00000004,	
sl@0: 		};
sl@0: 	/** The cursor type.
sl@0: 
sl@0: 	For possible values, see the ENamedCursors enum. */
sl@0: 	TInt iType;
sl@0: 	/** The height of the text cursor.
sl@0: 
sl@0: 	This value is also used for clipping custom text cursors, if the EFlagClipVertical
sl@0: 	flag is set. */
sl@0:     TInt iHeight;
sl@0: 	/** The ascent of the text cursor (the distance between the origin and the top). */
sl@0:     TInt iAscent;
sl@0: 	/** The width of the text cursor.
sl@0: 
sl@0: 	Custom text cursors are clipped to this value, if the EFlagClipHorizontal
sl@0: 	flag is set. */
sl@0:     TInt iWidth;
sl@0: 	/** Cursor flash and clipping flags.
sl@0: 
sl@0: 	For possible values, see the EFlags enum. */
sl@0:     TUint iFlags;
sl@0: 	/** The colour of the text cursor.
sl@0: 
sl@0: 	If the cursor is flashing, this colour is XOR'd with the screen.
sl@0: 
sl@0: 	This value is not used for custom text cursors. */
sl@0: 	TRgb iColor;
sl@0:     };
sl@0: 
sl@0: #endif // TEXTCURSOR_H