1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/os/textandloc/textrendering/textformatting/inc/FRMCURS.H Fri Jun 15 03:10:57 2012 +0200
1.3 @@ -0,0 +1,234 @@
1.4 +/*
1.5 +* Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies).
1.6 +* All rights reserved.
1.7 +* This component and the accompanying materials are made available
1.8 +* under the terms of "Eclipse Public License v1.0"
1.9 +* which accompanies this distribution, and is available
1.10 +* at the URL "http://www.eclipse.org/legal/epl-v10.html".
1.11 +*
1.12 +* Initial Contributors:
1.13 +* Nokia Corporation - initial contribution.
1.14 +*
1.15 +* Contributors:
1.16 +*
1.17 +* Description:
1.18 +* FORM Cursor Navigation header file holding policy interface class.
1.19 +*
1.20 +*/
1.21 +
1.22 +
1.23 +#ifndef __FRMCURS_H__
1.24 +#define __FRMCURS_H__
1.25 +
1.26 +
1.27 +#include <frmconst.h>
1.28 +#include <frmconst_partner.h>
1.29 +
1.30 +
1.31 +class CTmViewAnchoredLayout;
1.32 +class TTmDocPos;
1.33 +
1.34 +/**
1.35 +This policy interface class maintains the cursor position and sets the
1.36 +policy for its movement.
1.37 +@publishedPartner
1.38 +@deprecated
1.39 +*/
1.40 +class MCursorPositioningPolicy
1.41 +
1.42 + {
1.43 +public:
1.44 +
1.45 + //-- Interface enumerations ---------------------------------------------
1.46 +
1.47 +
1.48 + /** Types of delete operation. This is used when...???
1.49 + */
1.50 + enum TDeleteType
1.51 + {
1.52 + EDeleteUndefined = 0,
1.53 + EDeleteBackspace = 1,
1.54 + EDeleteForward = 2,
1.55 +
1.56 + EDeleteLast
1.57 + };
1.58 +
1.59 + /** Types of reformatting. This is used when...???
1.60 + */
1.61 + enum TTextChangeType
1.62 + {
1.63 + ETextChangeUndefined = 0,
1.64 + /** Change that causes no change in cursor position. */
1.65 + ETextChangeNonLocal = 1,
1.66 + /** Change that moves the cursor to its trailing edge. */
1.67 + ETextChangeTyping = 2,
1.68 +
1.69 + // Maybe several more.
1.70 + // ...
1.71 + ETExtChangeLast
1.72 + };
1.73 +
1.74 + /**
1.75 + Hint for positioning the visual cursor. Describes properties of the
1.76 + editing operation that is most likely to happen next.
1.77 + */
1.78 + enum TPosHint
1.79 + {
1.80 + EPosHintUndefined = 0,
1.81 + /** Left to right typing expected. */
1.82 + EInsertStrongL2R = 1,
1.83 + /** Right to left typing expected. */
1.84 + EInsertStrongR2L = 2,
1.85 +
1.86 + // Maybe several more.
1.87 + //...
1.88 + EPosHintLast
1.89 + };
1.90 +
1.91 +public:
1.92 +
1.93 + //-- Object creation/setup API ------------------------------------------
1.94 +
1.95 + /**
1.96 + */
1.97 + virtual ~MCursorPositioningPolicy() {}
1.98 +
1.99 + /**
1.100 + Sets the document/layout object on which all the cursor navigation will
1.101 + take place.
1.102 + */
1.103 + virtual void SetTmLayout(CTmViewAnchoredLayout* aLayout) = 0;
1.104 +
1.105 +
1.106 + //-- Cursor positioning API ---------------------------------------------
1.107 +
1.108 + /**
1.109 + Gets the cursor position for display and insertion.
1.110 + @return TTmDocPos value holding cursor document position.
1.111 + */
1.112 + virtual const TTmDocPos& Pos() const = 0;
1.113 +
1.114 + /**
1.115 + Sets the cursor position explicitly.
1.116 + @param aNewPos New position cursor is to be moved to.
1.117 + */
1.118 + virtual void SetPos(const TTmDocPos& aNewPos) = 0;
1.119 +
1.120 +
1.121 + /**
1.122 + @return ETrue if successful, EFalse otherwise e.g. no formatting
1.123 + */
1.124 + virtual void PosXyL(TPoint& aXy) const = 0;
1.125 +
1.126 + /**
1.127 + Sets the X, Y co-ordinates to jump to.
1.128 + @param aXy Layout co-ordinates to approx. move the cursor to.
1.129 + On exit
1.130 + @return ETrue if successful, EFalse otherwise e.g. no formatting
1.131 + */
1.132 + virtual void SetPosByXyL(TPoint& aNewXy) = 0;
1.133 +
1.134 + /**
1.135 + Allows change of cursor position in response to a hint as to
1.136 + positioning.
1.137 + @param aHint Text directional hint from client.
1.138 + */
1.139 + virtual void SetPositioningHintL(TPosHint aHint) = 0;
1.140 +
1.141 + /**
1.142 + Suggests a new latent X,Y position for Up/Down operations/scrolls.
1.143 + @param aX X Layout co-ordinate for latent position of cursor.
1.144 + */
1.145 + virtual void SetLatentX(TInt aX) = 0;
1.146 +
1.147 + /**
1.148 + Suggests a new latent X,Y position for Up/Down operations/scrolls.
1.149 + @param aY Y Layout co-ordinate for latent position of cursor.
1.150 + */
1.151 + virtual void SetLatentY(TInt aY) = 0;
1.152 +
1.153 + /**
1.154 + Suggests a new latent X,Y position for Up/Down operations/scrolls.
1.155 + @param aXy X,Y Layout co-ordinate for latent position of cursor.
1.156 + */
1.157 + virtual const TPoint& LatentXy() const = 0;
1.158 +
1.159 + /**
1.160 + Suggests a new latent X,Y position for Up/Down operations/scrolls.
1.161 + @param aXy X,Y Layout co-ordinate for latent position of cursor.
1.162 + */
1.163 + virtual void SetLatentXy(const TPoint& aXy) = 0;
1.164 +
1.165 + /**
1.166 + @leave
1.167 + */
1.168 + virtual const TPoint& UpdateLatentXyL() = 0;
1.169 +
1.170 +
1.171 + //--- Cursor navigation API ---------------------------------------------
1.172 +
1.173 +
1.174 + /**
1.175 + Moves the cursor up or down a line.
1.176 + @param aUp ETrue if wish to move up, EFalse to go down.
1.177 + @return TCursorMove Actual movement that took place.
1.178 + */
1.179 + virtual TCursorMove UpDownL(TBool aUp) = 0;
1.180 +
1.181 + /**
1.182 + Moves the cursor left or right a character position.
1.183 + @param aDown ETrue if wish to move left, EFalse to go right.
1.184 + @return TCursorMove Actual movement that took place.
1.185 + */
1.186 + virtual TCursorMove LeftRightL(TBool aLeft) = 0;
1.187 +
1.188 + /**
1.189 + Moves the cursor to the start or to the end of the line.
1.190 + @param aStart ETrue if wish to move to the start, EFalse to go to the end.
1.191 + @return TCursorMove Actual movement that took place.
1.192 + */
1.193 + virtual TCursorMove LineStartEndL(TBool aStart) = 0;
1.194 +
1.195 +
1.196 + //--- Cursor reactionary API to changes ---------------------------------
1.197 +
1.198 +
1.199 + /**
1.200 + Responds to total change of formatting.
1.201 + */
1.202 + virtual void HandleGlobalReformatL() = 0;
1.203 +
1.204 + /**
1.205 + Responds to partial change of formatting.
1.206 + @param aStart ?
1.207 + @param aOldEnd ?
1.208 + @param aNewEnd ?
1.209 + @param aParaFormatChg ?
1.210 + @param aChgType ?
1.211 + */
1.212 + virtual void HandleReformatL(TInt aStart, TInt aOldEnd,
1.213 + TInt aNewEnd, TBool aParaFormatChg, TTextChangeType aChgType) = 0;
1.214 +
1.215 +
1.216 + //-- Misc/Unknown API ---------------------------------------------------
1.217 +
1.218 +
1.219 + /**
1.220 + Gets the cursor position for delete. ???
1.221 + @param aDelType ?
1.222 + @param aStart ?
1.223 + @param aEnd ?
1.224 + */
1.225 + virtual void GetDeletePosition(TDeleteType aDelType, TInt& aStart,
1.226 + TInt& aEnd) const = 0;
1.227 +
1.228 + /**
1.229 + Place holder for future expansion when if more virtual methods
1.230 + are requried.
1.231 + */
1.232 + virtual void* ExtendedInterface(TUid aInterfaceId) = 0;
1.233 +
1.234 + };
1.235 +
1.236 +
1.237 +#endif // __FRMCURS_H__