Workspace 6.21.5
Public Slots | Signals | Public Member Functions | Protected Member Functions | List of all members
QtRectPropertyManager Class Reference

The QtRectPropertyManager provides and manages QRect properties. More...

#include <Workspace/Widgets/PropertyBrowser/qtpropertymanager.h>

Inheritance diagram for QtRectPropertyManager:
[legend]

Public Slots

void setConstraint (QtProperty *property, const QRect &constraint)
 
void setValue (QtProperty *property, const QRect &val)
 

Signals

void constraintChanged (QtProperty *property, const QRect &constraint)
 
void valueChanged (QtProperty *property, const QRect &val)
 
- Signals inherited from QtAbstractPropertyManager
void propertyChanged (QtProperty *property)
 
void propertyDestroyed (QtProperty *property)
 
void propertyInserted (QtProperty *property, QtProperty *parent, QtProperty *after)
 
void propertyRemoved (QtProperty *property, QtProperty *parent)
 

Public Member Functions

 QtRectPropertyManager (QObject *parent=nullptr)
 
 ~QtRectPropertyManager ()
 
QRect constraint (const QtProperty *property) const
 
QtIntPropertyManagersubIntPropertyManager () const
 
QRect value (const QtProperty *property) const
 
- Public Member Functions inherited from QtAbstractPropertyManager
 QtAbstractPropertyManager (QObject *parent=nullptr)
 
 ~QtAbstractPropertyManager ()
 
QtPropertyaddProperty (const QString &name=QString())
 
void clear () const
 
bool getModifiedOnValueChanged () const
 
QSet< QtProperty * > properties () const
 
void setModifiedOnValueChanged (bool modified)
 

Protected Member Functions

virtual void initializeProperty (QtProperty *property)
 
virtual void uninitializeProperty (QtProperty *property)
 
QString valueText (const QtProperty *property) const
 
- Protected Member Functions inherited from QtAbstractPropertyManager
virtual QtPropertycreateProperty ()
 
virtual QString displayText (const QtProperty *property) const
 
virtual EchoMode echoMode (const QtProperty *) const
 
virtual bool hasValue (const QtProperty *property) const
 
virtual void initializeProperty (QtProperty *property)=0
 
virtual void uninitializeProperty (QtProperty *property)
 
virtual QIcon valueIcon (const QtProperty *property) const
 
virtual QString valueText (const QtProperty *property) const
 

Detailed Description

A rectangle property has nested x, y, width and height subproperties. The top-level property's value can be retrieved using the value() function, and set using the setValue() slot.

The subproperties are created by a QtIntPropertyManager object. This manager can be retrieved using the subIntPropertyManager() function. In order to provide editing widgets for the subproperties in a property browser widget, this manager must be associated with an editor factory.

A rectangle property also has a constraint rectangle which can be retrieved using the constraint() function, and set using the setConstraint() slot.

In addition, QtRectPropertyManager provides the valueChanged() signal which is emitted whenever a property created by this manager changes, and the constraintChanged() signal which is emitted whenever such a property changes its constraint rectangle.

See also
QtAbstractPropertyManager, QtIntPropertyManager, QtRectFPropertyManager

Constructor & Destructor Documentation

◆ QtRectPropertyManager()

QtRectPropertyManager ( QObject *  parent = nullptr)

Creates a manager with the given parent.

◆ ~QtRectPropertyManager()

Destroys this manager, and all the properties it has created.

Member Function Documentation

◆ constraint()

QRect constraint ( const QtProperty property) const

Returns the given property's constraining rectangle. If returned value is null QRect it means there is no constraint applied.

See also
value(), setConstraint()

◆ constraintChanged

void constraintChanged ( QtProperty property,
const QRect &  constraint 
)
signal

This signal is emitted whenever property changes its constraint rectangle, passing a pointer to the property and the new constraint rectangle as parameters.

See also
setConstraint()

◆ initializeProperty()

void initializeProperty ( QtProperty property)
protectedvirtual

This function is called whenever a new valid property pointer has been created, passing the pointer as parameter.

The purpose is to let the manager know that the property has been created so that it can provide additional attributes for the new property, e.g. QtIntPropertyManager adds {QtIntPropertyManager::value()}{value}, {QtIntPropertyManager::minimum()}{minimum} and {QtIntPropertyManager::maximum()}{maximum} attributes. Since each manager subclass adds type specific attributes, this function is pure virtual and must be reimplemented when deriving from the QtAbstractPropertyManager class.

See also
addProperty(), createProperty()

Implements QtAbstractPropertyManager.

◆ setConstraint

void setConstraint ( QtProperty property,
const QRect &  constraint 
)
slot

Sets the given property's constraining rectangle to constraint.

When setting the constraint, the current value is adjusted if necessary (ensuring that the current rectangle value is inside the constraint). In order to reset the constraint pass a null QRect value.

See also
setValue(), constraint(), constraintChanged()

◆ setValue

void setValue ( QtProperty property,
const QRect &  value 
)
slot

Sets the value of the given property to value. Nested properties are updated automatically.

If the specified value is not inside the given property's constraining rectangle, the value is adjusted accordingly to fit within the constraint.

See also
value(), setConstraint(), valueChanged()

◆ subIntPropertyManager()

QtIntPropertyManager * subIntPropertyManager ( ) const

Returns the manager that creates the nested x, y, width and height subproperties.

In order to provide editing widgets for the mentioned subproperties in a property browser widget, this manager must be associated with an editor factory.

See also
QtAbstractPropertyBrowser::setFactoryForManager()

◆ uninitializeProperty()

void uninitializeProperty ( QtProperty property)
protectedvirtual

This function is called just before the specified property is destroyed.

The purpose is to let the property manager know that the property is being destroyed so that it can remove the property's additional attributes.

See also
clear(), propertyDestroyed()

Reimplemented from QtAbstractPropertyManager.

◆ value()

QRect value ( const QtProperty property) const

Returns the given property's value.

If the given property is not managed by this manager, this function returns an invalid rectangle.

See also
setValue(), constraint()

◆ valueChanged

void valueChanged ( QtProperty property,
const QRect &  value 
)
signal

This signal is emitted whenever a property created by this manager changes its value, passing a pointer to the property and the new value as parameters.

See also
setValue()

◆ valueText()

QString valueText ( const QtProperty property) const
protectedvirtual

Returns a string representing the current state of the given property.

The default implementation of this function returns an empty string.

See also
QtProperty::valueText()

Reimplemented from QtAbstractPropertyManager.