IGalleySettingsOverwrite Class Reference

#include <IGalleySettingsOverwrite.h>

Inheritance diagram for IGalleySettingsOverwrite:

Public Types
enum	{ kDefaultIID = IID_IGALLEYSETTINGSOVERWRITE }

Public Member Functions
virtual bool16	GetSettingsOverwrite ()=0
virtual void	SetSettingsOverwrite (bool16 overwrite)=0
virtual bool16	GetShowParagraphStyleNames ()=0
virtual void	SetShowParagraphStyleNames (bool16 showStyleNames)=0
virtual bool16	GetShowLineNumbers ()=0
virtual void	SetShowLineNumbers (bool16 showLineNumbers)=0
virtual bool16	GetIsGalleyAle ()=0
virtual void	SetGalleyAle (bool16 isAle)=0
virtual bool16	GetShowInlineNotes (UIDRef &storyRef)=0
virtual void	SetShowInlineNotes (bool16 show)=0
virtual int32	GetShowInlineNotesType ()=0
virtual void	SetShowInlineNotesType (int32 show)=0
virtual bool16	GetStoryInfo ()=0
virtual void	SetStoryInfo (bool16 show)=0
virtual bool16	GetTrackChangesBackgroundInColor ()=0
virtual void	SetTrackChangesBackgroundInColor (bool16 show)=0
virtual bool16	GetNotesBackgroundInColor ()=0
virtual void	SetNotesBackgroundInColor (bool16 show)=0
virtual bool16	GetShowTrackChanges ()=0
virtual void	SetShowTrackChanges (bool16 show)=0
virtual int32	GetShowTrackChangesType ()=0
virtual void	SetShowTrackChangesType (int32 show)=0
virtual PMString	GetDisplayFont ()=0
virtual void	SetDisplayFont (const PMString &font)=0
virtual PMReal	GetDisplayFontSize ()=0
virtual void	SetDisplayFontSize (PMReal size)=0
virtual PMReal	GetDisplayFontLeading ()=0
virtual void	SetDisplayFontLeading (PMReal leading)=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 interface sets the galley/story view settings when printing/PDF-exporting If GetSettingsOverwrite returns kTrue, the galley/story view will construct using this interface's setting, otherwise, the galley/story view will construct using the preference - IGalleySettings

Member Function Documentation

virtual PMString IGalleySettingsOverwrite::GetDisplayFont ( )

pure virtual

Get the display font

Parameters

none

Returns

PMString the font name

virtual PMReal IGalleySettingsOverwrite::GetDisplayFontLeading ( )

pure virtual

Get the display font leading

Parameters

none

Returns

PMReal

virtual PMReal IGalleySettingsOverwrite::GetDisplayFontSize ( )

pure virtual

Get the display font size

Parameters

none

Returns

PMReal

virtual bool16 IGalleySettingsOverwrite::GetIsGalleyAle ( )

pure virtual

Display accurate line endings or not

Parameters

none

Returns

bool16 kTrue means to display accurate line endings

virtual bool16 IGalleySettingsOverwrite::GetNotesBackgroundInColor ( )

pure virtual

Display the background color in Notes or not

Parameters

none

Returns

bool16 kTrue means to display the background color in Notes

virtual bool16 IGalleySettingsOverwrite::GetSettingsOverwrite ( )

pure virtual

Get the galley settings overwrite falg

Parameters

none

Returns

bool16 kTrue means this interface's settings are used to construct the galley/story view

virtual bool16 IGalleySettingsOverwrite::GetShowInlineNotes ( UIDRef &  storyRef )

pure virtual

Display Notes or not

Parameters

storyRef

The story the Notes belong to

Returns

bool16 kTrue means to display Notes

virtual int32 IGalleySettingsOverwrite::GetShowInlineNotesType ( )

pure virtual

Get the type of Notes to display in the view

Parameters

none

Returns

int32 0 means to display all Notes, 1 means to only display the visible Notes in document view

virtual bool16 IGalleySettingsOverwrite::GetShowLineNumbers ( )

pure virtual

Display line numbers or not

Parameters

none

Returns

bool16 kTrue means to display line numbers

virtual bool16 IGalleySettingsOverwrite::GetShowParagraphStyleNames ( )

pure virtual

Display paragraph style names or not

Parameters

none

Returns

bool16 kTrue means to display the paragraph style names

virtual bool16 IGalleySettingsOverwrite::GetShowTrackChanges ( )

pure virtual

Display tracked changes or not

Parameters

none

Returns

bool16 kTrue means to display tracked changes

virtual int32 IGalleySettingsOverwrite::GetShowTrackChangesType ( )

pure virtual

Get the type of tracked changes to display in the view

Parameters

none

Returns

int32 0 means to display all tracked changes, 1 means to only display the visible tracked changes in document view

virtual bool16 IGalleySettingsOverwrite::GetStoryInfo ( )

pure virtual

Display story information or not

Parameters

none

Returns

bool16 kTrue means to display story information

virtual bool16 IGalleySettingsOverwrite::GetTrackChangesBackgroundInColor ( )

pure virtual

Display the background color in tracked changes text or not

Parameters

none

Returns

bool16 kTrue means to display the background color in tracked changes text

virtual void IGalleySettingsOverwrite::SetDisplayFont ( const PMString &  font )

pure virtual

Set the display font

Parameters

font

virtual void IGalleySettingsOverwrite::SetDisplayFontLeading ( PMReal  leading )

pure virtual

set the display font leading

Parameters

leading

virtual void IGalleySettingsOverwrite::SetDisplayFontSize ( PMReal  size )

pure virtual

set the display font size

Parameters

size

virtual void IGalleySettingsOverwrite::SetGalleyAle ( bool16  isAle )

pure virtual

Set to display accurate line endings or not

Parameters

isAle

virtual void IGalleySettingsOverwrite::SetNotesBackgroundInColor ( bool16  show )

pure virtual

Set to display the background color in Notes or not

Parameters

show

virtual void IGalleySettingsOverwrite::SetSettingsOverwrite ( bool16  overwrite )

pure virtual

Set the galley settings overwrite falg

Parameters

overwrite

virtual void IGalleySettingsOverwrite::SetShowInlineNotes ( bool16  show )

pure virtual

Set to display Notes or not

Parameters

show

virtual void IGalleySettingsOverwrite::SetShowInlineNotesType ( int32  show )

pure virtual

Set the type of Notes to display in the view

Parameters

show,0

means to display all Notes, 1 means to only display the visible Notes in document view

virtual void IGalleySettingsOverwrite::SetShowLineNumbers ( bool16  showLineNumbers )

pure virtual

Set to display line numbers or not

Parameters

showLineNumbers

virtual void IGalleySettingsOverwrite::SetShowParagraphStyleNames ( bool16  showStyleNames )

pure virtual

Set to display paragraph names or not

Parameters

showStyleNames

virtual void IGalleySettingsOverwrite::SetShowTrackChanges ( bool16  show )

pure virtual

Set to display tracked changes or not

Parameters

show

virtual void IGalleySettingsOverwrite::SetShowTrackChangesType ( int32  show )

pure virtual

Set the type of tracked changes to display in the view

Parameters

show	0 means to display all tracked changes, 1 means to only display the visible tracked changes in document view

virtual void IGalleySettingsOverwrite::SetStoryInfo ( bool16  show )

pure virtual

Set to display story information or not

Parameters

show

virtual void IGalleySettingsOverwrite::SetTrackChangesBackgroundInColor ( bool16  show )

pure virtual

Set to display the background color in tracked changes text or not

Parameters

show