RPropertyListener

Class in Core Module
Header: #include <src/core/RPropertyListener.h>
Inherited by: RPropertyEditor

Description

Abstract base class for classes that are interested in properties of the current selection or the current action.

For example a property browser or editor.

Scriptable: This class is available in script environments.

Public Functions


virtual	~RPropertyListener`()`
virtual void	clearEditor`()=0` = 0 This method is called to signal that no properties are currently relevant.
virtual void	updateFromDocument`(RDocument document, bool onlyChanges, RS::EntityType entityTypeFilter=RS::EntityAll, bool manual=false, bool showOnRequest=false)=0` = 0* This method is called whenever the relevant combined properties of the objects in `document` have changed.
virtual void	updateFromObject`(RObject object, RDocument document=NULL)=0` = 0 This method is called if only the properties of the given property owner are currently relevant.

Member Documentation

~RPropertyListener

virtual RPropertyListener::~RPropertyListener()

virtual inline

clearEditor

virtual void RPropertyListener::clearEditor()=0 = 0

pure virtual

This method is called to signal that no properties are currently relevant.

For example that no entities are selected in a document or that nothing is being drawn at the moment.

Reimplemented in clearEditor.

updateFromDocument

virtual void RPropertyListener::updateFromDocument(RDocument *document, bool onlyChanges, RS::EntityType entityTypeFilter=RS::EntityAll, bool manual=false, bool showOnRequest=false)=0 = 0

pure virtual

This method is called whenever the relevant combined properties of the objects in document have changed.

For example this can mean that the selection in a document has changed and the combined properties of the selected entities should be displayed in a property browser or editor.

Parameters:

onlyChanges: Only changes of entities, the set of entities has not changed (no deletes, no additions).

Reimplemented in updateFromDocument.

updateFromObject

virtual void RPropertyListener::updateFromObject(RObject *object, RDocument *document=NULL)=0 = 0

pure virtual

This method is called if only the properties of the given property owner are currently relevant.

For example this can be the case when an entity is being drawn and only the properties of that entity should be displayed, so that the user can adjust properties before or while drawing the entity.

Reimplemented in updateFromObject.