#include <INoteSuite.h>

Inheritance diagram for INoteSuite:

Public Types
enum	{ kDefaultIID = IID_INOTESUITE }

enum	NavigateType { kNextNote =0, kPreviousNote }

enum	CopyToNoteType { kWordToNote =0, kLineToNote, kParaToNote, kStoryToNote }

Public Member Functions
virtual bool16	CanAddNote (IControlView *view) const =0

virtual void	DoAddNote (IControlView *view)=0

virtual bool16	CanConvertToNote (IControlView *view) const =0

virtual void	DoConvertToNote (IControlView *view, ClassID commandBossID)=0

virtual bool16	CanOpenNote (IControlView view, IControlView docView, PMString &menuString) const =0

virtual void	DoOpenNote (IControlView view, IControlView docView)=0

virtual bool16	CanDeleteNote (IControlView view, IControlView docView) const =0

virtual void	DoDeleteNote (IControlView view, IControlView docView)=0

virtual bool16	CanConvertToText (IControlView view, IControlView docView) const =0

virtual void	DoConvertToText (IControlView view, IControlView docView)=0

virtual bool16	CanScrollToNote (IControlView view, IControlView docView) const =0

virtual void	DoScrollToNote (IControlView view, IControlView docView)=0

virtual bool16	CanNavigateNote (IControlView view, IControlView docView, bool16 *inPalette=nil) const =0

virtual void	DoNavigateNote (IControlView view, IControlView docView, ISelectionManager *selMgr, NavigateType type)=0

virtual bool16	CanRemoveAllNotes (IControlView view, IControlView docView, IDocument *doc) const =0

virtual void	DoRemoveAllNotes (IControlView view, IControlView docView, IDocument *doc)=0

virtual bool16	CanRemoveStoryNotes (IControlView view, IControlView docView) const =0

virtual void	DoRemoveStoryNotes (IControlView view, IControlView docView)=0

virtual bool16	CanSplitNote (IControlView view, IControlView docView, bool16 bNotesMode=kFalse) const =0

virtual void	DoSplitNote (IControlView view, IControlView docView)=0

virtual bool16	CanShowHideNote (IControlView view, IControlView docView) const =0

virtual void	DoShowHideNote (IControlView view, IControlView docView)=0

virtual bool16	CanExpandAllNotes (IControlView view, IControlView docView) const =0

virtual void	DoExpandAllNotes (IControlView view, IControlView docView)=0

virtual bool16	CanCollapseAllNotes (IControlView view, IControlView docView) const =0

virtual void	DoCollapseAllNotes (IControlView view, IControlView docView)=0

virtual void	SetSelection (IControlView *view, ITextSelectionSuite::Units selectType)=0

virtual void	DoSetNoteToPalette (IControlView view, IControlView docView)=0

virtual bool16	IsInNote () 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

Detailed Description

A selection related text suite interface to perform the Notes actions

Member Enumeration Documentation

enum INoteSuite::CopyToNoteType

The type of text content copied to convert to a Note

enum INoteSuite::NavigateType

The navigation type

Member Function Documentation

virtual bool16 INoteSuite::CanAddNote ( IControlView * view ) const

pure virtual

Can add a Note

Parameters

view	The active context control view

Returns: bool16 kTrue means can add a Note

virtual bool16 INoteSuite::CanCollapseAllNotes	(	IControlView *	view,
		IControlView *	docView
	)		const

pure virtual

Can collapse all Notes in the document

Parameters

view	The active context control view
docView	The current view in the document

Returns: bool16 kTrue means there is at least one expanded Note displaying in the document

virtual bool16 INoteSuite::CanConvertToNote ( IControlView * view ) const

pure virtual

Can convert the selected text into a Note

Parameters

view	The active context control view

Returns: bool16

virtual bool16 INoteSuite::CanConvertToText	(	IControlView *	view,
		IControlView *	docView
	)		const

pure virtual

Can convert the selected text to a Note

Parameters

view	The active context control view
docView	The current view in the document

Returns: bool16

virtual bool16 INoteSuite::CanDeleteNote	(	IControlView *	view,
		IControlView *	docView
	)		const

pure virtual

Can delete the selected Note

Parameters

view	The active context control view
docView	The current view in the document

Returns: bool16 kTrue means can deleted the Note

virtual bool16 INoteSuite::CanExpandAllNotes	(	IControlView *	view,
		IControlView *	docView
	)		const

pure virtual

Can expand all Notes in the document

Parameters

view	The active context control view
docView	The current view in the document

Returns: bool16 kTrue means there is at least one collapsed Note displaying in the document

virtual bool16 INoteSuite::CanNavigateNote	(	IControlView *	view,
		IControlView *	docView,
		bool16 *	inPalette = `nil`
	)		const

pure virtual

Can navigate to previous/next Note

Parameters

view	The active context control view
docView	The current view in the document
inPalette	kTrue means the active context is in Note Palette

Returns: bool16

virtual bool16 INoteSuite::CanOpenNote	(	IControlView *	view,
		IControlView *	docView,
		PMString &	menuString
	)		const

pure virtual

Can open the Note

Parameters

view	The active context control view
docView	The current view in the document
menuString	"Open Note" if the active context is layout view, "Collapse Note" or "Expand Note" if the active context is galley/story view or Note palette view

Returns: bool16 kTrue means can open the Note in Note palette if active context is in layout view, kTrue means can collapsed/expand the Note if active context is in galley view or in Note Palette

virtual bool16 INoteSuite::CanRemoveAllNotes	(	IControlView *	view,
		IControlView *	docView,
		IDocument *	doc
	)		const

pure virtual

Can remove all Notes in the document

Parameters

view	The active context control view
docView	The current view in the document
doc	The document

Returns: bool16 kTrue means there is at least a Note in any editable story excepted the current story

virtual bool16 INoteSuite::CanRemoveStoryNotes	(	IControlView *	view,
		IControlView *	docView
	)		const

pure virtual

Can remove Notes from the story has insertion point

Parameters

view	The active context control view
docView	The current view in the document

Returns: bool16 kTrue means there is at least one Note in the current story and story is editable

virtual bool16 INoteSuite::CanScrollToNote	(	IControlView *	view,
		IControlView *	docView
	)		const

pure virtual

Can scroll to Note anchor

Parameters

view	The active context control view
docView	The current view in the document

Returns: bool16

virtual bool16 INoteSuite::CanShowHideNote	(	IControlView *	view,
		IControlView *	docView
	)		const

pure virtual

Can show or hide Notes

Parameters

view	The active context control view
docView	The current view in the document

Returns: bool16 kTrue means there is at least one Note in the document

virtual bool16 INoteSuite::CanSplitNote	(	IControlView *	view,
		IControlView *	docView,
		bool16	bNotesMode = `kFalse`
	)		const

pure virtual

Can split a Note

Parameters

view	The active context control view
docView	The current view in the document
bNotesMode	kTrue means to check if can split a Note from NotesMode action

Returns: bool16 if bNotesMode is kTrue, return kTrue when insertion point is inside a Note and not in the begin nor end of the Note content if bNotesMode is kFalse, return kTrue when insertion point is inside a Note

virtual void INoteSuite::DoAddNote ( IControlView * view )

pure virtual

Process Add a Note

Parameters

view	The active context control view

virtual void INoteSuite::DoCollapseAllNotes	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Collapse all Notes in the document

Parameters

view	The active context control view
docView	The current view in the document

virtual void INoteSuite::DoConvertToNote	(	IControlView *	view,
		ClassID	commandBossID
	)

pure virtual

Process the convertion of the selected text into a Note

Parameters

view	The active context control view
commandBossID	kConvertToNoteCmdBoss means convert the selected text into a Note( selected text was deleted). kCopyToNoteCmdBoss means copy the selected text and make a Note with the selected content (selected text was not deleted)

virtual void INoteSuite::DoConvertToText	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Convert the selected text to a Note

Parameters

view	The active context control view
docView	The current view in the document

virtual void INoteSuite::DoDeleteNote	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Process the deletion of Note

Parameters

view	The active context control view
docView	The current view in the document

virtual void INoteSuite::DoExpandAllNotes	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Process expand all Notes in the document

Parameters

view	The active context control view
docView	The current view in the document

virtual void INoteSuite::DoNavigateNote	(	IControlView *	view,
		IControlView *	docView,
		ISelectionManager *	selMgr,
		NavigateType	type
	)

pure virtual

Navigate the Note forward (kNextNote) or backward (kPreviousNote) from current insertion point

Parameters

view	The active context control view
docView	The current view in the document
selMgr	The selection manager for the view
type	kNextNote, kPreviousNote

virtual void INoteSuite::DoOpenNote	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Process display the selected Note to Note Palette if active context is layout view Process collapsed/expanded the Note if active context is galley/story view or Note Palette view

Parameters

view	The active context control view
docView	The current view in the document

virtual void INoteSuite::DoRemoveAllNotes	(	IControlView *	view,
		IControlView *	docView,
		IDocument *	doc
	)

pure virtual

Remove the Notes in all unlocked stories in the document

Parameters

view	The active context control view
docView	The current view in the document
doc	The document

virtual void INoteSuite::DoRemoveStoryNotes	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Remove all Notes from the unlocked story which has insertion point

Parameters

view	The active context control view
docView	The current view in the document

virtual void INoteSuite::DoScrollToNote	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Scroll to Note anchor

Parameters

view	The active context control view
docView	The current view in the document

virtual void INoteSuite::DoSetNoteToPalette	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Display the Note content to palette if clicks inside the inline Note, or selects the Note void action when the text focus is in Note palette

Parameters

view	The active context control view
docView	The current view in the document

virtual void INoteSuite::DoShowHideNote	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Toggle displaying Notes

Parameters

view	The active context control view
docView	The current view in the document

virtual void INoteSuite::DoSplitNote	(	IControlView *	view,
		IControlView *	docView
	)

pure virtual

Split a Note into two Notes, place insertion point between two Notes in story

Parameters

view	The active context control view
docView	The current view in the document

virtual bool16 INoteSuite::IsInNote ( ) const

pure virtual

Check if the insertion point is in a Note.

Parameters

none

Returns: bool16 kTrue if the selection is in a Note.

virtual void INoteSuite::SetSelection	(	IControlView *	view,
		ITextSelectionSuite::Units	selectType
	)

pure virtual

Process set selection

Parameters

view	The active context control view
selectType	The selection type

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation