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

#include <GraphicsData.h>

Public Member Functions

IGraphicsPort * GetGraphicsPort () const
 
IRasterPort * GetRasterPort () const
 
IDrwEvtDispatcher * GetDrawEventDispatcher () const
 
IDrawMgr * GetDrawManager () const
 
IControlView * GetView () const
 
IViewPort * GetViewPort () const
 
IViewPortAttributes * GetViewPortAttributes () const
 
ILayoutController * GetLayoutController () const
 
const PMMatrix & GetContentToViewMatrix () const
 
const PMMatrix & GetViewToContentMatrix () const
 
IGraphicsContext * GetGraphicsContext () const
 
DrawOptionsSet GetDrawOptions (const IPMUnknown *drawablePageItemInterface=nil) const
 
TextDrawInfo * GetTextDrawInfo () const
 

Friends

class GraphicsDataPtr
 

Detailed Description

GraphicsData is a data container interface which is passed into drawing code for shapes. GraphicsData contains a set of the most commonly used interfaces for drawing.

See Also
IGraphicsPort
IRasterPort
IDrwEvtDispatcher
IDrawMgr
IControlView
IViewPort
IViewPortAttributes
ILayoutController
IGraphicsContext

Member Function Documentation

const PMMatrix & GraphicsData::GetContentToViewMatrix () const
inline

Gets the transform matrix for converting from pasteboard to device coordinates

See Also
PMMatrix
Returns
the CTM
IDrwEvtDispatcher * GraphicsData::GetDrawEventDispatcher () const
inline

Gets the draw event dispatcher for this graphics data

Note: The draw event dispatcher will never be nil

See Also
IDrwEvtDispatcher
Returns
an IDrwEvtDispatcher instance
IDrawMgr * GraphicsData::GetDrawManager () const
inline

Gets the draw manager for this graphics data

Note: The draw manager will never be nil

See Also
IDrawMgr
Returns
an IDrawMgr instance
DrawOptionsSet GraphicsData::GetDrawOptions (const IPMUnknown * drawablePageItemInterface = nil) const

Gets the active draw options If drawablePageItemInterface is non-nil AND we are not printing (see IViewPortAttributes::GetViewPortIsPrintingPort()) AND "Ignore Local Overrides" is not set in the workspace's IDrawOptions settings, then drawablePageItemInterface will be checked for local overrides. If no local overrides exist or the argument is nil, then the draw options will be based upon the ViewPortAttribute settings, the workspace's IDrawOptions settings and the view's IDrawOptionsSetID.

See Also
DrawOptionsSet
Returns
the draw options to use
IGraphicsContext * GraphicsData::GetGraphicsContext () const
inline

Gets the graphics context for any that need it.

See Also
IGraphicsContext
Returns
an IGraphicsContext instance
IGraphicsPort * GraphicsData::GetGraphicsPort () const
inline

Gets the graphics port for this graphics data

Note: The graphics port will never be nil

See Also
IGraphicsPort
Returns
an IGraphicsPort instance
ILayoutController * GraphicsData::GetLayoutController () const
inline

Gets the layout controller for this graphics data

Note: The layout controller will not be nil during calls to inval, but may be nil otherwise

See Also
ILayoutController
Returns
an ILayoutController instance
IRasterPort * GraphicsData::GetRasterPort () const
inline

Gets the raster port for this graphics data

Note: The raster port may be nil if not drawing to the screen.

See Also
IRasterPort
Returns
an IRasterPort instance, or nil
TextDrawInfo * GraphicsData::GetTextDrawInfo () const
inline

Gets the text draw info for this graphics data

See Also
TextDrawInfo
Returns
a TextDrawInfo
IControlView * GraphicsData::GetView () const
inline

Gets the control view for this graphics data

Note: The control view may be nil (nil indicates drawing to a printer or other non-screen device)

See Also
IControlView
Returns
an IControlView instance, or nil
IViewPort * GraphicsData::GetViewPort () const
inline

Gets the view port for this graphics data

Note: The viewport will never be nil

See Also
IViewPort
Returns
an IViewPort instance
IViewPortAttributes * GraphicsData::GetViewPortAttributes () const
inline

Gets the view port attributes for this graphics data

Note: Viewport attributes will never be nil

See Also
IViewPortAttributes
Returns
an IViewPortAttributes instance
const PMMatrix & GraphicsData::GetViewToContentMatrix () const
inline

Gets the inverse transform matrix for converting from device to pasteboard coordinates

See Also
PMMatrix
Returns
the inverse CTM