#include <ICJKGridPrefs.h>

Inheritance diagram for ICJKGridPrefs:

Public Types
enum	{ kDefaultIID = IID_ICJKGRIDPREFS }

Public Member Functions
virtual bool16	GetSnapToLayoutGrid ()=0

virtual void	SetSnapToLayoutGrid (bool16 status)=0

virtual void	SetLayoutGridColor (const UIDRef uiColorUIDRef, bool16 bTranslateDBToDB=kTrue)=0

virtual const UIDRef	GetLayoutGridColor ()=0

virtual void	SetColorEveryNthCell (int16 n)=0

virtual int16	GetColorEveryNthCell ()=0

virtual void	SetSingleLineColorMode (bool16 isSingleLine)=0

virtual bool16	GetSingleLineColorMode ()=0

virtual void	SetICFMode (bool16 useICF)=0

virtual bool16	GetICFMode ()=0

virtual void	SetUseCircularCells (bool16 useCircles)=0

virtual bool16	GetUseCircularCells ()=0

virtual void	SetMinimumScale (const PMReal &minScale)=0

virtual PMReal	GetMinimumScale ()=0

virtual bool16	GetShowAllLayoutGrids ()=0

virtual void	SetShowAllLayoutGrids (bool16 show)=0

virtual bool16	GetShowAllFrameGrids ()=0

virtual void	SetShowAllFrameGrids (bool16 show)=0

virtual bool16	GetShowCharacterCount ()=0

virtual void	SetShowCharacterCount (bool16 show)=0

virtual void	CopyFrom (ICJKGridPrefs *source)=0

virtual bool16	GetSnapToLayoutGrid_DURING_CONVERSION_ONLY ()=0

virtual bool16	GetShowAllLayoutGrids_DURING_CONVERSION_ONLY ()=0

virtual bool16	GetShowAllFrameGrids_DURING_CONVERSION_ONLY ()=0

virtual bool16	GetShowCharacterCount_DURING_CONVERSION_ONLY ()=0

virtual int32	GetLayoutGridColorIndex_DURING_CONVERSION_ONLY ()=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

ICJKGridPrefs is an interface that allows for the access and modification of CJK Grid Preferences.

You may find these preferences on the application and/or document workspaces.

Member Function Documentation

virtual void ICJKGridPrefs::CopyFrom ( ICJKGridPrefs * source )

pure virtual

Utility method used to copy ICJKGridPrefs from another instance.

Parameters

source IN The source instance.

Precondition: *source must point to a valid ICJKGridPrefs instance.

Postcondition: The preferences are copied.

virtual int16 ICJKGridPrefs::GetColorEveryNthCell ( )

pure virtual

Which (Nth) cell is being colored?

Returns: Index

virtual bool16 ICJKGridPrefs::GetICFMode ( )

pure virtual

Are grids using ICF (HLTODO).

Returns: kTrue if grids are using ICF mode.

virtual const UIDRef ICJKGridPrefs::GetLayoutGridColor ( )

pure virtual

Gets the current layout grid color.

Returns: A UIDRef for the layout grids color.

virtual int32 ICJKGridPrefs::GetLayoutGridColorIndex_DURING_CONVERSION_ONLY ( )

pure virtual

Internal method used to convert a color index during conversion. Please do not call!

virtual PMReal ICJKGridPrefs::GetMinimumScale ( )

pure virtual

Gets the minimum viewing scale for grid drawing.  The grid will

not draw when scaled out beyond the minimum.

Returns: The current minimum scale

virtual bool16 ICJKGridPrefs::GetShowAllFrameGrids ( )

pure virtual

Gets view preference for show/hide all frame grids.

Returns: kTrue if all frame grids are visible, kFalse if hidden.

virtual bool16 ICJKGridPrefs::GetShowAllFrameGrids_DURING_CONVERSION_ONLY ( )

pure virtual

Internal method used to convert show frame grid setting. Please do not call!

virtual bool16 ICJKGridPrefs::GetShowAllLayoutGrids ( )

pure virtual

Gets view preference for show/hide all layout grids.

Returns: kTrue if all frame grids are visible, kFalse if hidden.

virtual bool16 ICJKGridPrefs::GetShowAllLayoutGrids_DURING_CONVERSION_ONLY ( )

pure virtual

Internal method used to convert show layout grid setting. Please do not call!

virtual bool16 ICJKGridPrefs::GetShowCharacterCount ( )

pure virtual

Gets view preference for show/hide character count.

Returns: kTrue if the character count is visible, kFalse if hidden.

virtual bool16 ICJKGridPrefs::GetShowCharacterCount_DURING_CONVERSION_ONLY ( )

pure virtual

Internal method used to convert show character count setting. Please do not call!

virtual bool16 ICJKGridPrefs::GetSingleLineColorMode ( )

pure virtual

When coloring every nth grid cell, do we start counting from the start of the line?

Returns: kTrue if we are in single line mode, meaning we start counting from the start of each line.

virtual bool16 ICJKGridPrefs::GetSnapToLayoutGrid ( )

pure virtual

Do drags currently snap to the layout grid

Returns: kTrue if drag should snap to layout grid

virtual bool16 ICJKGridPrefs::GetSnapToLayoutGrid_DURING_CONVERSION_ONLY ( )

pure virtual

Internal method used to convert snap to layout grid setting. Please do not call!

virtual bool16 ICJKGridPrefs::GetUseCircularCells ( )

pure virtual

Is grid drawing currently using circular cells.

Returns: kTrue for circular cells.

virtual void ICJKGridPrefs::SetColorEveryNthCell ( int16 n )

pure virtual

Sets which nth cell to color.

Parameters

n	IN Which nth cell to color.

virtual void ICJKGridPrefs::SetICFMode ( bool16 useICF )

pure virtual

Sets whether or not CJK Grids are using ICF Mode (HLTODO)

Parameters

useICF IN pass kTrue to use ICF mode.

virtual void ICJKGridPrefs::SetLayoutGridColor	(	const UIDRef	uiColorUIDRef,
		bool16	bTranslateDBToDB = `kTrue`
	)

pure virtual

Sets the color of the layout grid.

Parameters

uiColorUIDRef	IN The new color.
bTranslateDBToDB	IN kTrue if you want this UIDRef to be translated to the current database

virtual void ICJKGridPrefs::SetMinimumScale ( const PMReal & minScale )

pure virtual

Sets the minimum scale factor for grid drawing.  The grid will

not draw when scaled out beyond the minimum.

Parameters

minScale IN The new minimum

virtual void ICJKGridPrefs::SetShowAllFrameGrids ( bool16 show )

pure virtual

Sets view preference for show/hide frame grids.

Parameters

show	IN kFalse to hide, kTrue to show

virtual void ICJKGridPrefs::SetShowAllLayoutGrids ( bool16 show )

pure virtual

Sets view preference for show/hide layout grids.

Parameters

show	IN kFalse to hide, kTrue to show

virtual void ICJKGridPrefs::SetShowCharacterCount ( bool16 show )

pure virtual

Sets view preference for show/hide character count.

Parameters

show	IN kFalse to hide, kTrue to show

virtual void ICJKGridPrefs::SetSingleLineColorMode ( bool16 isSingleLine )

pure virtual

Sets whether or not we start counting from the start of each new line.

Parameters

isSingleLine IN pass kTrue to start at each line, kFalse to continue counting without regard to line boundaries.

virtual void ICJKGridPrefs::SetSnapToLayoutGrid ( bool16 status )

pure virtual

Sets if drags should snap to the layout grid

Parameters

status IN kTrue to set snap, kFalse to turn snapping off

virtual void ICJKGridPrefs::SetUseCircularCells ( bool16 useCircles )

pure virtual

Sets whether or not CJK grid drawing is to use circular cells.

Parameters

useCircles IN pass kTrue for circular cells.

Public Types

Public Member Functions

Detailed Description

Member Function Documentation