ICreateNoteCmdData Class Reference

#include <ICreateNoteCmdData.h>

Inheritance diagram for ICreateNoteCmdData:

Public Types
enum	{ kDefaultIID = IID_ICREATENOTECMDDATA }

Public Member Functions
virtual const WideString &	GetAuthor () const =0
virtual bool16	GetCollapse () const =0
virtual void	SetCollapse (const bool16 collapse)=0
virtual void	Set (const WideString &author, bool16 collapsedState)=0
virtual void	GetNoteContentRange (TextIndex &start, TextIndex &end)=0
virtual void	SetNoteContentRange (TextIndex start, TextIndex end)=0
virtual bool16	GetShouldUseExistingCharacter () const =0
virtual void	SetShouldUseExistingCharacter (const bool16 shouldUse)=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

Command data interface, set/get the Note data for the command kCreateNoteCmdBoss

Member Function Documentation

virtual const WideString& ICreateNoteCmdData::GetAuthor ( ) const

pure virtual

Get methose to get the author of the Note

Parameters

none

Returns

const

virtual bool16 ICreateNoteCmdData::GetCollapse ( ) const

pure virtual

Get method to get the collapsed state for the Note

Parameters

none

Returns

bool16 kTrue = Note will be collapsed

virtual void ICreateNoteCmdData::GetNoteContentRange ( TextIndex &  start, TextIndex &  end  )

pure virtual

Get method to get the range of text going into the Note

Parameters

start
end

virtual bool16 ICreateNoteCmdData::GetShouldUseExistingCharacter ( ) const

pure virtual

Get method to get whether or not to add the note character to the model or use the existing character

Parameters

none

Returns

bool16 kTrue = the create command should use the existing character (caller guarantees it is a valid "note" character)

virtual void ICreateNoteCmdData::Set ( const WideString &  author, bool16  collapsedState  )

pure virtual

Set the author and collapsed state for the Note

Parameters

author
collapsedState	kTrue = Note will be collapsed

virtual void ICreateNoteCmdData::SetCollapse ( const bool16  collapse )

pure virtual

Set method to set the collapsed state for the Note

Parameters

collapse

virtual void ICreateNoteCmdData::SetNoteContentRange ( TextIndex  start, TextIndex  end  )

pure virtual

Set method to set the range of text going into the Note

Parameters

start
end

virtual void ICreateNoteCmdData::SetShouldUseExistingCharacter ( const bool16  shouldUse )

pure virtual

Set method to set whether or not to add the note character to the model or use the existing character. The caller who sets this to kTrue guarantees that the special "note" character exists in the text model at the location where the note is being anchored.

Parameters

shouldUse