#include <INoteUIUtils.h>

Inheritance diagram for INoteUIUtils:

Public Types
enum	{ kDefaultIID = IID_INOTEUIUTILS }

enum	SelectionOwnerType { kNone, kSelectionInLayout, kSelectionInGalley, kSelectionInNoteInGalley, kSelectionInNoteInLayout }

Public Member Functions
virtual void	GoToNextNote (ISelectionManager *selMgr, TextIndex fromThisTextIndex, UIDRef docRef, UIDRef storyRef)=0

virtual void	GoToPreviousNote (ISelectionManager *selMgr, TextIndex fromThisTextIndex, UIDRef docRef, UIDRef storyRef)=0

virtual void	ShowNoteAnchorAt (ISelectionManager *selMgr, TextIndex noteAnchorPosition, UIDRef storyRef)=0

virtual void	DrawGalleyCaret (IControlView writingView, ITextLines textLines, int32 lineIndex, int32 caretOffsetIntoLine, int32 runIndex=-1, int32 caretOffsetIntoRun=-1)=0

virtual void	RenderThickCaret (IControlView *writingView, const IPMPoint &startPt, const IPMPoint &endPt)=0

virtual bool16	TextFocusInNote (UIDRef storyRef, TextIndex textIndex, TextIndex *anchorPosition)=0

virtual bool16	TextFocusInOwnedItem (UIDRef storyRef, TextIndex textFocus, TextIndex *owneItemPosition)=0

virtual void	SetGalleyWritingSelection (const RangeData &range)=0

virtual void	SelectNextNote (ISelectionManager *)=0

virtual void	SelectPrevNote (ISelectionManager *)=0

virtual void	ToggleNoteDisplay ()=0

virtual void	ExpandAllNotes ()=0

virtual void	CollapseAllNotes ()=0

virtual void	DoClearAllNotes ()=0

virtual void	DoOpenCloseNote ()=0

virtual bool16	GetFindChangeTextWalker () const =0

virtual bool16	GetSpellTextWalker () const =0

virtual bool16	GiveUpNoteSelection (IControlView *noteView=nil)=0

virtual ErrorCode	SetFrontDocViewSelection ()=0

virtual void	DrawHitTestBox (IControlView *view, const RangeData &caret, UIDRef storyRef)=0

virtual bool16	GetNoteRegion (ITextModel *textModel, TextIndex cursorIndexHit, int32 hitTestExpandOffset, TextIndex &anchorIndex) const =0

virtual void	ActivateInlineNote (UIDRef storyRef, UIDRef noteDataRef)=0

virtual void	InvalidateLayoutView ()=0

virtual SelectionOwnerType	GetCurrentTextSelection_ (TextIndex &nStart, TextIndex &nEnd, UIDRef *storyRef)=0

virtual bool16	InGalleyView ()=0

virtual void	GetCurrentActionState (TextIndex &focusStart, TextIndex &focusEnd, TextIndex &noteAnchorPos, UIDRef &storyRef, bool16 &storyHasFocus, bool16 &focusInsideNote, bool16 &focusInMainStoryThread, bool16 &noteHidden, bool16 &editable, bool16 &focusInsideDeletedText, TextIndex threadStart=nil, TextIndex threadEnd=nil)=0

virtual bool16	GetNewNoteActionState ()=0

virtual bool16	GetConvertToNoteActionState ()=0

virtual bool16	GetOpenNoteActionState ()=0

virtual bool16	GetDeleteNoteActionState ()=0

virtual bool16	GetScrollToAnchorActionState ()=0

virtual bool16	GetConvertToTextActionState ()=0

virtual bool16	GetSplitNoteActionState ()=0

virtual bool16	GetNaviationActionState ()=0

virtual bool16	GetExpandAllNoteActionState ()=0

virtual bool16	GetCollapseAllNoteActionState ()=0

virtual bool16	GetRemoveAllNoteActionState ()=0

virtual bool16	GetDisplayNoteActionState ()=0

virtual bool16	GetStoryNoteState (bool16 checkCollapsedState)=0

virtual bool16	FrontWindowGalley ()=0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Utility interface for Notes. Most of the utilities are not used in CS anymore. Instead, you should use INoteSuite and INoteSuiteUtils to achieve the same purpose.

Member Function Documentation

virtual void INoteUIUtils::ActivateInlineNote	(	UIDRef	storyRef,
		UIDRef	noteDataRef
	)

pure virtual

Put focus into an inline note.

Parameters

storyRef	The story
noteDataRef	The Note

virtual void INoteUIUtils::CollapseAllNotes ( )

pure virtual

Not used anymore. You can use INoteSuite::DoCollapseAllNotes(IControlView* view, IControlView* docView)

Parameters

none

virtual void INoteUIUtils::DoClearAllNotes ( )

pure virtual

Not used anymore. You can use INoteSuite::DoRemoveAllNotes(IControlView* view, IControlView* docView, IDocument *doc)

Parameters

none

virtual void INoteUIUtils::DoOpenCloseNote ( )

pure virtual

Not used anymore. You can use INoteSuite::DoOpenNote(IControlView* view, IControlView* docView)

Parameters

none

virtual void INoteUIUtils::DrawGalleyCaret	(	IControlView *	writingView,
		ITextLines *	textLines,
		int32	lineIndex,
		int32	caretOffsetIntoLine,
		int32	runIndex = `-1`,
		int32	caretOffsetIntoRun = `-1`
	)

pure virtual

This method draws a thick caret over the galley text with the given caret offset in the given line index. This can be used by the cursor provider to show visual feedback that galley text is being hovered on.

Parameters

writingView	The galley/story control view
textLines	The galley's ITextLines
lineIndex	The line index
caretOffsetIntoLine	The text index
runIndex	The text run index, default = -1, -1 means to use param caretOffsetIntoLine
caretOffsetIntoRun	default to -1, -1 means to use param caretOffsetIntoLine If runIndex != -1 and caretOffsetIntoRun != -1, means to use param caretOffsetIntoRun

virtual void INoteUIUtils::DrawHitTestBox	(	IControlView *	view,
		const RangeData &	caret,
		UIDRef	storyRef
	)

pure virtual

Draw a sqare box around the expansion zone near the note anchor character given in caret (RangeData(NoteAnchorIndex, RangeData::kLeanForward))

Parameters

view	The galley control view
caret	The range to be drawn
storyRef	The story

virtual void INoteUIUtils::ExpandAllNotes ( )

pure virtual

Not used anymore. You can use INoteSuite::DoExpandAllNotes(IControlView* view, IControlView* docView)

Parameters

none

virtual bool16 INoteUIUtils::FrontWindowGalley ( )

pure virtual

Removed : DoDragDropNote; use INoteUtils::DoDragDropNoteModel insteadInternal Use Only

virtual bool16 INoteUIUtils::GetCollapseAllNoteActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetConvertToNoteActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetConvertToTextActionState ( )

pure virtual

Internal Use Only

virtual void INoteUIUtils::GetCurrentActionState	(	TextIndex &	focusStart,
		TextIndex &	focusEnd,
		TextIndex &	noteAnchorPos,
		UIDRef &	storyRef,
		bool16 &	storyHasFocus,
		bool16 &	focusInsideNote,
		bool16 &	focusInMainStoryThread,
		bool16 &	noteHidden,
		bool16 &	editable,
		bool16 &	focusInsideDeletedText,
		TextIndex *	threadStart = `nil`,
		TextIndex *	threadEnd = `nil`
	)

pure virtual

Internal Use Only

virtual SelectionOwnerType INoteUIUtils::GetCurrentTextSelection_	(	TextIndex &	nStart,
		TextIndex &	nEnd,
		UIDRef *	storyRef
	)

pure virtual

Get current text selection from galley or layout

Parameters

nStart	The begin text index selection
nEnd	The end text index selection
storyRef	The story

Returns: SelectionOwnerType return INoteUIUtils::kSelectionInGalley, INoteUIUtils::kSelectionInNoteInGalley, INoteUIUtils::kSelectionInNoteInLayout, and INoteUIUtils::kSelectionInLayout

virtual bool16 INoteUIUtils::GetDeleteNoteActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetDisplayNoteActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetExpandAllNoteActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetFindChangeTextWalker ( ) const

pure virtual

Not used anymore.

Parameters

none

Returns: bool16

virtual bool16 INoteUIUtils::GetNaviationActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetNewNoteActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetNoteRegion	(	ITextModel *	textModel,
		TextIndex	cursorIndexHit,
		int32	hitTestExpandOffset,
		TextIndex &	anchorIndex
	)		const

pure virtual

Not used anymore.

Parameters

textModel
cursorIndexHit
hitTestExpandOffset
anchorIndex

Returns: bool16

virtual bool16 INoteUIUtils::GetOpenNoteActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetRemoveAllNoteActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetScrollToAnchorActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetSpellTextWalker ( ) const

pure virtual

Not used anymore.

Parameters

none

Returns: bool16

virtual bool16 INoteUIUtils::GetSplitNoteActionState ( )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GetStoryNoteState ( bool16 checkCollapsedState )

pure virtual

Internal Use Only

virtual bool16 INoteUIUtils::GiveUpNoteSelection ( IControlView * noteView = nil )

pure virtual

Deselect note text selection.

Parameters

noteView The Note palette control view

Returns: bool16 kTrue means active selection is Note selection and has been deselect kFalse means active selection is not Note selection

virtual void INoteUIUtils::GoToNextNote	(	ISelectionManager *	selMgr,
		TextIndex	fromThisTextIndex,
		UIDRef	docRef,
		UIDRef	storyRef
	)

pure virtual

Not used anymore. You can use INoteSuitUtils::NavigateNote(ISelectionManager* selMgr, IControlView *docView, TextIndex fromThisTextIndex, UIDRef storyRef, INoteSuite::NavigateType type) to navigate Notes.

Parameters

selMgr
fromThisTextIndex
docRef
storyRef

virtual void INoteUIUtils::GoToPreviousNote	(	ISelectionManager *	selMgr,
		TextIndex	fromThisTextIndex,
		UIDRef	docRef,
		UIDRef	storyRef
	)

pure virtual

Not used anymore. You can use INoteSuitUtils::NavigateNote(ISelectionManager* selMgr, IControlView *docView, TextIndex fromThisTextIndex, UIDRef storyRef, INoteSuite::NavigateType type) to navigate Notes.

Parameters

selMgr
fromThisTextIndex
docRef
storyRef

virtual bool16 INoteUIUtils::InGalleyView ( )

pure virtual

check to see if active view is galley/story view

Parameters

none

Returns: bool16

virtual void INoteUIUtils::InvalidateLayoutView ( )

pure virtual

Invalidate the front document layout view to force redraw.

Parameters

none

virtual void INoteUIUtils::RenderThickCaret	(	IControlView *	writingView,
		const IPMPoint &	startPt,
		const IPMPoint &	endPt
	)

pure virtual

This method draws a thick caret over the galley text with the given drawPt and endPt. Used by DrawGalleyCaret

Parameters

writingView	The galley control view
startPt	The start point
endPt	The end point

virtual void INoteUIUtils::SelectNextNote ( ISelectionManager * )

pure virtual

Not used anymore.

Parameters

ISelectionManager*

virtual void INoteUIUtils::SelectPrevNote ( ISelectionManager * )

pure virtual

Not used anymore.

Parameters

ISelectionManager*

virtual ErrorCode INoteUIUtils::SetFrontDocViewSelection ( )

pure virtual

Yields selection back to the frontmost document window

Parameters

none

Returns: ErrorCode

virtual void INoteUIUtils::SetGalleyWritingSelection ( const RangeData & range )

pure virtual

Not used anymore.

Parameters

range

virtual void INoteUIUtils::ShowNoteAnchorAt	(	ISelectionManager *	selMgr,
		TextIndex	noteAnchorPosition,
		UIDRef	storyRef
	)

pure virtual

Not used anymore. You can use INoteSuite::DoScrollToNote(IControlView* view, IControlView* docView)

Parameters

selMgr
noteAnchorPosition
storyRef

virtual bool16 INoteUIUtils::TextFocusInNote	(	UIDRef	storyRef,
		TextIndex	textIndex,
		TextIndex *	anchorPosition
	)

pure virtual

Check if textIndex is inside a Note.

Parameters

storyRef	The story
textIndex	The text index
anchorPosition	return the text anchor index of the Note or kInvalidTextIndex

Returns: bool16 kTrue means textIndex is inside a Note, kFalse means textIndex is not inside a Note

virtual bool16 INoteUIUtils::TextFocusInOwnedItem	(	UIDRef	storyRef,
		TextIndex	textFocus,
		TextIndex *	owneItemPosition
	)

pure virtual

Not used anymore.

Parameters

storyRef
textFocus
owneItemPosition

Returns: bool16

virtual void INoteUIUtils::ToggleNoteDisplay ( )

pure virtual

Not used anymore. You can use INoteSuite::DoShowHideNote(IControlView* view, IControlView* docView)

Parameters

none

Public Types

Public Member Functions

Detailed Description

Member Function Documentation