ICTextNavigationSuite.h

//========================================================================================
// 
// $File$
// 
// Owner: Ben Park
// 
// $Author$
// 
// $DateTime$
// 
// $Revision$
// 
// $Change$
// 
// Copyright 1997-2010 Adobe Systems Incorporated. All rights reserved.
// 
// NOTICE: Adobe permits you to use, modify, and distribute this file in accordance 
// with the terms of the Adobe license agreement accompanying it. If you have received
// this file from a source other than Adobe, then your use, modification, or 
// distribution of it requires the prior written permission of Adobe.
// 
//========================================================================================

#ifndef __ICTextNavigationSuite__
#define __ICTextNavigationSuite__

#include "IPMUnknown.h"

#include "UIDRef.h"
#include "WritingModeUIID2.h"
#include "WritingModeID2.h"
class RangeData;
/*
 This sucker is used for navigating the Galley Text. The big table below was copied from
 ITextSelectionNavigator, and it's a list of keyboard shortcuts that can be used. 
 I'll modify it as new stuff is added. Of course, this can be used w/o keyboard shortcuts 
 (ex. triple click will select a paragraph).
 
 No. Shortcut Unit Direction Type Mac OS Windows
 ======================================================================================================
 699 Move to the right one character kChar kNext replace Right arrow Right arrow 
 700 Move to the left one character kChar kPrev replace Left arrow Left arrow
 701 Move up one line kLine kPrev replace Up arrow Up arrow 
 702 Move down one line kLine kNext replace Down arrow Down arrow 
 703 Move to the right one word kWord kNext replace Cmd + Right Arrow Ctrl + Right Arrow 
 704 Move to the left one word kWord kPrev replace Cmd + Left Arrow Ctrl + Left Arrow
 705 Move to the start of the line kLine kStart replace Home Home
 706 Move to the end of the line kLine kEnd replace End End
 707 Move to the previous para kPara kPrev replace Cmd + Up Arrow Ctrl + Up Arrow
 708 Move to the next para kPara kNext replace Cmd + Down Arrow Ctrl + Down Arrow
 709 Move to end of story kStory kEnd replace Cmd + End Ctrl + End
 710 Move to begining of story kStory kStart replace Cmd + Home Ctrl + Home
 712 Select word kWord kAll replace Double Click Double Click 
 713 Select one character to the right kChar kNext expand Shift + Right Arrow Shift + Right Arrow 
 714 Select one character to the left kChar kPrev expand Shift + Left Arrow Shift + Left Arrow 
 715 Select one word to the right kWord kNext expand Cmd + Shift + Right Arrow Ctrl + Shift + Right Arrow
 716 Select one word to the left kWord kPrev expand Cmd + Shift + Left Arrow Ctrl + Shift + Left Arrow 
 717 Select to the start of the line kLine kStart expand Shift + Home Shift + Home
 718 Select to the end of the line kLine kEnd expand Shift + End Shift + End
 719 Select one line above kLine kPrev expand Shift + Up Arrow Shift + Up Arrow 
 720 Select one line below kLine kNext expand Shift + Down Arrow Shift + Down Arrow 
 721 Select one paragraph before kPara kPrev expand Cmd + Shift + Up Arrow Ctrl + Shift + Up Arrow
 722 Select one paragraph forward kPara kPrev expand Cmd + Shift + Down Arrow Ctrl + Shift + Down Arrow
 723 Select all chars. in story kStory kAll expand Cmd + A Ctrl + A 
 724 Select chars. from insertion point kChar kAll expand Shift + Click Shift + Click 
 725 Select to end of story kStory kEnd expand Cmd + Shift + End Ctrl + Shift + End
 726 Select to beginning of story kStory kStart expand Cmd + Shift + Home Ctrl + Shift + Home
*/
 
 class TextSelectionIndex
 {
 
 public:
 inline TextSelectionIndex() :
 fIndex( kInvalidTextIndex ),
 fEndOfLine( kFalse )
 {};
 
 
 inline TextSelectionIndex( TextIndex nIndex, bool16 endOfLine /*= kFalse*/) : 
 fIndex( nIndex ), 
 fEndOfLine( endOfLine )
 { }
 
 TextSelectionIndex& operator= (const TextSelectionIndex& rhs)
 {
 fIndex = rhs.fIndex;
 fEndOfLine = rhs.fEndOfLine;
 
 return *this;
 }
 
 TextIndex fIndex;

 bool16 fEndOfLine;
 };
 
 const TextSelectionIndex kInvalidTextSelectionIndex (kInvalidTextIndex, kFalse);
 
 
 
class SelectionExtension;

class ICTextNavigationSuite : public IPMUnknown
{
public:
 enum { kDefaultIID = IID_ICTEXTNAVIGATIONSUITE };
 
 enum Units { 
 kNone,
 kChar,
 kWord,
 kLine,
 kParagraph,
 kStory,
 kSentence
 };

 enum Direction {
 kNext,
 kPrev,
 kStart,
 kEnd,
 kAll
 }; 

#if 0

#endif

 enum ScrollChoice {
 kDontScrollSelection,
 kScrollIntoView
 };

 enum LooseEnd { 
 kLooseStart,
 kLooseEnd
 };

 //virtual bool16 SetTextSelection( const RangeData& range, 
 // bool16 endUsedLast = kTrue, bool16 drawIt = kFalse, bool16 autoScroll = kTrue ) = 0;

 virtual bool16 SetTextSelection( const RangeData& range, 
 LooseEnd endUsedLast /*= kLooseEnd*/, ScrollChoice autoScroll /*= kScrollIntoView*/, SelectionExtension *extendToUIDPair = nil) = 0; //draw == true

 virtual bool16 SelectAll() = 0;

 virtual bool16 SelectTextAt( TextSelectionIndex nTo, Units nUnits) = 0;

 virtual bool16 MoveTextSelection( Units nUnits, Direction nDirection) = 0; //drawit == kTrue

 virtual bool16 ExpandTo( TextSelectionIndex nTo) = 0;

 virtual bool16 ExpandTextSelection ( Units nUnits, Direction nDirection) = 0;

 virtual void ResetNavigationState () = 0;
 
 // These functins allow outside users to get the relevant Text Nav Data. The factors tracked here are:
 // Last up/down position
 // Anchor point
 // Start/end indexes end of line data

 virtual RangeData GetAnchorData ( bool16 *usedEndLast ) = 0;

 virtual TextIndex InterpretHitTest( int32 clickCount, TextIndex newPosition, TextSelectionIndex *pEnd) = 0;


 virtual void MoveSelectionToVisiblePage() = 0;

};


#endif // __ICTextNavigationSuite__