All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Interface CATIWorkshop

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---CATIWorkshop
 

Usage: you can freely reimplement this interface.


interface CATIWorkshop

Interface to create a workshop.
Role: The workshop is the object that gathers the tools to work on the document. It may contain different workbenches. Tools are grouped in toolbars and menus. These tools are commands which are handled by workshop and its workbenches by means of command headers. To be able to request its workshop, the document must contain an object which implements the CATIUIActivate interface.

To enable the instanciation of the workshop you must:

See also:
CATIWorkbench, CATIWorkbenchAddin


Method Index


o CreateCommands()
Instantiates the command headers.
o CreateWorkshop()
Creates the workshop accesses.
o GetAddinInterface()
Returns the name of the interface exposed by the workshop to create add-ins.
o GetWorkbenchInterface()
Returns the name of the interface exposed by the workshop to create workbenches.

Methods


o CreateCommands
public virtual void CreateCommands()= 0
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.
See also:
CATCommandHeader
o CreateWorkshop
public virtual CATCmdWorkshop * CreateWorkshop()= 0
Creates the workshop accesses.
Role: Creates the containers for the workshop, the menubar, the menus, and the toolbars, the starters for the commands, and arranges the commands in the menus and toolbars. With the NewAccess macro you have explanations to create each component of the workshop and how to arrange it.
Warning: The workshop's name must be the same as the class implementing this interface.
Returns:
The workshop's container .
o GetAddinInterface
public virtual CATClassId GetAddinInterface()= 0
Returns the name of the interface exposed by the workshop to create add-ins.
Role: To enable client applications of your workshop to add their own addins , you should provide an interface that the client application will implement. This interface should derive from the CATIWorkbenchAddin 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 workshop.
o GetWorkbenchInterface
public virtual CATClassId GetWorkbenchInterface()= 0
Returns the name of the interface exposed by the workshop to create workbenches.
Role: To enable client applications of your workshop to add their own workbenches, you should provide an interface that the client application will implement. This interface should derive from the CATIWorkbench interface. Each implementation of this interface is a workbench of this workshop.
Warning: The name of this interface must be CATIxxxConfiguration, where xxx is the name of your workshop.

This object is included in the file: CATIWorkshop.h
If needed, your Imakefile.mk should include the module: CATApplicationFrame

Copyright © 2003, Dassault Systèmes. All rights reserved.