- All Implemented Interfaces:
QtObjectInterface
- See Also:
-
Constructor Summary
ConstructorDescriptionConstructs aboolean
-typed property.QBooleanProperty
(boolean initialValue) Constructs aboolean
-typed property with the provided initialValue.QBooleanProperty
(QBooleanPropertyBinding binding) Constructs aboolean
-typed property with the provided binding.Constructs aboolean
-typed property with the provided binding.QBooleanProperty
(BooleanSupplier functor) Constructs aboolean
-typed property bound to the providedfunctor
. -
Method Summary
Modifier and TypeMethodDescriptionRegisters the given functor f as a callback that shall be called whenever the value of the bindable changes.binding()
Returns the binding expression that is associated with this property.boolean
Checks if the property has a binding.Registers the given functor f as a callback that shall be called whenever the value of the property changes.setBinding
(QBooleanPropertyBinding newBinding) Associates the value of this property with the providednewBinding
expression and returns the previously associated binding.setBinding
(QPropertyBinding<@QtPrimitiveType Boolean> newBinding) Associates the value of this property with the providednewBinding
expression and returns the previously associated binding.boolean
setBinding
(QUntypedPropertyBinding newBinding) Associates the value of this property with the providednewBinding
expression.setBinding
(BooleanSupplier functor) Associates the value of this property with the providedfunctor
and returns the previously associated binding.void
setValue
(boolean newValue) Assigns newValue to this property and removes the property's associated binding, if present.Subscribes the given functor f as a callback that is called immediately and whenever the value of the property changes in the future.Disassociates the binding expression from this property and returns it.boolean
value()
Returns the value of the property.Methods inherited from class io.qt.core.QBooleanPropertyData
getValueBypassingBindings, setValueBypassingBindings
Methods inherited from class io.qt.QtObject
dispose, equals, isDisposed
-
Constructor Details
-
QBooleanProperty
public QBooleanProperty()Constructs aboolean
-typed property. -
QBooleanProperty
public QBooleanProperty(boolean initialValue) Constructs aboolean
-typed property with the provided initialValue.- Parameters:
initialValue
-
-
QBooleanProperty
Constructs aboolean
-typed property with the provided binding.- Parameters:
binding
-
-
QBooleanProperty
Constructs aboolean
-typed property with the provided binding.- Parameters:
binding
-
-
QBooleanProperty
Constructs a
boolean
-typed property bound to the providedfunctor
.- Parameters:
functor
-
-
-
Method Details
-
value
Returns the value of the property. This may evaluate a binding expression that is tied to this property, before returning the value.- Returns:
- value
-
setValue
Assigns newValue to this property and removes the property's associated binding, if present.
- Parameters:
newValue
-
-
setBinding
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.
- Parameters:
newBinding
-- Returns:
- oldBinding
-
setBinding
@QtUninvokable public QBooleanPropertyBinding setBinding(QPropertyBinding<@QtPrimitiveType Boolean> newBinding) Associates the value of this property with the provided
newBinding
expression and returns the previously associated binding.The binding's value type (
QUntypedPropertyBinding.valueMetaType()
) has to beboolean
, otherwise the property remains unchanged.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.
- Parameters:
newBinding
-- Returns:
- oldBinding
-
setBinding
Associates the value of this property with the provided
newBinding
expression.The binding's value type (
QUntypedPropertyBinding.valueMetaType()
) has to beboolean
, otherwise the property remains unchanged and the method returnsfalse
.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.
- Parameters:
newBinding
-- Returns:
- true if types match, false otherwise.
-
setBinding
Associates the value of this property with the provided
functor
and returns the previously associated binding.The first time the property value is read, the binding is evaluated by invoking
BooleanSupplier.getAsBoolean()
offunctor
. Whenever a dependency of the binding changes, the binding will be re-evaluated the next time the value of this property is read.- Parameters:
functor
-- Returns:
- oldBinding
-
hasBinding
Checks if the property has a binding.- Returns:
- true if the property has a binding, false otherwise.
-
binding
Returns the binding expression that is associated with this property. A default constructedQBooleanPropertyBinding
will be returned if no such association exists.- Returns:
- binding
-
takeBinding
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.
- Returns:
- the removed binding
-
onValueChanged
Registers the given functor f as a callback that shall be called whenever the value of the property changes.
The returned property change handler object keeps track of the registration. As long as the change handler is alive i.e. as long as a reference to the
QPropertyChangeHandler
instance exists, the callback remains installed. When the garbage collection deletes the instance, the callback is de-registered.- Parameters:
f
-- Returns:
- property change handler
- See Also:
-
subscribe
Subscribes the given functor f as a callback that is called immediately and whenever the value of the property changes in the future.- Parameters:
f
-- Returns:
- property change handler
- See Also:
-
addNotifier
Registers the given functor f as a callback that shall be called whenever the value of the bindable changes.
The returned property notifier object keeps track of the registration. As long as the notifier is alive i.e. as long as a reference to the
QPropertyNotifier
instance exists, the callback remains installed. When the garbage collection deletes the instance, the callback is de-registered.- Parameters:
f
-- Returns:
- property notifier
- See Also:
-