IInCopyGalleySettingData Class Reference

#include <IInCopyGalleySettingData.h>

Inheritance diagram for IInCopyGalleySettingData:

Public Types
enum	{ kDefaultIID = IID_IINCOPYGALLEYSETTINGDATA }

Public Member Functions
virtual void	CopyData (IInCopyGalleySettingData const *copyFrom)=0
virtual void	SetWritingView (IControlView *view)=0
virtual IControlView *	GetWritingView () const =0
virtual void	SetInfoColumnView (IControlView *view)=0
virtual IControlView *	GetInfoColumnView () const =0
virtual void	SetLineNumberView (IControlView *view)=0
virtual IControlView *	GetLineNumberView () const =0
virtual void	SetInfoSplitterView (IControlView *view)=0
virtual IControlView *	GetInfoSplitterView () const =0
virtual void	SetTotalHeight (PMReal height)=0
virtual PMReal	GetTotalHeight () const =0
virtual void	SetStartLineNumber (int32 line)=0
virtual int32	GetStartLineNumber () const =0
virtual void	SetEndLineNumber (int32 line)=0
virtual int32	GetEndLineNumber () const =0
virtual void	SetColumnWidth (PMReal width)=0
virtual PMReal	GetColumnWidth () const =0
virtual void	SetGalleySetting (bool16 setting)=0
virtual bool16	GetGalleySetting () const =0
virtual void	SetDocUIDRef (const UIDRef &docUIDRef)=0
virtual const UIDRef &	GetDocUIDRef () const =0
virtual void	SetParaStyles (bool16 displayed)=0
virtual bool16	GetParaStyles () const =0
virtual void	SetLineNumber (bool16 displayed)=0
virtual bool16	GetLineNumber () const =0
virtual void	SetALE (bool16 displayed)=0
virtual bool16	GetALE () const =0
virtual void	SetNotes (bool16 displayed)=0
virtual bool16	GetNotes () const =0
virtual void	SetTrackChanges (bool16 displayed)=0
virtual bool16	GetTrackChanges () const =0
virtual void	SetNotesType (int32 type)=0
virtual int32	GetNotesType () const =0
virtual void	SetTrackChangesType (int32 type)=0
virtual int32	GetTrackChangesType () const =0
virtual void	SetFontName (const PMString &fontName)=0
virtual PMString	GetFontName () const =0
virtual void	SetFontType (const PMString &fontType)=0
virtual PMString	GetFontType () const =0
virtual void	SetFontSize (const PMString &fontSize)=0
virtual PMString	GetFontSize () const =0
virtual void	SetFontLeading (const PMString &fontLeading)=0
virtual PMString	GetFontLeading () const =0
virtual void	SetWhich (int32 range)=0
virtual int32	GetWhich () const =0
virtual void	SetRange (PMString range)=0
virtual PMString	GetRange () const =0
virtual void	SetFrameSize (PMRect frame)=0
virtual PMRect	GetFrameSize () const =0
virtual void	SetFill (bool16 displayed)=0
virtual bool16	GetFill () const =0
virtual void	SetScope (int32 scope)=0
virtual int32	GetScope () const =0
virtual void	SetStoryInfo (bool16 displayed)=0
virtual bool16	GetStoryInfo () const =0
virtual void	SetNotesBackgroundInColor (bool16 displayed)=0
virtual bool16	GetNotesBackgroundInColor () const =0
virtual void	SetTrackChangesBackgroundInColor (bool16 displayed)=0
virtual bool16	GetTrackChangesBackgroundInColor () const =0
virtual void	SetPagesInfo (bool16 displayed)=0
virtual bool16	GetPagesInfo () const =0
virtual void	SetColumns (int32 columns)=0
virtual int32	GetColumns () const =0
virtual int32	GetStoryCount () const =0
virtual int32	GetStoryIndex (const UIDRef &storyRef) const =0
virtual const UIDRef &	GetStoryRef (int32 index) const =0
virtual bool16	GetNthStoryCollapsedState (int32 index) const =0
virtual void	SetCurrentStoryIndex (int32 index)=0
virtual int32	GetCurrentStoryIndex () const =0
virtual void	QueryGalleySettings (IDocument *document, IControlView *galley)=0
virtual void	SetLineRangeLimits (IControlView *galley)=0
virtual void	InitializeColumnBounds ()=0
virtual PMRect	GetNthColumnBounds (int32 index) const =0
virtual int32	GetColumnBoundsCount () 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

Interface that contains settings that used to construct the galley panel, and contains information about the constructed galley panel for printing/pdf-export in InCopy

Member Function Documentation

virtual void IInCopyGalleySettingData::CopyData ( IInCopyGalleySettingData const *  copyFrom )

pure virtual

Copy the interface data

Parameters

copyFrom

The interface data to be copied

virtual bool16 IInCopyGalleySettingData::GetALE ( ) const

pure virtual

Get method to get if printing/PDF-exporting with accurate line ening

Parameters

none

Returns

bool16 kTrue means to print/PDF-export with accurate line ening

virtual int32 IInCopyGalleySettingData::GetColumnBoundsCount ( ) const

pure virtual

Get the total number of columnes rect bounding will be print/PDF-export

Parameters

none

Returns

int32

virtual int32 IInCopyGalleySettingData::GetColumns ( ) const

pure virtual

Get method to get number of column in printing/PDF-exporting

Parameters

none

Returns

int32

virtual PMReal IInCopyGalleySettingData::GetColumnWidth ( ) const

pure virtual

Get method to get the width of the printing column in galley panel

Parameters

none

Returns

PMReal

virtual int32 IInCopyGalleySettingData::GetCurrentStoryIndex ( ) const

pure virtual

Get method to get the current story index

Parameters

none

Returns

int32

virtual const UIDRef& IInCopyGalleySettingData::GetDocUIDRef ( ) const

pure virtual

Get method to get the document UIDRef

Parameters

none

Returns

const

virtual int32 IInCopyGalleySettingData::GetEndLineNumber ( ) const

pure virtual

Note used anymore.

Parameters

none

Returns

int32

virtual bool16 IInCopyGalleySettingData::GetFill ( ) const

pure virtual

Get method to get if printing/PDF-exporting fills the panel with multi-column

Parameters

none

Returns

bool16

virtual PMString IInCopyGalleySettingData::GetFontLeading ( ) const

pure virtual

Get method to get the font leading for printing/PDF-exporting

Parameters

none

Returns

PMString

virtual PMString IInCopyGalleySettingData::GetFontName ( ) const

pure virtual

Get method to get the font for printing/PDF-exporting

Parameters

none

Returns

PMString The font name

virtual PMString IInCopyGalleySettingData::GetFontSize ( ) const

pure virtual

Get method to get the font size for printing/PDF-exporting

Parameters

none

Returns

PMString

virtual PMString IInCopyGalleySettingData::GetFontType ( ) const

pure virtual

Get method to get the font for printing/PDF-exporting

Parameters

none

Returns

PMString

virtual PMRect IInCopyGalleySettingData::GetFrameSize ( ) const

pure virtual

Get method to get the printing galley panel size

Parameters

none

Returns

PMRect

virtual bool16 IInCopyGalleySettingData::GetGalleySetting ( ) const

pure virtual

Set method to get the flag that tells if this is a temporary galley panel

Parameters

none

Returns

bool16 kFalse means this is a temporary galley panel

virtual IControlView* IInCopyGalleySettingData::GetInfoColumnView ( ) const

pure virtual

Get method to get the info column control view

Parameters

none

Returns

IControlView

virtual IControlView* IInCopyGalleySettingData::GetInfoSplitterView ( ) const

pure virtual

Get method to get the splitter panel control view

Parameters

none

Returns

IControlView

virtual bool16 IInCopyGalleySettingData::GetLineNumber ( ) const

pure virtual

Get method to get if printing/PDF-exporting with line number

Parameters

none

Returns

bool16 kTrue means to print/PDF-export with line number

virtual IControlView* IInCopyGalleySettingData::GetLineNumberView ( ) const

pure virtual

Not used anymore. Get method to get the line number control view

Parameters

none

Returns

IControlView

virtual bool16 IInCopyGalleySettingData::GetNotes ( ) const

pure virtual

Get method to get printing/PDF-exporting with Notes displayed

Parameters

none

Returns

bool16 kTrue means to print/PDF-export with Notes displayed

virtual bool16 IInCopyGalleySettingData::GetNotesBackgroundInColor ( ) const

pure virtual

Get method to get inline Notes background color when printing/PDF-exporting

Parameters

none

Returns

bool16

virtual int32 IInCopyGalleySettingData::GetNotesType ( ) const

pure virtual

Get method to get the Notes display type

Parameters

none

Returns

int32 0 = display all Notes, 1 = display visible Notes

virtual PMRect IInCopyGalleySettingData::GetNthColumnBounds ( int32  index ) const

pure virtual

Get the column's rect bounding by given column index

Parameters

index

Returns

PMRect

virtual bool16 IInCopyGalleySettingData::GetNthStoryCollapsedState ( int32  index ) const

pure virtual

Get method the get the collapsing state of the story by given index

Parameters

index

Returns

bool16

virtual bool16 IInCopyGalleySettingData::GetPagesInfo ( ) const

pure virtual

Get method to get if printing/PDF-exporting with page information

Parameters

none

Returns

bool16

virtual bool16 IInCopyGalleySettingData::GetParaStyles ( ) const

pure virtual

Get method to get if printing/PDF-exporting with paragraph style

Parameters

none

Returns

bool16 kTrue means to print/PDF-export with paragraph style

virtual PMString IInCopyGalleySettingData::GetRange ( ) const

pure virtual

Get method to get line range for printing/PDF-exporting

Parameters

none

Returns

PMString

virtual int32 IInCopyGalleySettingData::GetScope ( ) const

pure virtual

Get method to get the story scope for printing/PDF-exporting

Parameters

none

Returns

int32 0 = all stories, 1 = current story in active document, 2 = expanded story in active document

virtual int32 IInCopyGalleySettingData::GetStartLineNumber ( ) const

pure virtual

Not used anymore.

Parameters

none

Returns

int32

virtual int32 IInCopyGalleySettingData::GetStoryCount ( ) const

pure virtual

Get method to get the number of story to print/PDF-export

Parameters

none

Returns

int32

virtual int32 IInCopyGalleySettingData::GetStoryIndex ( const UIDRef &  storyRef ) const

pure virtual

Get method to get the index of story by given story UIDRef

Parameters

storyRef

Returns

int32

virtual bool16 IInCopyGalleySettingData::GetStoryInfo ( ) const

pure virtual

Get method to get if printing/PDF-exporting with story information

Parameters

none

Returns

bool16

virtual const UIDRef& IInCopyGalleySettingData::GetStoryRef ( int32  index ) const

pure virtual

Get method to get story UIDRef by given the index

Parameters

index

Returns

const

virtual PMReal IInCopyGalleySettingData::GetTotalHeight ( ) const

pure virtual

Get method to get the total height of the constructed galley view

Parameters

none

Returns

PMReal

virtual bool16 IInCopyGalleySettingData::GetTrackChanges ( ) const

pure virtual

Get method to get printing/PDF-exporting with track changes displayed

Parameters

none

Returns

bool16 kTrue means printing/PDF-exporting with track changes displayed

virtual bool16 IInCopyGalleySettingData::GetTrackChangesBackgroundInColor ( ) const

pure virtual

Get method to get if track changes background with color when printing/PDF-exporting

Parameters

none

Returns

bool16

virtual int32 IInCopyGalleySettingData::GetTrackChangesType ( ) const

pure virtual

Get method to get the Track Changes display type

Parameters

none

Returns

int32 0 = display all Track Changes, 1 = display visible Track Changes

virtual int32 IInCopyGalleySettingData::GetWhich ( ) const

pure virtual

Get method to get the type of scope for printing/PDF-exporting

Parameters

none

Returns

int32 0 = all stories, 1 = range

virtual IControlView* IInCopyGalleySettingData::GetWritingView ( ) const

pure virtual

Get method to get the galley control view

Parameters

none

Returns

IControlView

virtual void IInCopyGalleySettingData::InitializeColumnBounds ( )

pure virtual

Calculate each rect bounding for each column in a page for printting/PDF-exporting

Parameters

none

virtual void IInCopyGalleySettingData::QueryGalleySettings ( IDocument *  document, IControlView *  galley  )

pure virtual

Query the current document galley settings to store in IInCopyGalleySettingData

Parameters

document	The active document
galley	Galley control view in active document

virtual void IInCopyGalleySettingData::SetALE ( bool16  displayed )

pure virtual

Set method to set printing/PDF-exporting with accurate line ening

Parameters

displayed

virtual void IInCopyGalleySettingData::SetColumns ( int32  columns )

pure virtual

Set method to set number of column to print/PDF-export in a single page

Parameters

columns

virtual void IInCopyGalleySettingData::SetColumnWidth ( PMReal  width )

pure virtual

Set method to store the width of the printing column in galley panel

Parameters

width

virtual void IInCopyGalleySettingData::SetCurrentStoryIndex ( int32  index )

pure virtual

Set method to store the current story index

Parameters

index

virtual void IInCopyGalleySettingData::SetDocUIDRef ( const UIDRef &  docUIDRef )

pure virtual

Set method to store the document UIDRef

Parameters

docUIDRef

virtual void IInCopyGalleySettingData::SetEndLineNumber ( int32  line )

pure virtual

Not used anymore.

Parameters

line

virtual void IInCopyGalleySettingData::SetFill ( bool16  displayed )

pure virtual

Set method to set printing/PDF-exporting to fill the panel with multi-column

Parameters

displayed

virtual void IInCopyGalleySettingData::SetFontLeading ( const PMString &  fontLeading )

pure virtual

Set method to set the font leading for printing/PDF-exporting

Parameters

fontLeading

virtual void IInCopyGalleySettingData::SetFontName ( const PMString &  fontName )

pure virtual

Set method to set the font for printing/PDF-exporting

Parameters

fontName

virtual void IInCopyGalleySettingData::SetFontSize ( const PMString &  fontSize )

pure virtual

Set method to set the font size for printing/PDF-exporting

Parameters

fontSize

virtual void IInCopyGalleySettingData::SetFontType ( const PMString &  fontType )

pure virtual

Set method to set the font type for printing/PDF-exporting

Parameters

fontType

virtual void IInCopyGalleySettingData::SetFrameSize ( PMRect  frame )

pure virtual

Set method to store the printing galley panel size

Parameters

frame

virtual void IInCopyGalleySettingData::SetGalleySetting ( bool16  setting )

pure virtual

Set method to store the flag that tells if this is a temporary galley panel

Parameters

setting

kFalse means this is a temporary galley panel

virtual void IInCopyGalleySettingData::SetInfoColumnView ( IControlView *  view )

pure virtual

Set method to store the Info Column (kInfoColumnID) control view

Parameters

view

virtual void IInCopyGalleySettingData::SetInfoSplitterView ( IControlView *  view )

pure virtual

Set method to store the splitter panel control view

Parameters

view

virtual void IInCopyGalleySettingData::SetLineNumber ( bool16  displayed )

pure virtual

Set method to set printing/PDF-exporting with line number

Parameters

displayed

virtual void IInCopyGalleySettingData::SetLineNumberView ( IControlView *  view )

pure virtual

Not used anymore. Set method to store the line number control view

Parameters

view

virtual void IInCopyGalleySettingData::SetLineRangeLimits ( IControlView *  galley )

pure virtual

Calculate and set the min/max number of galley lines by giving the galley control view

Parameters

galley

virtual void IInCopyGalleySettingData::SetNotes ( bool16  displayed )

pure virtual

Set method to set printing/PDF-exporting with Notes displayed

Parameters

displayed

virtual void IInCopyGalleySettingData::SetNotesBackgroundInColor ( bool16  displayed )

pure virtual

Set method to set inline Notes background with color when printing/PDF-exporting

Parameters

displayed

virtual void IInCopyGalleySettingData::SetNotesType ( int32  type )

pure virtual

Set method to set the Notes display type

Parameters

type	0 = display all Notes, 1 = display visible Notes

virtual void IInCopyGalleySettingData::SetPagesInfo ( bool16  displayed )

pure virtual

Set method to set printing/PDF-exporting with page information

Parameters

displayed

virtual void IInCopyGalleySettingData::SetParaStyles ( bool16  displayed )

pure virtual

Set method to set printing/PDF-exporting with paragraph style

Parameters

displayed

virtual void IInCopyGalleySettingData::SetRange ( PMString  range )

pure virtual

Set method to set line range for printing/PDF-exporting

Parameters

range

virtual void IInCopyGalleySettingData::SetScope ( int32  scope )

pure virtual

Set method to set the story scope for printing/PDF-exporting

Parameters

scope

0 = all stories, 1 = current story in active document, 2 = expanded story in active document

virtual void IInCopyGalleySettingData::SetStartLineNumber ( int32  line )

pure virtual

Not used anymore.

Parameters

line

virtual void IInCopyGalleySettingData::SetStoryInfo ( bool16  displayed )

pure virtual

Set method to set printing/PDF-exporting with story information

Parameters

displayed

virtual void IInCopyGalleySettingData::SetTotalHeight ( PMReal  height )

pure virtual

Set method to store the total height of the constructed galley view

Parameters

height

virtual void IInCopyGalleySettingData::SetTrackChanges ( bool16  displayed )

pure virtual

Set method to set printing/PDF-exporting with track changes displayed

Parameters

displayed

virtual void IInCopyGalleySettingData::SetTrackChangesBackgroundInColor ( bool16  displayed )

pure virtual

Set method to set track changes background with color when printing/PDF-exporting

Parameters

displayed

virtual void IInCopyGalleySettingData::SetTrackChangesType ( int32  type )

pure virtual

Set method to set the Track Changes display type

Parameters

type	0 = display all Track Changes, 1 = display visible Track Changes

virtual void IInCopyGalleySettingData::SetWhich ( int32  range )

pure virtual

Set method to set the type of scope for printing/PDF-exporting

Parameters

range

0 = all stories, 1 = range

virtual void IInCopyGalleySettingData::SetWritingView ( IControlView *  view )

pure virtual

Set method to store the galley control view for print/PDF-export

Parameters

view