INotePrefCmdData Class Reference

#include <INotePrefCmdData.h>

Inheritance diagram for INotePrefCmdData:

Public Member Functions
virtual void	Set (const UIDRef &doc, int32 colorIndex, bool16 showTips, bool16 spellCheckNote, bool16 findReplaceNote, INotePref::BackgroundColorChoice displayChoice, INotePref::NoteColorChoice noteColorChoice)=0
virtual void	SetDocument (const UIDRef &doc)=0
virtual void	SetColorID (const int32 val)=0
virtual const UIDRef &	GetDocument () const =0
virtual const int32	GetColorID () const =0
virtual const bool16	GetShowNoteTips () const =0
virtual const bool16	GetSpellCheckContent () const =0
virtual const bool16	GetFindReplaceContent () const =0
virtual const INotePref::BackgroundColorChoice	GetBackgroundColorChoice () const =0
virtual const INotePref::NoteColorChoice	GetNoteColorChoice () 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

kNotePrefsCmdBoss Command data interface, sets the Notes preferences values.

Member Function Documentation

virtual const INotePref::BackgroundColorChoice INotePrefCmdData::GetBackgroundColorChoice ( ) const

pure virtual

Get the type of inline Notes background color to use

Parameters

none

Returns

const

virtual const int32 INotePrefCmdData::GetColorID ( ) const

pure virtual

Get the color index

Parameters

none

Returns

const

virtual const UIDRef& INotePrefCmdData::GetDocument ( ) const

pure virtual

Get document

Parameters

none

Returns

const

virtual const bool16 INotePrefCmdData::GetFindReplaceContent ( ) const

pure virtual

Find/replace the inline Notes content or not

Parameters

none

Returns

const kTrue means to find/change inline Notes content

virtual const INotePref::NoteColorChoice INotePrefCmdData::GetNoteColorChoice ( ) const

pure virtual

Get the type of inline Notes color to use

Parameters

none

Returns

const

virtual const bool16 INotePrefCmdData::GetShowNoteTips ( ) const

pure virtual

Show inline Notes tips or not

Parameters

none

Returns

const kTrue means to show inline Notes tips

virtual const bool16 INotePrefCmdData::GetSpellCheckContent ( ) const

pure virtual

Spell/check the inline Notes content or not

Parameters

none

Returns

const kTrue means to spell/check inline Notes content

virtual void INotePrefCmdData::Set ( const UIDRef &  doc, int32  colorIndex, bool16  showTips, bool16  spellCheckNote, bool16  findReplaceNote, INotePref::BackgroundColorChoice  displayChoice, INotePref::NoteColorChoice  noteColorChoice  )

pure virtual

Set the values

Parameters

doc	Not used, since the kNotePrefsCmdBoss sets the session Notes preferences, can be UIDRef::gNull
colorIndex	The color index the inline Note displayed
showTips	kTrue means to show inline Notes tips
spellCheckNote	kTrue means to spell/check the inline Notes content
findReplaceNote	kTrue means to find/replace the inline Notes content
displayChoice	The type of inline Notes background color to use
noteColorChoice	The type of inline Notes color to use

virtual void INotePrefCmdData::SetColorID ( const int32  val )

pure virtual

Set the inline Notes color index

Parameters

val

virtual void INotePrefCmdData::SetDocument ( const UIDRef &  doc )

pure virtual

Set the document

Parameters

doc