InDesign SDK  20.5
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Friends Groups Pages
Public Types | Public Member Functions | List of all members
ISetDrawOptionOverrideCmdData Class Referenceabstract

#include <ISetDrawOptionOverrideCmdData.h>

Inheritance diagram for ISetDrawOptionOverrideCmdData:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_ISETDRAWOPTIONOVERRIDECMDDATA }
 

Public Member Functions

virtual void SetDisplayOption (uint32 displayOption)=0
 
virtual uint32 GetDisplayOption () const =0
 
virtual void ClearOptionRange ()=0
 
virtual void AppendOptionRange (const DisplayOptionRange &range)=0
 
virtual int32 GetOptionRangeCount () const =0
 
virtual DisplayOptionRange GetNthDisplayOptionRange (int32 n) const =0
 
virtual void SetOverrideLocation (IDrawOptionOverrides::OverrideLocation location)=0
 
virtual
IDrawOptionOverrides::OverrideLocation 		GetOverrideLocation () 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

Description: This interface is a data interface for the kSetDrawOptionOverrideCmdBoss and is used to set drawing characteristics of page items. Typically, draw options are set on the View and apply to all page items. However, draw options can also be set on individual page items as overrides. Early versions of InDesign persisted these object level overrides such that if you changed a display setting on a page item, closed and re-opened a document, the changed setting was still active. On the surface, this behavior seems appropriate. However, drawing in high-quality mode can be expensive, especially the first time you draw an object. Therefore, if you opened a document with persisted display overrides on 1 or more page items, the first draw of the document could be quite slow giving the impression that document Open was slow. So, in later versions of InDesign, this behavior was changed such that the object level display overrides were not persisted unless new preference was set to force the overrides to be persisted.

This interface and its associated command are used to set the override options on 1 or more page items.

See Also
IDrawOptionOverrides.h, IDrawOptions.h

Member Function Documentation

virtual void ISetDrawOptionOverrideCmdData::ClearOptionRange ()
pure virtual

The option range methods are used to store the values that will be passed to IDrawOptions::SetDrawOptionGroup().

virtual uint32 ISetDrawOptionOverrideCmdData::GetDisplayOption () const
pure virtual

Get the display option that was set via SetDisplayOption().

virtual void ISetDrawOptionOverrideCmdData::SetDisplayOption (uint32 displayOption)
pure virtual

Set the display setting on the target page items to one of the draw options defined in IDrawOptions.h such as IDrawOptions::kUseDefault.

Parameters
displayOption[IN]:
virtual void ISetDrawOptionOverrideCmdData::SetOverrideLocation (IDrawOptionOverrides::OverrideLocation location)
pure virtual

Accessor for override location. Default is IDrawOptionOverrides::kUseDisplayPreferences. The override location determines if the override is persisted or not. You can explicitly set whether or not it is persisted or allow the command to determine whether or not to persist based on the value of IDrawOptions::GetSaveLocalOverrides()