ISetDrawOptionsCmdData Class Reference

#include <ISetDrawOptionsCmdData.h>

Inheritance diagram for ISetDrawOptionsCmdData:

Public Types
enum	SetDrawOptionsSetFlags { kSetSaveLocalOverrides = 0x01 }

Public Member Functions
virtual void	SetSet (DrawOptionsSet set, bool8 isDefault)=0
virtual void	SetIgnore (bool8 ignoreOverrides)=0
virtual void	SetSaveLocalOverrides (bool8 save)=0
virtual bool8	GetSet (DrawOptionsSet *set) const =0
virtual bool8	IsDefault (void) const =0
virtual bool8	DoIgnore (void) const =0
virtual bool8	DoSaveLocalOverrides () const =0
virtual SetDrawOptionsSetFlags	GetSetFlags () 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

ISetDrawOptionsCmdData

This class is used to apply or clear display option overrides on page items. Overrides can be persistent (not recommended) or non-persistent (recommended).

Member Enumeration Documentation

enum ISetDrawOptionsCmdData::SetDrawOptionsSetFlags

enum flags

Member Function Documentation

virtual bool8 ISetDrawOptionsCmdData::DoIgnore ( void  ) const

pure virtual

Returns kTrue if local display setting overrides on page items should be ignored. That is, are we ignoring local overrides?

virtual bool8 ISetDrawOptionsCmdData::DoSaveLocalOverrides ( ) const

pure virtual

Returns whether we are persisting local overrides

virtual bool8 ISetDrawOptionsCmdData::GetSet ( DrawOptionsSet *  set ) const

pure virtual

Parameters

set	- IN: Pointer to a valid DrawOptionsSet.

Returns

Returns kTrue if SetSet was previously called. Returns kFalse if SetSet was never called.

virtual SetDrawOptionsSetFlags ISetDrawOptionsCmdData::GetSetFlags ( ) const

pure virtual

Obsolete. Serves no useful purpose.

virtual bool8 ISetDrawOptionsCmdData::IsDefault ( void  ) const

pure virtual

Returns whether the set returned via GetSet the default view set.

virtual void ISetDrawOptionsCmdData::SetIgnore ( bool8  ignoreOverrides )

pure virtual

SetIgnore Set the "Ignore Local Overrides" setting. When kTrue, local overrides (stored in a page item's IDrawOptionOverrides interface) will be ignored. Note: YOU MUST CALL THIS METHOD TO GUARANTEE THAT THE IGNOREOVERRIDES SETTINGS IS CORRECT.

Parameters

ignoreOverrides

- IN: kTrue to ignore local display overrides (set from the Object->Display Performance menu).

virtual void ISetDrawOptionsCmdData::SetSaveLocalOverrides ( bool8  save )

pure virtual

Parameters

save	- IN: kTrue to persist local display overrides on page items. Not recommended as it can dramatically slow down the time it takes to open and navigate through a document.

virtual void ISetDrawOptionsCmdData::SetSet ( DrawOptionsSet  set, bool8  isDefault  )

pure virtual

Add or replace a DrawOptionsSet to the list of DrawOptionsSets stored in the Session workspace. Note: CALLING THIS ROUTINE IS OPTIONAL IF ALL YOU WANT TO DO IS SET THE IGNORE FLAG.

Parameters

set	- IN: The new set of draw options.
isDefault	- IN: kTrue to use this set as the default set of draw options for new windows.