All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Interface CATIAfrCommandHeaderRep

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---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 CATAfrDialogCommandHeader , 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: in other words, each time the command header instance is associated with a starter.

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 CATAfrCommandHeaderRep, 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 HRESULT CreateCtxMenuRep( const CATDialog* iParent,
CATAfrCommandHeaderRep** oHdrRep) = 0
Creates a representation to be displayed in a contextual menu.
Role:This method creates and returns an instance of a class deriving from CATAfrCommandHeaderRep 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 HRESULT CreateMenuRep( const CATDialog* iParent,
CATAfrCommandHeaderRep** oHdrRep) = 0
Creates a representation to be displayed in the menu bar.
Role:This method creates and returns an instance of a class deriving from CATAfrCommandHeaderRep 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 HRESULT CreateToolbarRep( const CATDialog* iParent,
CATAfrCommandHeaderRep** oHdrRep) = 0
Creates a representation to be displayed in a toolbar.
Role:This method creates and returns an instance of a class deriving from CATAfrCommandHeaderRep 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: CATApplicationFrame

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