FBPropertyManager Class Reference
 
 
 
FBPropertyManager Class Reference

This reference page is linked to from the following overview topics: FBProperty - Object Properties.


#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 1100 of file fbproperties.h.

Public Member Functions

  FBPropertyManager ()
  Constructor.
  ~FBPropertyManager ()
  Destructor.
int  Add (FBProperty *Property)
  Add a property to the property manager.
FBProperty operator[] (int pIndex)
  Overloaded [] operator.
int  GetCount ()
  Get the number of properties stored in property manager.
FBProperty Find (const char *pPropertyName, bool pMultilangLookup=true)
  Find a property, based on its name.
int  Remove (FBProperty *pProperty)
  Remove a property.
void  AddToCache (FBProperty *pProperty)
void  RemoveFromCache (KProperty *pProperty)
FBProperty FindInCache (KProperty *pProperty)

Friends

class  FBComponent
class  FBVisualComponent

Constructor & Destructor Documentation

FBPropertyManager::FBPropertyManager ( )

Constructor.

FBPropertyManager::~FBPropertyManager ( )

Destructor.


Member Function Documentation

int FBPropertyManager::Add ( FBProperty Property )

Add a property to the property manager.

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

Overloaded [] operator.

Access the property at pIndex.

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

Get the number of properties stored in property manager.

Returns:
Number of properties in manager.
FBProperty* FBPropertyManager::Find ( const char *  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 FBPropertyManager::Remove ( FBProperty pProperty )

Remove a property.

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

Add a property to PropertyCache.

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

Remove a property from PropertyCache.

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

Find a property in PropertyCache.

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

Friends And Related Function Documentation

friend class FBComponent [friend]

Definition at line 1177 of file fbproperties.h.

friend class FBVisualComponent [friend]

Definition at line 1178 of file fbproperties.h.


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