Class: TFrameCreationToolFor

Declaration: FrameTools.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TSimpleMouseTool

Inherited By:

None.

Purpose:

TFrameCreationToolFor is a template class used to create embedded frames for specific model and presenter state classes. This class also provides for the graphic to be shown in the tool palette, and creates an interactor appropriate for dragging out an embedded frame of a certain type.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Don't derive from this class.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TFrameCreationToolFor::TFrameCreationToolFor

TFrameCreationToolFor ()
TFrameCreationToolFor (MGraphic * adoptedPaletteGraphic)
TFrameCreationToolFor (const TFrameCreationToolFor < AModel, APresenterState >&)

Interface Category:

API.

Purpose:

Default constructor.
Creates a new TFrameCreationToolFor whose graphic in the tool palette is the one specified.
Creates a new TFrameCreationToolFor the specified model and presenter state.

Calling Context:

Called by the stream-in operators.
You can call this function directly.
You can call this function directly.

Parameters:

Takes no parameters.
MGraphic * adoptedPaletteGraphic -The palette graphic to adopt.
const TFrameCreationToolFor < AModel -The model for the new tool object.
APresenterState >& -The presenter state for the new tool object.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameCreationToolFor::~TFrameCreationToolFor

virtual ~ TFrameCreationToolFor ()

Interface Category:

API.

Purpose:

Destructor.

Calling Context:

Called to destroy an object.

Parameters:

Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameCreationToolFor::operator=

TFrameCreationToolFor < AModel , APresenterState >& operator =(const TFrameCreationToolFor < AModel, APresenterState >&)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Call this function by using the operator in an assignment statement.

Parameters:

const TFrameCreationToolFor < AModel APresenterState >& -The object to copy.

Return Value:

Returns a const reference to the left-hand side object.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameCreationToolFor::operator>>=

virtual TStream & operator >>=(TStream &) const

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream to which the object streams itself out.

Return Value:

Returns a reference to the stream the object streams itself out to.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameCreationToolFor::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream from which the object streams itself in.

Return Value:

Returns a reference to the stream the object streams itself in from.

Exceptions:

Throws a TInvalidVersionError if the version of the object on the stream is unknown to the version of the shared library installed.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameCreationToolFor::GetTargetType

virtual TTypeDescription GetTargetType () const

Interface Category:

API.

Purpose:

Returns the target type this creation tool will operator on. The type is MToolSupporter.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Type of tool target.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameCreationToolFor::GetPaletteText

virtual void GetPaletteText (TText &) const

Interface Category:

API.

Purpose:

Returns the text displayed by the tool palette.

Calling Context:

You can call this function directly.

Parameters:

TText & -The text as returned by this function.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameCreationToolFor::CreatePaletteGraphic

virtual MGraphic * CreatePaletteGraphic () const

Interface Category:

API.

Purpose:

Creates a palette graphic appropriate for the embedded frame created by this tool.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the newly created palette graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TFrameCreationToolFor::CreateCursorGraphic

virtual MGraphic * CreateCursorGraphic () const

Interface Category:

API.

Purpose:

Creates a graphic to be used when the user is dragging out an embedded frame of this type.

Calling Context:

You can call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns the newly created cursor graphic.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This member function can be overridden by a derived class in order to change the cursor graphic.

Member Function: TFrameCreationToolFor::MouseDown

virtual bool MouseDown (TMouseDownEvent &)

Interface Category:

API.

Purpose:

Processes a mouse-down event that occurs after the user selects this tool in the tool palette and clicks down in the destination view to begin dragging out an embedded frame.

Calling Context:

Called by the Input Framework.

Parameters:

TMouseDownEvent & -The mouse-down event.

Return Value:

Returns true if this function processed the mouse-down event, or false if the event should be passed on to the next view.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

This member function can be overridden if a derived class of TFrameEmbedderDragInteractor is used.

Member Function: TFrameCreationToolFor::CreateInteractor

virtual TToolInteractor * CreateInteractor (MToolTarget *) const

Interface Category:

API.

Purpose:

Creates an interactor appropriate for dragging out an embedded frame of the appropriate type.

Calling Context:

Called from MouseDown.

Parameters:

MToolTarget * -The object on which the interactor will interact.

Return Value:

Returns the newly created interactor.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Click the icon to mail questions or corrections about this material to Taligent personnel.