Taxonomy Categories:
Member Functions:
Interface Category:
API.
Inherits From:
MToolHandler
Inherited By:
None.
Purpose:
MGUIToolHandler is an MToolHandler that is specialized to implement the command invocation member functions correctly in the context of a presentation framework document. It is mixin class.
Instantiation:
Allocate on the heap or the stack.
Deriving Classes:
None provided.
Concurrency:
Not multithread safe.
Resource Use:
No special requirements.
- MGUIToolHandler (const MGUIBundle * bundleAlias)
- MGUIToolHandler ()
Interface Category:
API.
Purpose:
- Creates a new GUI Tool Handler object with the specified GUI bundle.
- Default constructor.
Calling Context:
- You can call this function directly.
- Called by the stream-in operators.
Parameters:
- const MGUIBundle * bundleAlias -The GUI bundle for the new object.
- Takes no parameters.
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual ~ MGUIToolHandler ()
Interface Category:
API.
Purpose:
Destructor.
Calling Context:
Called to destroy an object.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void AdoptAndDo (TToolCommandBinding *)
Interface Category:
API.
Purpose:
Adopts a tool command binding and executes it. The binding contains a command and a target, which can be a model selection or a presenter state selection. Modify document data only using commands. The command is added to the document history if it modifies the document and is undoable. If it modifies the document and is not undoable, the document history is cleared.
Calling Context:
You can call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void DoBegin (TToolCommandBinding &)
Interface Category:
API.
Purpose:
Takes an incremental command and begins execution. The binding contains a command and target, which can be a model selection or a presenter state selection. Modify document data only using commands. The command is added to the document history if it modifies the document and is undoable. If it modifies the document and is not undoable, the document history is cleared.
Only one incremental command can be outstanding at any one time. If another command is started, the currently executing incremental command is automatically ended.
Calling Context:
You can call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws no exceptions, passes all exceptions through.
Concurrency:
Not multithread safe.
Other Considerations:
None.
virtual void DoIncrement (TToolCommandBinding &)
Interface Category:
API.
Purpose:
Takes an incremental command and continues execution. The command binding must be the same binding used in a previous DoBegin.
Calling Context:
You can call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws TCompoundDocumentException::kExpectedDoBegin if DoBegin was not previously called for this command.
Concurrency:
Not multithread safe.
Other Considerations:
Preconditions:
Assertion (DoBegin previously called for this command).
Member Function: MGUIToolHandler::AdoptAndDoEnd
virtual void AdoptAndDoEnd (TToolCommandBinding *)
Interface Category:
API.
Purpose:
Adopts an incremental command and ends execution. The command binding must be the same binding used in a previous DoBegin.
Calling Context:
You can call this function directly.
Parameters:
Return Value:
None.
Exceptions:
Throws TCompoundDocumentException::kExpectedDoBegin if DoBegin was not previously called for this command.
Concurrency:
Not multithread safe.
Other Considerations:
Preconditions:
Assertion (DoBegin previously called for this command).
Click the icon to mail questions or corrections about this material to Taligent personnel.
Copyright©1995 Taligent,Inc. All rights reserved.