Richard Boegli's CnC_Generals_Zero_Hour Fork WIP
This is documentation of Richard Boegil's Zero Hour Fork
 
Loading...
Searching...
No Matches
Classes | Public Member Functions | Protected Types | Protected Attributes | List of all members
EnumParameterClass Class Reference

#include <parameter.h>

Inherits ParameterClass.

Classes

struct  _ENUM_VALUE
 

Public Member Functions

 EnumParameterClass (int *value)
 
 EnumParameterClass (const EnumParameterClass &src)
 
virtual ~EnumParameterClass (void)
 
const EnumParameterClass & operator= (const EnumParameterClass &src)
 
bool operator== (const EnumParameterClass &src)
 
bool operator== (const ParameterClass &src)
 
virtual Type Get_Type (void) const
 
virtual bool Is_Type (Type type) const
 
virtual void __cdecl Add_Values (const char *first_name, int first_value,...)
 
virtual void Add_Value (const char *display_name, int value)
 
virtual int Get_Count (void) const
 
virtual const char * Get_Entry_Name (int index) const
 
virtual int Get_Entry_Value (int index) const
 
virtual void Set_Selected_Value (int value)
 
virtual int Get_Selected_Value (void) const
 
virtual void Copy_Value (const ParameterClass &src)
 
- Public Member Functions inherited from ParameterClass
 ParameterClass (void)
 
 ParameterClass (const ParameterClass &src)
 
virtual ~ParameterClass (void)
 
const ParameterClass & operator= (const ParameterClass &src)
 
virtual DefParameterClass * As_DefParameterClass (void)
 
virtual bool Is_Modifed (void) const
 
virtual void Set_Modified (bool onoff=true)
 
virtual const char * Get_Name (void) const
 
virtual void Set_Name (const char *new_name)
 
virtual const char * Get_Units_Name (void) const
 
virtual void Set_Units_Name (const char *units_name)
 

Protected Types

typedef struct EnumParameterClass::_ENUM_VALUE ENUM_VALUE
 

Protected Attributes

DynamicVectorClass< ENUM_VALUE > m_List
 
int * m_Value
 

Additional Inherited Members

- Public Types inherited from ParameterClass
enum  Type {
  TYPE_INT = 0 , TYPE_FLOAT , TYPE_STRING , TYPE_VECTOR3 ,
  TYPE_MATRIX3D , TYPE_BOOL , TYPE_TRANSITION , TYPE_MODELDEFINITIONID ,
  TYPE_FILENAME , TYPE_ENUM , TYPE_GAMEOBJDEFINITIONID , TYPE_SCRIPT ,
  TYPE_SOUND_FILENAME , TYPE_ANGLE , TYPE_WEAPONOBJDEFINITIONID , TYPE_AMMOOBJDEFINITIONID ,
  TYPE_SOUNDDEFINITIONID , TYPE_COLOR , TYPE_PHYSDEFINITIONID , TYPE_EXPLOSIONDEFINITIONID ,
  TYPE_DEFINITIONIDLIST , TYPE_ZONE , TYPE_FILENAMELIST , TYPE_SEPARATOR ,
  TYPE_GENERICDEFINITIONID , TYPE_SCRIPTLIST , TYPE_VECTOR2 , TYPE_RECT ,
  TYPE_TEXTURE_FILENAME , TYPE_STRINGSDB_ID
}
 
- Static Public Member Functions inherited from ParameterClass
static ParameterClass * Construct (ParameterClass::Type type, void *data, const char *param_name)
 

Detailed Description

Definition at line 429 of file parameter.h.

Member Typedef Documentation

◆ ENUM_VALUE

typedef struct EnumParameterClass::_ENUM_VALUE EnumParameterClass::ENUM_VALUE
protected

Constructor & Destructor Documentation

◆ EnumParameterClass() [1/2]

EnumParameterClass::EnumParameterClass ( int * value)

Definition at line 526 of file parameter.cpp.

◆ EnumParameterClass() [2/2]

EnumParameterClass::EnumParameterClass ( const EnumParameterClass & src)

Definition at line 538 of file parameter.cpp.

◆ ~EnumParameterClass()

virtual EnumParameterClass::~EnumParameterClass ( void )
inlinevirtual

Definition at line 438 of file parameter.h.

Member Function Documentation

◆ Add_Value()

void EnumParameterClass::Add_Value ( const char * display_name,
int value )
virtual

Definition at line 624 of file parameter.cpp.

◆ Add_Values()

void __cdecl EnumParameterClass::Add_Values ( const char * first_name,
int first_value,
... )
virtual

Definition at line 637 of file parameter.cpp.

◆ Copy_Value()

void EnumParameterClass::Copy_Value ( const ParameterClass & src)
virtual

Reimplemented from ParameterClass.

Definition at line 607 of file parameter.cpp.

◆ Get_Count()

virtual int EnumParameterClass::Get_Count ( void ) const
inlinevirtual

Definition at line 458 of file parameter.h.

◆ Get_Entry_Name()

virtual const char * EnumParameterClass::Get_Entry_Name ( int index) const
inlinevirtual

Definition at line 459 of file parameter.h.

◆ Get_Entry_Value()

virtual int EnumParameterClass::Get_Entry_Value ( int index) const
inlinevirtual

Definition at line 460 of file parameter.h.

◆ Get_Selected_Value()

virtual int EnumParameterClass::Get_Selected_Value ( void ) const
inlinevirtual

Definition at line 463 of file parameter.h.

◆ Get_Type()

virtual Type EnumParameterClass::Get_Type ( void ) const
inlinevirtual

Implements ParameterClass.

Definition at line 452 of file parameter.h.

◆ Is_Type()

virtual bool EnumParameterClass::Is_Type ( Type type) const
inlinevirtual

Reimplemented from ParameterClass.

Definition at line 453 of file parameter.h.

◆ operator=()

const EnumParameterClass & EnumParameterClass::operator= ( const EnumParameterClass & src)

Definition at line 552 of file parameter.cpp.

◆ operator==() [1/2]

bool EnumParameterClass::operator== ( const EnumParameterClass & src)

Definition at line 569 of file parameter.cpp.

◆ operator==() [2/2]

bool EnumParameterClass::operator== ( const ParameterClass & src)
virtual

Implements ParameterClass.

Definition at line 589 of file parameter.cpp.

◆ Set_Selected_Value()

virtual void EnumParameterClass::Set_Selected_Value ( int value)
inlinevirtual

Definition at line 462 of file parameter.h.

Member Data Documentation

◆ m_List

DynamicVectorClass<ENUM_VALUE> EnumParameterClass::m_List
protected

Definition at line 486 of file parameter.h.

◆ m_Value

int* EnumParameterClass::m_Value
protected

Definition at line 487 of file parameter.h.

The documentation for this class was generated from the following files: