All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

ApplicationFrame Class CATStackableCommandSet

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

Usage: you must use this class as is. You should never derive it.


public class CATStackableCommandSet

Class to store a list of command header instance name.


Constructor and Destructor Index


o CATStackableCommandSet()
Constructs a default list of command header name.
o CATStackableCommandSet(CATStackableCommandSet*)
Constructs a list of command header name from an other one.
o ~CATStackableCommandSet()

Method Index


o AddCommand(CATString&)
Adds a name to the list.
o AddCommand(char*)
Adds a name to the list.
o AddSet(CATStackableCommandSet&)
Adds a set of command header name.
o Contains(CATString&,unsigned long*)
Checks if a name exists in the list.
o GetSize()
Returns the count of name in the list.
o RemoveCommand(CATString&)
Removes a name from the list.
o RemoveCommand(char*)
Removes a name from the list.

Constructor and Destructor


o CATStackableCommandSet
public CATStackableCommandSet()
Constructs a default list of command header name.
Role:This method constructs a list with some command header names.
o CATStackableCommandSet
public CATStackableCommandSet(CATStackableCommandSet* iFrom)
Constructs a list of command header name from an other one.
Role: This method duplicates a list of command header name.
Parameters:
iFrom
The list to duplicate
o ~CATStackableCommandSet
public virtual ~CATStackableCommandSet()

Methods


o AddCommand
public CATBoolean AddCommand( const CATString& iCommandHdrName)
Adds a name to the list.
Parameters:
iCommandHdrName
The name of the command header to add.
Returns:
If TRUE the name has been added in the list, otherwise FALSE
o AddCommand
public CATBoolean AddCommand( const char* iCommandHdrName)
Adds a name to the list.
Parameters:
iCommandHdrName
The name of the command header to add.
Returns:
If TRUE the name has been added in the list, FALSE otherwise.
o AddSet
public CATBoolean AddSet(CATStackableCommandSet& iSet)
Adds a set of command header name.
Role: Each name of the input set is added to the list thanks to the AddCommand method. It means that there is no duplicate element in the resulting list.
Parameters:
iSet
The list to merge.
Returns:
always TRUE
o Contains
public CATBoolean Contains( const CATString& iCommandHdrName,
unsigned long* oPos= 0)
Checks if a name exists in the list.
Parameters:
iCommandHdrName
The name of the command header to find out.
oPos
The position of iCommandHdrName in the list. The range of the value is between 0 and
GetSize -1 if the returned value is TRUE, otherwise the value is not significant.
Returns:
If TRUE the name has been found in the list, FALSE otherwise.
o GetSize
public unsigned long GetSize()const
Returns the count of name in the list.
Returns:
The size of the list.
o RemoveCommand
public CATBoolean RemoveCommand( const CATString& iCommandHdrName)
Removes a name from the list.
Parameters:
iCommandHdrName
The name of the command header to remove.
Returns:
If TRUE the name has been removed from the list, FALSE otherwise.
o RemoveCommand
public CATBoolean RemoveCommand( const char* iCommandHdrName)
Removes a name from the list.
Parameters:
iCommandHdrName
The name of the command header to remove.
Returns:
If TRUE the name has been removed from the list, FALSE otherwise.

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

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