All Frameworks Class Hierarchy This Framework Indexes Previous Next

AfrFoundation CATAfrCommandHeaderRep

Usage: you can derive this class.

public class CATAfrCommandHeaderRep

Base class to create a customized representation for a command header.
Role:This class is the base class to create a customized representation for a class. This customized command header must derive from the class, and must implement the interface. This interface contains three methods to overload the default representation of the command header into a toolbar, the menubar or a contextual menu. In most cases, only one method creates an instance of a class deriving from CATAfrCommandHeaderRep, and the two others create nothing.

The method is automatically called just after the instantiation of the class deriving from CATAfrCommandHeaderRep. This method generally creates dialog object, whose the dialog parent is the first argument of the constructor, and that you retrieve with the method.

It is strongly recommended to read User Interfaces articles about command header into the CAA Encyclopedia before to creating such classes. You will learn how to manage the multi-representation, and more generally how to "refresh" all the instances of the representations.

Constructor and Destructor Index

o CATAfrCommandHeaderRep(CATDialog*,CATString&): Constructs a customized representation for a command header.
o ~CATAfrCommandHeaderRep()

Method Index

o Build(): Creates the customized representation.
o GetDialogParent(CATDialog**): Retrieves the dialog parent.

Constructor and Destructor

o CATAfrCommandHeaderRep

public CATAfrCommandHeaderRep(	const	`iParent`,
		`iCommandName`)

Constructs a customized representation for a command header.

Parameters:

iParent: The Dialog parent of dialog objects created by the
iCommandName: The name of the command. It is the argument of the

o ~CATAfrCommandHeaderRep

public virtual ~CATAfrCommandHeaderRep(

)

Methods

o Build

public virtual Build(

)

Creates the customized representation.
Role:This method instantiates Dialog objects whose the dialog parent is the value returned by the method.

o GetDialogParent

public GetDialogParent( const ioParent)

Retrieves the dialog parent.