io.qt.core.QBooleanProperty Maven / Gradle / Ivy
/****************************************************************************
**
** Copyright (C) 2009-2022 Dr. Peter Droste, Omix Visualization GmbH & Co. KG. All rights reserved.
**
** This file is part of Qt Jambi.
**
** ** $BEGIN_LICENSE$
** GNU Lesser General Public License Usage
** This file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** GNU General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the
** packaging of this file. Please review the following information to
** ensure the GNU General Public License version 3.0 requirements will be
** met: http://www.gnu.org/copyleft/gpl.html.
** $END_LICENSE$
**
** This file is provided AS IS with NO WARRANTY OF ANY KIND, INCLUDING THE
** WARRANTY OF DESIGN, MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
**
****************************************************************************/
package io.qt.core;
import io.qt.QtPrimitiveType;
import io.qt.QtUninvokable;
/**
* QBooleanProperty is primitive-typed version of QProperty<Boolean>.
* @see QProperty
*/
public final class QBooleanProperty extends QBooleanPropertyData {
static boolean checkType(QMetaType metaType){
return metaType!=null && metaType.id()==QMetaType.Type.Bool.value();
}
/**
* Constructs a boolean-typed property.
*/
public QBooleanProperty() {
super();
}
/**
* Constructs a boolean-typed property with the provided initialValue.
* @param initialValue
*/
public QBooleanProperty(boolean initialValue) {
super(initialValue);
}
/**
* Constructs a boolean-typed property with the provided binding.
* @param binding
*/
public QBooleanProperty(QBooleanPropertyBinding binding) {
super();
d.setBinding(binding, this);
}
/**
* Constructs a boolean-typed property with the provided binding.
* @param binding
*/
public QBooleanProperty(QPropertyBinding<@QtPrimitiveType Boolean> binding) {
super();
if(checkType(binding.valueMetaType()))
d.setBinding(binding, this);
}
/**
* Constructs a boolean-typed property bound to the provided functor.
* @param functor
*/
public QBooleanProperty(java.util.function.BooleanSupplier functor) {
this(new QBooleanPropertyBinding(functor));
}
/**
* Returns the value of the property. This may evaluate a binding expression that is tied to this property, before returning the value.
* @return value
*/
@QtUninvokable
public boolean value()
{
if (d.hasBinding())
d.evaluateIfDirty(this);
d.registerWithCurrentlyEvaluatingBinding();
return this.getValueBypassingBindings();
}
/**
* Assigns newValue to this property and removes the property's associated binding, if present.
* @param newValue
*/
@QtUninvokable
public void setValue(boolean newValue)
{
d.removeBinding();
if (this.setValueBypassingBindings(newValue))
d.notifyObservers(this);
}
/**
* 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.
* @param newBinding
* @return oldBinding
*/
@QtUninvokable
public QBooleanPropertyBinding setBinding(QBooleanPropertyBinding newBinding)
{
QUntypedPropertyBinding oldBinding = d.setBinding(newBinding, this);
d.notifyObservers(this);
if(oldBinding instanceof QBooleanPropertyBinding)
return (QBooleanPropertyBinding)oldBinding;
else
return new QBooleanPropertyBinding(oldBinding);
}
/**
* Associates the value of this property with the provided newBinding expression and returns the previously associated binding.
* The binding's value type ({@link QUntypedPropertyBinding#valueMetaType()}) has to be boolean,
* 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.
* @param newBinding
* @return oldBinding
*/
@QtUninvokable
public QBooleanPropertyBinding setBinding(QPropertyBinding<@QtPrimitiveType Boolean> newBinding)
{
if(!io.qt.core.QBooleanProperty.checkType(newBinding.valueMetaType()))
return new QBooleanPropertyBinding();
QUntypedPropertyBinding oldBinding = d.setBinding(newBinding, this);
d.notifyObservers(this);
if(oldBinding instanceof QBooleanPropertyBinding)
return (QBooleanPropertyBinding)oldBinding;
else
return new QBooleanPropertyBinding(oldBinding);
}
/**
* Associates the value of this property with the provided newBinding expression.
* The binding's value type ({@link QUntypedPropertyBinding#valueMetaType()}) has to be boolean,
* otherwise the property remains unchanged and the method returns false.
* 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.
* @param newBinding
* @return true if types match, false otherwise.
*/
@QtUninvokable
public boolean setBinding(QUntypedPropertyBinding newBinding)
{
if(io.qt.core.QBooleanProperty.checkType(newBinding.valueMetaType())) {
d.setBinding(newBinding, this);
d.notifyObservers(this);
return true;
}else {
return false;
}
}
/**
* 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 {@link java.util.function.BooleanSupplier#getAsBoolean()} of functor.
* Whenever a dependency of the binding changes, the binding will be re-evaluated the next time the value of this property is read.
* @param functor
* @return oldBinding
*/
@QtUninvokable
public QBooleanPropertyBinding setBinding(java.util.function.BooleanSupplier functor)
{
return setBinding(new QBooleanPropertyBinding(functor));
}
@QtUninvokable
private QBooleanPropertyBinding makeBinding()
{
return new QBooleanPropertyBinding(this::value);
}
/**
* Checks if the property has a binding.
* @return true if the property has a binding, false otherwise.
*/
@QtUninvokable
public boolean hasBinding() { return d.hasBinding(); }
/**
* Returns the binding expression that is associated with this property.
* A default constructed {@link QBooleanPropertyBinding} will be returned if no such association exists.
* @return binding
*/
@QtUninvokable
public QBooleanPropertyBinding binding()
{
return new QBooleanPropertyBinding(this);
}
/**
* 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.
* @return the removed binding
*/
@QtUninvokable
public QBooleanPropertyBinding takeBinding()
{
return new QBooleanPropertyBinding(d.setBinding(new QBooleanPropertyBinding(), this));
}
/**
* 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 {@link QPropertyChangeHandler} instance exists,
* the callback remains installed. When the garbage collection deletes the instance, the callback is de-registered.
* @param f
* @return property change handler
* @see QPropertyChangeHandler
*/
@QtUninvokable
public QPropertyChangeHandler onValueChanged(Runnable f)
{
return new QPropertyChangeHandler(d, f);
}
/**
* Subscribes the given functor f as a callback that is called immediately and whenever the value of the property changes in the future.
* @param f
* @return property change handler
* @see QPropertyChangeHandler
* @see #onValueChanged(Runnable)
*/
@QtUninvokable
public QPropertyChangeHandler subscribe(Runnable f)
{
f.run();
return onValueChanged(f);
}
/**
* 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 {@link QPropertyNotifier} instance exists,
* the callback remains installed. When the garbage collection deletes the instance, the callback is de-registered.
* @param f
* @return property notifier
* @see QPropertyNotifier
*/
@io.qt.QtUninvokable
public QPropertyNotifier addNotifier(Runnable f)
{
return new QPropertyNotifier(d, f);
}
@QtUninvokable
QPropertyBindingData bindingData() { return d; }
private final QPropertyBindingData d = new QPropertyBindingData();
}