AfrInterfaces Interface CATIWorkbench
Usage: you cannot implement this base interface directly. You must first derive it and then implement the derived interface.
interface CATIWorkbench
Interface to derive to create a workbench.
Role: The workbench is the object seen by the end user in place of the
workshop. As in workshops, tools are grouped in toolbars and menus.
These tools are commands which are handled by workshop and its workbenches by means of
command headers.
The workshop dedicated to this workbench features a specific workbench
interface which derives from CATIWorkbench.
Each workbench of this workshop is an implementation of this specific workbench interface.
To enable the instanciation of the workbench you must:
- Create a workbench factory interface which derives from .
- Implement this factory interface with the help of these two macros:
and
.
- See also:
-
Method Index
- o
CreateCommands()
- Instantiates the command headers.
- o
CreateWorkbench()
- Creates the workbench accesses.
- o
GetAddinInterface()
- Returns the name of the interface exposed by the workbench to create add-ins.
Methods
o CreateCommands
| public virtual CreateCommands( | ) |
-
Instantiates the command headers.
Role: Each command you want to make available in your workshop or
workbench must have a command header. The command header holds the necessary
information to load the command, such as the name of the
shared library in which the command's executable code is located, the name of the
command class, and the data to pass to the command's code when this command
becomes the current one. The command header has resources for each command to display
such as the command name shown to the end user, its ToolTip displayed in a balloon,
its help message, and its icon.
Each instance of header is deleted by CATIA.
o CreateWorkbench
| public virtual CreateWorkbench( | ) |
-
Creates the workbench accesses.
Role: Creates the containers for the workbench, the menubar, the menus, and the toolbars,
the starters for the commands, and arranges the commands in the menus and toolbars.
With the
macro you have explanations to create each component of the workbench and how to arrange it.
Warning:
The workbench's name must be the same as the class implementing this interface.
- Returns:
- The workbench's container .
o GetAddinInterface
| public virtual GetAddinInterface( | ) |
-
Returns the name of the interface exposed by the workbench to create add-ins.
Role: To enable client applications of your workbench to add their
own addins , you should provide an interface that the client application will implement.
This interface should derive from the
interface.
Warning: The name of this interface must be pppIxxxAddin, where
ppp is your application prefix (such as CAT for CATIA) and xxx is the name of your
workbench.
This object is included in the file: CATIWorkbench.h
If needed, your Imakefile.mk should include the module: CATAfrItf
Copyright © 1999-2014, Dassault Systèmes. All rights reserved.