INotePref Class Reference

#include <INotePref.h>

Inheritance diagram for INotePref:

Public Types
enum	BackgroundColorChoice { kGalleyColorBG, kNoteColorBG }
enum	NoteColorChoice { kUseUserColor, kUseNotePrefColor }

Public Member Functions
virtual void	SetColorID (const int32 colorIndex)=0
virtual const int32	GetColorID () const =0
virtual void	SetShowNoteTips (const bool16 showTips)=0
virtual const bool16	GetShowNoteTips () const =0
virtual void	SetSpellCheckContent (const bool16 spellCheck)=0
virtual const bool16	GetSpellCheckContent () const =0
virtual void	SetFindReplaceContent (const bool16 findReplace)=0
virtual const bool16	GetFindReplaceContent () const =0
virtual void	SetBackgroundColorChoice (const BackgroundColorChoice newChoice)=0
virtual const BackgroundColorChoice	GetBackgroundColorChoice () const =0
virtual void	SetNoteColorChoice (const NoteColorChoice newChoice)=0
virtual const 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

This session interface presents the inline Notes options : ineline Notes color, inline Notes background color, show Notes tip, find/replace ineline Notes content, and spell check inline Notes content

Member Enumeration Documentation

enum INotePref::BackgroundColorChoice

Which type of background color for Notes to use

enum INotePref::NoteColorChoice

Which type of color for Notes to use

Member Function Documentation

virtual const BackgroundColorChoice INotePref::GetBackgroundColorChoice ( ) const

pure virtual

Get the type of inline Notes background color to use

Returns

const kGalleyColorBG means when display inline Notes, use the galley/story background color(IGalleySettings::GetBackgroundColor()) as inline Notes background color kNotesColorBG means when display inlien Notes, use the user's color if INotePref::GetNoteColorChoice() is INotePref::kUseUserColor, otherwise use INotePref::GetColorID()

virtual const int32 INotePref::GetColorID ( ) const

pure virtual

Get the Notes color index

virtual const bool16 INotePref::GetFindReplaceContent ( ) const

pure virtual

Find/replace inline Notes content or not

virtual const NoteColorChoice INotePref::GetNoteColorChoice ( ) const

pure virtual

Get the type of inline Notes color to use

Returns

const kUseUserColor means to display inline Notes using user's color kUseNotePrefColor means to display inline Notes using INotePref::GetColorID()

virtual const bool16 INotePref::GetShowNoteTips ( ) const

pure virtual

Display Notes tips containing user info and Notes content or not

virtual const bool16 INotePref::GetSpellCheckContent ( ) const

pure virtual

Spell check inline Notes content or not

virtual void INotePref::SetBackgroundColorChoice ( const BackgroundColorChoice  newChoice )

pure virtual

Set the type of inline Notes background color to use

Parameters

newChoice

kGalleyColorBG , kNotesColorBG

virtual void INotePref::SetColorID ( const int32  colorIndex )

pure virtual

Set the Notes color

Parameters

colorIndex

color index

virtual void INotePref::SetFindReplaceContent ( const bool16  findReplace )

pure virtual

Set to find/replace inline Notes content or not

Parameters

findReplace

whether to find/replace

virtual void INotePref::SetNoteColorChoice ( const NoteColorChoice  newChoice )

pure virtual

Set the type of inline Notes color to use

Parameters

newChoice

kUseUserColor, kUseNotePrefColor

virtual void INotePref::SetShowNoteTips ( const bool16  showTips )

pure virtual

Show or hide Notes tips containing user info and Notes content

Parameters

showTips

whether to show tips

virtual void INotePref::SetSpellCheckContent ( const bool16  spellCheck )

pure virtual

Set to spell check inline Notes content or not

Parameters

spellCheck

whether to spellcheck