FBPropertyStringList Class Reference

Property: StringList More...

#include <fbproperties.h>

Inheritance diagram for FBPropertyStringList:

Public Member Functions
	FBPropertyStringList ()
	Constructor. More...
virtual	~FBPropertyStringList ()
	Destructor. More...
FBPropertyStringList *	Init (FBComponent *pComponent, const char *pName)
	Property initialization function. More...
kReference	GetReferenceAt (int pIndex)
	Get the reference at pIndex. More...
void	SetReferenceAt (int pIndex, kReference pRef)
	Set reference at pIndex. More...
int	Find (kReference pRef)
	Find the index of a reference. More...
int	Find (const char *S)
	Find the index of a string. More...
virtual const char *	GetAt (int pIndex)
	Get the string stored at pIndex. More...
const char *	operator[] (int pIndex)
	[] operator overload. More...
void	Sort ()
	Sort list ascending. More...
int	GetCount ()
	Get the number of items in the list. More...
int	Remove (const char *S)
	Remove a string from the list. More...
virtual int	Add (const char *S, kReference pRef=0)
	Add a string to the list. More...
virtual void	Clear ()
	Clear the list (remove all the items). More...
virtual void	RemoveAt (int pIndex)
	Remove an entry at pIndex. More...
virtual int	IndexOf (const char *S)
	Get the index of a string. More...
virtual void	InsertAt (int pIndex, const char *S, kReference pRef=0)
	Insert an entry at pIndex. More...
virtual bool	SetAt (int pIndex, const char *pString)
	Set the string at pIndex. More...
virtual bool	IsList () override
	Is this class a list? More...
virtual const char *	AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI) override
	Get as string. More...
virtual bool	SetString (const char *pString) override
	Set string for list. More...
virtual FBPropertyType	GetPropertyType () override
	Get the property's type. More...
Public Member Functions inherited from FBProperty
	FBProperty ()
	Constructor. More...
void	SetEnable (bool pValue)
	Set property enable status. More...
const char *	GetName ()
	Get the property's name. More...
void	SetName (const char *pName)
	Set the property's name. More...
const char *	GetPropertyTypeName ()
	Get the property's type name. More...
virtual KDataType *	GetDataType ()
	Get the property datatype pointer. More...
virtual void	SetData (void *pData)
	Set the value of the property, passing the type as an argument. More...
virtual void	GetData (void *pData, int pSize, FBEvaluateInfo *pEvalInfo=NULL) const
	Get the value of a property. More...
int	AsInt ()
	Get the property as an integer. More...
bool	SetInt (int pInt)
	Set the property from an integer. More...
const char *	OriValueAsString ()
	Get the property original value (before any modification) as string. More...
bool	IsAnimated () const
	Get the property animated flag status. More...
bool	OriIsAnimated () const
	Get the property original animated flag status (before any modification) More...
virtual bool	IsAnimatable ()
bool	IsInternal () const
bool	IsUserProperty ()
bool	IsTextureConnectableProperty ()
bool	IsReferenceProperty ()
bool	IsMinClamp ()
	Indicate if minimum value clamping will be applied on user input value. More...
bool	IsMaxClamp ()
	Indicate if maximum value clamping will be applied on user input value. More...
bool	IsTemporaryProperty ()
	Indicate if a property was created on retrieve because it didn't exist. More...
bool	AcceptTemporaryProperty (const char *pEnumList[]=NULL, fbExternalGetSetHandler pGet=NULL, fbExternalGetSetHandler pSet=NULL)
	Accept a temporary property as a dynamic property. More...
bool	IsObjectList ()
	Indicate if is an instance of FBPropertyListObject. More...
virtual bool	IsReadOnly ()
	Is property read-only? More...
virtual const char *	EnumList (int pIndex)
	Return the string of an enum value. More...
FBStringList *	GetEnumStringList (bool pCreateIt=false)
	String list for enum properties. More...
void	NotifyEnumStringListChanged ()
	Notify system that the enum list was modified. More...
void	ModifyPropertyFlag (FBPropertyFlag pFlag, bool pValue)
	ModifyPropertyFlag. More...
FBPropertyFlag	GetPropertyFlags ()
	GetPropertyFlags. More...
bool	GetPropertyFlag (FBPropertyFlag pFlag)
	GetPropertyFlag. More...
void	SetMinMax (double pMin, double pMax, bool pForceMinClamp=false, bool pForceMaxClamp=false)
	SetMinMax. More...
void	SetMin (double pMin, bool pForceMinClamp=false)
	SetMin. More...
void	SetMax (double pMax, bool pForceMaxClamp=false)
	SetMax. More...
double	GetMin ()
	GetMin. More...
double	GetMax ()
	GetMax. More...
void *	GetParent ()
	Get the parent of the object. More...
int	GetSubMemberCount () const
	GetSubMemberCount. More...
bool	AllowsLocking () const
	AllowsLocking. More...
bool	HasSomethingLocked () const
	HasSomethingLocked. More...
bool	IsLocked () const
	IsLocked. More...
bool	IsMemberLocked (int pIndex) const
	IsMemberLocked. More...
void	SetLocked (bool pLocked)
	SetLocked. More...
void	SetMemberLocked (int pIndex, bool pLocked)
	SetMemberLocked. More...
FBProperty *	GetReferencedProperty ()
	Get the referenced property, in the case of this property is a reference property (see the IsReferenceProperty() method). More...
Public Member Functions inherited from FBWrapperHolder
FBScriptWrapper *	GetWrapper ()
	Return the wrapper interface of this FBObject. More...
void	AddWrapper (FBScriptWrapper *)
void	RemoveWrapper (FBScriptWrapper *)

Additional Inherited Members
Protected Member Functions inherited from FBPlug
bool	IsSDKComponent ()
	Return whether or not item is an SDK component. More...
bool	ConnectSrc (FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...
bool	ConnectDst (FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...
bool	ConnectSrcAt (int pDst_SrcIndex, FBPlug *pSrc, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a source connection. More...
bool	ConnectDstAt (int pSrc_DstIndex, FBPlug *pDst, FBConnectionType pConnectionType=kFBConnectionTypeNone)
	Add a destination connection. More...
bool	DisconnectDst (FBPlug *pDst)
	Remove a destination connection. More...
bool	DisconnectSrc (FBPlug *pSrc)
	Remove a source connection. More...
void	DisconnectAllSrc ()
	Remove all source connections. More...
void	DisconnectAllDst ()
	Remove all destination connections. More...
bool	DisconnectDstAt (int pIndex)
	Remove a destination connection at a specified index. More...
bool	DisconnectSrcAt (int pIndex)
	Remove a source connection at a specified index. More...
bool	ReplaceDstAt (int pIndex, FBPlug *pDst)
	Replace a destination connection at a specified index. More...
bool	ReplaceSrcAt (int pIndex, FBPlug *pSrc)
	Replace a source connection at a specified index. More...
bool	SwapSrc (int pIndexA, int pIndexB)
	Swap source connection at index A with source connection at index B. More...
bool	MoveSrcAt (int pIndex, int pAtIndex)
	Move source connection at pIndex to pAtIndex. More...
bool	MoveSrcAt (FBPlug *pSrc, FBPlug *pAtSrc)
	Move source connection pSrc to the position of pAtSrc. More...
int	GetSrcCount ()
	Get source connection count. More...
FBPlug *	GetSrc (int pIndex)
	Get a source connection's plug at specified index. More...
FBConnectionType	GetSrcType (int pIndex)
	Get a source connection's type at specified index. More...
int	GetDstCount ()
	Get destination connection count. More...
FBPlug *	GetDst (int pIndex)
	Get a destination connection's plug at specified index. More...
FBConnectionType	GetDstType (int pIndex)
	Get a destination connection's type at specified index. More...
bool	BeginChange ()
	Begins a change on multiple plugs. More...
void	EndChange ()
	Ends a change on multiple plugs. More...
void	SetSelfModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's self modification flag. More...
bool	GetSelfModified (FBPlugModificationFlag pFlag)
	Tell if the plug's self has changed. More...
void	SetContentModified (FBPlugModificationFlag pFlag, bool pBool)
	Set the plug's owned property/object's modification flag. More...
bool	GetContentModified (FBPlugModificationFlag pFlag)
	Tell if the plug's content has changed. More...
int	GetPlugConnectionModifiedList (FBPlugList &pPlugList, FBPlugModificationFlag pConnectionModificatonFlag, bool pAddRemove)
	Get plug's modified src/dst property/object connection added/removed List. More...
bool	RevertModification (FBPlugModificationFlag pFlag=kFBAllModifiedMask)
	Revert the plug's modification to original status. More...
void	SetStatusFlag (FBPlugStatusFlag pStatus, bool pValue)
	Set the plug's status flag. More...
bool	GetStatusFlag (FBPlugStatusFlag pStatus) const
	Tell if the plug's status has changed. More...
FBPlug *	GetOwner ()
	Get the owner of this plug. More...
FBPlug *	GetOwned (int pIndex)
	Get the owned plug at specified index. More...
int	GetOwnedCount ()
	Get the owned plug count. More...
virtual const char *	ClassName ()
	internal System vars. More...
virtual bool	Is (int pTypeId)
	Is( int pTypeId ) More...
virtual int	GetTypeId ()
	GetTypeId( int pTypeId ) More...
virtual bool	PlugDataNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugDataNotify when overloaded is equivalent of FBSystem.OnConnectionDataNotify but in the context of the derived object only. More...
virtual bool	PlugStateNotify (FBConnectionAction pAction, FBPlug *pThis, void *pData=NULL, void *pDataOld=NULL, int pDataSize=0)
	PlugStateNotify when overloaded is equivalent of FBSystem.OnConnectionStateNotify but in the context of the derived object only. More...
virtual bool	PlugNotify (FBConnectionAction pAction, FBPlug *pThis, int pIndex, FBPlug *pPlug=NULL, FBConnectionType pConnectionType=kFBConnectionTypeNone, FBPlug *pNewPlug=NULL)
	PlugNotify when overloaded is equivalent of FBSystem.OnConnectionNotify but in the context of the derived object only. More...
virtual void	FBDelete ()
	Actual destructor for a FBPlug. More...
Static Protected Member Functions inherited from FBPlug
static int	GetInternalClassId ()
	Internal class Id. More...
Protected Attributes inherited from FBProperty
FBString	mName
void *	mParent
Protected Attributes inherited from FBPlug
bool	mAllocated
	Contain the Allocation State of the Component. More...
HIObject	mObject
	Handle on the Plug. More...
bool	mSDKComponent
	bool Plug is an SDK component. More...
Static Protected Attributes inherited from FBPlug
static const char *	ClassGroupName
	ClassGroupName of the object. More...
static int	TypeInfo
	TypeInfo. More...
static int	mGlobalTypeInfo
	Represente the Type Index. More...

Detailed Description

Property: StringList

Definition at line 988 of file fbproperties.h.

Constructor & Destructor Documentation

FBPropertyStringList()

FBPropertyStringList

(

)

Constructor.

~FBPropertyStringList()

virtual ~FBPropertyStringList ( )

virtual

Destructor.

Member Function Documentation

Add()

virtual int Add ( const char *  S, kReference  pRef = 0  )

virtual

Add a string to the list.

Parameters

S	String to add to list.
pRef	Reference to stored with string (default = 0)

Returns

Index where item was stored.

AsString()

virtual const char* AsString ( FBDataAsStringFlag  pFlag = kFBDataAsStringUI )

overridevirtual

Get as string.

Parameters

pFlag

Specifies the purpose of returned string it defaults to kFBDataAsStringUI.

Returns

String list.

Reimplemented from FBProperty.

Clear()

virtual void Clear ( )

virtual

Clear the list (remove all the items).

Find() [1/2]

int Find

(

const char *

S

)

Find the index of a string.

Parameters

S	String to find in list.

Returns

Index of string S.

Find() [2/2]

int Find

(

kReference

pRef

)

Find the index of a reference.

Parameters

pRef	Reference to find in list.

Returns

Index where reference is stored.

GetAt()

virtual const char* GetAt ( int  pIndex )

virtual

Get the string stored at pIndex.

Parameters

pIndex

Index to access

Returns

String stored at pIndex.

GetCount()

int GetCount

(

)

Get the number of items in the list.

Returns

Number of strings stored in the list.

GetPropertyType()

virtual FBPropertyType GetPropertyType ( )

inlineoverridevirtual

Get the property's type.

Returns

The property's type.

Reimplemented from FBProperty.

Definition at line 1111 of file fbproperties.h.

References kFBPT_stringlist.

GetReferenceAt()

kReference GetReferenceAt

(

int

pIndex

)

Get the reference at pIndex.

Parameters

pIndex

Index to get reference at.

Returns

Reference stored at pIndex.

IndexOf()

virtual int IndexOf ( const char *  S )

virtual

Get the index of a string.

Parameters

S	String to look for.

Returns

Index where string S was found.

Init()

FBPropertyStringList* Init	(	FBComponent *	pComponent,
		const char *	pName
	)

Property initialization function.

Parameters

pComponent	Owner component.
pName	Name of FBPropertyStringList

Returns

Pointer to this FBPropertyStringList

InsertAt()

virtual void InsertAt ( int  pIndex, const char *  S, kReference  pRef = 0  )

virtual

Insert an entry at pIndex.

Parameters

pIndex	Index where item is to be inserted.
S	String to insert.
pRef	Reference to store with string.

IsList()

virtual bool IsList ( )

overridevirtual

Is this class a list?

Returns

true (this class is a list).

Reimplemented from FBProperty.

operator[]()

const char* operator[]

(

int

pIndex

)

[] operator overload.

Return the string stored at pIndex.

Parameters

pIndex

Index to access.

Returns

String stored at pIndex.

Remove()

int Remove

(

const char *

S

)

Remove a string from the list.

Parameters

S	String to remove from the list.

Returns

Index where item was found.

RemoveAt()

virtual void RemoveAt ( int  pIndex )

virtual

Remove an entry at pIndex.

Parameters

pIndex

Index where item is to be removed from.

SetAt()

virtual bool SetAt ( int  pIndex, const char *  pString  )

virtual

Set the string at pIndex.

Parameters

pIndex	Index where string is to be set.
pString	String to set value at pIndex with.

Returns

true if success.

SetReferenceAt()

void SetReferenceAt	(	int	pIndex,
		kReference	pRef
	)

Set reference at pIndex.

Parameters

pIndex	Index to set reference at.
pRef	Reference to store.

SetString()

virtual bool SetString ( const char *  pString )

overridevirtual

Set string for list.

Parameters

pString

String to set for list, with format same as AsString(kFBDataAsStringPersistence)

Returns

True if it was possible.

Reimplemented from FBProperty.

Sort()

void Sort

(

)

Sort list ascending.

---

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

• fbproperties.h