AfrInterfaces Interface CATIWorkbenchAddin

Usage: you cannot implement this base interface directly. You must first derive it and then implement the derived interface.


interface CATIWorkbenchAddin

Interface to derive to create an addin.
Role: Existing workshops or workbenches can be customized by the client application programmer. This customization consists in putting commands into one or several new toolbars, and add these toolbars to the appropriate workshop or workbench. Note that an add-in cannot customize the menu bar.
The workshop or the workbench should feature an add-in interface that you will implement to provide the toolbars using a class extending a late type. This add-in interface derives from the CATIWorkbenchAddin interface and it's valid for workshops as well as workbenches.

See also:
CATIWorkbench


Method Index


o CreateCommands()
Instantiates the command headers.
o CreateToolbars()
Creates toolbars containers.

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 CreateToolbars
public virtual CATCmdContainer * CreateToolbars()= 0
Creates toolbars containers.
Role: Creates toolbars's container with the NewAccess macro, and arranges commands in the toolbars. Toolbars are chained together.
Returns:
The first toolbar of the chain.

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

Copyright © 1999-2014, Dassault Systèmes. All rights reserved.