FBPropertyManager Class Reference

FBPropertyManager Class Reference

#include <fbproperties.h>

Class Description

Property Manager.

The property manager exists in all FBComponent objects, and contains an array of all the registered properties. These properties may be SDK properties, internal properties or both.

Definition at line 1120 of file fbproperties.h.

Public Member Functions

 FBPropertyManager ()
 Constructor. More...
 
 ~FBPropertyManager ()
 Destructor. More...
 
int Add (FBProperty *Property)
 Add a property to the property manager. More...
 
FBPropertyoperator[] (int pIndex)
 Overloaded [] operator. More...
 
int GetCount ()
 Get the number of properties stored in property manager. More...
 
FBPropertyFind (const char *pPropertyName, bool pMultilangLookup=true)
 Find a property, based on its name. More...
 
void FindPropertiesByName (const char *pPropertyNamePattern, FBArrayTemplate< FBProperty * > &pPropList, bool pMultilangLookup=true)
 This function will query the property list for properties fulfilling a particular name pattern. More...
 
int Remove (FBProperty *pProperty)
 Remove a property. More...
 
void AddToCache (FBProperty *pProperty)
 
void RemoveFromCache (KProperty *pProperty)
 
FBPropertyFindInCache (KProperty *pProperty)
 

Friends

class FBComponent
 
class FBVisualComponent
 

Constructor & Destructor Documentation

Constructor.

Destructor.

Member Function Documentation

int Add ( FBProperty Property)

Add a property to the property manager.

Parameters
PropertyHandle to property to add.
Returns
Index in list where Property was added.
void AddToCache ( FBProperty pProperty)

Add a property to PropertyCache.

Parameters
pPropertyProperty to add to cache.
FBProperty* Find ( const char *  pPropertyName,
bool  pMultilangLookup = true 
)

Find a property, based on its name.

Parameters
pPropertyNameName of property to look for.
pMultilangLookupWhen searching, indicate if the name lookup should also be done on the property name as shown in the GUI. (default = true)
Returns
Handle to property found.
FBProperty* FindInCache ( KProperty *  pProperty)

Find a property in PropertyCache.

Parameters
pPropertyProperty to find.
Returns
Property from cache.
void FindPropertiesByName ( const char *  pPropertyNamePattern,
FBArrayTemplate< FBProperty * > &  pPropList,
bool  pMultilangLookup = true 
)

This function will query the property list for properties fulfilling a particular name pattern.

Parameters
pPropertyNamePatternIndicate the name pattern to search. This pattern can contain any amount of *. (ex: *tr*mod*scene )
pPropListList that contains the resulting properties matching the pattern
pMultilangLookupWhen searching, indicate if the name lookup should also be done on the property name as shown in the GUI. (default = true)
Note
The script FindPropertiesWithWildcard.py shows how to use this function.
int GetCount ( )

Get the number of properties stored in property manager.

Returns
Number of properties in manager.
FBProperty* operator[] ( int  pIndex)

Overloaded [] operator.

Access the property at pIndex.

Parameters
pIndexIndex of property to access.
Returns
Property stored at pIndex.
int Remove ( FBProperty pProperty)

Remove a property.

Parameters
pPropertyProperty to remove.
Returns
Index where property was found.
void RemoveFromCache ( KProperty *  pProperty)

Remove a property from PropertyCache.

Parameters
pPropertyProperty to remove from cache.

Friends And Related Function Documentation

friend class FBComponent
friend

Definition at line 1205 of file fbproperties.h.

friend class FBVisualComponent
friend

Definition at line 1206 of file fbproperties.h.


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