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

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi Show documentation
QtJambi base module containing QtCore, QtGui and QtWidgets.
There is a newer version: 6.8.2
/****************************************************************************
**
** 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;

/**
 * QFloatBindable is primitive-typed version of QBindable<Float>.
 * @see QBindable
 */
public final class QFloatBindable extends QUntypedBindable {

	private QFloatBindable(QPrivateConstructor p) {
		super(p);
	}

	/**
	 * Creates a new float-typed invalid bindable.
	 */
	public QFloatBindable() {
		super(null, null);
	}
	
	/**
	 * Creates a copy of the provided bindable. 
	 * If the type of the other bindable is not float it remains invalid.
	 * @param other
	 */
	public QFloatBindable(QUntypedBindable other) {
		super(other.data(), other.iface());
		check();
	}
	
	private void check() {
		QBindableInterface iface = iface();
		if(iface!=null) {
			QMetaType metaType = iface.metaType();
			if(metaType==null 
					|| metaType.sizeOf()!=4
					|| (metaType.id()!=QMetaType.Type.Float.value()
						&& metaType.id()!=QMetaType.Type.Double.value())) {
				setIface(null);
				setData(null);
			}
		}
	}

	QFloatBindable(QUntypedPropertyData d, QBindableInterface i) {
		super(d, i);
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * @param property
	 */
	public QFloatBindable(QFloatProperty property) {
		super(property, bindableInterface(0));
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * @param property
	 */
	public QFloatBindable(QObject.QFloatProperty property) {
		super(property, bindableInterface(1));
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * @param property
	 */
	public QFloatBindable(QObject.QComputedFloatProperty property) {
		super(property, bindableInterface(2));
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * If the type of the property is not float an {@link IllegalArgumentException} is thrown.
	 * @param property
	 */
	public QFloatBindable(QProperty<@QtPrimitiveType Float> property) {
		super(property, QBindable.bindableInterface(property.valueMetaType().id(), 0));
		check();
		if(iface()==null)
			throw new IllegalArgumentException("Given QProperty is not of float type.");
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * If the type of the property is not float an {@link IllegalArgumentException} is thrown.
	 * @param property
	 */
	public QFloatBindable(QObject.QProperty<@QtPrimitiveType Float> property) {
		super(property, QBindable.bindableInterface(property.valueMetaType().id(), 1));
		check();
		if(iface()==null)
			throw new IllegalArgumentException("Given QProperty is not of float type.");
	}
	
	/**
	 * Creates a new bindable from provided property.
	 * If the type of the property is not float an {@link IllegalArgumentException} is thrown.
	 * @param property
	 */
	public QFloatBindable(QObject.QComputedProperty<@QtPrimitiveType Float> property) {
		super(property, bindableInterface(2));
		check();
		if(iface()==null)
			throw new IllegalArgumentException("Given QProperty is not of float type.");
	}
	
	static native QBindableInterface bindableInterface(int propertyType);

	/**
	 * Creates a binding to the underlying property.
	 */
	@QtUninvokable
	@Override
	public QFloatPropertyBinding makeBinding()
    {
		QUntypedPropertyBinding binding = super.makeBinding();
		if(binding instanceof QFloatPropertyBinding) {
			return (QFloatPropertyBinding)binding;
		}else {
			return new QFloatPropertyBinding(binding);
		}
    }
	
    /**
     * Returns the binding expression that is associated with the underlying property. 
     * A default constructed {@link QFloatPropertyBinding} will be returned if no such association exists.
     * @return binding
     */
	@QtUninvokable
	@Override
    public QFloatPropertyBinding binding()
    {
		QUntypedPropertyBinding binding = super.binding();
		if(binding instanceof QFloatPropertyBinding) {
			return (QFloatPropertyBinding)binding;
		}else {
			return new QFloatPropertyBinding(binding);
		}
    }
    
	@QtUninvokable
	public QFloatPropertyBinding setBinding(QFloatPropertyBinding binding)
    {
		QUntypedPropertyBinding oldBinding = super.overrideBinding(binding);
		if(oldBinding instanceof QFloatPropertyBinding) {
			return (QFloatPropertyBinding)oldBinding;
		}else {
			return new QFloatPropertyBinding(oldBinding);
		}
    }
    
	@QtUninvokable
	public QFloatPropertyBinding setBinding(QPropertyBinding<@QtPrimitiveType Float> binding)
    {
		if(binding!=null && !QFloatProperty.checkType(binding.valueMetaType()))
			return new QFloatPropertyBinding();
		QUntypedPropertyBinding oldBinding = super.overrideBinding(binding);
		if(oldBinding instanceof QFloatPropertyBinding) {
			return (QFloatPropertyBinding)oldBinding;
		}else {
			return new QFloatPropertyBinding(oldBinding);
		}
    }
	
	@QtUninvokable
	public QFloatPropertyBinding setBinding(io.qt.QtUtilities.FloatSupplier functor)
    {
		return setBinding(new QFloatPropertyBinding(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 QFloatPropertyBinding takeBinding()
    {
        return setBinding(new QFloatPropertyBinding());
    }
    
	/**
	 * 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 float value() {
        return value(QtJambi_LibraryUtilities.internal.nativeId(this.iface()), QtJambi_LibraryUtilities.internal.nativeId(this.data()));
    }
    
	/**
	 * Assigns newValue to the underlying property and removes the property's associated binding, if present.
	 * @param newValue
	 */
    @io.qt.QtUninvokable
    public final void setValue(float value) {
        setValue(QtJambi_LibraryUtilities.internal.nativeId(this.iface()), QtJambi_LibraryUtilities.internal.nativeId(this.data()), value);
    }
    
    @io.qt.QtUninvokable
    static native float value(long ifaceId, long dataId);
    
    @io.qt.QtUninvokable
    static native void setValue(long ifaceId, long dataId, float value);
}