IStrokeEditorPanelData Class Reference

#include <IStrokeEditorPanelData.h>

Inheritance diagram for IStrokeEditorPanelData:

Public Types
enum	{ kDefaultIID = IID_ISTROKEEDITORPANELDATA }

Public Member Functions
virtual void	Initialize (IPathStroker const *stroker, bool16 &wasApplicable)=0
virtual void	CleanUp ()=0
virtual IPathStroker *	GetPathStroker () const =0
virtual void	DrawPreview (IGraphicsPort *port, PMPoint const &start, PMPoint const &end, PMReal const &strokeWeight) const =0
virtual IPathStroker *	CreatePathStroker (IDataBase *db) const =0
virtual bool16	UpdatePathStroker (IPathStroker *stroker) 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

Interface to be implemented by stroke-specific panels in the stroke editor dialog.

See Also

IPathStroker

Member Function Documentation

virtual void IStrokeEditorPanelData::CleanUp ( )

pure virtual

Clean up routine called by the stroke editor dialog as the dialog is being destructed. Subclasses should override to clean up their internal state

virtual IPathStroker* IStrokeEditorPanelData::CreatePathStroker ( IDataBase *  db ) const

pure virtual

Returns a new path stroker in the specified database using current panel settings.

Parameters

db	The database for the new stroker

Returns

New stroker instance

virtual void IStrokeEditorPanelData::DrawPreview ( IGraphicsPort *  port, PMPoint const &  start, PMPoint const &  end, PMReal const &  strokeWeight  ) const

pure virtual

Draws a proxy representation of the current stroker data for use in the stroke editor preview widget.

Parameters

port	The port to draw to
start	Starting point of the path to stroke
end	Ending point of path
strokeWeight	Stroke weight of line

virtual IPathStroker* IStrokeEditorPanelData::GetPathStroker ( ) const

pure virtual

Accessor method. Retrieves path stroker this panel was initialized with, or nil.

Returns

The panel's path stroker

virtual void IStrokeEditorPanelData::Initialize ( IPathStroker const *  stroker, bool16 &  wasApplicable  )

pure virtual

Initialization routine. The stroke editor dialog will call this while it is initializing. The stroker parameter should be used to initialize the panel's internal state.

Note: It is legal for the stroke editor to pass a path stroker that is either nil or else of a different type than that handled by the panel. Well-written implementations should handle these cases gracefully by falling back on the default case.

Parameters

stroker	The stroker being edited by the dialog
wasApplicable	OUT Set to kTrue if stroker is associated with this panel, else kFalse

virtual bool16 IStrokeEditorPanelData::UpdatePathStroker ( IPathStroker *  stroker ) const

pure virtual

Updates a path stroker to current panel settings.

Parameters

stroker

The stroker to update

Returns

kTrue if successful, else kFalse