#include <IStrokeFillControlData.h>

Inheritance diagram for IStrokeFillControlData:

Public Types
enum	{ kDefaultIID = IID_ISTROKEFILLCONTROLDATA }

enum	DisplayOptionType { kNoOption = 0, kOptionDialog, kRenderObjectPanel }

enum	PartCode { kNone = -1, kStroke, kFill }

Public Member Functions
virtual int16	GetStrokeFillWidth (void)=0

virtual void	SetStrokeFillWidth (int16 width)=0

virtual int16	GetStrokeFillHeight (void)=0

virtual void	SetStrokeFillHeight (int16 height)=0

virtual int16	GetStrokeFillOverlap (void)=0

virtual void	SetStrokeFillOverlap (int16 overlapAmount)=0

virtual int16	GetStrokeFillHiliteBorder (void)=0

virtual void	SetStrokeFillHiliteBorder (int16 border)=0

virtual int16	GetStrokeWidth (void)=0

virtual void	SetStrokeWidth (int16 strokeWidth)=0

virtual bool16	GetDraggable (void)=0

virtual void	SetDraggable (bool16 isDraggable)=0

virtual IStrokeFillControlData::DisplayOptionType	GetDisplayOption (void)=0

virtual void	SetDisplayOption (IStrokeFillControlData::DisplayOptionType displayOption)=0

virtual bool16	GetSwitchable (void)=0

virtual void	SetSwitchable (bool16 isSwitchable)=0

virtual ToolboxProxy::ActiveProxyType	GetActive (void)=0

virtual void	SetActive (ToolboxProxy::ActiveProxyType activeProxy)=0

virtual bool16	UseMetaData (void)=0

virtual void	SetUseMetaData (bool16 usingMetaData)=0

virtual bool16	UseFillMetaData (void)=0

virtual void	SetFillUseMetaData (bool16 usingMetaData)=0

virtual bool16	UseStrokeMetaData (void)=0

virtual void	SetStrokeUseMetaData (bool16)=0

virtual IPMUnknown *	GetFillMetaData (void)=0

virtual void	SetFillMetaData (IPMUnknown *fillMetaData)=0

virtual IPMUnknown *	GetStrokeMetaData (void)=0

virtual void	SetStrokeMetaData (IPMUnknown *strokeMetaData)=0

virtual UID	GetFillUID (void)=0

virtual void	SetFillUID (UID fillUID)=0

virtual UID	GetStrokeUID (void)=0

virtual void	SetStrokeUID (UID strokeUID)=0

virtual IDataBase *	GetDataBase (void)=0

virtual void	SetDataBase (IDataBase *iDataBase)=0

virtual bool16	IsFillIndeterminate (void)=0

virtual void	SetFillIndeterminate (bool16 setInderminant)=0

virtual bool16	IsStrokeIndeterminate (void)=0

virtual void	SetStrokeIndeterminate (bool16 setInderminant)=0

virtual PMReal	GetFillTint (void)=0

virtual void	SetFillUIDAndTint (UID fillUID, const PMReal &fillTint=kInvalidTintPercent)=0

virtual PMReal	GetStrokeTint (void)=0

virtual void	SetStrokeUIDAndTint (UID strokeUID, const PMReal &strokeTint=kInvalidTintPercent)=0

virtual void	InvalidateView (void)=0

virtual void	InvalidateStroke (void)=0

virtual void	InvalidateFill (void)=0

virtual IStrokeFillControlData::PartCode	GetPartCode (const PMPoint &localPoint) 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

A widget data interface for the stroke/fill proxy widget. For rendering the stroke/fill proxy, two strategies are used: UID and metadata. The metadata object here could be any object that the client use for rendering the stroke/fill proxy view.

Member Enumeration Documentation

enum IStrokeFillControlData::DisplayOptionType

DisplayOptionType specifies what to do when user double-click on the stroke/fill proxy.
Enumerator
kNoOption
kNoOption indicates don't do anything.
kOptionDialog
kOptionDialog brings up the swatch option dialog.
kRenderObjectPanel
kRenderObjectPanel brings up either the color picker or the gradient panel.

enum IStrokeFillControlData::PartCode

Enumerator
kNone	kNone specifies the current mouse location is outside of stroke/fill proxy widget.
kStroke	kStroke specifies the current mouse location is in the stroke proxy widget.
kFill	kFill specifies the current mouse location is in the fill proxy widget.

Member Function Documentation

virtual ToolboxProxy::ActiveProxyType IStrokeFillControlData::GetActive ( void )

pure virtual

Returns the current active proxy type.

Returns: either kStrokeActive or kFillActive.

See Also: ToolboxProxyTypes.h

virtual IDataBase* IStrokeFillControlData::GetDataBase ( void )

pure virtual

Returns the database associated with the stroke and fill UID.

Returns: the fill/stroke database.

virtual IStrokeFillControlData::DisplayOptionType IStrokeFillControlData::GetDisplayOption ( void )

pure virtual

Returns the type of display option when double-click on the stroke/fill proxy widget.

Returns: the type of display option. This would be one of

virtual bool16 IStrokeFillControlData::GetDraggable ( void )

pure virtual

Returns true if the stroke/fill proxy is draggable.

virtual IPMUnknown* IStrokeFillControlData::GetFillMetaData ( void )

pure virtual

Returns the metadata object we are using to draw the fill proxy.

Returns: the fill metadata object.

virtual PMReal IStrokeFillControlData::GetFillTint ( void )

pure virtual

Returns the current fill tint percent.

virtual UID IStrokeFillControlData::GetFillUID ( void )

pure virtual

Returns the swatch UID we are using to draw the fill proxy.

Returns: the fill UID.

virtual IStrokeFillControlData::PartCode IStrokeFillControlData::GetPartCode ( const PMPoint & localPoint ) const

pure virtual

Returns the position of the mouse relative to the stroke/fill proxy.

Parameters

localPoint the mouse position.

Returns: one of .

virtual int16 IStrokeFillControlData::GetStrokeFillHeight ( void )

pure virtual

Returns the stroke/fill proxy widget's height.

virtual int16 IStrokeFillControlData::GetStrokeFillHiliteBorder ( void )

pure virtual

Returns the border width to draw around the fill and stroke proxy. If it is set to 0, then border is not drawn.

Returns: the stroke/fill proxy border width.

virtual int16 IStrokeFillControlData::GetStrokeFillOverlap ( void )

pure virtual

Returns the amount to overlapp the stroke and fill proxy. -1 means fill only, -2 means stroke only.

virtual int16 IStrokeFillControlData::GetStrokeFillWidth ( void )

pure virtual

Returns the stroke/fill proxy widget's width.

virtual IPMUnknown* IStrokeFillControlData::GetStrokeMetaData ( void )

pure virtual

Returns the metadata object we are using to draw the stroke proxy.

Returns: the stroke metadata object.

virtual PMReal IStrokeFillControlData::GetStrokeTint ( void )

pure virtual

Returns the current stroke tint percent.

virtual UID IStrokeFillControlData::GetStrokeUID ( void )

pure virtual

Returns the swatch UID we are using to draw the stroke proxy.

Returns: the stroke UID.

virtual int16 IStrokeFillControlData::GetStrokeWidth ( void )

pure virtual

Returns the width of the stroke proxy.

virtual bool16 IStrokeFillControlData::GetSwitchable ( void )

pure virtual

Returns whether the widget can toggle between fill and stroke modes. When not switchable, only fill or only stroke will be drawn depending on GetActive

virtual void IStrokeFillControlData::InvalidateFill ( void )

pure virtual

Invalidate the fill proxy view.

virtual void IStrokeFillControlData::InvalidateStroke ( void )

pure virtual

Invalidate the stroke proxy view.

virtual void IStrokeFillControlData::InvalidateView ( void )

pure virtual

Invalidate the stroke/fill proxy view.

virtual bool16 IStrokeFillControlData::IsFillIndeterminate ( void )

pure virtual

Returns the true if fill is indeterminant.

virtual bool16 IStrokeFillControlData::IsStrokeIndeterminate ( void )

pure virtual

Returns the true if stroke is indeterminant.

virtual void IStrokeFillControlData::SetActive ( ToolboxProxy::ActiveProxyType activeProxy )

pure virtual

Sets the current active proxy type to the one specified.

Parameters

activeProxy is the new active proxy.

virtual void IStrokeFillControlData::SetDataBase ( IDataBase * iDataBase )

pure virtual

Sets the database associated with the stroke/fill UID.

Parameters

iDataBase the database.

virtual void IStrokeFillControlData::SetDisplayOption ( IStrokeFillControlData::DisplayOptionType displayOption )

pure virtual

Sets the type of display option when double-click on the stroke/fill proxy widget.

Parameters

displayOption the type of display option. This would be one of

virtual void IStrokeFillControlData::SetDraggable ( bool16 isDraggable )

pure virtual

Set to true if the stroke/fill proxy is draggable.

Parameters

isDraggable is true if the stroke/fill proxy is draggable.

virtual void IStrokeFillControlData::SetFillIndeterminate ( bool16 setInderminant )

pure virtual

Sets the to true if fill is indeterminant.

Parameters

setInderminant is true if fill is indeterminat.

virtual void IStrokeFillControlData::SetFillMetaData ( IPMUnknown * fillMetaData )

pure virtual

Sets the fill metadata for drawing the fill proxy.

Parameters

fillMetaData the fill metadata

virtual void IStrokeFillControlData::SetFillUID ( UID fillUID )

pure virtual

Sets the fill UID for drawing the fill proxy.

Parameters

fillUID the fill UID.

virtual void IStrokeFillControlData::SetFillUIDAndTint	(	UID	fillUID,
		const PMReal &	fillTint = `kInvalidTintPercent`
	)

pure virtual

Sets the current fill UID and tint percent.

Parameters

fillUID	the current fill UID.
fillTint	the current fill tint percent.

virtual void IStrokeFillControlData::SetFillUseMetaData ( bool16 usingMetaData )

pure virtual

Sets to true if using metadata to draw the fill proxy. Otherwise sets to false if using UIDs.

Parameters

usingMetaData is true if drawing fill proxy with metadata

virtual void IStrokeFillControlData::SetStrokeFillHeight ( int16 height )

pure virtual

Sets the stroke/fill widget's proxy height.

Parameters

height the stroke/fill proxy widget's height.

virtual void IStrokeFillControlData::SetStrokeFillHiliteBorder ( int16 border )

pure virtual

Sets the border width to draw around the fill and stroke proxy.

Parameters

border the stroke/fill proxy border width.

virtual void IStrokeFillControlData::SetStrokeFillOverlap ( int16 overlapAmount )

pure virtual

Sets the amount to overlapp the stroke and fill proxy. Use a value < 0 to draw the widget in just one mode, e.g. just draw the fill or the stroke widget, but not both

Parameters

overlapAmount the stroke/fill proxy overlap amount.

virtual void IStrokeFillControlData::SetStrokeFillWidth ( int16 width )

pure virtual

Sets the stroke/fill proxy widget's width.

Parameters

width the stroke/fill proxy widget's width.

virtual void IStrokeFillControlData::SetStrokeIndeterminate ( bool16 setInderminant )

pure virtual

Sets the to true if stroke is indeterminant.

Parameters

setInderminant is true if stroke is indeterminat.

virtual void IStrokeFillControlData::SetStrokeMetaData ( IPMUnknown * strokeMetaData )

pure virtual

Sets the stroke metadata for drawing the stroke proxy.

Parameters

strokeMetaData the fill metadata

virtual void IStrokeFillControlData::SetStrokeUID ( UID strokeUID )

pure virtual

Sets the stroke UID for drawing the stroke proxy.

Parameters

strokeUID the stroke UID.

virtual void IStrokeFillControlData::SetStrokeUIDAndTint	(	UID	strokeUID,
		const PMReal &	strokeTint = `kInvalidTintPercent`
	)

pure virtual

Sets the current stroke UID and tint percent.

Parameters

strokeUID	the current stroke UID.
strokeTint	the current stroke tint percent.

virtual void IStrokeFillControlData::SetStrokeUseMetaData ( bool16 )

pure virtual

Sets to true if using metadata to draw the stroke proxy. Otherwise sets to false if using UIDs.

Parameters

usingMetaData is true if drawing stroke proxy with metadata

virtual void IStrokeFillControlData::SetStrokeWidth ( int16 strokeWidth )

pure virtual

Sets the width of the stroke proxy.

Parameters

strokeWidth the stroke proxy width.

virtual void IStrokeFillControlData::SetSwitchable ( bool16 isSwitchable )

pure virtual

Sets whether the widget can toggle between displaying fill or stroke in the front.

Parameters

isSwitchable kTrue to allow switchability, kFalse to disallow.

virtual void IStrokeFillControlData::SetUseMetaData ( bool16 usingMetaData )

pure virtual

Sets to true if using metadata to draw the stroke/fill proxy. Otherwise sets to false if using UIDs.

Parameters

usingMetaData is true if drawing stroke/fill proxy with metadata

virtual bool16 IStrokeFillControlData::UseFillMetaData ( void )

pure virtual

Returns true if using metadata to draw the fill proxy. Otherwise returns false if using UIDs.

Returns: true if drawing fill proxy with metadata

virtual bool16 IStrokeFillControlData::UseMetaData ( void )

pure virtual

Returns true if using metadata to draw the stroke/fill proxy. Otherwise returns false if using UIDs.

Returns: true if drawing stroke/fill proxy with metadata

virtual bool16 IStrokeFillControlData::UseStrokeMetaData ( void )

pure virtual

Returns true if using metadata to draw the stroke proxy. Otherwise returns false if using UIDs.

Returns: true if drawing stroke proxy with metadata

Enumerator
kNoOption	kNoOption indicates don't do anything.
kOptionDialog	kOptionDialog brings up the swatch option dialog.
kRenderObjectPanel	kRenderObjectPanel brings up either the color picker or the gradient panel.

Public Types

Public Member Functions

Detailed Description

Member Enumeration Documentation

Member Function Documentation