io.qt.webengine.core.QWebEnginePermission Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi-webenginecore Show documentation
Provides public API shared by both modules {@code qtjambi.webenginequick} and {@code qtjambi.webenginewidgets}.
There is a newer version: 6.7.2
Show newest version
package io.qt.webengine.core;

import io.qt.*;


/**
 * A QWebEnginePermission is an object used to access and modify the state of a single permission that's been granted or denied to a specific origin URL
 * Java wrapper for Qt class QWebEnginePermission
 * @since This class was introduced in Qt 6.8.
 */
public class QWebEnginePermission extends QtObject
    implements java.lang.Cloneable
{
    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(QWebEnginePermission.class);
    
    /**
     * Java wrapper for Qt enum QWebEnginePermission::PermissionType
     */
    public enum PermissionType implements QtByteEnumerator {
        /**
         * Representing QWebEnginePermission::PermissionType::Unsupported
         */
        Unsupported((byte)0),
        /**
         * Representing QWebEnginePermission::PermissionType::MediaAudioCapture
         */
        MediaAudioCapture((byte)1),
        /**
         * Representing QWebEnginePermission::PermissionType::MediaVideoCapture
         */
        MediaVideoCapture((byte)2),
        /**
         * Representing QWebEnginePermission::PermissionType::MediaAudioVideoCapture
         */
        MediaAudioVideoCapture((byte)3),
        /**
         * Representing QWebEnginePermission::PermissionType::DesktopVideoCapture
         */
        DesktopVideoCapture((byte)4),
        /**
         * Representing QWebEnginePermission::PermissionType::DesktopAudioVideoCapture
         */
        DesktopAudioVideoCapture((byte)5),
        /**
         * Representing QWebEnginePermission::PermissionType::MouseLock
         */
        MouseLock((byte)6),
        /**
         * Representing QWebEnginePermission::PermissionType::Notifications
         */
        Notifications((byte)7),
        /**
         * Representing QWebEnginePermission::PermissionType::Geolocation
         */
        Geolocation((byte)8),
        /**
         * Representing QWebEnginePermission::PermissionType::ClipboardReadWrite
         */
        ClipboardReadWrite((byte)9),
        /**
         * Representing QWebEnginePermission::PermissionType::LocalFontsAccess
         */
        LocalFontsAccess((byte)10);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

        private PermissionType(byte value) {
            this.value = value;
        }

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

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull PermissionType resolve(byte value) {
            switch (value) {
            case 0: return Unsupported;
            case 1: return MediaAudioCapture;
            case 2: return MediaVideoCapture;
            case 3: return MediaAudioVideoCapture;
            case 4: return DesktopVideoCapture;
            case 5: return DesktopAudioVideoCapture;
            case 6: return MouseLock;
            case 7: return Notifications;
            case 8: return Geolocation;
            case 9: return ClipboardReadWrite;
            case 10: return LocalFontsAccess;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final byte value;
    }
    
    /**
     * Java wrapper for Qt enum QWebEnginePermission::State
     */
    public enum State implements QtByteEnumerator {
        /**
         * Representing QWebEnginePermission::State::Invalid
         */
        Invalid((byte)0),
        /**
         * Representing QWebEnginePermission::State::Ask
         */
        Ask((byte)1),
        /**
         * Representing QWebEnginePermission::State::Granted
         */
        Granted((byte)2),
        /**
         * Representing QWebEnginePermission::State::Denied
         */
        Denied((byte)3);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

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

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

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull State resolve(byte value) {
            switch (value) {
            case 0: return Invalid;
            case 1: return Ask;
            case 2: return Granted;
            case 3: return Denied;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final byte value;
    }
    
    
    /**
     * See QWebEnginePermission::QWebEnginePermission()
     */
    public QWebEnginePermission(){
        super((QPrivateConstructor)null);
        initialize_native(this);
    }
    
    private native static void initialize_native(QWebEnginePermission instance);
    
    /**
     * See QWebEnginePermission::QWebEnginePermission(QWebEnginePermission)
     * @param other
     */
    public QWebEnginePermission(io.qt.webengine.core.@StrictNonNull QWebEnginePermission other){
        super((QPrivateConstructor)null);
        java.util.Objects.requireNonNull(other, "Argument 'other': null not expected.");
        initialize_native(this, other);
    }
    
    private native static void initialize_native(QWebEnginePermission instance, io.qt.webengine.core.QWebEnginePermission other);
    
    /**
     * See QWebEnginePermission::deny()const
     */
    public final void deny(){
        deny_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void deny_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEnginePermission::grant()const
     */
    public final void grant(){
        grant_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void grant_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEnginePermission::isValid()const
     * @return
     */
    @QtPropertyReader(name="isValid")
    @QtPropertyConstant
    @QtUninvokable
    public final boolean isValid(){
        return isValid_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isValid_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEnginePermission::operator=(QWebEnginePermission)
     * @param other
     */
    @QtUninvokable
    public final void assign(io.qt.webengine.core.@StrictNonNull QWebEnginePermission other){
        java.util.Objects.requireNonNull(other, "Argument 'other': null not expected.");
        assign_native_cref_QWebEnginePermission(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(other));
    }
    
    @QtUninvokable
    private native void assign_native_cref_QWebEnginePermission(long __this__nativeId, long other);
    
    /**
     * See operator==(QWebEnginePermission,QWebEnginePermission)
     * @param rhs
     * @return
     */
    @QtUninvokable
    public final boolean equals(io.qt.webengine.core.@StrictNonNull QWebEnginePermission rhs){
        java.util.Objects.requireNonNull(rhs, "Argument 'rhs': null not expected.");
        return equals_native_cref_QWebEnginePermission(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(rhs));
    }
    
    @QtUninvokable
    private native boolean equals_native_cref_QWebEnginePermission(long __this__nativeId, long rhs);
    
    /**
     * See QWebEnginePermission::origin()const
     * @return
     */
    @QtPropertyReader(name="origin")
    @QtPropertyConstant
    @QtUninvokable
    public final io.qt.core.@NonNull QUrl origin(){
        return origin_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QUrl origin_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEnginePermission::permissionType()const
     * @return
     */
    @QtPropertyReader(name="permissionType")
    @QtPropertyConstant
    @QtUninvokable
    public final io.qt.webengine.core.QWebEnginePermission.@NonNull PermissionType permissionType(){
        return io.qt.webengine.core.QWebEnginePermission.PermissionType.resolve(permissionType_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native byte permissionType_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEnginePermission::reset()const
     */
    public final void reset(){
        reset_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void reset_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEnginePermission::state()const
     * @return
     */
    @QtPropertyReader(name="state")
    @QtPropertyConstant
    @QtUninvokable
    public final io.qt.webengine.core.QWebEnginePermission.@NonNull State state(){
        return io.qt.webengine.core.QWebEnginePermission.State.resolve(state_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native byte state_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEnginePermission::swap(QWebEnginePermission&)
     * @param other
     */
    @QtUninvokable
    public final void swap(io.qt.webengine.core.@StrictNonNull QWebEnginePermission other){
        java.util.Objects.requireNonNull(other, "Argument 'other': null not expected.");
        swap_native_ref_QWebEnginePermission(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(other));
    }
    
    @QtUninvokable
    private native void swap_native_ref_QWebEnginePermission(long __this__nativeId, long other);
    
    /**
     * See QWebEnginePermission::isPersistent(QWebEnginePermission::PermissionType)
     * @param permissionType
     * @return
     */
    public static boolean isPersistent(io.qt.webengine.core.QWebEnginePermission.@NonNull PermissionType permissionType){
        return isPersistent_native_QWebEnginePermission_PermissionType(permissionType.value());
    }
    
    private native static boolean isPersistent_native_QWebEnginePermission_PermissionType(byte permissionType);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QWebEnginePermission(QPrivateConstructor p) { super(p); } 
    

    /**
     * See operator==(QWebEnginePermission,QWebEnginePermission)
     */
    @Override
    @QtUninvokable
    public boolean equals(Object other) {
        if (other==null || other instanceof io.qt.webengine.core.QWebEnginePermission) {
            return equals((io.qt.webengine.core.QWebEnginePermission) other);
        }

        return false;
    }


    /**
     * Returns the objects's hash code computed by qHash(QWebEnginePermission).
     */
    @QtUninvokable
    @Override
    public int hashCode() {
        return hashCode_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    @QtUninvokable
    private native static int hashCode_native(long __this_nativeId);
    
    /**
     * Creates and returns a copy of this object.
    See QWebEnginePermission::QWebEnginePermission(QWebEnginePermission)
     */
    @QtUninvokable
    @Override
    public QWebEnginePermission clone() {
        return clone_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    private static native QWebEnginePermission clone_native(long __this_nativeId);
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #origin()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.core.@NonNull QUrl getOrigin() {
        return origin();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #permissionType()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.webengine.core.QWebEnginePermission.@NonNull PermissionType getPermissionType() {
        return permissionType();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #state()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.webengine.core.QWebEnginePermission.@NonNull State getState() {
        return state();
    }
}