STK::IPropertySource Class Reference

Interface to an object which is capable of supplying properties for display by the standard property sheet page implementation (PropertySheetPage). More...

#include <STK_IPropertySource.h>

Inheritance diagram for STK::IPropertySource:

Collaboration diagram for STK::IPropertySource:

List of all members.

Public Member Functions
virtual	~IPropertySource ()
	virtual dtor
virtual bool	isPropertySet (String const &id) const =0
	Returns whether the value of the property with the given id has changed from its default value.
virtual const String *	getPropertyValue (String const &id) const =0
	Returns the displayed value of the property with the given id if it has one.
Static Public Member Functions
static const std::list < PropertyDescriptor > &	getPropertyDescriptors ()
	Returns the list of property descriptors for this property source.
Protected Member Functions
	IPropertySource ()
	default ctor
Static Protected Attributes
static std::list < PropertyDescriptor >	descriptors_ = std::list<PropertyDescriptor>()
	A list of descriptors of the model objects.

---

Detailed Description

Interface to an object which is capable of supplying properties for display by the standard property sheet page implementation (PropertySheetPage).

PropertySheetPage discovers the properties to display from currently selected elements. Elements that implement IPropertySource directly are included. Clients should implement this interface for any newly-defined elements that are to have properties displayable by PropertySheetPage.

See also:

PropertySheetPage

Definition at line 73 of file STK_IPropertySource.h.

---

Constructor & Destructor Documentation

STK::IPropertySource::IPropertySource

(

)

[protected]

default ctor

Definition at line 48 of file STK_IPropertySource.cpp.

  { ;}

STK::IPropertySource::~IPropertySource

(

)

[virtual]

virtual dtor

Definition at line 51 of file STK_IPropertySource.cpp.

  { ;}

---

Member Function Documentation

static const std::list<PropertyDescriptor>& STK::IPropertySource::getPropertyDescriptors

(

)

[inline, static]

Returns the list of property descriptors for this property source.

Implementors should cache the descriptors as they will be asked for the descriptors with any edit/update.

Returns:

the property descriptors List

Definition at line 95 of file STK_IPropertySource.h.

References descriptors_.

    { return descriptors_;}

virtual bool STK::IPropertySource::isPropertySet

(

String const &

id

)

const [pure virtual]

Returns whether the value of the property with the given id has changed from its default value.

Returns false if this source does not have the specified property.

If the notion of default value is not meaningful for the specified property then false is returned.

Parameters:

id	the id of the property

Returns:

true if the value of the specified property has changed from its original default value, false if the specified property does not have a meaningful default value, and false if this source does not have the specified property

Implemented in STK::Connection, STK::GProgram, and STK::IStep.

virtual const String* STK::IPropertySource::getPropertyValue

(

String const &

id

)

const [pure virtual]

Returns the displayed value of the property with the given id if it has one.

Returns NULL if the property's value is NULL or if this source does not have the specified property.

Parameters:

id	the id of the property being set

Returns:

the value of the property, or NULL

Implemented in STK::Connection, STK::GProgram, and STK::IStep.

---

Member Data Documentation

std::list< PropertyDescriptor > STK::IPropertySource::descriptors_ = std::list<PropertyDescriptor>() [static, protected]

A list of descriptors of the model objects.

Definition at line 77 of file STK_IPropertySource.h.

Referenced by getPropertyDescriptors().

---

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

• STK_IPropertySource.h
• STK_IPropertySource.cpp