QtBase
v6.3.1
|
The QProperty class is a template class that enables automatic property bindings. More...
#include <qproperty.h>
Public Types | |
using | value_type = typename QPropertyData< T >::value_type |
using | parameter_type = typename QPropertyData< T >::parameter_type |
using | rvalue_ref = typename QPropertyData< T >::rvalue_ref |
using | arrow_operator_result = typename QPropertyData< T >::arrow_operator_result |
Public Types inherited from QPropertyData< T > | |
using | value_type = T |
using | parameter_type = std::conditional_t< UseReferences, const T &, T > |
using | rvalue_ref = typename std::conditional_t< UseReferences, T &&, DisableRValueRefs > |
using | arrow_operator_result = std::conditional_t< std::is_pointer_v< T >, const T &, std::conditional_t< QTypeTraits::is_dereferenceable_v< T >, const T &, void > > |
Related Functions | |
(Note that these are not member functions.) | |
void | beginPropertyUpdateGroup () |
void | endPropertyUpdateGroup () |
Additional Inherited Members | |
Protected Attributes inherited from QPropertyData< T > | |
T | val = T() |
Static Protected Attributes inherited from QPropertyData< T > | |
static constexpr bool | UseReferences = !(std::is_arithmetic_v<T> || std::is_enum_v<T> || std::is_pointer_v<T>) |
The QProperty class is a template class that enables automatic property bindings.
\inmodule QtCore
QProperty<T> is one of the classes implementing \l {Qt Bindable Properties}. It is a container that holds an instance of T. You can assign a value to it and you can read it via the value() function or the T conversion operator. You can also tie the property to an expression that computes the value dynamically, the binding expression. It is represented as a C++ lambda and can be used to express relationships between different properties in your application.
Definition at line 349 of file qproperty.h.
using QProperty< T >::arrow_operator_result = typename QPropertyData<T>::arrow_operator_result |
Definition at line 365 of file qproperty.h.
using QProperty< T >::parameter_type = typename QPropertyData<T>::parameter_type |
Definition at line 363 of file qproperty.h.
using QProperty< T >::rvalue_ref = typename QPropertyData<T>::rvalue_ref |
Definition at line 364 of file qproperty.h.
using QProperty< T >::value_type = typename QPropertyData<T>::value_type |
Definition at line 362 of file qproperty.h.
Constructs a property with a default constructed instance of T.
|
inlineexplicit |
Definition at line 368 of file qproperty.h.
|
inlineexplicit |
Definition at line 369 of file qproperty.h.
|
inlineexplicit |
Constructs a property that is tied to the provided binding expression. The first time the property value is read, the binding is evaluated. Whenever a dependency of the binding changes, the binding will be re-evaluated the next time the value of this property is read.
Definition at line 370 of file qproperty.h.
|
inlineexplicit |
Definition at line 375 of file qproperty.h.
Destroys the property.
|
inline |
Subscribes the given functor f as a callback that is called whenever the value of the property changes.
The callback f is expected to be a type that has a plain call operator () without any parameters. This means that you can provide a C++ lambda expression, a std::function or even a custom struct with a call operator.
The returned property change handler object keeps track of the subscription. When it goes out of scope, the callback is unsubscribed.
This method is in some cases easier to use than onValueChanged(), as the returned object is not a template. It can therefore more easily be stored, e.g. as a member in a class.
Definition at line 497 of file qproperty.h.
|
inline |
Returns the binding expression that is associated with this property. A default constructed QPropertyBinding<T> will be returned if no such association exists.
Definition at line 471 of file qproperty.h.
|
inline |
Definition at line 503 of file qproperty.h.
Definition at line 469 of file qproperty.h.
|
inline |
Registers the given functor f as a callback that shall be called whenever the value of the property changes. On each value change, the handler is either called immediately, or deferred, depending on the context.
The callback f is expected to be a type that has a plain call operator () without any parameters. This means that you can provide a C++ lambda expression, a std::function or even a custom struct with a call operator.
The returned property change handler object keeps track of the registration. When it goes out of scope, the callback is de-registered.
Definition at line 482 of file qproperty.h.
|
inline |
|
inline |
|
inline |
|
inline |
Assigns newValue to this property and returns a reference to this QProperty.
Definition at line 437 of file qproperty.h.
|
inline |
Associates the value of this property with the provided newBinding expression and returns the previously associated binding. The first time the property value is read, the binding is evaluated. Whenever a dependency of the binding changes, the binding will be re-evaluated the next time the value of this property is read.
Definition at line 443 of file qproperty.h.
|
inline |
This is an overloaded member function, provided for convenience. It differs from the above function only in what argument(s) it accepts.
Associates the value of this property with the provided newBinding expression. The first time the property value is read, the binding is evaluated. Whenever a dependency of the binding changes, the binding will be re-evaluated the next time the value of this property is read.
Returns true if the type of this property is the same as the type the binding function returns; false otherwise.
Definition at line 448 of file qproperty.h.
|
inline |
|
inline |
Assigns newValue to this property and removes the property's associated binding, if present.
Definition at line 422 of file qproperty.h.
|
inline |
|
inline |
Subscribes the given functor f as a callback that is called immediately and whenever the value of the property changes in the future. On each value change, the handler is either called immediately, or deferred, depending on the context.
The callback f is expected to be a type that can be copied and has a plain call operator() without any parameters. This means that you can provide a C++ lambda expression, a std::function or even a custom struct with a call operator.
The returned property change handler object keeps track of the subscription. When it goes out of scope, the callback is unsubscribed.
Definition at line 489 of file qproperty.h.
|
inline |
Disassociates the binding expression from this property and returns it. After calling this function, the value of the property will only change if you assign a new value to it, or when a new binding is set.
Definition at line 476 of file qproperty.h.
Returns the value of the property. This may evaluate a binding expression that is tied to this property, before returning the value.
Definition at line 385 of file qproperty.h.
|
related |
Marks the beginning of a property update group. Inside this group, changing a property does neither immediately update any dependent properties nor does it trigger change notifications. Those are instead deferred until the group is ended by a call to endPropertyUpdateGroup.
Groups can be nested. In that case, the deferral ends only after the outermost group has been ended.
Definition at line 223 of file qproperty.cpp.
|
related |
Ends a property update group. If the outermost group has been ended, and deferred binding evaluations and notifications happen now.
Definition at line 243 of file qproperty.cpp.