All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Interface CATIAfrPaletteOptions

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

Usage: you can freely reimplement this interface.


interface CATIAfrPaletteOptions

Interface for workbenches to dynamically fill the Tools Palette.
Role: The Tools Palette is a special toolbar which updates dynamically when:

To be exact, a workbench may implement CATIAfrPaletteOptions interface using the WORKBENCHId_Palette late type where WORKBENCHId is the identifier of the workbench. This identifier is the third argument of the NewAccess macro used in the CATIWorkbench.CreateWorkbench method to define the contents of the workbench.
NewAccess(CATCmdWorkbench,pWORKBENCHId,WORKBENCHId);
The Tools Palette contains options.
An option is a CATCommandHeader instance which may start a simple command ( CATCommand ) ; avoid dialog ( CATDlgDialog ) or state commands (CATStateCommand). Often a check header, encapsulated by the CATAfrCheckHeaderAccessor class, is sufficient.
The GetPaletteOptions enables you to specify the options available when the workbench is the current one.

About the CATCommandHeader instance usage
You may create the header instances at any time before the GetPaletteOptions method is called or even inside this method. You have only one rule to respect, a command header instance must be created only once during the CATFrmEditor life. The CATAfrGetCommandHeader global fuction can be used to retrieve a command header instance from its identifier, or to check its existence before its creation.


Method Index


o GetPaletteOptions()
Gets the options to display when entering the workbench.

Methods


o GetPaletteOptions
public virtual CATLISTP(CATCommandHeader) GetPaletteOptions()= 0
Gets the options to display when entering the workbench.
Returns:
List of options.
The returned options are added to the Palette when the workbench is started and they are automatically removed when leaving the workbench.

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

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