IPagesPanelPrefs Class Reference

#include <IPagesPanelPrefs.h>

Inheritance diagram for IPagesPanelPrefs:

Public Types
enum	{   kInvalidPageIconSize = -1, kExtraSmallPageIconSize = 0, kExtraSmall = kExtraSmallPageIconSize, kSmallPageIconSize = 1,   kSmall = kSmallPageIconSize, kMediumPageIconSize = 2, kMedium = kMediumPageIconSize, kLargePageIconSize = 3,   kLarge = kLargePageIconSize, kExtraLargePageIconSize = 4, kGradeAJumbo = kExtraLargePageIconSize, kExtraExtraLargePageIconSize = 5 }
enum	ViewSetting { kInvalidView = -1, kHorizontally = 0, kVertically = 1, kByAlternateLayout = 2 }
typedef int32	IconSize

Public Member Functions
virtual void	SetIconSize (IconSize iconSize)=0
virtual IconSize	GetLayoutIconSize ()=0
virtual void	SetViewSetting (ViewSetting setting)=0
virtual ViewSetting	GetViewSetting ()=0
virtual void	SetMasterIconSize (IconSize iconSize)=0
virtual IconSize	GetMasterIconSize ()=0
virtual void	SetMasterVerticalView (bool16 on)=0
virtual bool16	GetMasterVerticalView ()=0
virtual void	SetPagesFixedSize (bool16 on)=0
virtual bool16	GetPagesFixedSize ()=0
virtual void	SetMasterFixedSize (bool16 on)=0
virtual bool16	GetMasterFixedSize ()=0
virtual void	SetPagesOnTop (bool16 on)=0
virtual bool16	GetPagesOnTop ()=0
virtual void	SetPagesThumbnails (bool16 on)=0
virtual bool16	GetPagesThumbnails ()=0
virtual void	SetMastersThumbnails (bool16 on)=0
virtual bool16	GetMastersThumbnails ()=0
virtual void	SetShowTransparencyIcon (bool16 on)=0
virtual bool16	GetShowTransparencyIcon ()=0
virtual void	SetShowTransitionsIcon (bool16 on)=0
virtual bool16	GetShowTransitionsIcon ()=0
virtual void	SetShowRotationIcon (bool16 on)=0
virtual bool16	GetShowRotationIcon ()=0
virtual int32	GetLayoutVerticalInterSpreadSpace ()=0
virtual int32	GetMasterVerticalInterSpreadSpace ()=0
virtual int32	GetHorizontalInterSpreadSpace (IconSize iconSize)=0
virtual int32	GetMasterPageRowHeight ()=0
virtual int32	GetLayoutPageRowHeight ()=0
virtual int32	GetMasterPageTabWidth (IGeometry *thePage)=0
virtual int32	GetLayoutPageTabWidth (IGeometry *thePage)=0
virtual int32	GetMasterPageTabHeight ()=0
virtual int32	GetLayoutPageTabHeight ()=0
virtual int32	GetCornerFoldSize (IconSize iconSize)=0
virtual int32	GetSpreadBorderWidth (IconSize iconSize, bool16 bVerticalMode)=0
virtual int32	GetSpreadBorderHeight (IconSize iconSize, int32 *spaceAbove, int32 *spaceBelow)=0
virtual int32	GetSpreadTextOffset (IconSize iconSize)=0
virtual int32	GetSpreadTextSize (IconSize iconSize)=0
virtual int32	GetSectionMarkerSize (IconSize iconSize, bool16 bVerticalMode)=0
virtual int32	GetPanelBorder (IconSize iconSize, int32 *spaceAtTop, int32 *spaceAtBottom)=0
virtual PMPoint	GetColorLabelSize (IconSize iconSize)=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

Preferences that define the appearance of the pages panel

Member Enumeration Documentation

anonymous enum

Enumerated sizes for the Pages Panel page and master page icons

Enumerator
kInvalidPageIconSize	Invalid setting, used internally for command as an "ignore" value
kExtraSmallPageIconSize	Allows 1 master page prefix character to be visible
kSmallPageIconSize	Allows 2 master page prefix characters to be visible
kMediumPageIconSize	Allows 3 master page prefix characters to be visible
kLargePageIconSize	Allows 4 master page prefix characters to be visible
kExtraLargePageIconSize	Allows 5 master page prefix characters to be visible

enum IPagesPanelPrefs::ViewSetting

View setting enum.

Enumerator
kHorizontally	Value that means don't change the view setting
kVertically	Standard setting for rows of pages arranged from left to right, multiple pages per row.
kByAlternateLayout	View setting for one page per row, arranged and stacked vertically.

Member Function Documentation

virtual PMPoint IPagesPanelPrefs::GetColorLabelSize ( IconSize  iconSize )

pure virtual

Get the height of the color flag (below the page tab widget)

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise

Returns

for the given page tab icon size, how tall the color label should be

virtual int32 IPagesPanelPrefs::GetCornerFoldSize ( IconSize  iconSize )

pure virtual

Get the number of pixels used to draw the fold in the corner of a page tab

Parameters

iconSize

size of the page tab icons

Returns

How many pixels the corner fold should be for the specified icon size

virtual int32 IPagesPanelPrefs::GetHorizontalInterSpreadSpace ( IconSize  iconSize )

pure virtual

Get the number of pixels between spreads (horizontally) in the pages panel - used in wrapping view

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise

Returns

the empty space between columns in the pages panel (this same value is used in both the masters and pages section).

virtual IconSize IPagesPanelPrefs::GetLayoutIconSize ( )

pure virtual

Get page tab icon size

Returns

Pages subpanel icon size (value is one of the enums in IPagesPanelPrefs)

virtual int32 IPagesPanelPrefs::GetLayoutVerticalInterSpreadSpace ( )

pure virtual

Get the number of pixels between spreads (vertically) in the pages panel

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise

Returns

the empty space between rows in the pages panel (this same value is used in vertical and wrapping modes, in both the masters and pages section).

virtual bool16 IPagesPanelPrefs::GetMasterFixedSize ( )

pure virtual

Get master pane fixed size

Returns

kTrue if master pages subpanel is fixed size on resize, kFalse if variable size

virtual IconSize IPagesPanelPrefs::GetMasterIconSize ( )

pure virtual

Get master page icon size

Returns

master pages subpanel icon size (value is one of the enums in IPagesPanelPrefs)

virtual int32 IPagesPanelPrefs::GetMasterPageRowHeight ( )

pure virtual

Get the number of vertical pixels used by each row of the pages panel

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise
widthToHeightRatio	- IN: Typically, we draw a rectangle with a folder corner for each page and the ratio of the width to height is 3:4. However, it may be desirable to draw a rectangle that maintains the proportions of the actual page size if, for example, we want to draw a thumbnail of the page.

Returns

how many pixels tall is a row (horizontal or vertical layout; masters or pages) when the icon size specified is used?

virtual int32 IPagesPanelPrefs::GetMasterPageTabHeight ( )

pure virtual

Get the number of pixels high each page tab will be

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise
widthToHeightRatio	- IN: Typically, we draw a rectangle with a folder corner for each page and the ratio of the width to height is 3:4. However, it may be desirable to draw a rectangle that maintains the proportions of the actual page size if, for example, we want to draw a thumbnail of the page.

Returns

how tall should the page icons be, given the specified icon size

virtual int32 IPagesPanelPrefs::GetMasterPageTabWidth ( IGeometry *  thePage )

pure virtual

Get the number of pixels wide a page tab will be

Parameters

iconSize	size of the page tab icons
widthToHeightRatio	- IN: Typically, we draw a rectangle with a folder corner for each page and the ratio of the width to height is 3:4. However, it may be desirable to draw a rectangle that maintains the proportions of the actual page size if, for example, we want to draw a thumbnail of the page.

Returns

how wide the page icons should be, given the specified icon size,

virtual bool16 IPagesPanelPrefs::GetMastersThumbnails ( )

pure virtual

Get thumbnails setting for masters section

Returns

kTrue if masters thumbnails are on, kFalse if off

virtual bool16 IPagesPanelPrefs::GetMasterVerticalView ( )

pure virtual

Get vertical view (kTrue), or wrapping view (kFalse)

Returns

kTrue if masters is in vertical view, or kFalse if wrapping view

virtual bool16 IPagesPanelPrefs::GetPagesFixedSize ( )

pure virtual

Get pages fixed size

Returns

kTrue if pages subpanel is fixed size on resize, kFalse if variable size

virtual bool16 IPagesPanelPrefs::GetPagesOnTop ( )

pure virtual

Get pages on top

Returns

kTrue if pages subpanel is on top, kFalse if it is on bottom

virtual bool16 IPagesPanelPrefs::GetPagesThumbnails ( )

pure virtual

Get thumbnails setting for pages section

Returns

kTrue if pages thumbnails are on, kFalse if off

virtual int32 IPagesPanelPrefs::GetPanelBorder ( IconSize  iconSize, int32 *  spaceAtTop, int32 *  spaceAtBottom  )

pure virtual

Get the number of pixels above the first and below the last spread widget.

Parameters

iconSize	size of the page tab icons
spaceAtTop	white space above all rows
spaceAtBottom	white space below all rows

Returns

for the given page tab icon size, how much white space should be left above the first row & after the last row? (returns spaceAtTop)

virtual int32 IPagesPanelPrefs::GetSectionMarkerSize ( IconSize  iconSize, bool16  bVerticalMode  )

pure virtual

Get the height of the section marker (above the spread widget)

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise

Returns

for the given page tab icon size, how tall the section marker should be

virtual bool16 IPagesPanelPrefs::GetShowRotationIcon ( )

pure virtual

Get the bool indicating if the rotation icon should be drawn on spreads with non-zero rotation applied.

Returns

kTrue if the rotation icon is on; kFalse otherwise

virtual bool16 IPagesPanelPrefs::GetShowTransitionsIcon ( )

pure virtual

Get the bool indicating if the transition icon should be drawn on spreads with page transitions applied.

Returns

kTrue if the spread has a transition applied; kFalse otherwise

virtual bool16 IPagesPanelPrefs::GetShowTransparencyIcon ( )

pure virtual

Get the bool indicating if the transparency indicator should be drawn on spreads with transparency applied. This is the checkerboard icon.

Returns

kTrue if the transparency icon is on; kFalse otherwise

virtual int32 IPagesPanelPrefs::GetSpreadBorderHeight ( IconSize  iconSize, int32 *  spaceAbove, int32 *  spaceBelow  )

pure virtual

Get the number of pixels around each spread widget vertically

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise
spaceAbove	space above
spaceBelow	space below

Returns

how tall should the border be for the specified icon size? Optionally, break that down into space below and space above

virtual int32 IPagesPanelPrefs::GetSpreadBorderWidth ( IconSize  iconSize, bool16  bVerticalMode  )

pure virtual

Get the number of pixels around each spread widget horizontally

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise

Returns

how wide, beyond the page tab, should the spread widget be for the specified icon size? this width is added to both sides of the spread widget

virtual int32 IPagesPanelPrefs::GetSpreadTextOffset ( IconSize  iconSize )

pure virtual

Get the number of pixels between the bottom of the spread widget and the top of the text widget

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise

Returns

how many pixels there should be between the spread widget and the text underneath it

virtual int32 IPagesPanelPrefs::GetSpreadTextSize ( IconSize  iconSize )

pure virtual

Get the number of pixels tall the text under the spread is

Parameters

iconSize	size of the page tab icons
bVerticalMode	kTrue if panel is in vertical mode, kFalse otherwise

Returns

how tall the text is underneath this spread

virtual ViewSetting IPagesPanelPrefs::GetViewSetting ( )

pure virtual

Get method for the view setting of the layout pages subpanel.

Returns

a value from ViewSetting enum

virtual void IPagesPanelPrefs::SetIconSize ( IconSize  iconSize )

pure virtual

Set page tab icon size

Parameters

set	pages subpanel icon size (value is one of the enums in IPagesPanelPrefs)

virtual void IPagesPanelPrefs::SetMasterFixedSize ( bool16  on )

pure virtual

Set master pane to be fixed size

Parameters

on	set master pages subpanel to fixed size on resize if kTrue, variable size if kFalse

virtual void IPagesPanelPrefs::SetMasterIconSize ( IconSize  iconSize )

pure virtual

Set master page icon size

Parameters

set	master pages subpanel icon size (value is one of the enums in IPagesPanelPrefs)

virtual void IPagesPanelPrefs::SetMastersThumbnails ( bool16  on )

pure virtual

Set thumbnails on or off for masters section

Parameters

on	masters thumbnails on if kTrue, off if kFalse

virtual void IPagesPanelPrefs::SetMasterVerticalView ( bool16  on )

pure virtual

Set vertical view (kTrue), or wrapping view (kFalse)

Parameters

on	set masters to vertical view if kTrue, or wrapping view if kFalse

virtual void IPagesPanelPrefs::SetPagesFixedSize ( bool16  on )

pure virtual

Set fixed size pages pane

Parameters

on	set pages subpanel to fixed size on resize if kTrue, variable size if kFalse

virtual void IPagesPanelPrefs::SetPagesOnTop ( bool16  on )

pure virtual

Set pages on top

Parameters

on	pages subpanel on top if kTrue, on bottom if kFalse

virtual void IPagesPanelPrefs::SetPagesThumbnails ( bool16  on )

pure virtual

Set thumbnails on or off for pages section

Parameters

on	pages thumbnails on if kTrue, off if kFalse

virtual void IPagesPanelPrefs::SetShowRotationIcon ( bool16  on )

pure virtual

Set rotation icon on or off

Parameters

on	rotation icon is on if kTrue, off if kFalse

virtual void IPagesPanelPrefs::SetShowTransitionsIcon ( bool16  on )

pure virtual

Set transitions icon on or off

Parameters

on	transitions icon is on if kTrue, off if kFalse

virtual void IPagesPanelPrefs::SetShowTransparencyIcon ( bool16  on )

pure virtual

Set transparency icon on or off

Parameters

on	transparency icon is on if kTrue, off if kFalse

virtual void IPagesPanelPrefs::SetViewSetting ( ViewSetting  setting )

pure virtual

Set method for how to arrange pages.

Parameters

setting,a

ViewSetting enum

See Also

ViewSetting for valid values.