williamr@2: // Copyright (c) 2003-2009 Nokia Corporation and/or its subsidiary(-ies). williamr@2: // All rights reserved. williamr@2: // This component and the accompanying materials are made available williamr@2: // 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 williamr@2: // which accompanies this distribution, and is available williamr@2: // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html". williamr@2: // williamr@2: // Initial Contributors: williamr@2: // Nokia Corporation - initial contribution. williamr@2: // williamr@2: // Contributors: williamr@2: // williamr@2: // Description: williamr@2: // FORM Cursor Navigation header file holding policy interface class. williamr@2: // williamr@2: // williamr@2: williamr@2: #ifndef __FRMCURS_H__ williamr@2: #define __FRMCURS_H__ williamr@2: williamr@2: williamr@2: #include williamr@2: williamr@2: williamr@2: class CTmViewAnchoredLayout; williamr@2: class TTmDocPos; williamr@2: williamr@2: /** williamr@2: This policy interface class maintains the cursor position and sets the williamr@2: policy for its movement. williamr@2: @publishedPartner williamr@2: @deprecated williamr@2: */ williamr@2: class MCursorPositioningPolicy williamr@2: williamr@2: { williamr@2: public: williamr@2: williamr@2: //-- Interface enumerations --------------------------------------------- williamr@2: williamr@2: williamr@2: /** Types of delete operation. This is used when...??? williamr@2: */ williamr@2: enum TDeleteType williamr@2: { williamr@2: EDeleteUndefined = 0, williamr@2: EDeleteBackspace = 1, williamr@2: EDeleteForward = 2, williamr@2: williamr@2: EDeleteLast williamr@2: }; williamr@2: williamr@2: /** Types of reformatting. This is used when...??? williamr@2: */ williamr@2: enum TTextChangeType williamr@2: { williamr@2: ETextChangeUndefined = 0, williamr@2: /** Change that causes no change in cursor position. */ williamr@2: ETextChangeNonLocal = 1, williamr@2: /** Change that moves the cursor to its trailing edge. */ williamr@2: ETextChangeTyping = 2, williamr@2: williamr@2: // Maybe several more. williamr@2: // ... williamr@2: ETExtChangeLast williamr@2: }; williamr@2: williamr@2: /** williamr@2: Hint for positioning the visual cursor. Describes properties of the williamr@2: editing operation that is most likely to happen next. williamr@2: */ williamr@2: enum TPosHint williamr@2: { williamr@2: EPosHintUndefined = 0, williamr@2: /** Left to right typing expected. */ williamr@2: EInsertStrongL2R = 1, williamr@2: /** Right to left typing expected. */ williamr@2: EInsertStrongR2L = 2, williamr@2: williamr@2: // Maybe several more. williamr@2: //... williamr@2: EPosHintLast williamr@2: }; williamr@2: williamr@2: public: williamr@2: williamr@2: //-- Object creation/setup API ------------------------------------------ williamr@2: williamr@2: /** williamr@2: */ williamr@2: virtual ~MCursorPositioningPolicy() {} williamr@2: williamr@2: /** williamr@2: Sets the document/layout object on which all the cursor navigation will williamr@2: take place. williamr@2: */ williamr@2: virtual void SetTmLayout(CTmViewAnchoredLayout* aLayout) = 0; williamr@2: williamr@2: williamr@2: //-- Cursor positioning API --------------------------------------------- williamr@2: williamr@2: /** williamr@2: Gets the cursor position for display and insertion. williamr@2: @return TTmDocPos value holding cursor document position. williamr@2: */ williamr@2: virtual const TTmDocPos& Pos() const = 0; williamr@2: williamr@2: /** williamr@2: Sets the cursor position explicitly. williamr@2: @param aNewPos New position cursor is to be moved to. williamr@2: */ williamr@2: virtual void SetPos(const TTmDocPos& aNewPos) = 0; williamr@2: williamr@2: williamr@2: /** williamr@2: @return ETrue if successful, EFalse otherwise e.g. no formatting williamr@2: */ williamr@2: virtual void PosXyL(TPoint& aXy) const = 0; williamr@2: williamr@2: /** williamr@2: Sets the X, Y co-ordinates to jump to. williamr@2: @param aXy Layout co-ordinates to approx. move the cursor to. williamr@2: On exit williamr@2: @return ETrue if successful, EFalse otherwise e.g. no formatting williamr@2: */ williamr@2: virtual void SetPosByXyL(TPoint& aNewXy) = 0; williamr@2: williamr@2: /** williamr@2: Allows change of cursor position in response to a hint as to williamr@2: positioning. williamr@2: @param aHint Text directional hint from client. williamr@2: */ williamr@2: virtual void SetPositioningHintL(TPosHint aHint) = 0; williamr@2: williamr@2: /** williamr@2: Suggests a new latent X,Y position for Up/Down operations/scrolls. williamr@2: @param aX X Layout co-ordinate for latent position of cursor. williamr@2: */ williamr@2: virtual void SetLatentX(TInt aX) = 0; williamr@2: williamr@2: /** williamr@2: Suggests a new latent X,Y position for Up/Down operations/scrolls. williamr@2: @param aY Y Layout co-ordinate for latent position of cursor. williamr@2: */ williamr@2: virtual void SetLatentY(TInt aY) = 0; williamr@2: williamr@2: /** williamr@2: Suggests a new latent X,Y position for Up/Down operations/scrolls. williamr@2: @param aXy X,Y Layout co-ordinate for latent position of cursor. williamr@2: */ williamr@2: virtual const TPoint& LatentXy() const = 0; williamr@2: williamr@2: /** williamr@2: Suggests a new latent X,Y position for Up/Down operations/scrolls. williamr@2: @param aXy X,Y Layout co-ordinate for latent position of cursor. williamr@2: */ williamr@2: virtual void SetLatentXy(const TPoint& aXy) = 0; williamr@2: williamr@2: /** williamr@2: @leave williamr@2: */ williamr@2: virtual const TPoint& UpdateLatentXyL() = 0; williamr@2: williamr@2: williamr@2: //--- Cursor navigation API --------------------------------------------- williamr@2: williamr@2: williamr@2: /** williamr@2: Moves the cursor up or down a line. williamr@2: @param aUp ETrue if wish to move up, EFalse to go down. williamr@2: @return TCursorMove Actual movement that took place. williamr@2: */ williamr@2: virtual TCursorMove UpDownL(TBool aUp) = 0; williamr@2: williamr@2: /** williamr@2: Moves the cursor left or right a character position. williamr@2: @param aDown ETrue if wish to move left, EFalse to go right. williamr@2: @return TCursorMove Actual movement that took place. williamr@2: */ williamr@2: virtual TCursorMove LeftRightL(TBool aLeft) = 0; williamr@2: williamr@2: /** williamr@2: Moves the cursor to the start or to the end of the line. williamr@2: @param aStart ETrue if wish to move to the start, EFalse to go to the end. williamr@2: @return TCursorMove Actual movement that took place. williamr@2: */ williamr@2: virtual TCursorMove LineStartEndL(TBool aStart) = 0; williamr@2: williamr@2: williamr@2: //--- Cursor reactionary API to changes --------------------------------- williamr@2: williamr@2: williamr@2: /** williamr@2: Responds to total change of formatting. williamr@2: */ williamr@2: virtual void HandleGlobalReformatL() = 0; williamr@2: williamr@2: /** williamr@2: Responds to partial change of formatting. williamr@2: @param aStart ? williamr@2: @param aOldEnd ? williamr@2: @param aNewEnd ? williamr@2: @param aParaFormatChg ? williamr@2: @param aChgType ? williamr@2: */ williamr@2: virtual void HandleReformatL(TInt aStart, TInt aOldEnd, williamr@2: TInt aNewEnd, TBool aParaFormatChg, TTextChangeType aChgType) = 0; williamr@2: williamr@2: williamr@2: //-- Misc/Unknown API --------------------------------------------------- williamr@2: williamr@2: williamr@2: /** williamr@2: Gets the cursor position for delete. ??? williamr@2: @param aDelType ? williamr@2: @param aStart ? williamr@2: @param aEnd ? williamr@2: */ williamr@2: virtual void GetDeletePosition(TDeleteType aDelType, TInt& aStart, williamr@2: TInt& aEnd) const = 0; williamr@2: williamr@2: /** williamr@2: Place holder for future expansion when if more virtual methods williamr@2: are requried. williamr@2: */ williamr@2: virtual void* ExtendedInterface(TUid aInterfaceId) = 0; williamr@2: williamr@2: }; williamr@2: williamr@2: williamr@2: #endif // __FRMCURS_H__