IPageNumberPrefs Class Reference

#include <IPageNumberPrefs.h>

Inheritance diagram for IPageNumberPrefs:

Public Types
enum	{ kDefaultIID = IID_IPAGENUMBERPREFS }

Public Member Functions
virtual void	SetOrdinalNumbering (bool16 on)=0
virtual bool16	GetOrdinalNumbering () 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

Stores session preferences relating how UI widgets display page numbers. This is a UI-only setting that doesn't affect how page number characters in text stories are computed/displayed.

See Also

kWorkspaceBoss

kSetPageNumberPrefsCmdCmdBoss

IPageList.h

ISection.h

ISectionList.h

Widgets.fh, PageNumEditBoxWidget, PageNumEditBoxWidget, and PageNumPlusMasterEditBoxWidget

Member Function Documentation

virtual bool16 IPageNumberPrefs::GetOrdinalNumbering ( ) const

pure virtual

Return the value used for page numbering widgets.

Parameters

none

Returns

kTrue for oridinal numbering, kFalse for standard/section numbering.

virtual void IPageNumberPrefs::SetOrdinalNumbering ( bool16  on )

pure virtual

Set value for ordinal numbering (kTrue) or standard/section numbering (kFalse). When ordinal numbering is on, page number and page range widgets will display 1 for first page of document, 2 for second page, etc. When standard numbering is used, the first page number will use its page number as determined by what section it is in.

Parameters

bool16

on, kTrue for ordinal, kFalse for section numbering (the default).