ILineNumberDrawer Class Reference

#include <ILineNumberDrawer.h>

Inheritance diagram for ILineNumberDrawer:

Public Types
enum	{ kDefaultIID = IID_ILINENUMBERDRAWER }

Public Member Functions
virtual void	SetDisplayInfoColumn (bool16 display)=0
virtual bool16	GetDisplayInfoColumn ()=0
virtual void	DrawLineNumber (IGraphicsContext *gc, int32 flags, int32 at)=0
virtual PMReal	DrawParagraphName (IGraphicsContext *gc, int32 flags, int32 at, bool16 overflow=kFalse)=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

This interface is used to control the drawing of the line information at the left side of galley and story views. In the info column or paragraph style column as it is called in InDesign. Probably, the only parts relevant to external parties is the SetDisplayInfoColumn() and GetDisplayInfoColumn() routines.

Member Function Documentation

virtual void ILineNumberDrawer::DrawLineNumber ( IGraphicsContext *  gc, int32  flags, int32  at  )

pure virtual

Draw a line number at the proper position for a specific line in the view. This applies to galley view only story view does not display line numbers. The line numbers are for lines as they would display if they were in layout view. This routine will also call the DrawParagraphName routine below.

Parameters

gc	- context to draw into
flags	- standard draw flags (same as for page items etc.). Used to tell if currently printing. Use 0 for a standard screen draw
at	- galley view line index to draw a line number for.

Returns

none

virtual PMReal ILineNumberDrawer::DrawParagraphName ( IGraphicsContext *  gc, int32  flags, int32  at, bool16  overflow = kFalse  )

pure virtual

Draw a paragraph style name in the info column. These would draw only on lines that start a paragraph

Parameters

gc	- context to draw into
flags	- standard draw flags (same as for page items etc.). Used to tell if currently printing. Use 0 for a standard screen draw
at	- line index to draw a line number for will only draw if the line starts a new paragraph.
overflow	- are we in overset text when drawing this.

Returns

no longer relavent (ignore).

virtual bool16 ILineNumberDrawer::GetDisplayInfoColumn ( )

pure virtual

Get the current display state of the info column.

Returns

kTrue if the Info Column is showing

virtual void ILineNumberDrawer::SetDisplayInfoColumn ( bool16  display )

pure virtual

Turn on or off the display of line numbers (also paragraph style names). Collapses the whole info column or expands it to it's previous state.

Parameters

display

- kTrue to uncollapse and kFalse to collapse it.

Returns

none