All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Class CATAfrDialogCommandHeader

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---System.CATEventSubscriber
        |
        +---ApplicationFrame.CATCommandHeader
          |
          +---CATAfrDialogCommandHeader
 

Usage: you can derive this class.


public class CATAfrDialogCommandHeader

Base class to create a command header with a customized representation.
Role: This class enables you to create a command header with a customized representation. It means a representation which will be not the default one: a push button in a toolbar, and a push item in the menu bar or a contextual menu.

To do that, you should implement the CATIAfrCommandHeaderRep interface on the class deriving of CATAfrDialogCommandHeader. This interface enables you to provide your specific representation in the toolbar, or/and the menubar, or/and the contextual menu. This representation is an instance of a class deriving of the CATAfrCommandHeaderRep class.


The CATCommand class describes how to create a customized command header.


Constructor and Destructor Index


o CATAfrDialogCommandHeader(CATCommandHeader*)
Constructs a command header instance.
o CATAfrDialogCommandHeader(CATString&,int)
Constructs a command header instance.
o ~CATAfrDialogCommandHeader()

Method Index


o Clone()
Clones the command header.

Constructor and Destructor


o CATAfrDialogCommandHeader
protected CATAfrDialogCommandHeader(CATCommandHeader* iHeaderToCopy)
Constructs a command header instance. Role:This method calls the CATCommandHeader copy constructor. In your derived class overwrite this method such that:
 MyHeader::MyHeader(CATCommandHeader * iHeaderToCopy):
                           CATAfrDialogCommandHeader(iHeaderToCopy)
 {
 }   
 
This method is called by the Clone method.
Parameters:
iHeaderToCopy
The header to copy.
o CATAfrDialogCommandHeader
protected CATAfrDialogCommandHeader( const CATString& iHeaderIdentificator,
int iState= CATFrmAvailable)
Constructs a command header instance.
Parameters:
iHeaderIdentificator
The identificator of the command header class instance. It is the command argument of the SetAccessCommand macro. It is used for NLS resources.
iState
The command header state.
Legal values:
  • CATFrmAvailable (The default value)
  • CATFrmUnavailable
  • o ~CATAfrDialogCommandHeader
    public virtual ~CATAfrDialogCommandHeader()

    Methods


    o Clone
    public CATCommandHeader * Clone()
    Clones the command header. Role:This method calls the constructor with a CATCommandHeader pointer as argument. In your derived class overwrite this method such that:
     CATCommandHeader * MyHeader::Clone ()                                  
     { 
       return new MyHeader(this); 
     }   
     
    You must never call a Clone method. This method is called by the "frame". Today, it is called for your CAA instances in only one case: when the command header instance is created in an Add-in of the General workshop, refer to the CATIAfrGeneralWksAddin interface for more details about these Add-ins.
    Returns:
    The new command header instance.

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

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