pCon.planner Plugin SDK  Version 8.8.1
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Properties Events
Public Member Functions | Events | List of all members
X3g::Plugin::PropertyProvider Class Reference

Property Provider. More...

Inherited by X3g::Plugin::IPropertyProvider.

Public Member Functions

ReadOnlyCollection< IProperty^ >^ GetProperties ()
 Returns a list of supported properties. More...
 
IPropertyGetProperty (System::String^ pKey)
 Returns a property by key. More...
 
bool BeginChangeSection ()
 Notifies about a section where multiple properties may change. More...
 
bool EndChangeSection ()
 Notifies about the end of a property change section. More...
 
void Add (IPropertyCallbacks^ pCallbacks)
 Adds custom properties to a provider. More...
 
void Remove (IPropertyCallbacks^ pCallbacks)
 Removes custom properties from a provider. More...
 
void Update (bool pValuesOnly)
 Notifies observers that properties have changed. More...
 

Events

PropertiesChangedEventHandler^  PropertiesChanged [add, remove, raise]
 Notifies about change of property list or property values. More...
 

Detailed Description

Property Provider.

Member Function Documentation

void X3g::Plugin::PropertyProvider::Add ( IPropertyCallbacks pCallbacks)

Adds custom properties to a provider.

bool X3g::Plugin::PropertyProvider::BeginChangeSection ( )

Notifies about a section where multiple properties may change.

The provider may collect all changes made within this section, and may notify observers only once on finish. Subsections are also allowed, but notifications will be sent only when the outer section is closed.

bool X3g::Plugin::PropertyProvider::EndChangeSection ( )

Notifies about the end of a property change section.

ReadOnlyCollection< X3g::Plugin::IProperty^ > X3g::Plugin::PropertyProvider::GetProperties ( )

Returns a list of supported properties.

Includes custom properties.

IProperty X3g::Plugin::PropertyProvider::GetProperty ( System::String^  pKey)

Returns a property by key.

Returns null if property doesn't exist.

void X3g::Plugin::PropertyProvider::Remove ( IPropertyCallbacks pCallbacks)

Removes custom properties from a provider.

void X3g::Plugin::PropertyProvider::Update ( bool  pValuesOnly)

Notifies observers that properties have changed.

Parameter pValuesOnly should be true if list of properties is still the same and only values or states have changed.

If this method is called within a change section observers are notified when EndChangeSection is called.

Event Documentation

PropertiesChangedEventHandler^ X3g::Plugin::PropertyProvider::PropertiesChanged
addremoveraise

Notifies about change of property list or property values.

Supported for top-level entities only.