FBPropertyManager Class Reference


Detailed 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.

List of all members.

Public Member Functions

  __init__ ()
  Constructor.
  __del__ ()
  Destructor.
int  Add (HFBProperty Property)
  Add a property to the property manager.
HFBProperty  operator[] (int pIndex)
  Overloaded [] operator.
int  GetCount ()
  Get the number of properties stored in property manager.
HFBProperty  Find (str pPropertyName, bool pMultilangLookup=True)
  Find a property, based on its name.
int  Remove (FBProperty pProperty)
  Remove a property.
  AddToCache (FBProperty pProperty)
  Add a property to PropertyCache.
  RemoveFromCache (KProperty pProperty)
  Remove a property from PropertyCache.
FBProperty  FindInCache (KProperty pProperty)
  Find a property in PropertyCache.

Member Function Documentation

__init__ ( )
__del__ ( )
int Add ( HFBProperty  Property )

Add a property to the property manager.

Parameters:
Property Handle to property to add.
Returns:
Index in list where Property was added.
HFBProperty operator[] ( int  pIndex )

Overloaded [] operator.

Access the property at pIndex.

Parameters:
pIndex Index of property to access.
Returns:
Property stored at pIndex.
int GetCount ( )

Get the number of properties stored in property manager.

Returns:
Number of properties in manager.
HFBProperty Find ( str  pPropertyName,
bool  pMultilangLookup = True 
)

Find a property, based on its name.

Parameters:
pPropertyName Name of property to look for.
pMultilangLookup When 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.
int Remove ( FBProperty  pProperty )

Remove a property.

Parameters:
pProperty Property to remove.
Returns:
Index where property was found.
AddToCache ( FBProperty  pProperty )

Add a property to PropertyCache.

Parameters:
pProperty Property to add to cache.
RemoveFromCache ( KProperty  pProperty )

Remove a property from PropertyCache.

Parameters:
pProperty Property to remove from cache.
FBProperty FindInCache ( KProperty  pProperty )

Find a property in PropertyCache.

Parameters:
pProperty Property to find.
Returns:
Property from cache.

FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager
FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager FBPropertyManager