InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
IDisplayOverrideMgr Class Referenceabstract
Inheritance diagram for IDisplayOverrideMgr:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDISPLAYOVERRIDESMGR }
 

Public Member Functions

virtual uint32 GetDrawOptionsGroup (UID uidShape, bool16 bForUIWidget)=0
 
virtual void SetDrawOptionsGroup (UID uidShape, uint32 nGroup)=0
 
virtual void SetInterruptDraw (bool16 bInterrupt)=0
 
virtual bool16 IsDrawInterrupted ()=0
 
virtual void SetMostRecentDrawOptionsID (uint32 n)=0
 
virtual uint32 GetMostRecentDrawOptionsID ()=0
 
virtual void GetInMemoryOverrides (uint32 nDrawGroup, UIDList &uidOverrides)=0
 
- Public Member Functions inherited from IPMUnknown
virtual IPMUnknownQueryInterface (PMIID interfaceID) const =0
 
virtual void AddRef () const =0
 
virtual void Release () const =0
 

Member Function Documentation

virtual uint32 IDisplayOverrideMgr::GetDrawOptionsGroup (UID uidShape,
bool16 bForUIWidget 
)
pure virtual

Returns the current draw options for the specified shape. Depending on the interrupt state. In Dragontail, draw options are non-persistent.

bForUIWidget should be true when you are deciding what option should be checked, and false when you are deciding how to draw the actual page item. Sometimes, when ignore local overrides is checked, the UI appears different than how the page item is actually drawn.

virtual void IDisplayOverrideMgr::GetInMemoryOverrides (uint32 nDrawGroup,
UIDListuidOverrides 
)
pure virtual

Retrieves the set of uids that have the specified in-memory override.

virtual bool16 IDisplayOverrideMgr::IsDrawInterrupted ()
pure virtual

Returns true if draw is currently interrupted.

virtual void IDisplayOverrideMgr::SetDrawOptionsGroup (UID uidShape,
uint32 nGroup 
)
pure virtual

Update the draw options. This call:will set the status to the specified group, regardless of the interrupt state.

virtual void IDisplayOverrideMgr::SetInterruptDraw (bool16 bInterrupt)
pure virtual

This method changes all overrides to 'optimized'. They stay that way until: A. ResumeAfterInterrupt is called, in which case all overrides that haven't been updated since the interrupt return to their original state. B. A new value is set on a particular page item.

virtual void IDisplayOverrideMgr::SetMostRecentDrawOptionsID (uint32 n)
pure virtual

Set and retrieve the most recently used active set ID for the view. We do this so that when the user hits escape, the view setting is restored.