IPagesPanelPrefsCmdData Class Reference

#include <IPagesPanelPrefsCmdData.h>

Inheritance diagram for IPagesPanelPrefsCmdData:

Public Member Functions
virtual const IPagesPanelPrefs::IconSize	GetIconSize () const =0
virtual void	SetIconSize (IPagesPanelPrefs::IconSize size)=0
virtual const IPagesPanelPrefs::ViewSetting	GetViewSetting () const =0
virtual void	SetViewSetting (IPagesPanelPrefs::ViewSetting setting)=0
virtual const IPagesPanelPrefs::IconSize	GetMasterIconSize () const =0
virtual void	SetMasterIconSize (IPagesPanelPrefs::IconSize size)=0
virtual const bool16	GetMastersVerticalView () const =0
virtual void	SetMastersVerticalView (bool16 vertical)=0
virtual const bool16	GetPagesFixedSize () const =0
virtual void	SetPagesFixedSize (bool16 fixed)=0
virtual const bool16	GetMastersFixedSize () const =0
virtual void	SetMastersFixedSize (bool16 fixed)=0
virtual const bool16	GetPagesOnTop () const =0
virtual void	SetPagesOnTop (bool16 top)=0
virtual const bool16	GetPagesThumbnails () const =0
virtual void	SetPagesThumbnails (bool16 on)=0
virtual const bool16	GetMastersThumbnails () const =0
virtual void	SetMastersThumbnails (bool16 on)=0
virtual const bool16	GetShowTransparencyIcon () const =0
virtual void	SetShowTransparencyIcon (bool16 show)=0
virtual const bool16	GetShowTransitionsIcon () const =0
virtual void	SetShowTransitionsIcon (bool16 show)=0
virtual const bool16	GetShowRotationIcon () const =0
virtual void	SetShowRotationIcon (bool16 show)=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

Command data interface defining the parameters that the pages panel uses to draw used by kSetPagesPanelPrefsCmdBoss Users of this command may set just the values that are changing, by default others will remain as is.

Member Function Documentation

virtual const IPagesPanelPrefs::IconSize IPagesPanelPrefsCmdData::GetIconSize ( ) const

pure virtual

Get the enumerated value indicating the icon size to use in the pages subpanel

Returns

Pages subpanel icon size

virtual const IPagesPanelPrefs::IconSize IPagesPanelPrefsCmdData::GetMasterIconSize ( ) const

pure virtual

Get the enumerated value indicating the icon size to use in the master pages subpanel

Returns

master pages subpanel icon size

virtual const bool16 IPagesPanelPrefsCmdData::GetMastersFixedSize ( ) const

pure virtual

Get the bool indicating if the master pages subpanel is a fixed size

Returns

kFalse if the master pages section resizes when the window resizes, kTrue otherwise

virtual const bool16 IPagesPanelPrefsCmdData::GetMastersThumbnails ( ) const

pure virtual

Get the bool indicating if the thumbnails are on or off for masters

Returns

kTrue if the thumbnails are on; kFalse otherwise

virtual const bool16 IPagesPanelPrefsCmdData::GetMastersVerticalView ( ) const

pure virtual

Get the show vertical setting for the master pages subpanel

Returns

kTrue if Vertical, kFalse if master pages section is set to wrapping, -1 to leave unchanged

virtual const bool16 IPagesPanelPrefsCmdData::GetPagesFixedSize ( ) const

pure virtual

Get the bool indicating if the pages subpanel is a fixed size

Returns

kFalse if the pages section resizes when the window resizes, kTrue otherwise

virtual const bool16 IPagesPanelPrefsCmdData::GetPagesOnTop ( ) const

pure virtual

Get the bool indicating if the pages subpanel is on top

Returns

kTrue if the pages section is on the top; kFalse otherwise

virtual const bool16 IPagesPanelPrefsCmdData::GetPagesThumbnails ( ) const

pure virtual

Get the bool indicating if the thumbnails are on or off for pages

Returns

kTrue if the thumbnails are on; kFalse otherwise

virtual const bool16 IPagesPanelPrefsCmdData::GetShowRotationIcon ( ) const

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 const bool16 IPagesPanelPrefsCmdData::GetShowTransitionsIcon ( ) const

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 const bool16 IPagesPanelPrefsCmdData::GetShowTransparencyIcon ( ) const

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 const IPagesPanelPrefs::ViewSetting IPagesPanelPrefsCmdData::GetViewSetting ( ) const

pure virtual

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

Returns

a value from ViewSetting enum

virtual void IPagesPanelPrefsCmdData::SetIconSize ( IPagesPanelPrefs::IconSize  size )

pure virtual

Set the enumerated value indicating the icon size to use in the pages subpanel

Parameters

size	the Pages subpanel icon size, kInvalidSize to leave unchanged.

virtual void IPagesPanelPrefsCmdData::SetMasterIconSize ( IPagesPanelPrefs::IconSize  size )

pure virtual

Set the enumerated value indicating the icon size to use in the masters subpanel

Parameters

size	the Masters subpanel icon size, kInvalidSize to leave unchanged.

virtual void IPagesPanelPrefsCmdData::SetMastersFixedSize ( bool16  fixed )

pure virtual

Set the bool indicating if the master pages subpanel is a fixed size

Parameters

fixed

kFalse if the master pages section resizes when the window resizes, kTrue otherwise, -1 to leave unchanged

virtual void IPagesPanelPrefsCmdData::SetMastersThumbnails ( bool16  on )

pure virtual

Set the bool indicating if the thumbnails are on or off for masters

Parameters

on	kTrue if the thumbnails are on; kFalse otherwise, -1 to leave unchanged

virtual void IPagesPanelPrefsCmdData::SetMastersVerticalView ( bool16  vertical )

pure virtual

Set the show vertical setting for the master pages subpanel

Parameters

vertical

kTrue if Vertical, kFalse if master pages section is set to wrapping, -1 to leave unchanged

virtual void IPagesPanelPrefsCmdData::SetPagesFixedSize ( bool16  fixed )

pure virtual

Set the bool indicating if the pages subpanel is a fixed size

Parameters

fixed

kFalse if the pages section resizes when the window resizes, kTrue otherwise, -1 to leave unchanged

virtual void IPagesPanelPrefsCmdData::SetPagesOnTop ( bool16  top )

pure virtual

Set the bool indicating if the pages subpanel is on top

Parameters

kTrue

if the pages section is on the top; kFalse otherwise, -1 to leave unchanged

virtual void IPagesPanelPrefsCmdData::SetPagesThumbnails ( bool16  on )

pure virtual

Set the bool indicating if the thumbnails are on or off for pages

Parameters

on	kTrue if the thumbnails are on; kFalse otherwise, -1 to leave unchanged

virtual void IPagesPanelPrefsCmdData::SetShowRotationIcon ( bool16  show )

pure virtual

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

Parameters

show	kTrue if the rotation icon is on; kFalse otherwise, -1 to leave unchanged

virtual void IPagesPanelPrefsCmdData::SetShowTransitionsIcon ( bool16  show )

pure virtual

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

Parameters

show	if the spread has a transition applied; kFalse otherwise, -1 to leave unchanged

virtual void IPagesPanelPrefsCmdData::SetShowTransparencyIcon ( bool16  show )

pure virtual

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

Parameters

show	kTrue if the transparency icon is on; kFalse otherwise, -1 to leave unchanged

virtual void IPagesPanelPrefsCmdData::SetViewSetting ( IPagesPanelPrefs::ViewSetting  setting )

pure virtual

Set the view setting for the pages subpanel

Parameters

setting,a

ViewSetting enum

See Also

IPagesPanelPrefs::ViewSetting