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

#include <ICJKGridPainter.h>

Inheritance diagram for ICJKGridPainter:
IPMUnknown

Public Member Functions

virtual IDrawCJKGrid * QueryDrawCJKGrid ()=0
 
virtual void SetDrawBoss (ClassID drawBoss)=0
 
virtual ClassID GetDrawBoss ()=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

ICJKGridPainter allows for custom grid drawing.  This interface can be used to

specify a ClassID of a boss that implements the IDrawCJKGrid interface. This implementation will be used to draw the grid instead of the default implementation provided by InDesign.

The default grid drawing boss is kDefaultCJKGridDrawBoss. It's important to note that if another boss is specified in this interface, there is nothing stopping you from manually instantiating a kDefaultCJKGridDrawBoss and calling the Draw methods from the custom implementation. This would allow you to draw before or after the default grid drawing code.

Member Function Documentation

virtual ClassID ICJKGridPainter::GetDrawBoss ()
pure virtual

Get the boss that will draw this grid.

Returns
ClassID of the boss that will be used to draw this grid.
virtual IDrawCJKGrid* ICJKGridPainter::QueryDrawCJKGrid ()
pure virtual

Query for the IDrawCJKGrid instance as specified by the ClassID stored in this object.

Returns
A pointer to a valid IDrawCJKGrid instance or nil on failure.
virtual void ICJKGridPainter::SetDrawBoss (ClassID drawBoss)
pure virtual

Set the boss that will draw this grid.

Parameters
drawBossIN The ClassID of the boss that will be used to draw this grid.
Precondition
The boss specified by drawBoss should implement IDrawCJKGrid.