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

#include <IDrawOptions.h>

Inheritance diagram for IDrawOptions:
IPMUnknown

Public Types

enum  { kDefaultIID = IID_IDRAWOPTIONS }
 
enum  {
  kUseDefault = kMaxUInt32, kFastGroup = 0, kTypicalGroup, kHighQualityGroup,
  kNavigatorGroup, kFastScrollGroup, kSepPrvGroup, kFlatPrvGroup,
  kSnapshotUtilsPrvGroup
}
 
enum  RasterDisplay { kRasterGrayOut = 0, kRasterProxy, kRasterHighRes }
 
enum  VectorDisplay { kVectorGrayOut = 0, kVectorProxy, kDisplayList }
 
enum  Transparencies {
  kXPOff = 0, kXPLow, kXPMedium, kXPHigh,
  kXPMaximum
}
 

Public Member Functions

virtual int32 GetCount (void) const =0
 
virtual void SetSet (const DrawOptionsSet &set)=0
 
virtual void RemoveSet (uint32 setID)=0
 
virtual bool8 SetActiveSetID (uint32 setID)=0
 
virtual uint32 GetActiveSetID (void) const =0
 
virtual bool8 GetSetByID (uint32 setID, DrawOptionsSet *result) const =0
 
virtual DrawOptionsSet GetSetByIndex (int32 setIndex) const =0
 
virtual void SetIgnoreOverrides (bool8 ignore)=0
 
virtual bool8 GetIgnoreOverrides (void) const =0
 
virtual void SetSaveLocalOverrides (bool8 save)=0
 
virtual bool8 GetSaveLocalOverrides () 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

IDrawOptions Use this class to control the drawing quality of page items to a port. Each type of graphics port interface lives on a boss with a corresponding IID_IDRAWOPTIONS interface. That is, each port has its own IDrawOptions which control the drawing quality of page items into that port.

Member Enumeration Documentation

anonymous enum

default IID enumerator

anonymous enum

Standard Application defined Set IDs kUseDefault Local override value kFastGroup Disable anti-aliasing and transparency; draw gray boxes for images; greek text kTypicalGroup Enable anti-aliasing and medium transparency, draw proxy images, greek small text kHighQualityGroup Enable anti-aliasing and high quality transparency, draw all images at high quality kNavigatorGroup Private draw options for the Navigator panel kFastScrollGroup Private draw options when in "fast scroll" mode kSepPrvGroup Private draw options for Separations Preview mode kFlatPrvGroup Private draw options for Flattener Preview mode kSnapshotUtilsPrvGroup Private draw options for SnapshotUtils

enum IDrawOptions::RasterDisplay

Raster specific settings kRasterGrayOut Images draw as a gray box kRasterProxy Force proxy to draw at proxy resolution kRasterHighRes High Res image

enum IDrawOptions::Transparencies

Transparency specific settings kXPOff kXPLow Crude approximations of transparency effects, blends honored kXPMedium Low quality transparency effects, no page isolation set kXPHigh Normal kXPMaximum Resolution independent transparency effects (may not be implemented)

enum IDrawOptions::VectorDisplay

Vector graphic (placed PDF, PICT, EPS, WMF) specific settings kVectorGrayOut Images draw as a gray box kVectorProxy Force proxy to draw at proxy resolution kDisplayList High Res Display list

Member Function Documentation

virtual uint32 IDrawOptions::GetActiveSetID (void ) const
pure virtual

Return the active DrawOptions set that will be used when drawing to the associated port.

virtual int32 IDrawOptions::GetCount (void ) const
pure virtual

Return the number of DrawOption sets that have been defined.

virtual bool8 IDrawOptions::GetIgnoreOverrides (void ) const
pure virtual

Return the "Ignore Local Overrides" setting, which is kFalse by default.

virtual bool8 IDrawOptions::GetSaveLocalOverrides () const
pure virtual

Return kTrue if the local overrides setting on page items is persisted.

virtual bool8 IDrawOptions::GetSetByID (uint32 setID,
DrawOptionsSet * result 
) const
pure virtual

Get the DrawOptionsSet with the given setID

Parameters
setID- IN: setID of the DrawOptionsSet we are interested in.
result- OUT: Pointer to the DrawOptionsSet with the associated setID.
Returns
kTrue if successful
virtual DrawOptionsSet IDrawOptions::GetSetByIndex (int32 setIndex) const
pure virtual

Get the nth, zero-based DrawOptionsSet. This routine is useful when iterating over all of the DrawOptionsSets.

Parameters
setIndex- IN: zero-based index.
Returns
The DrawOptionsSet with the associated setID.
virtual void IDrawOptions::RemoveSet (uint32 setID)
pure virtual

Remove the DrawOptions set whose DrawOptionsSet.setID matches the setID paramater.

Parameters
setID- IN: ID of the custom set to remove.
virtual bool8 IDrawOptions::SetActiveSetID (uint32 setID)
pure virtual

Set the active DrawOptions set that will be used when drawing to the associated port.

Parameters
setID- IN: setID fo the DrawOptionsSet to set as the active set.
virtual void IDrawOptions::SetIgnoreOverrides (bool8 ignore)
pure virtual

Set the "Ignore Local Overrides" setting

Parameters
ignore- IN: kTrue to ignore local overrides, kFalse to honor them.
virtual void IDrawOptions::SetSaveLocalOverrides (bool8 save)
pure virtual

Determines whether local display overrides are saved in the document, or merely kept in memory and lost on doc close.

Parameters
save- IN: kTrue to persist the local overrides. Not recommended.
virtual void IDrawOptions::SetSet (const DrawOptionsSet & set)
pure virtual

Set all the options for a given Set. If a set does not exist with the same setID then it will be added. If you are adding your own set, then define the set's setID to be your pluginID plus a constant to avoid conflicts with other 3rd party sets.

Parameters
set- IN: custom set to add to the list of DrawOption sets.