#include <IDocStructurePrefs.h>

Inheritance diagram for IDocStructurePrefs:

Public Types
enum	{ kDefaultIID = IID_IDOCSTRUCTUREPREFS }

Public Member Functions
virtual void	CopyFields (IDocStructurePrefs *other)=0

virtual bool16	StructureIsShown () const =0

virtual void	SetShowStructure (bool16 showStructure)=0

virtual PMReal	GetStructureWidth () const =0

virtual void	SetStructureWidth (PMReal structureWidth)=0

virtual bool16	StructureValidationIsShown () const =0

virtual void	SetShowStructureValidation (bool16 showStructureValidation)=0

virtual PMReal	GetStructureValidationHeight () const =0

virtual void	SetStructureValidationHeight (PMReal structureValidationHeight)=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

Class to manipulate the structure-view preferences. Persisted on session and in each document workspace. Change by using a command (kChangeDocStructurePrefsCmdBoss) which takes UID of boss object with this interface as first and only thing in its item list.

Member Function Documentation

virtual void IDocStructurePrefs::CopyFields ( IDocStructurePrefs * other )

pure virtual

Copy fields from another instance of this interface

Parameters

other The other interface to copy data from

virtual PMReal IDocStructurePrefs::GetStructureValidationHeight ( ) const

pure virtual

Accessor for height of validation view

Returns: current height of validation view preference

virtual PMReal IDocStructurePrefs::GetStructureWidth ( ) const

pure virtual

Accessor for width of structure view

Returns: current width of structure view preference

virtual void IDocStructurePrefs::SetShowStructure ( bool16 showStructure )

pure virtual

Mutator for structure view visibility property

Parameters

showStructure kTrue if structure should be set visible, kFalse otherwise

virtual void IDocStructurePrefs::SetShowStructureValidation ( bool16 showStructureValidation )

pure virtual

Mutator for Validation pane visibility property

Parameters

showStructureValidation kTrue if validation should be set visible, kFalse otherwise

virtual void IDocStructurePrefs::SetStructureValidationHeight ( PMReal structureValidationHeight )

pure virtual

Mutator for height of validation view

Parameters

structureValidationHeight specify pixel height of the validation view

virtual void IDocStructurePrefs::SetStructureWidth ( PMReal structureWidth )

pure virtual

Mutator for width of structure view

Parameters

structureWidth specify pixel width of the structure view

virtual bool16 IDocStructurePrefs::StructureIsShown ( ) const

pure virtual

Determine whether the structure pane is shown in layout window?

Returns: kTrue if structure-view visible, kFalse otherwise.

virtual bool16 IDocStructurePrefs::StructureValidationIsShown ( ) const

pure virtual

Determine whether the Validation pane is shown in structure pane?

Returns: kTrue if Validation-view visible, kFalse otherwise.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation