Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
QtRectFPropertyManager Class Reference

The QtRectFPropertyManager provides and manages QRectF properties. More...

#include <qtpropertymanager_p.h>

+ Inheritance diagram for QtRectFPropertyManager:
+ Collaboration diagram for QtRectFPropertyManager:

Public Slots

void setValue (QtProperty *property, const QRectF &val)
 Sets the value of the given property to value.
 
void setConstraint (QtProperty *property, const QRectF &constraint)
 Sets the given property's constraining rectangle to constraint.
 
void setDecimals (QtProperty *property, int prec)
 Sets the precision of the given property to prec.
 
- Public Slots inherited from QObject
void deleteLater ()
 \threadsafe
 

Signals

void valueChanged (QtProperty *property, const QRectF &val)
 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.
 
void constraintChanged (QtProperty *property, const QRectF &constraint)
 This signal is emitted whenever property changes its constraint rectangle, passing a pointer to the property and the new constraint rectangle as parameters.
 
void decimalsChanged (QtProperty *property, int prec)
 This signal is emitted whenever a property created by this manager changes its precision of value, passing a pointer to the property and the new prec value.
 
- Signals inherited from QtAbstractPropertyManager
void propertyInserted (QtProperty *property, QtProperty *parent, QtProperty *after)
 This signal is emitted when a new subproperty is inserted into an existing property, passing pointers to the newProperty, parentProperty and precedingProperty as parameters.
 
void propertyChanged (QtProperty *property)
 This signal is emitted whenever a property's data changes, passing a pointer to the property as parameter.
 
void propertyRemoved (QtProperty *property, QtProperty *parent)
 This signal is emitted when a subproperty is removed, passing pointers to the removed property and the parent property as parameters.
 
void propertyDestroyed (QtProperty *property)
 This signal is emitted when the specified property is about to be destroyed.
 
- Signals inherited from QObject
void destroyed (QObject *=nullptr)
 This signal is emitted immediately before the object obj is destroyed, after any instances of QPointer have been notified, and cannot be blocked.
 
void objectNameChanged (const QString &objectName, QPrivateSignal)
 This signal is emitted after the object's name has been changed.
 

Public Member Functions

 QtRectFPropertyManager (QObject *parent=0)
 Creates a manager with the given parent.
 
 ~QtRectFPropertyManager ()
 Destroys this manager, and all the properties it has created.
 
QtDoublePropertyManagersubDoublePropertyManager () const
 Returns the manager that creates the nested x, y, width and height subproperties.
 
QRectF value (const QtProperty *property) const
 Returns the given property's value.
 
QRectF constraint (const QtProperty *property) const
 Returns the given property's constraining rectangle.
 
int decimals (const QtProperty *property) const
 Returns the given property's precision, in decimals.
 
- Public Member Functions inherited from QtAbstractPropertyManager
 QtAbstractPropertyManager (QObject *parent=0)
 Creates an abstract property manager with the given parent.
 
 ~QtAbstractPropertyManager ()
 Destroys the manager.
 
QSet< QtProperty * > properties () const
 Returns the set of properties created by this manager.
 
void clear () const
 Destroys all the properties that this manager has created.
 
QtPropertyaddProperty (const QString &name=QString())
 Creates a property with the given name which then is owned by this manager.
 
- Public Member Functions inherited from QObject
Q_INVOKABLE QObject (QObject *parent=nullptr)
 Constructs an object with parent object parent.
 
virtual ~QObject ()
 Destroys the object, deleting all its child objects.
 
virtual bool event (QEvent *event)
 This virtual function receives events to an object and should return true if the event e was recognized and processed.
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 Filters events if this object has been installed as an event filter for the watched object.
 
QString objectName () const
 
Q_WEAK_OVERLOAD void setObjectName (const QString &name)
 Sets the object's name to name.
 
void setObjectName (QAnyStringView name)
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
QBindable< QStringbindableObjectName ()
 
bool isWidgetType () const
 Returns true if the object is a widget; otherwise returns false.
 
bool isWindowType () const
 Returns true if the object is a window; otherwise returns false.
 
bool isQuickItemType () const
 Returns true if the object is a QQuickItem; otherwise returns false.
 
bool signalsBlocked () const noexcept
 Returns true if signals are blocked; otherwise returns false.
 
bool blockSignals (bool b) noexcept
 If block is true, signals emitted by this object are blocked (i.e., emitting a signal will not invoke anything connected to it).
 
QThreadthread () const
 Returns the thread in which the object lives.
 
bool moveToThread (QThread *thread QT6_DECL_NEW_OVERLOAD_TAIL)
 Changes the thread affinity for this object and its children and returns true on success.
 
int startTimer (int interval, Qt::TimerType timerType=Qt::CoarseTimer)
 This is an overloaded function that will start a timer of type timerType and a timeout of interval milliseconds.
 
int startTimer (std::chrono::nanoseconds time, Qt::TimerType timerType=Qt::CoarseTimer)
 
void killTimer (int id)
 Kills the timer with timer identifier, id.
 
void killTimer (Qt::TimerId id)
 
template<typename T >
findChild (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns the child of this object that can be cast into type T and that is called name, or \nullptr if there is no such object.
 
template<typename T >
QList< T > findChildren (QAnyStringView aName, Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 Returns all children of this object with the given name that can be cast to type T, or an empty list if there are no such objects.
 
template<typename T >
findChild (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
template<typename T >
QList< T > findChildren (Qt::FindChildOptions options=Qt::FindChildrenRecursively) const
 This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
 
const QObjectListchildren () const
 Returns a list of child objects.
 
void setParent (QObject *parent)
 Makes the object a child of parent.
 
void installEventFilter (QObject *filterObj)
 Installs an event filter filterObj on this object.
 
void removeEventFilter (QObject *obj)
 Removes an event filter object obj from this object.
 
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *member, Qt::ConnectionType type=Qt::AutoConnection) const
 
bool disconnect (const char *signal=nullptr, const QObject *receiver=nullptr, const char *member=nullptr) const
 
bool disconnect (const QObject *receiver, const char *member=nullptr) const
 
void dumpObjectTree () const
 Dumps a tree of children to the debug output.
 
void dumpObjectInfo () const
 Dumps information about signal connections, etc.
 
bool setProperty (const char *name, const QVariant &value)
 Sets the value of the object's name property to value.
 
bool setProperty (const char *name, QVariant &&value)
 
QVariant property (const char *name) const
 Returns the value of the object's name property.
 
QList< QByteArraydynamicPropertyNames () const
 
QBindingStoragebindingStorage ()
 
const QBindingStoragebindingStorage () const
 
QObjectparent () const
 Returns a pointer to the parent object.
 
bool inherits (const char *classname) const
 Returns true if this object is an instance of a class that inherits className or a QObject subclass that inherits className; otherwise returns false.
 

Protected Member Functions

QString valueText (const QtProperty *property) const override
 \reimp
 
void initializeProperty (QtProperty *property) override
 \reimp
 
void uninitializeProperty (QtProperty *property) override
 \reimp
 
- Protected Member Functions inherited from QtAbstractPropertyManager
virtual bool hasValue (const QtProperty *property) const
 Returns whether the given property has a value.
 
virtual QIcon valueIcon (const QtProperty *property) const
 Returns an icon representing the current state of the given property.
 
virtual QtPropertycreateProperty ()
 Creates a property.
 
- Protected Member Functions inherited from QObject
QObjectsender () const
 Returns a pointer to the object that sent the signal, if called in a slot activated by a signal; otherwise it returns \nullptr.
 
int senderSignalIndex () const
 
int receivers (const char *signal) const
 Returns the number of receivers connected to the signal.
 
bool isSignalConnected (const QMetaMethod &signal) const
 
virtual void timerEvent (QTimerEvent *event)
 This event handler can be reimplemented in a subclass to receive timer events for the object.
 
virtual void childEvent (QChildEvent *event)
 This event handler can be reimplemented in a subclass to receive child events.
 
virtual void customEvent (QEvent *event)
 This event handler can be reimplemented in a subclass to receive custom events.
 
virtual void connectNotify (const QMetaMethod &signal)
 
virtual void disconnectNotify (const QMetaMethod &signal)
 
 QObject (QObjectPrivate &dd, QObject *parent=nullptr)
 

Additional Inherited Members

- Static Public Member Functions inherited from QObject
static QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *member, Qt::ConnectionType=Qt::AutoConnection)
 \threadsafe
 
static QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::ContextTypeForFunctor< Func2 >::ContextType *context, Func2 &&slot, Qt::ConnectionType type=Qt::AutoConnection)
 
template<typename Func1 , typename Func2 >
static QMetaObject::Connection connect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, Func2 &&slot)
 
static bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *member)
 \threadsafe
 
static bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &member)
 
static bool disconnect (const QMetaObject::Connection &)
 Disconnect a connection.
 
template<typename Func1 , typename Func2 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const typename QtPrivate::FunctionPointer< Func2 >::Object *receiver, Func2 slot)
 
template<typename Func1 >
static bool disconnect (const typename QtPrivate::FunctionPointer< Func1 >::Object *sender, Func1 signal, const QObject *receiver, void **zero)
 
- Protected Attributes inherited from QObject
QScopedPointer< QObjectDatad_ptr
 
- Properties inherited from QObject
QString objectName
 the name of this object
 

Detailed Description

The QtRectFPropertyManager provides and manages QRectF properties.

\inmodule QtDesigner

Since
4.4

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 QtDoublePropertyManager object. This manager can be retrieved using the subDoublePropertyManager() 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, QtRectFPropertyManager 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, QtDoublePropertyManager, QtRectPropertyManager

Definition at line 484 of file qtpropertymanager_p.h.

Constructor & Destructor Documentation

◆ QtRectFPropertyManager()

QtRectFPropertyManager::QtRectFPropertyManager ( QObject * parent = 0)

Creates a manager with the given parent.

Definition at line 4248 of file qtpropertymanager.cpp.

◆ ~QtRectFPropertyManager()

QtRectFPropertyManager::~QtRectFPropertyManager ( )

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

Definition at line 4263 of file qtpropertymanager.cpp.

References QtAbstractPropertyManager::clear().

+ Here is the call graph for this function:

Member Function Documentation

◆ constraint()

QRectF QtRectFPropertyManager::constraint ( const QtProperty * property) const

Returns the given property's constraining rectangle.

If returned value is null QRectF it means there is no constraint applied.

See also
value(), setConstraint()

Definition at line 4311 of file qtpropertymanager.cpp.

◆ constraintChanged

void QtRectFPropertyManager::constraintChanged ( QtProperty * property,
const QRectF & 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()

◆ decimals()

int QtRectFPropertyManager::decimals ( const QtProperty * property) const

Returns the given property's precision, in decimals.

See also
setDecimals()

Definition at line 4301 of file qtpropertymanager.cpp.

◆ decimalsChanged

void QtRectFPropertyManager::decimalsChanged ( QtProperty * property,
int prec )
signal

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

See also
setDecimals()

◆ initializeProperty()

void QtRectFPropertyManager::initializeProperty ( QtProperty * property)
overrideprotectedvirtual

\reimp

Implements QtAbstractPropertyManager.

Definition at line 4477 of file qtpropertymanager.cpp.

References QtProperty::addSubProperty().

+ Here is the call graph for this function:

◆ setConstraint

void QtRectFPropertyManager::setConstraint ( QtProperty * property,
const QRectF & 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 QRectF value.

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

Definition at line 4389 of file qtpropertymanager.cpp.

◆ setDecimals

void QtRectFPropertyManager::setDecimals ( QtProperty * property,
int prec )
slot

Sets the precision of the given property to prec.

The valid decimal range is 0-13. The default is 2.

See also
decimals()

Definition at line 4447 of file qtpropertymanager.cpp.

References QtRectFPropertyManagerPrivate::Data::decimals.

◆ setValue

void QtRectFPropertyManager::setValue ( QtProperty * property,
const QRectF & 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()

Definition at line 4344 of file qtpropertymanager.cpp.

◆ subDoublePropertyManager()

QtDoublePropertyManager * QtRectFPropertyManager::subDoublePropertyManager ( ) 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()

Definition at line 4278 of file qtpropertymanager.cpp.

◆ uninitializeProperty()

void QtRectFPropertyManager::uninitializeProperty ( QtProperty * property)
overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 4519 of file qtpropertymanager.cpp.

◆ value()

QRectF QtRectFPropertyManager::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()

Definition at line 4291 of file qtpropertymanager.cpp.

◆ valueChanged

void QtRectFPropertyManager::valueChanged ( QtProperty * property,
const QRectF & 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 QtRectFPropertyManager::valueText ( const QtProperty * property) const
overrideprotectedvirtual

\reimp

Reimplemented from QtAbstractPropertyManager.

Definition at line 4319 of file qtpropertymanager.cpp.


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