FBPropertyStringList Class Reference

#include <pyfbsdk.h>

Inheritance diagram for FBPropertyStringList:

Public Member Functions
int	__len__ ()
	Returns the number of elements.
str	__getitem__ (int pIndex)
	Returns the ith component Corresponds to python: print v[1].
	__setitem__ (int pIndex, str pValue)
	Sets the ith components Corresponds to python: v[1] = my_component.
bool	__contains__ (str pValue)
	Check if a FCComponent is already in PropertyList Corresponds to python: if object in propertyList:
	append (str pValue)
	Append new str at end of list.
int	count ()
	Returns the number of elements.
	insert (int pIndex, str pValue)
	Insert a new element in list.
	remove (int pIndex)
	Remove an element in list.
	removeAll ()
	Remove all elements of list
str	pop ()
	Remove last element of list.
str	pop (int pIndex)
	Remove an element in list.
int	findFromReference (int pReference)
	Find the index of an element from its attached reference.
	setReferenceAt (int pReference)
	Sets the reference value of an object.
int	getReferenceAt (int pIndex)
	Retrieve the reference of an object at ith position.
	FBPropertyStringList ()
	Constructor.
Public Member Functions inherited from FBPropertyList
int	__len__ ()
	Returns the number of elements.
Element	__getitem__ (int pIndex)
	Returns the ith component Corresponds to python: print l[1].
Public Member Functions inherited from FBProperty
	FBProperty ()
	Constructor.
bool	AllowsLocking ()
	AllowsLocking.
str	AsString (FBDataAsStringFlag pFlag=kFBDataAsStringUI)
	Get the property value as a string.
str	EnumList (int pIndex)
	Return the string of an enum value.
FBStringList	GetEnumStringList (bool pCreateIt=False)
	String list for enum properties.
float	GetMax ()
	GetMax.
float	GetMin ()
	GetMin.
str	GetName ()
	Get the property's name.
bool	GetPropertyFlag (FBFlag pFlag)
	GetPropertyFlag.
FBFlag	GetPropertyFlags ()
	GetPropertyFlags.
FBType	GetPropertyType ()
	Get the property's type.
str	GetPropertyTypeName ()
	Get the property's type name.
FBProperty	GetReferencedProperty ()
	Get the referenced property, in the case of this property is a reference property (see the IsReferenceProperty() method).
int	GetSubMemberCount ()
	GetSubMemberCount.
bool	HasSomethingLocked ()
	HasSomethingLocked.
bool	IsAnimatable ()
bool	IsInternal ()
bool	IsList ()
	Verify if property is of this type.
bool	IsLocked ()
	IsLocked.
bool	IsMaxClamp ()
	Indicate if maximum value clamping will be applied on user input value.
bool	IsMemberLocked (int pIndex)
	IsMemberLocked.
bool	IsMinClamp ()
	Indicate if minimum value clamping will be applied on user input value.
bool	IsObjectList ()
	Indicate if is an instance of FBPropertyListObject.
bool	IsReadOnly ()
	Is property read-only?
bool	IsReferenceProperty ()
bool	IsTextureConnectableProperty ()
bool	IsUserProperty ()
	ModifyPropertyFlag (FBFlag pFlag, bool pValue)
	ModifyPropertyFlag.
	NotifyEnumStringListChanged ()
	Notify system that the enum list was modified.
str	OriValueAsString ()
	Get the property original value (before any modification) as string.
	SetLocked (bool pLocked)
	SetLocked.
	SetMax (float pMax, bool pForceMaxClamp=False)
	SetMax.
	SetMemberLocked (int pIndex, bool pLocked)
	SetMemberLocked.
	SetMin (float pMin, bool pForceMinClamp=False)
	SetMin.
	SetName (str pName)
	Set the property's name.
bool	SetString (str pString)
	Set the property value from a string.

Additional Inherited Members
Public Attributes inherited from FBProperty
str	Name
	Read Property: The property's name.
object	Data
	Read Write Property: The property data value. Type of this depends on the subclass of FBProperty (ex: in a FBPropertyInt, Data is of type int).
Public Attributes inherited from FBPlug
str	ClassGroupName
	ClassGroupName of the object.
int	TypeInfo
	TypeInfo.

Detailed Description

# Supported list protocol methods:    
 len(propertyStringList)
 component= propertyStringList[0]
 propertyStringList[0] = my_string
 
 if my_string in propertyStringList:
    print "it is contained!"
 
 del propertyStringList[0]

Constructor & Destructor Documentation

FBPropertyStringList()

FBPropertyStringList

(

)

Constructor.

Member Function Documentation

__contains__()

bool __contains__

(

str

pValue

)

Check if a FCComponent is already in PropertyList Corresponds to python: if object in propertyList:

Parameters

pValue

Component to check for inclusion

Returns

Is the String contained or not?

__getitem__()

str __getitem__

(

int

pIndex

)

Returns the ith component Corresponds to python: print v[1].

Parameters

pIndex

Index of the components to get (0 to 2)

Returns

str component value.

__len__()

int __len__

(

)

Returns the number of elements.

Corresponds to python: len(object)

Returns

number of elements in list.

__setitem__()

__setitem__	(	int	pIndex,
		str	pValue
	)

Sets the ith components Corresponds to python: v[1] = my_component.

Parameters

pIndex	Index of the components to set
pValue	a str to set

append()

append

(

str

pValue

)

Append new str at end of list.

Parameters

pValue

to append

count()

int count

(

)

Returns the number of elements.

Corresponds to python: del propertyList[2]

Returns

number of elements in list.

findFromReference()

int findFromReference

(

int

pReference

)

Find the index of an element from its attached reference.

Parameters

pReference

Reference of searched object.

Returns

Returns the index of the element corresponding to reference.

getReferenceAt()

int getReferenceAt

(

int

pIndex

)

Retrieve the reference of an object at ith position.

Parameters

pIndex

Index of the object to find reference.

Returns

Returns the reference of the object.

insert()

insert	(	int	pIndex,
		str	pValue
	)

Insert a new element in list.

Parameters

pIndex	Index where to insert string
pValue	String to append

pop() [1/2]

str pop

(

)

Remove last element of list.

Returns

Returns the element that was removed.

pop() [2/2]

str pop

(

int

pIndex

)

Remove an element in list.

Parameters

pIndex

Index where to remove element.

Returns

Returns the element that was removed.

remove()

remove

(

int

pIndex

)

Remove an element in list.

Parameters

pIndex

Index where to remove element.

removeAll()

removeAll

(

)

Remove all elements of list

setReferenceAt()

setReferenceAt

(

int

pReference

)

Sets the reference value of an object.

Parameters

pReference

Reference of the object.