All Frameworks Class Hierarchy This Framework Indexes Previous Next

AfrInterfaces Interface CATIAfrCommandHeaderRep

Usage: you can freely reimplement this interface.

interface CATIAfrCommandHeaderRep

Interface to customize the representations of a command header.
RoleThis interface, implemented on a class deriving from , enables you to provide for your command header a customized representation into the toolbar, and/or the menubar, and/or the contextual menu .
This interface is called by the "frame" when a representation of the command header is necessary during a workshop change ( and only during workshop change ) : in other words, each time the command header instance is associated with a starter during workshop change.

You can in a workshop, associated with more one starter a command header instance,
The end user can Drag/Drop a command header instance into a toolbar thanks the Tools/Customize command.
If two documents are opened, there are two representations of the same command header instance

Depending on the type of container of the starter, one of the three methods of this interface is called. Each method creates an instance of a class deriving from , or either returns E_FAIL if no representation.

Method Index

o CreateCtxMenuRep(CATDialog*,CATAfrCommandHeaderRep**): Creates a representation to be displayed in a contextual menu.
o CreateMenuRep(CATDialog*,CATAfrCommandHeaderRep**): Creates a representation to be displayed in the menu bar.
o CreateToolbarRep(CATDialog*,CATAfrCommandHeaderRep**): Creates a representation to be displayed in a toolbar.

Methods

o CreateCtxMenuRep

public virtual CreateCtxMenuRep(	const	`iParent`,
		`oHdrRep`)

Creates a representation to be displayed in a contextual menu.
Role:This method creates and returns an instance of a class deriving from which will be the representation of the command header in a toolbar. This representation manages one or several Dialog derived objects. The representation will be automatically released .

Parameters:

iParent: The parent for the CATDialog derived objects to create
oHdrRep: The representation to be displayed in a contextual menu.

Returns:

S_OK : oHdrRep is created otherwise E_FAIL

o CreateMenuRep

public virtual CreateMenuRep(	const	`iParent`,
		`oHdrRep`)

Creates a representation to be displayed in the menu bar.
Role:This method creates and returns an instance of a class deriving from which will be the representation of the command header in a toolbar. This representation manages one or several Dialog derived objects. The representation will be automatically released .

Parameters:

iParent: The parent for the CATDialog derived objects to create
oHdrRep: The representation to be displayed in the menu bar.

Returns:

S_OK : oHdrRep is created otherwise E_FAIL

o CreateToolbarRep

public virtual CreateToolbarRep(	const	`iParent`,
		`oHdrRep`)

Creates a representation to be displayed in a toolbar.
Role:This method creates and returns an instance of a class deriving from which will be the representation of the command header in a toolbar. This representation manages one or several Dialog derived objects. The representation will be automatically released .

Parameters:

iParent: The parent for the CATDialog derived objects to create
oHdrRep: The representation to be displayed in a toolbar.

Returns:

S_OK : oHdrRep is created otherwise E_FAIL

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