io.qt.widgets.QScroller 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.0
package io.qt.widgets;

import io.qt.*;


/**
 * Enables kinetic scrolling for any scrolling widget or graphics item
 * Java wrapper for Qt class QScroller
 */
public final class QScroller 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(QScroller.class);
    
    /**
     * Java wrapper for Qt enum QScroller::Input
     */
    @QtUnlistedEnum
    public enum Input implements QtEnumerator {
        /**
         * Representing QScroller::InputPress
         */
        InputPress(1),
        /**
         * Representing QScroller::InputMove
         */
        InputMove(2),
        /**
         * Representing QScroller::InputRelease
         */
        InputRelease(3);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

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

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

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull Input resolve(int value) {
            switch (value) {
            case 1: return InputPress;
            case 2: return InputMove;
            case 3: return InputRelease;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * Java wrapper for Qt enum QScroller::ScrollerGestureType
     */
    @QtUnlistedEnum
    public enum ScrollerGestureType implements QtEnumerator {
        /**
         * Representing QScroller::TouchGesture
         */
        TouchGesture(0),
        /**
         * Representing QScroller::LeftMouseButtonGesture
         */
        LeftMouseButtonGesture(1),
        /**
         * Representing QScroller::RightMouseButtonGesture
         */
        RightMouseButtonGesture(2),
        /**
         * Representing QScroller::MiddleMouseButtonGesture
         */
        MiddleMouseButtonGesture(3);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

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

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

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull ScrollerGestureType resolve(int value) {
            switch (value) {
            case 0: return TouchGesture;
            case 1: return LeftMouseButtonGesture;
            case 2: return RightMouseButtonGesture;
            case 3: return MiddleMouseButtonGesture;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * Java wrapper for Qt enum QScroller::State
     */
    public enum State implements QtEnumerator {
        /**
         * Representing QScroller::Inactive
         */
        Inactive(0),
        /**
         * Representing QScroller::Pressed
         */
        Pressed(1),
        /**
         * Representing QScroller::Dragging
         */
        Dragging(2),
        /**
         * Representing QScroller::Scrolling
         */
        Scrolling(3);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

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

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

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull State resolve(int value) {
            switch (value) {
            case 0: return Inactive;
            case 1: return Pressed;
            case 2: return Dragging;
            case 3: return Scrolling;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    

    /**
     * See QScroller::scrollerPropertiesChanged(QScrollerProperties)
     */
    @QtPropertyNotify(name="scrollerProperties")
    public final @NonNull Signal1 scrollerPropertiesChanged = new Signal1<>();

    /**
     * See QScroller::stateChanged(QScroller::State)
     */
    @QtPropertyNotify(name="state")
    public final @NonNull Signal1 stateChanged = new Signal1<>();
    
    /**
     * See QScroller::ensureVisible(QRectF,qreal,qreal)
     */
    public final void ensureVisible(io.qt.core.@NonNull QRectF rect, double xmargin, double ymargin){
        ensureVisible_native_cref_QRectF_qreal_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(rect), xmargin, ymargin);
    }
    
    private native void ensureVisible_native_cref_QRectF_qreal_qreal(long __this__nativeId, long rect, double xmargin, double ymargin);
    
    /**
     * See QScroller::ensureVisible(QRectF,qreal,qreal,int)
     */
    public final void ensureVisible(io.qt.core.@NonNull QRectF rect, double xmargin, double ymargin, int scrollTime){
        ensureVisible_native_cref_QRectF_qreal_qreal_int(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(rect), xmargin, ymargin, scrollTime);
    }
    
    private native void ensureVisible_native_cref_QRectF_qreal_qreal_int(long __this__nativeId, long rect, double xmargin, double ymargin, int scrollTime);
    
    /**
     * See QScroller::finalPosition()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QPointF finalPosition(){
        return finalPosition_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QPointF finalPosition_native_constfct(long __this__nativeId);
    
    /**
     * See QScroller::handleInput(QScroller::Input,QPointF,qint64)
     */
    @QtUninvokable
    public final boolean handleInput(io.qt.widgets.QScroller.@NonNull Input input, io.qt.core.@NonNull QPointF position, long timestamp){
        return handleInput_native_QScroller_Input_cref_QPointF_qint64(QtJambi_LibraryUtilities.internal.nativeId(this), input.value(), QtJambi_LibraryUtilities.internal.checkedNativeId(position), timestamp);
    }
    
    @QtUninvokable
    private native boolean handleInput_native_QScroller_Input_cref_QPointF_qint64(long __this__nativeId, int input, long position, long timestamp);
    
    /**
     * See QScroller::pixelPerMeter()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QPointF pixelPerMeter(){
        return pixelPerMeter_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QPointF pixelPerMeter_native_constfct(long __this__nativeId);
    
    /**
     * See QScroller::resendPrepareEvent()
     */
    public final void resendPrepareEvent(){
        resendPrepareEvent_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void resendPrepareEvent_native(long __this__nativeId);
    
    /**
     * See QScroller::scrollTo(QPointF)
     */
    public final void scrollTo(io.qt.core.@NonNull QPointF pos){
        scrollTo_native_cref_QPointF(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(pos));
    }
    
    private native void scrollTo_native_cref_QPointF(long __this__nativeId, long pos);
    
    /**
     * See QScroller::scrollTo(QPointF,int)
     */
    public final void scrollTo(io.qt.core.@NonNull QPointF pos, int scrollTime){
        scrollTo_native_cref_QPointF_int(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(pos), scrollTime);
    }
    
    private native void scrollTo_native_cref_QPointF_int(long __this__nativeId, long pos, int scrollTime);
    
    /**
     * See QScroller::scrollerProperties()const
     */
    @QtPropertyReader(name="scrollerProperties")
    @QtUninvokable
    public final io.qt.widgets.@NonNull QScrollerProperties scrollerProperties(){
        return scrollerProperties_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.widgets.QScrollerProperties scrollerProperties_native_constfct(long __this__nativeId);
    
    /**
     * See QScroller::setScrollerProperties(QScrollerProperties)
     */
    @QtPropertyWriter(name="scrollerProperties")
    public final void setScrollerProperties(io.qt.widgets.@NonNull QScrollerProperties prop){
        setScrollerProperties_native_cref_QScrollerProperties(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(prop));
    }
    
    private native void setScrollerProperties_native_cref_QScrollerProperties(long __this__nativeId, long prop);
    
    /**
     * See QScroller::setSnapPositionsX(QList<qreal>)
     */
    @QtUninvokable
    public final void setSnapPositionsX(java.util.@NonNull Collection positions){
        setSnapPositionsX_native_cref_QList(QtJambi_LibraryUtilities.internal.nativeId(this), positions);
    }
    
    @QtUninvokable
    private native void setSnapPositionsX_native_cref_QList(long __this__nativeId, java.util.Collection positions);
    
    /**
     * See QScroller::setSnapPositionsX(qreal,qreal)
     */
    @QtUninvokable
    public final void setSnapPositionsX(double first, double interval){
        setSnapPositionsX_native_qreal_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), first, interval);
    }
    
    @QtUninvokable
    private native void setSnapPositionsX_native_qreal_qreal(long __this__nativeId, double first, double interval);
    
    /**
     * See QScroller::setSnapPositionsY(QList<qreal>)
     */
    @QtUninvokable
    public final void setSnapPositionsY(java.util.@NonNull Collection positions){
        setSnapPositionsY_native_cref_QList(QtJambi_LibraryUtilities.internal.nativeId(this), positions);
    }
    
    @QtUninvokable
    private native void setSnapPositionsY_native_cref_QList(long __this__nativeId, java.util.Collection positions);
    
    /**
     * See QScroller::setSnapPositionsY(qreal,qreal)
     */
    @QtUninvokable
    public final void setSnapPositionsY(double first, double interval){
        setSnapPositionsY_native_qreal_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), first, interval);
    }
    
    @QtUninvokable
    private native void setSnapPositionsY_native_qreal_qreal(long __this__nativeId, double first, double interval);
    
    /**
     * See QScroller::state()const
     */
    @QtPropertyReader(name="state")
    @QtUninvokable
    public final io.qt.widgets.QScroller.@NonNull State state(){
        return io.qt.widgets.QScroller.State.resolve(state_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int state_native_constfct(long __this__nativeId);
    
    /**
     * See QScroller::stop()
     */
    @QtUninvokable
    public final void stop(){
        stop_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native void stop_native(long __this__nativeId);
    
    /**
     * See QScroller::target()const
     */
    @QtUninvokable
    public final io.qt.core.@Nullable QObject target(){
        return target_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QObject target_native_constfct(long __this__nativeId);
    
    /**
     * See QScroller::velocity()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QPointF velocity(){
        return velocity_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QPointF velocity_native_constfct(long __this__nativeId);
    
    /**
     * See QScroller::activeScrollers()
     */
    public native static io.qt.core.@NonNull QList activeScrollers();
    
    /**
     * See QScroller::grabGesture(QObject*,QScroller::ScrollerGestureType)
     */
    public static io.qt.core.Qt.@NonNull GestureType grabGesture(io.qt.core.@Nullable QObject target, io.qt.widgets.QScroller.@NonNull ScrollerGestureType gestureType){
        return io.qt.core.Qt.GestureType.resolve(grabGesture_native_QObject_ptr_QScroller_ScrollerGestureType(QtJambi_LibraryUtilities.internal.checkedNativeId(target), gestureType.value()));
    }
    
    private native static int grabGesture_native_QObject_ptr_QScroller_ScrollerGestureType(long target, int gestureType);
    
    /**
     * See QScroller::grabbedGesture(QObject*)
     */
    public static io.qt.core.Qt.@NonNull GestureType grabbedGesture(io.qt.core.@Nullable QObject target){
        return io.qt.core.Qt.GestureType.resolve(grabbedGesture_native_QObject_ptr(QtJambi_LibraryUtilities.internal.checkedNativeId(target)));
    }
    
    private native static int grabbedGesture_native_QObject_ptr(long target);
    
    /**
     * See QScroller::hasScroller(QObject*)
     */
    public static boolean hasScroller(io.qt.core.@Nullable QObject target){
        return hasScroller_native_QObject_ptr(QtJambi_LibraryUtilities.internal.checkedNativeId(target));
    }
    
    private native static boolean hasScroller_native_QObject_ptr(long target);
    
    /**
     * See QScroller::scroller(QObject*)
     */
    public static io.qt.widgets.@Nullable QScroller scroller(io.qt.core.@Nullable QObject target){
        return scroller_native_QObject_ptr(QtJambi_LibraryUtilities.internal.checkedNativeId(target));
    }
    
    private native static io.qt.widgets.QScroller scroller_native_QObject_ptr(long target);
    
    /**
     * See QScroller::ungrabGesture(QObject*)
     */
    public static void ungrabGesture(io.qt.core.@Nullable QObject target){
        ungrabGesture_native_QObject_ptr(QtJambi_LibraryUtilities.internal.checkedNativeId(target));
    }
    
    private native static void ungrabGesture_native_QObject_ptr(long target);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    private QScroller(QPrivateConstructor p) { super(p); } 
    
    
    /**
     * Overloaded function for {@link #ensureVisible(io.qt.core.QRectF, double, double)}.
     */
    public final void ensureVisible(io.qt.core.@NonNull QRect rect, double xmargin, double ymargin) {
        ensureVisible(new io.qt.core.QRectF(rect), xmargin, ymargin);
    }
    
    /**
     * Overloaded function for {@link #ensureVisible(io.qt.core.QRectF, double, double, int)}.
     */
    public final void ensureVisible(io.qt.core.@NonNull QRect rect, double xmargin, double ymargin, int scrollTime) {
        ensureVisible(new io.qt.core.QRectF(rect), xmargin, ymargin, scrollTime);
    }
    
    /**
     * Overloaded function for {@link #handleInput(io.qt.widgets.QScroller.Input, io.qt.core.QPointF, long)}
     *  with timestamp = 0.
     */
    @QtUninvokable
    public final boolean handleInput(io.qt.widgets.QScroller.@NonNull Input input, io.qt.core.@NonNull QPointF position) {
        return handleInput(input, position, (long)0);
    }
    
    /**
     * Overloaded function for {@link #handleInput(io.qt.widgets.QScroller.Input, io.qt.core.QPoint, long)}
     *  with timestamp = 0.
     */
    @QtUninvokable
    public final boolean handleInput(io.qt.widgets.QScroller.@NonNull Input input, io.qt.core.@NonNull QPoint position) {
        return handleInput(input, position, (long)0);
    }
    
    /**
     * Overloaded function for {@link #handleInput(io.qt.widgets.QScroller.Input, io.qt.core.QPointF, long)}.
     */
    @QtUninvokable
    public final boolean handleInput(io.qt.widgets.QScroller.@NonNull Input input, io.qt.core.@NonNull QPoint position, long timestamp) {
        return handleInput(input, new io.qt.core.QPointF(position), timestamp);
    }
    
    /**
     * Overloaded function for {@link #scrollTo(io.qt.core.QPointF)}.
     */
    public final void scrollTo(io.qt.core.@NonNull QPoint pos) {
        scrollTo(new io.qt.core.QPointF(pos));
    }
    
    /**
     * Overloaded function for {@link #scrollTo(io.qt.core.QPointF, int)}.
     */
    public final void scrollTo(io.qt.core.@NonNull QPoint pos, int scrollTime) {
        scrollTo(new io.qt.core.QPointF(pos), scrollTime);
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #scrollerProperties()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.widgets.@NonNull QScrollerProperties getScrollerProperties() {
        return scrollerProperties();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #state()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.widgets.QScroller.@NonNull State getState() {
        return state();
    }
    
    /**
     * Overloaded function for {@link #grabGesture(io.qt.core.QObject, io.qt.widgets.QScroller.ScrollerGestureType)}
     *  with gestureType = io.qt.widgets.QScroller.ScrollerGestureType.TouchGesture.
     */
    public static io.qt.core.Qt.@NonNull GestureType grabGesture(io.qt.core.@Nullable QObject target) {
        return grabGesture(target, io.qt.widgets.QScroller.ScrollerGestureType.TouchGesture);
    }
}