ITextSelectionSuite Class Reference

#include <ITextSelectionSuite.h>

Inheritance diagram for ITextSelectionSuite:

Public Types
enum	{ kDefaultIID = IID_ITEXTSELECTION_SUITE }
enum	ToggleType { kFootnotesOnly, kAnchoredFramesOnly, kAnyType }
enum	Change {   kMoveSelection = 0, kMove = kMoveSelection, kReplaceSelection = kMove, kExtendSelection = 1,   kExtend = kExtendSelection }
enum	Units {   kNone = 0, kCharacter, kChar = kCharacter, kWord,   kLine, kSentence, kParagraph = 5, kStory = 9 }
enum	Direction {   kNext, kPrev, kStart, kEnd,   kAll }

Public Member Functions
virtual void	SetActiveConcreteSelection (ClassID)=0
virtual ClassID	GetActiveConcreteSelection ()=0
virtual bool16	SetTextSelection (const UIDRef &story, const RangeData &range, Selection::ScrollChoice doScroll, const RangeData *scrollTo)=0
virtual bool16	SetTextSelection (IPMUnknown *targetingBoss, Selection::ScrollChoice doScroll, const RangeData *scrollTo)=0
virtual bool16	CanToggleAnchorSelection (ToggleType type=kAnyType)=0
virtual bool16	ToggleAnchorSelection (ToggleType type=kAnyType)=0
virtual bool16	ChangeTextSelection (Change moveOrExtend, Units textUnits, Direction direction, Selection::ScrollChoice autoScroll)=0
virtual bool16	ScrollViewTo (IControlView *view, const RangeData &location)=0
virtual bool16	ScrollViewToSelection (IControlView *view)=0
virtual bool16	CenterViewOn (IControlView *view, const RangeData &location)=0
virtual bool16	CenterSelectionInView (IControlView *view)=0
virtual TextSelectionState *	SelectTextInViewBegin (IControlView *view, const PBPMPoint &viewLoc, ITextStoryThread *theStoryThread, ParcelKey theParcel, Change change, Units units)=0
virtual void	SelectTextInViewContinue (TextSelectionState *state, const PBPMPoint &viewLoc, ParcelKey parcelHitKey)=0
virtual void	SelectTextInViewFlush (TextSelectionState *state)=0
virtual void	SelectTextInViewSuspend (TextSelectionState *state)=0
virtual void	SelectTextInViewResume (TextSelectionState *state, const PBPMPoint &viewLoc, ParcelKey parcelHitKey)=0
virtual void	SelectTextInViewEnd (TextSelectionState *state)=0
virtual bool16	IsTextSelectionInTable () const =0
virtual bool16	IsTextSelectionInFootnote () const =0
virtual bool16	IsInsertionPoint () const =0
virtual bool16	CanTrackerExtendTableSelection (ITableModel *trackerFramesTableModel) const =0
Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0
virtual void	AddRef () const =0
virtual void	Release () const =0

Protected Types
enum	DrawChoice { kDontDrawSelection, kDrawSelection }

Friends
class	TextSelectionIntegratorSuite
class	TextSelectionIntegratorSuiteTemp
class	TextCellTextSelectTracker
class	TextCellSelectTracker
class	HorizontalIBeamCrsrProvider
class	FootnoteTextSelectTracker
class	FrameShape
class	TextSelectionHighlighter
class	CWaxRunText
class	TableShape
class	CLineSegmentAdornment
class	MoveRowColumnTracker
class	CharacterAlternatesData

Detailed Description

Interface for the text selection suite.

Note

several declarations are marked for internal use only. These declarations are still present in this file in their current form due to time contraints only. Expect that they will be modified or removed in a future version of this interface.

Member Enumeration Documentation

enum ITextSelectionSuite::DrawChoice

protected

for internal use only

Member Function Documentation

virtual bool16 ITextSelectionSuite::CanToggleAnchorSelection ( ToggleType  type = kAnyType )

pure virtual

can we move the selection from anchored text (anchored frame, footnote, etc.) to the anchor itself (or vice-versa)

Parameters

type	can control what sort of toggling to test

Returns

can Toggle, kTrue, otherwise, kFalse.

virtual bool16 ITextSelectionSuite::CanTrackerExtendTableSelection ( ITableModel *  trackerFramesTableModel ) const

pure virtual

for internal use only

virtual bool16 ITextSelectionSuite::CenterSelectionInView ( IControlView *  view )

pure virtual

for internal use only

virtual bool16 ITextSelectionSuite::CenterViewOn ( IControlView *  view, const RangeData &  location  )

pure virtual

for internal use only

virtual bool16 ITextSelectionSuite::ChangeTextSelection ( Change  moveOrExtend, Units  textUnits, Direction  direction, Selection::ScrollChoice  autoScroll  )

pure virtual

select text relative to the current text selection in the view or views associated with this suite.

Parameters

moveOrExtend	kExtend causes the selection to be extended from its current position, kMove causes the selection to move relative to its current position.
textUnits	the units of text by which the selection changes.
direction	the direction by which the selection changes.
autoScroll	whether to scroll the new selection into view.

Returns

on success, kTrue, otherwise, kFalse.

virtual ClassID ITextSelectionSuite::GetActiveConcreteSelection ( )

pure virtual

for internal use only

virtual bool16 ITextSelectionSuite::IsTextSelectionInTable ( ) const

pure virtual

for internal use only

virtual bool16 ITextSelectionSuite::ScrollViewTo ( IControlView *  view, const RangeData &  location  )

pure virtual

without changing the current text selection, scroll into view the given text location of the story currently containing the selection.

Parameters

view	the view to be scrolled.
location	the text range to scroll into view.

Returns

on success, kTrue, otherwise, kFalse.

virtual bool16 ITextSelectionSuite::ScrollViewToSelection ( IControlView *  view )

pure virtual

for internal use only

virtual TextSelectionState* ITextSelectionSuite::SelectTextInViewBegin ( IControlView *  view, const PBPMPoint &  viewLoc, ITextStoryThread *  theStoryThread, ParcelKey  theParcel, Change  change, Units  units  )

pure virtual

for internal use only

virtual void ITextSelectionSuite::SelectTextInViewContinue ( TextSelectionState *  state, const PBPMPoint &  viewLoc, ParcelKey  parcelHitKey  )

pure virtual

for internal use only

virtual void ITextSelectionSuite::SelectTextInViewEnd ( TextSelectionState *  state )

pure virtual

for internal use only

virtual void ITextSelectionSuite::SelectTextInViewFlush ( TextSelectionState *  state )

pure virtual

for internal use only

virtual void ITextSelectionSuite::SelectTextInViewResume ( TextSelectionState *  state, const PBPMPoint &  viewLoc, ParcelKey  parcelHitKey  )

pure virtual

for internal use only

virtual void ITextSelectionSuite::SelectTextInViewSuspend ( TextSelectionState *  state )

pure virtual

for internal use only

virtual void ITextSelectionSuite::SetActiveConcreteSelection ( ClassID  )

pure virtual

for internal use only

virtual bool16 ITextSelectionSuite::SetTextSelection ( const UIDRef &  story, const RangeData &  range, Selection::ScrollChoice  doScroll, const RangeData *  scrollTo  )

pure virtual

select text in the view or views associated with this suite.

Parameters

story	the story to select.
range	the text range to select.
doScroll	whether to scroll the new selection into view.
scrollTo	if doScroll == Selection::kScrollIntoView, the range of text that should be brought into view.

Returns

on success, kTrue, otherwise, kFalse.

virtual bool16 ITextSelectionSuite::SetTextSelection ( IPMUnknown *  targetingBoss, Selection::ScrollChoice  doScroll, const RangeData *  scrollTo  )

pure virtual

select text in the view or views associated with this suite.

Parameters

targetingBoss	a boss with an ITextTarget interface containing the story and range to select.
doScroll	whether to scroll the new selection into view.
scrollTo	if doScroll == Selection::kScrollIntoView, the range of text that should be brought into view.

Returns

on success, kTrue, otherwise, kFalse.

virtual bool16 ITextSelectionSuite::ToggleAnchorSelection ( ToggleType  type = kAnyType )

pure virtual

move the selection from anchored text (anchored frame, footnote, etc.) to the anchor itself (or vice-versa)

Parameters

type	can control what sort of toggling to allow

Returns

on success, kTrue, otherwise, kFalse.