io.qt.positioning.QGeoPositionInfoSource Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi-positioning Show documentation
Provides access to position, satellite and area monitoring classes.
There is a newer version: 6.8.0
package io.qt.positioning;

import io.qt.*;


/**
 * Abstract base class for the distribution of positional updates
 * Java wrapper for Qt class QGeoPositionInfoSource
 */
public abstract class QGeoPositionInfoSource extends io.qt.core.QObject
{
    static {
        QtJambi_LibraryUtilities.initialize();
    }
    
    /**
     * This variable stores the meta-object for the class.
     */
    public static final io.qt.core.@NonNull QMetaObject staticMetaObject = io.qt.core.QMetaObject.forType(QGeoPositionInfoSource.class);
    
    @NativeAccess
    private static final class ConcreteWrapper extends QGeoPositionInfoSource {
        
        @NativeAccess
        private ConcreteWrapper(QPrivateConstructor p) { super(p); }
        
        @Override
        @QtUninvokable
        public io.qt.positioning.QGeoPositionInfoSource.@NonNull Error error(){
            return io.qt.positioning.QGeoPositionInfoSource.Error.resolve(error_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
        }
        @QtUninvokable
        private native int error_native_constfct(long __this__nativeId);
        
        
        @Override
        @QtUninvokable
        public io.qt.positioning.@NonNull QGeoPositionInfo lastKnownPosition(boolean fromSatellitePositioningMethodsOnly){
            return lastKnownPosition_native_bool_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), fromSatellitePositioningMethodsOnly);
        }
        @QtUninvokable
        private native io.qt.positioning.QGeoPositionInfo lastKnownPosition_native_bool_constfct(long __this__nativeId, boolean fromSatellitePositioningMethodsOnly);
        
        
        @Override
        @QtUninvokable
        public int minimumUpdateInterval(){
            return minimumUpdateInterval_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
        }
        @QtUninvokable
        private native int minimumUpdateInterval_native_constfct(long __this__nativeId);
        
        
        @Override
        public void requestUpdate(int timeout){
            requestUpdate_native_int(QtJambi_LibraryUtilities.internal.nativeId(this), timeout);
        }
        private native void requestUpdate_native_int(long __this__nativeId, int timeout);
        
        
        @Override
        public void startUpdates(){
            startUpdates_native(QtJambi_LibraryUtilities.internal.nativeId(this));
        }
        private native void startUpdates_native(long __this__nativeId);
        
        
        @Override
        public void stopUpdates(){
            stopUpdates_native(QtJambi_LibraryUtilities.internal.nativeId(this));
        }
        private native void stopUpdates_native(long __this__nativeId);
        
        
        @Override
        @QtUninvokable
        public io.qt.positioning.QGeoPositionInfoSource.@NonNull PositioningMethods supportedPositioningMethods(){
            return new io.qt.positioning.QGeoPositionInfoSource.PositioningMethods(supportedPositioningMethods_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
        }
        @QtUninvokable
        private native int supportedPositioningMethods_native_constfct(long __this__nativeId);
        
    }
    
    /**
     * Java wrapper for Qt enum QGeoPositionInfoSource::Error
     */
    public enum Error implements QtEnumerator {
        /**
         * Representing QGeoPositionInfoSource::AccessError
         */
        AccessError(0),
        /**
         * Representing QGeoPositionInfoSource::ClosedError
         */
        ClosedError(1),
        /**
         * Representing QGeoPositionInfoSource::UnknownSourceError
         */
        UnknownSourceError(2),
        /**
         * Representing QGeoPositionInfoSource::NoError
         */
        NoError(3),
        /**
         * Representing QGeoPositionInfoSource::UpdateTimeoutError
         */
        UpdateTimeoutError(4);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

        private Error(int value) {
            this.value = value;
        }

        /**
         * {@inheritDoc}
         */
        public int value() {
            return value;
        }

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull Error resolve(int value) {
            switch (value) {
            case 0: return AccessError;
            case 1: return ClosedError;
            case 2: return UnknownSourceError;
            case 3: return NoError;
            case 4: return UpdateTimeoutError;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * Java wrapper for Qt enum QGeoPositionInfoSource::PositioningMethod
     * 
     * @see PositioningMethods
     */
    public enum PositioningMethod implements QtFlagEnumerator {
        /**
         * Representing QGeoPositionInfoSource::NoPositioningMethods
         */
        NoPositioningMethods(0),
        /**
         * Representing QGeoPositionInfoSource::SatellitePositioningMethods
         */
        SatellitePositioningMethods(255),
        /**
         * Representing QGeoPositionInfoSource::NonSatellitePositioningMethods
         */
        NonSatellitePositioningMethods(-256),
        /**
         * Representing QGeoPositionInfoSource::AllPositioningMethods
         */
        AllPositioningMethods(-1);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

        private PositioningMethod(int value) {
            this.value = value;
        }

        /**
         * {@inheritDoc}
         */
        public int value() {
            return value;
        }

        /**
         * Create a QFlags of the enum entry.
         * @return QFlags
         */
        public @NonNull PositioningMethods asFlags() {
            return new PositioningMethods(value);
        }

        /**
         * Combines this entry with other enum entry.
         * @param e enum entry
         * @return new flag
         */
        public @NonNull PositioningMethods combined(@NonNull PositioningMethod e) {
            return asFlags().setFlag(e, true);
        }

        /**
         * Excludes other enum entry from a flag of this entry.
         * @param e enum entry
         * @return new flag
         */
        public @NonNull PositioningMethods cleared(@NonNull PositioningMethod e) {
            return asFlags().setFlag(e, false);
        }

        /**
         * Creates a new {@link PositioningMethods} from the entries.
         * @param values entries
         * @return new flag
         */
        public static @NonNull PositioningMethods flags(@Nullable PositioningMethod @NonNull... values) {
            return new PositioningMethods(values);
        }

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull PositioningMethod resolve(int value) {
            switch (value) {
            case 0: return NoPositioningMethods;
            case 255: return SatellitePositioningMethods;
            case -256: return NonSatellitePositioningMethods;
            case -1: return AllPositioningMethods;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * {@link QFlags} type for enum {@link PositioningMethod}
     */
    public static final class PositioningMethods extends QFlags implements Comparable {
        private static final long serialVersionUID = 0x5819ac22f39010fdL;
        static {
            QtJambi_LibraryUtilities.initialize();
        }

        /**
         * Creates a new PositioningMethods where the flags in args are set.
         * @param args enum entries
         */
        public PositioningMethods(@Nullable PositioningMethod @NonNull... args){
            super(args);
        }

        /**
         * Creates a new PositioningMethods with given value.
         * @param value
         */
        public PositioningMethods(int value) {
            super(value);
        }

        /**
         * Combines this flags with enum entry.
         * @param e enum entry
         * @return new PositioningMethods
         */
        @Override
        public final @NonNull PositioningMethods combined(@StrictNonNull PositioningMethod e){
            return new PositioningMethods(value() | e.value());
        }

        /**
         * Sets the flag e
         * @param e enum entry
         * @return this
         */
        public final @NonNull PositioningMethods setFlag(@Nullable PositioningMethod e){
            return setFlag(e, true);
        }

        /**
         * Sets or clears the flag flag
         * @param e enum entry
         * @param on set (true) or clear (false)
         * @return this
         */
        public final @NonNull PositioningMethods setFlag(@Nullable PositioningMethod e, boolean on){
            if (on) {
            	setValue(value() | e.value());
            }else {
            	setValue(value() & ~e.value());
            }
            return this;
        }

        /**
         * Returns an array of flag objects represented by this PositioningMethods.
         * @return array of enum entries
         */
        @Override
        public final @NonNull PositioningMethod @NonNull[] flags(){
            return super.flags(PositioningMethod.values());
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public final @NonNull PositioningMethods clone(){
            return new PositioningMethods(value());
        }

        /**
         * {@inheritDoc}
         */
        @Override
        public final int compareTo(@StrictNonNull PositioningMethods other){
            return Integer.compare(value(), other.value());
        }
    }
    

    /**
     * See QGeoPositionInfoSource::errorOccurred(QGeoPositionInfoSource::Error)
     */
    public final @NonNull Signal1 errorOccurred = new Signal1<>();

    /**
     * See QGeoPositionInfoSource::positionUpdated(QGeoPositionInfo)
     */
    public final @NonNull Signal1 positionUpdated = new Signal1<>();

    /**
     * See QGeoPositionInfoSource::supportedPositioningMethodsChanged()
     */
    public final @NonNull Signal0 supportedPositioningMethodsChanged = new Signal0();
    
    /**
     * See QGeoPositionInfoSource::QGeoPositionInfoSource(QObject*)
     */
    public QGeoPositionInfoSource(io.qt.core.@Nullable QObject parent){
        super((QPrivateConstructor)null);
        initialize_native(this, parent);
    }
    
    private native static void initialize_native(QGeoPositionInfoSource instance, io.qt.core.QObject parent);
    
    /**
     * See QGeoPositionInfoSource::bindablePreferredPositioningMethods()
     */
    @QtPropertyBindable(name="preferredPositioningMethods")
    @QtUninvokable
    public final io.qt.core.@NonNull QBindable bindablePreferredPositioningMethods(){
        return bindablePreferredPositioningMethods_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QBindable bindablePreferredPositioningMethods_native(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::bindableUpdateInterval()
     */
    @QtPropertyBindable(name="updateInterval")
    @QtUninvokable
    public final io.qt.core.@NonNull QIntBindable bindableUpdateInterval(){
        return bindableUpdateInterval_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QIntBindable bindableUpdateInterval_native(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::preferredPositioningMethods()const
     */
    @QtPropertyReader(name="preferredPositioningMethods")
    @QtUninvokable
    public final io.qt.positioning.QGeoPositionInfoSource.@NonNull PositioningMethods preferredPositioningMethods(){
        return new io.qt.positioning.QGeoPositionInfoSource.PositioningMethods(preferredPositioningMethods_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int preferredPositioningMethods_native_constfct(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::sourceName()const
     */
    @QtPropertyReader(name="sourceName")
    @QtUninvokable
    public final java.lang.@NonNull String sourceName(){
        return sourceName_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String sourceName_native_constfct(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::updateInterval()const
     */
    @QtPropertyReader(name="updateInterval")
    @QtUninvokable
    public final int updateInterval(){
        return updateInterval_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native int updateInterval_native_constfct(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::backendProperty(QString)const
     */
    @QtUninvokable
    public java.lang.Object backendProperty(java.lang.@NonNull String name){
        return backendProperty_native_cref_QString_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), name);
    }
    
    @QtUninvokable
    private native java.lang.Object backendProperty_native_cref_QString_constfct(long __this__nativeId, java.lang.String name);
    
    /**
     * See QGeoPositionInfoSource::error()const
     */
    @QtUninvokable
    public abstract io.qt.positioning.QGeoPositionInfoSource.@NonNull Error error();
    
    @QtUninvokable
    private native int error_native_constfct(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::lastKnownPosition(bool)const
     */
    @QtUninvokable
    public abstract io.qt.positioning.@NonNull QGeoPositionInfo lastKnownPosition(boolean fromSatellitePositioningMethodsOnly);
    
    @QtUninvokable
    private native io.qt.positioning.QGeoPositionInfo lastKnownPosition_native_bool_constfct(long __this__nativeId, boolean fromSatellitePositioningMethodsOnly);
    
    /**
     * See QGeoPositionInfoSource::minimumUpdateInterval()const
     */
    @QtPropertyReader(name="minimumUpdateInterval")
    @QtUninvokable
    public abstract int minimumUpdateInterval();
    
    @QtUninvokable
    private native int minimumUpdateInterval_native_constfct(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::requestUpdate(int)
     */
    public abstract void requestUpdate(int timeout);
    
    private native void requestUpdate_native_int(long __this__nativeId, int timeout);
    
    /**
     * See QGeoPositionInfoSource::setBackendProperty(QString,QVariant)
     */
    @QtUninvokable
    public boolean setBackendProperty(java.lang.@NonNull String name, java.lang.Object value){
        return setBackendProperty_native_cref_QString_cref_QVariant(QtJambi_LibraryUtilities.internal.nativeId(this), name, value);
    }
    
    @QtUninvokable
    private native boolean setBackendProperty_native_cref_QString_cref_QVariant(long __this__nativeId, java.lang.String name, java.lang.Object value);
    
    /**
     * See QGeoPositionInfoSource::setPreferredPositioningMethods(QGeoPositionInfoSource::PositioningMethods)
     */
    @QtPropertyWriter(name="preferredPositioningMethods")
    @QtUninvokable
    public void setPreferredPositioningMethods(io.qt.positioning.QGeoPositionInfoSource.@NonNull PositioningMethods methods){
        setPreferredPositioningMethods_native_QGeoPositionInfoSource_PositioningMethods(QtJambi_LibraryUtilities.internal.nativeId(this), methods.value());
    }
    
    @QtUninvokable
    private native void setPreferredPositioningMethods_native_QGeoPositionInfoSource_PositioningMethods(long __this__nativeId, int methods);
    
    /**
     * See QGeoPositionInfoSource::setUpdateInterval(int)
     */
    @QtPropertyWriter(name="updateInterval")
    @QtUninvokable
    public void setUpdateInterval(int msec){
        setUpdateInterval_native_int(QtJambi_LibraryUtilities.internal.nativeId(this), msec);
    }
    
    @QtUninvokable
    private native void setUpdateInterval_native_int(long __this__nativeId, int msec);
    
    /**
     * See QGeoPositionInfoSource::startUpdates()
     */
    public abstract void startUpdates();
    
    private native void startUpdates_native(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::stopUpdates()
     */
    public abstract void stopUpdates();
    
    private native void stopUpdates_native(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::supportedPositioningMethods()const
     */
    @QtUninvokable
    public abstract io.qt.positioning.QGeoPositionInfoSource.@NonNull PositioningMethods supportedPositioningMethods();
    
    @QtUninvokable
    private native int supportedPositioningMethods_native_constfct(long __this__nativeId);
    
    /**
     * See QGeoPositionInfoSource::availableSources()
     */
    public native static io.qt.core.@NonNull QStringList availableSources();
    
    /**
     * See QGeoPositionInfoSource::createDefaultSource(QVariantMap,QObject*)
     */
    public static io.qt.positioning.@Nullable QGeoPositionInfoSource createDefaultSource(java.util.@NonNull Map parameters, io.qt.core.@Nullable QObject parent){
        return createDefaultSource_native_cref_QMap_QObject_ptr(parameters, QtJambi_LibraryUtilities.internal.checkedNativeId(parent));
    }
    
    private native static io.qt.positioning.QGeoPositionInfoSource createDefaultSource_native_cref_QMap_QObject_ptr(java.util.Map parameters, long parent);
    
    /**
     * See QGeoPositionInfoSource::createDefaultSource(QObject*)
     */
    public static io.qt.positioning.@Nullable QGeoPositionInfoSource createDefaultSource(io.qt.core.@Nullable QObject parent){
        return createDefaultSource_native_QObject_ptr(QtJambi_LibraryUtilities.internal.checkedNativeId(parent));
    }
    
    private native static io.qt.positioning.QGeoPositionInfoSource createDefaultSource_native_QObject_ptr(long parent);
    
    /**
     * See QGeoPositionInfoSource::createSource(QString,QVariantMap,QObject*)
     */
    public static io.qt.positioning.@Nullable QGeoPositionInfoSource createSource(java.lang.@NonNull String sourceName, java.util.@NonNull Map parameters, io.qt.core.@Nullable QObject parent){
        return createSource_native_cref_QString_cref_QMap_QObject_ptr(sourceName, parameters, QtJambi_LibraryUtilities.internal.checkedNativeId(parent));
    }
    
    private native static io.qt.positioning.QGeoPositionInfoSource createSource_native_cref_QString_cref_QMap_QObject_ptr(java.lang.String sourceName, java.util.Map parameters, long parent);
    
    /**
     * See QGeoPositionInfoSource::createSource(QString,QObject*)
     */
    public static io.qt.positioning.@Nullable QGeoPositionInfoSource createSource(java.lang.@NonNull String sourceName, io.qt.core.@Nullable QObject parent){
        return createSource_native_cref_QString_QObject_ptr(sourceName, QtJambi_LibraryUtilities.internal.checkedNativeId(parent));
    }
    
    private native static io.qt.positioning.QGeoPositionInfoSource createSource_native_cref_QString_QObject_ptr(java.lang.String sourceName, long parent);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QGeoPositionInfoSource(QPrivateConstructor p) { super(p); } 
    
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #preferredPositioningMethods()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.positioning.QGeoPositionInfoSource.@NonNull PositioningMethods getPreferredPositioningMethods() {
        return preferredPositioningMethods();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #sourceName()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getSourceName() {
        return sourceName();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #updateInterval()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final int getUpdateInterval() {
        return updateInterval();
    }
    
    /**
     * Overloaded function for {@link #lastKnownPosition(boolean)}
     *  with fromSatellitePositioningMethodsOnly = false.
     */
    @QtUninvokable
    public final io.qt.positioning.@NonNull QGeoPositionInfo lastKnownPosition() {
        return lastKnownPosition((boolean)false);
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #minimumUpdateInterval()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final int getMinimumUpdateInterval() {
        return minimumUpdateInterval();
    }
    
    /**
     * Overloaded function for {@link #requestUpdate(int)}
     *  with timeout = 0.
     */
    public final void requestUpdate() {
        requestUpdate((int)0);
    }
    
    /**
     * Overloaded function for {@link #setPreferredPositioningMethods(io.qt.positioning.QGeoPositionInfoSource.PositioningMethods)}.
     */
    @QtUninvokable
    public final void setPreferredPositioningMethods(io.qt.positioning.QGeoPositionInfoSource.@NonNull PositioningMethod @NonNull... methods) {
        setPreferredPositioningMethods(new io.qt.positioning.QGeoPositionInfoSource.PositioningMethods(methods));
    }
}