Public Member Functions | Static Public Attributes

FBPropertyBaseAnimatableEnum< tType > Class Template Reference

Search for all occurrences

Detailed Description

template<class tType>
class FBPropertyBaseAnimatableEnum< tType >

Base template class for enum properties.

Definition at line 1725 of file fbproperties.h.

#include <fbproperties.h>

Inheritance diagram for FBPropertyBaseAnimatableEnum< tType >:
Inheritance graph
[legend]

List of all members.

Public Member Functions

 FBPropertyBaseAnimatableEnum ()
 Constructor.
 ~FBPropertyBaseAnimatableEnum ()
 Destructor.
 FBPropertyBaseAnimatableEnum (const FBPropertyBaseAnimatableEnum< tType > &pValue)
 FBPropertyBaseAnimatableEnum.
 operator tType () const
 Overloaded cast to tType operator.
virtual const char * EnumList (int pIndex) override
 Return the string of an enum value.
virtual const char * AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI) override
 Get as string.
virtual bool SetString (const char *pString) override
 Set string as enum value.
void operator= (tType pValue)
 Overloaded = operator.

Static Public Attributes

static const char * mStrings []
 String list.

Constructor & Destructor Documentation

Constructor.

Definition at line 1734 of file fbproperties.h.

{}  

Destructor.

Definition at line 1737 of file fbproperties.h.

        {
        }  
FBPropertyBaseAnimatableEnum ( const FBPropertyBaseAnimatableEnum< tType > &  pValue) [inline]

FBPropertyBaseAnimatableEnum.

Parameters:
pValueFBPropertyBaseAnimatableEnum.

Definition at line 1744 of file fbproperties.h.

{ operator=((tType)pValue ); }

Member Function Documentation

void operator= ( tType  pValue) [inline]

Overloaded = operator.

Set the value of the current object using Set function.

Parameters:
pValueValue to set for object.

Definition at line 1751 of file fbproperties.h.

{ SetData( &pValue ); }
operator tType ( ) const [inline]

Overloaded cast to tType operator.

Get the value of the current object using Get fuction.

Returns:
tType cast of current object.

Definition at line 1758 of file fbproperties.h.

{ tType Value; GetData( &Value,sizeof(Value) ); return Value; } 
virtual const char* EnumList ( int  pIndex) [inline, override, virtual]

Return the string of an enum value.

Parameters:
pIndexEnum value to get string for.
Returns:
String value of enum specified by pIndex.

Reimplemented from FBProperty.

Definition at line 1760 of file fbproperties.h.

        {   
            if( IsInternal() )
            {
                return FBProperty::EnumList( pIndex );
            }
            else if(mStrings)
            {
                return mStrings[pIndex]; 
            }
            else
            {
                assert(mStrings || IsInternal());
                return NULL;
            }
        }
virtual const char* AsString ( FBDataAsStringFlag  pFlag = kFBDataAsStringUI) [inline, override, virtual]

Get as string.

Parameters:
pFlagSpecifies the purpose of returned string it defaults to kFBDataAsStringUI.
Returns:
Enum value as string.

Reimplemented from FBProperty.

Definition at line 1781 of file fbproperties.h.

{ return EnumList( AsInt() );}
virtual bool SetString ( const char *  pString) [inline, override, virtual]

Set string as enum value.

Parameters:
pStringString to set, with format same as AsString(kFBDataAsStringPersistence)
Returns:
True if success.

Reimplemented from FBProperty.

Definition at line 1787 of file fbproperties.h.

        {
            int         Count=0;
            const char *    tmpstr;
            while ((tmpstr=EnumList( Count ))!=NULL) {
                if (strcmp(tmpstr,pString)==0) {
                    SetData( &Count );
                    return true;
                }
                Count++;
            }
            return false;
        }

Member Data Documentation

const char* mStrings[] [static]

String list.

Definition at line 1730 of file fbproperties.h.


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