Class: TStandardCanvasView

Declaration: StandardGrafEdit.h

Taxonomy Categories:

Member Functions:

Interface Category:

API.

Inherits From:

TCanvasView

Inherited By:

None.

Purpose:

A TCanvasView derived class that assumes storage in a TStandardCanvasModel, current selection management in a TStandardCanvasPresenterState, and command execution in a document.

Instantiation:

Allocate on the heap or the stack.

Deriving Classes:

Intended to be derived but can also be used as is.

Concurrency:

Not multithread safe.

Resource Use:

No special requirements.

Member Function: TStandardCanvasView::Hash

virtual long Hash () const

Interface Category:

API.

Purpose:

Returns a unique value that can assist in identifying the object or comparing it to other objects.

Calling Context:

Called to generate a hash value.

Parameters:

Takes no parameters.

Return Value:

long -The hash value.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::AdoptAndDo

virtual void AdoptAndDo (TToolCommandBinding *)

Interface Category:

API.

Purpose:

Supports the execution of commands produced by cursor tools.

Calling Context:

Called by the Cursor Tools framework.

Parameters:

TToolCommandBinding * -The binding to adopt and do.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Wraps the binding in a TDocumentComponentToolCommandBinding and passes it to the corresponding compound document function.

Member Function: TStandardCanvasView::DoBegin

virtual void DoBegin (TToolCommandBinding &)

Interface Category:

API.

Purpose:

Supports the execution of commands produced by cursor tools.

Calling Context:

Called by the Cursor Tools framework.

Parameters:

TToolCommandBinding & -The binding to do begin.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Wraps the binding in a TDocumentComponentToolCommandBinding and passes it to the corresponding compound document function.

Member Function: TStandardCanvasView::DoIncrement

virtual void DoIncrement (TToolCommandBinding &)

Interface Category:

API.

Purpose:

Supports the execution of commands produced by cursor tools.

Calling Context:

Called by the Cursor Tools framework.

Parameters:

TToolCommandBinding & -The binding to do increment.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Wraps the binding in a TDocumentComponentToolCommandBinding and passes it to the corresponding compound document function.

Member Function: TStandardCanvasView::AdoptAndDoEnd

virtual void AdoptAndDoEnd (TToolCommandBinding *)

Interface Category:

API.

Purpose:

Supports the execution of commands produced by cursor tools.

Calling Context:

Called by the Cursor Tools framework.

Parameters:

TToolCommandBinding * -The binding to adopt and do end.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Wraps the binding in a TDocumentComponentToolCommandBinding and passes it to the corresponding compound document function.

Member Function: TStandardCanvasView::EnumerateGraphics

virtual void EnumerateGraphics (TCanvasGraphicFilter &, TCanvasGraphicFunnel &) const

Interface Category:

API.

Purpose:

Passively iterates over graphics in the underlying standard canvas model. The filter controls which graphics are enumerated and in which order. The funnel defines how each enumerated graphic is processed.

Calling Context:

Called by various canvas view and interactor functions.

Parameters:

TCanvasGraphicFilter & -The filter.
TCanvasGraphicFunnel & -The funnel.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::CreateEmptySelection

virtual MCanvasSelection * CreateEmptySelection () const

Interface Category:

API.

Purpose:

Creates a new empty selection of the appropriate type for the corresponding application that the view represents.

Calling Context:

Called by various canvas view and interactor functions.

Parameters:

Takes no parameters.

Return Value:

MCanvasSelection * -An empty MCanvasSelection derived class.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Delegates to the model to create the selection.

Member Function: TStandardCanvasView::CopyCurrentSelection

virtual MCanvasSelection * CopyCurrentSelection () const

Interface Category:

API.

Purpose:

Returns a copy of the current selection.

Calling Context:

Called by various canvas view and interactor functions.

Parameters:

Takes no parameters.

Return Value:

MCanvasSelection * -An MCanvasSelection derived class.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Delegates to the presenter state to copy the current selection.

Member Function: TStandardCanvasView::SetCurrentSelection

virtual void SetCurrentSelection (const MCanvasSelection &)

Interface Category:

API.

Purpose:

Sets the current selection that is displayed to the user in the view.

Calling Context:

Called by various canvas view and interactor functions.

Parameters:

const MCanvasSelection & -The selection to set.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Delegates to the presenter state to set the current selection.

Member Function: TStandardCanvasView::AdoptCurrentSelection

virtual void AdoptCurrentSelection (MCanvasSelection *)

Interface Category:

API.

Purpose:

Adopts a selection as the current selection that is displayed to the user in the view.

Calling Context:

Called by various canvas view and interactor functions.

Parameters:

MCanvasSelection * -The selection to adopt.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Delegates to the presenter state to adopt the current selection.

Member Function: TStandardCanvasView::LookupCanvasModelForReading

const TStandardCanvasModel * LookupCanvasModelForReading ( TDocumentComponentReadEntry &) const

Interface Category:

API.

Purpose:

Produces a const pointer to the model given document component read entry.

Calling Context:

Call this function directly.

Parameters:

TDocumentComponentReadEntry & -A document component read entry.

Return Value:

A pointer to the model.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::HandleGraphicsChanged

virtual void HandleGraphicsChanged (const TNotification &)

Interface Category:

API.

Purpose:

Handles the notification of the event of graphics in the underlying model changing.

Calling Context:

Response to notification.

Parameters:

const TNotification & -The notification.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::HandleSelectionChanged

virtual void HandleSelectionChanged (const TNotification &)

Interface Category:

API.

Purpose:

Handles the notification of the event of the current selection changing.

Calling Context:

Response to notification.

Parameters:

const TNotification & -The notification.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::HandleDrasticChange

virtual void HandleDrasticChange (const TNotification &)

Interface Category:

API.

Purpose:

Handles the notification of an event that requires refreshing the entire view.

Calling Context:

Response to notification.

Parameters:

const TNotification & -The notification.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::GetPresenterStateReference

TPresenterStateReference GetPresenterStateReference () const

Interface Category:

API.

Purpose:

Returns a reference to the presenter state.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

TPresenterStateReference -A reference to the presenter state.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::GetModelReference

TModelReference GetModelReference () const

Interface Category:

API.

Purpose:

Returns a reference to the model.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

TModelReference -A reference to the model.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::RegisterNotificationInterest

virtual void RegisterNotificationInterest ( TRequestBasedMemberFunctionConnectionTo < TCanvasView > &)

Interface Category:

API.

Purpose:

Registers interest in the notification of graphics changing and the current selection changing.

Calling Context:

Called by the Graphics Editing framework.

Parameters:

TRequestBasedMemberFunctionConnectionTo < TCanvasView > & -The connection for adding interest.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

Override to register for additional notification interest, but also call the base class implementation.

Member Function: TStandardCanvasView::operator<<=

virtual TStream & operator <<= (TStream &)

Interface Category:

API.

Purpose:

Stream-in operator.

Calling Context:

Called to stream in data.

Parameters:

TStream & -The stream the object is streamed in from.

Return Value:

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

Exceptions:

Throws a TStandardException(kStreamBadVersion,0) when streaming in a version other than kOriginalVersion. Passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::operator>>=

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

Interface Category:

API.

Purpose:

Stream-out operator.

Calling Context:

Called to stream out data.

Parameters:

TStream & -The stream the object is streamed out to.

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: TStandardCanvasView::operator=

TStandardCanvasView & operator =(const TStandardCanvasView &)

Interface Category:

API.

Purpose:

Assignment operator.

Calling Context:

Called when an object is assigned to another compatible object.

Parameters:

const TStandardCanvasView & -The object to be copied.

Return Value:

A non-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: TStandardCanvasView::~TStandardCanvasView

virtual ~ TStandardCanvasView ()

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: TStandardCanvasView::TStandardCanvasView

TStandardCanvasView (TGUIBundle * theBundleToAlias)
TStandardCanvasView (const TStandardCanvasView &)
TStandardCanvasView ()

Interface Category:

API.

Purpose:

Constructor.
Copy constructor.
Default constructor.

Calling Context:

Called to create a new object.
Called to copy an object.
Called by the stream-in operators.

Parameters:

TGUIBundle * theBundleToAlias -The GUI bundle to use for initialization of the new object.
const TStandardCanvasView & -Another standard canvas view.
Takes no parameters.

Return Value:

None.

Exceptions:

Throws no exceptions, passes all exceptions through.

Concurrency:

Not multithread safe.

Other Considerations:

None.

Member Function: TStandardCanvasView::GetGUIBundle

TGUIBundle * GetGUIBundle () const

Interface Category:

API.

Purpose:

Allows access to the current GUI bundle for this canvas view.

Calling Context:

Call this function directly.

Parameters:

Takes no parameters.

Return Value:

Returns a pointer to this canvas's GUI bundle.

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.