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

The QtSizePropertyManager provides and manages QSize properties. More...

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

Inheritance diagram for QtSizePropertyManager:
[legend]

Public Slots

void setMaximum (QtProperty *property, const QSize &maxVal)
 
void setMinimum (QtProperty *property, const QSize &minVal)
 
void setRange (QtProperty *property, const QSize &minVal, const QSize &maxVal)
 
void setValue (QtProperty *property, const QSize &val)
 

Signals

void rangeChanged (QtProperty *property, const QSize &minVal, const QSize &maxVal)
 
void valueChanged (QtProperty *property, const QSize &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

 QtSizePropertyManager (QObject *parent=nullptr)
 
 ~QtSizePropertyManager ()
 
QSize maximum (const QtProperty *property) const
 
QSize minimum (const QtProperty *property) const
 
QtIntPropertyManagersubIntPropertyManager () const
 
QSize 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 size property has nested 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 size property also has a range of valid values defined by a minimum size and a maximum size. These sizes can be retrieved using the minimum() and the maximum() functions, and set using the setMinimum() and setMaximum() slots. Alternatively, the range can be defined in one go using the setRange() slot.

In addition, QtSizePropertyManager provides the valueChanged() signal which is emitted whenever a property created by this manager changes, and the rangeChanged() signal which is emitted whenever such a property changes its range of valid sizes.

See also
QtAbstractPropertyManager, QtIntPropertyManager, QtSizeFPropertyManager

Constructor & Destructor Documentation

◆ QtSizePropertyManager()

QtSizePropertyManager ( QObject *  parent = nullptr)

Creates a manager with the given parent.

◆ ~QtSizePropertyManager()

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

Member Function Documentation

◆ 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.

◆ maximum()

QSize maximum ( const QtProperty property) const

Returns the given property's maximum size value.

See also
setMaximum(), minimum(), setRange()

◆ minimum()

QSize minimum ( const QtProperty property) const

Returns the given property's minimum size value.

See also
setMinimum(), maximum(), setRange()

◆ rangeChanged

void rangeChanged ( QtProperty property,
const QSize &  minimum,
const QSize &  maximum 
)
signal

This signal is emitted whenever a property created by this manager changes its range of valid sizes, passing a pointer to the property and the new minimum and maximum sizes.

See also
setRange()

◆ setMaximum

void setMaximum ( QtProperty property,
const QSize &  maxVal 
)
slot

Sets the maximum size value for the given property to maxVal.

When setting the maximum size value, the minimum and current values are adjusted if necessary (ensuring that the size range remains valid and that the current value is within the range).

See also
maximum(), setRange(), rangeChanged()

◆ setMinimum

void setMinimum ( QtProperty property,
const QSize &  minVal 
)
slot

Sets the minimum size value for the given property to minVal.

When setting the minimum size value, the maximum and current values are adjusted if necessary (ensuring that the size range remains valid and that the current value is within the range).

See also
minimum(), setRange(), rangeChanged()

◆ setRange

void setRange ( QtProperty property,
const QSize &  minimum,
const QSize &  maximum 
)
slot

Sets the range of valid values.

This is a convenience function defining the range of valid values in one go; setting the minimum and maximum values for the given property with a single function call.

When setting a new range, the current value is adjusted if necessary (ensuring that the value remains within the range).

See also
setMinimum(), setMaximum(), rangeChanged()

◆ setValue

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

Sets the value of the given property to value.

If the specified value is not valid according to the given property's size range, the value is adjusted to the nearest valid value within the size range.

See also
value(), setRange(), valueChanged()

◆ subIntPropertyManager()

QtIntPropertyManager * subIntPropertyManager ( ) const

Returns the manager that creates the nested width and height subproperties.

In order to provide editing widgets for the width and height properties 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()

QSize 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 size

See also
setValue()

◆ valueChanged

void valueChanged ( QtProperty property,
const QSize &  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.