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

Go to download
/****************************************************************************
**
** 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.QtUninvokable;

/**
 * The QPropertyData class is a helper class for properties with automatic property bindings.
 * Java wrapper for Qt class QPropertyData
 * For primitive-typed implementations see:
 * 
 * {@link QBooleanPropertyData}
 * {@link QBytePropertyData}
 * {@link QShortPropertyData}
 * {@link QIntPropertyData}
 * {@link QLongPropertyData}
 * {@link QFloatPropertyData}
 * {@link QDoublePropertyData}
 * {@link QCharPropertyData}
 * 
 */
public abstract class QPropertyData extends QUntypedPropertyData {

	public QPropertyData() {
		super();
	}

	QPropertyData(QPrivateConstructor p) {
		super(p);
	}

	abstract QMetaType valueMetaType();
	
    /**
     * Returns the data stored in this property.
     * Note: As this will bypass any binding evaluation it might return an outdated value if a binding is set on this property. 
     * Using this method will also not register the property access with any currently executing binding.
     * @return value bypassing bindings
     */
	@QtUninvokable
	public abstract T getValueBypassingBindings();
	
    /**
     * Sets the data value stored in this property to val.
     * Note: Using this method will bypass any potential binding registered for this property.
     * @param val
     */
	@QtUninvokable
	public abstract boolean setValueBypassingBindings(T val);
}