Python Reference Guide
 
Loading...
Searching...
No Matches
FBPropertyViewList Class Reference

FBProperty View List. More...

#include <pyfbsdk.h>

Inheritance diagram for FBPropertyViewList:

Public Member Functions

FBViewDefinition AddPropertyView (FBProperty pProperty, str pHierarchy)
 Add property view.
 
FBViewDefinition FindPropertyView (str pPropertyName)
 Find property view for pPropertyName in this list.
 
bool IsEditable ()
 Is property view list editable.
 
bool RemovePropertyView (FBViewDefinition pPropertyViewDefinition)
 Remove property view from view list.
 

Detailed Description

FBProperty View List.


Hold list of description for view set.

Member Function Documentation

◆ AddPropertyView()

FBViewDefinition AddPropertyView ( FBProperty  pProperty,
str  pHierarchy 
)

Add property view.

Parameters
pPropertyProperty to add.
pHierarchyHierarchy under which property view should be created, each level name is separated by dot (for example "Degrees of Freedom.Translation").
Returns
created object (should not be called on non editable view list).

◆ FindPropertyView()

FBViewDefinition FindPropertyView ( str  pPropertyName)

Find property view for pPropertyName in this list.

◆ IsEditable()

bool IsEditable ( )

Is property view list editable.

◆ RemovePropertyView()

bool RemovePropertyView ( FBViewDefinition  pPropertyViewDefinition)

Remove property view from view list.

Parameters
pPropertyViewDefinitionProperty view definition to destroy.
Returns
true when pPropertyViewDefinition got removed and free (should not be called on non editable view list).