All Downloads are FREE. Search and download functionalities are using the official Maven repository.

io.qt.core.QBooleanBindable Maven / Gradle / Ivy

There is a newer version: 6.8.0
Show newest version
/****************************************************************************
**
** Copyright (C) 2009-2024 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.NonNull;
import io.qt.QtPrimitiveType;
import io.qt.QtUninvokable;
import io.qt.StrictNonNull;

/**
 * QBooleanBindable is primitive-typed version of QBindable<Boolean>.
 * @see QBindable
 */
public final class QBooleanBindable extends QUntypedBindable {
	
	private QBooleanBindable(QPrivateConstructor p) {
		super(p);
	}

	/**
	 * Creates a new boolean-typed invalid bindable.
	 */
	public QBooleanBindable() {
		super(null, null);
	}
	
	/**
	 * Creates a copy of the provided bindable. 
	 * If the type of the other bindable is not boolean it remains invalid.
	 * @param other
	 */
	public QBooleanBindable(@StrictNonNull QUntypedBindable other) {
		super(other.data(), other.iface());
		check();
	}
	
	private void check() {
		QBindableInterface iface = iface();
		if(iface!=null) {
			QMetaType metaType = iface.metaType();
			if(!QBooleanProperty.checkType(metaType)
					&& metaType.id()!=QMetaType.Type.QVariant.value()) {
				setIface(null);
				setData(null);
			}
		}
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * @param property
	 */
	public QBooleanBindable(@StrictNonNull QBooleanProperty property) {
		super(property, bindableInterface(0));
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * @param property
	 */
	public QBooleanBindable(QObject.@StrictNonNull QBooleanProperty property) {
		super(property, bindableInterface(1));
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * @param property
	 */
	public QBooleanBindable(QObject.@StrictNonNull QComputedBooleanProperty property) {
		super(property, bindableInterface(2));
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * If the type of the property is not boolean an {@link IllegalArgumentException} is thrown.
	 * @param property
	 */
	public QBooleanBindable(@StrictNonNull QProperty<@NonNull@QtPrimitiveType Boolean> property) {
		super(property, QBindable.bindableInterface(property.valueMetaType().id(), 0));
		check();
		if(iface()==null)
			throw new IllegalArgumentException("Given QProperty is not of boolean type.");
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * If the type of the property is not boolean an {@link IllegalArgumentException} is thrown.
	 * @param property
	 */
	public QBooleanBindable(QObject.@StrictNonNull QProperty<@NonNull@QtPrimitiveType Boolean> property) {
		super(property, QBindable.bindableInterface(property.valueMetaType().id(), 1));
		check();
		if(iface()==null)
			throw new IllegalArgumentException("Given QProperty is not of boolean type.");
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * If the type of the property is not boolean an {@link IllegalArgumentException} is thrown.
	 * @param property
	 */
	public QBooleanBindable(QObject.@StrictNonNull QComputedProperty<@NonNull@QtPrimitiveType Boolean> property) {
		super(property, QBindable.bindableInterface(property.valueMetaType().id(), 2));
		check();
		if(iface()==null)
			throw new IllegalArgumentException("Given QProperty is not of boolean type.");
	}
	
	/**
	 * Creates a new bindable from provided meta property of given object.
	 * If the type of the property is not boolean an {@link IllegalArgumentException} is thrown.
	 * @param object
	 * @param property
	 */
	public QBooleanBindable(@StrictNonNull QObject object, @StrictNonNull String property) {
		this(object, object.metaObject().property(property));
	}
	
	/**
	 * Creates a new bindable from provided meta property of given object.
	 * If the type of the property is not boolean an {@link IllegalArgumentException} is thrown.
	 * @param object
	 * @param property
	 */
	public QBooleanBindable(@StrictNonNull QObject object, @StrictNonNull QMetaProperty property) {
		super(object, property, QBindable.bindableInterface(property));
		check();
		if(iface()==null)
			throw new IllegalArgumentException("Given QMetaProperty is not of boolean type.");
	}
	
	static native QBindableInterface bindableInterface(int propertyType);

	QBooleanBindable(QUntypedPropertyData d, QBindableInterface i) {
		super(d, i);
	}

	/**
	 * Creates a binding to the underlying property.
	 */
	@QtUninvokable
	@Override
	public @NonNull QBooleanPropertyBinding makeBinding()
    {
		QUntypedPropertyBinding binding = super.makeBinding();
		if(binding instanceof QBooleanPropertyBinding) {
			return (QBooleanPropertyBinding)binding;
		}else {
			return new QBooleanPropertyBinding(binding);
		}
    }
	
    /**
     * Returns the binding expression that is associated with the underlying property. 
     * A default constructed {@link QBooleanPropertyBinding} will be returned if no such association exists.
     * @return binding
     */
	@QtUninvokable
	@Override
    public @NonNull QBooleanPropertyBinding binding()
    {
		QUntypedPropertyBinding binding = super.binding();
		if(binding instanceof QBooleanPropertyBinding) {
			return (QBooleanPropertyBinding)binding;
		}else {
			return new QBooleanPropertyBinding(binding);
		}
    }
    
	@QtUninvokable
	public @NonNull QBooleanPropertyBinding setBinding(@StrictNonNull QBooleanPropertyBinding binding)
    {
		QUntypedPropertyBinding oldBinding = super.overrideBinding(binding);
		if(oldBinding instanceof QBooleanPropertyBinding) {
			return (QBooleanPropertyBinding)oldBinding;
		}else {
			return new QBooleanPropertyBinding(oldBinding);
		}
    }
    
	@QtUninvokable
	public @NonNull QBooleanPropertyBinding setBinding(@StrictNonNull QPropertyBinding<@NonNull@QtPrimitiveType Boolean> binding)
    {
		if(binding!=null && !QBooleanProperty.checkType(binding.valueMetaType()))
			return new QBooleanPropertyBinding();
		QUntypedPropertyBinding oldBinding = super.overrideBinding(binding);
		if(oldBinding instanceof QBooleanPropertyBinding) {
			return (QBooleanPropertyBinding)oldBinding;
		}else {
			return new QBooleanPropertyBinding(oldBinding);
		}
    }
	
	@QtUninvokable
	public @NonNull QBooleanPropertyBinding setBinding(java.util.function.@StrictNonNull BooleanSupplier functor)
    {
		return setBinding(new QBooleanPropertyBinding(functor));
    }
	
	/**
	 * 

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 @NonNull QBooleanPropertyBinding takeBinding() { return setBinding(new QBooleanPropertyBinding()); } /** * Returns the value of the underlying property. This may evaluate a binding expression that is tied to the property, before returning the value. * @return value */ @io.qt.QtUninvokable public final boolean value() { return value(QtJambi_LibraryUtilities.internal.nativeId(this.iface()), QtJambi_LibraryUtilities.internal.nativeId(this.data())); } /** *

Assigns value to the underlying property and removes the property's associated binding, if present.

* @param value */ @io.qt.QtUninvokable public final void setValue(boolean value) { setValue(QtJambi_LibraryUtilities.internal.nativeId(this.iface()), QtJambi_LibraryUtilities.internal.nativeId(this.data()), value); } @io.qt.QtUninvokable static native boolean value(long ifaceId, long dataId); @io.qt.QtUninvokable static native void setValue(long ifaceId, long dataId, boolean value); }




© 2015 - 2024 Weber Informatics LLC | Privacy Policy