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

#include <parameter.h>

Inherits ParameterClass.

Inherited by FilenameParameterClass.

Public Member Functions

 StringParameterClass (StringClass *string)
 
 StringParameterClass (const StringParameterClass &src)
 
virtual ~StringParameterClass (void)
 
const StringParameterClass & operator= (const StringParameterClass &src)
 
bool operator== (const StringParameterClass &src)
 
bool operator== (const ParameterClass &src)
 
virtual Type Get_Type (void) const
 
virtual bool Is_Type (Type type) const
 
virtual const char * Get_String (void) const
 
virtual void Set_String (const char *string)
 
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 Attributes

StringClass * m_String
 

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 260 of file parameter.h.

Constructor & Destructor Documentation

◆ StringParameterClass() [1/2]

StringParameterClass::StringParameterClass ( StringClass * string)

Definition at line 202 of file parameter.cpp.

◆ StringParameterClass() [2/2]

StringParameterClass::StringParameterClass ( const StringParameterClass & src)

Definition at line 213 of file parameter.cpp.

◆ ~StringParameterClass()

virtual StringParameterClass::~StringParameterClass ( void )
inlinevirtual

Definition at line 269 of file parameter.h.

Member Function Documentation

◆ Copy_Value()

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

Reimplemented from ParameterClass.

Reimplemented in FilenameParameterClass, and TextureFilenameParameterClass.

Definition at line 278 of file parameter.cpp.

◆ Get_String()

const char * StringParameterClass::Get_String ( void ) const
virtual

Definition at line 295 of file parameter.cpp.

◆ Get_Type()

virtual Type StringParameterClass::Get_Type ( void ) const
inlinevirtual

Implements ParameterClass.

Reimplemented in FilenameParameterClass, SoundFilenameParameterClass, and TextureFilenameParameterClass.

Definition at line 283 of file parameter.h.

◆ Is_Type()

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

Reimplemented from ParameterClass.

Reimplemented in FilenameParameterClass, SoundFilenameParameterClass, and TextureFilenameParameterClass.

Definition at line 284 of file parameter.h.

◆ operator=()

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

Definition at line 227 of file parameter.cpp.

◆ operator==() [1/2]

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

Implements ParameterClass.

Definition at line 260 of file parameter.cpp.

◆ operator==() [2/2]

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

Definition at line 241 of file parameter.cpp.

◆ Set_String()

void StringParameterClass::Set_String ( const char * string)
virtual

Definition at line 311 of file parameter.cpp.

Member Data Documentation

◆ m_String

StringClass* StringParameterClass::m_String
protected

Definition at line 298 of file parameter.h.

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