io.qt.webengine.core.QWebEngineDownloadRequest 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.*;


/**
 * Information about a download
 * Java wrapper for Qt class QWebEngineDownloadRequest
 */
public class QWebEngineDownloadRequest 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(QWebEngineDownloadRequest.class);
    
    /**
     * Java wrapper for Qt enum QWebEngineDownloadRequest::DownloadInterruptReason
     */
    public enum DownloadInterruptReason implements QtEnumerator {
        /**
         * Representing QWebEngineDownloadRequest::NoReason
         */
        NoReason(0),
        /**
         * Representing QWebEngineDownloadRequest::FileFailed
         */
        FileFailed(1),
        /**
         * Representing QWebEngineDownloadRequest::FileAccessDenied
         */
        FileAccessDenied(2),
        /**
         * Representing QWebEngineDownloadRequest::FileNoSpace
         */
        FileNoSpace(3),
        /**
         * Representing QWebEngineDownloadRequest::FileNameTooLong
         */
        FileNameTooLong(5),
        /**
         * Representing QWebEngineDownloadRequest::FileTooLarge
         */
        FileTooLarge(6),
        /**
         * Representing QWebEngineDownloadRequest::FileVirusInfected
         */
        FileVirusInfected(7),
        /**
         * Representing QWebEngineDownloadRequest::FileTransientError
         */
        FileTransientError(10),
        /**
         * Representing QWebEngineDownloadRequest::FileBlocked
         */
        FileBlocked(11),
        /**
         * Representing QWebEngineDownloadRequest::FileSecurityCheckFailed
         */
        FileSecurityCheckFailed(12),
        /**
         * Representing QWebEngineDownloadRequest::FileTooShort
         */
        FileTooShort(13),
        /**
         * Representing QWebEngineDownloadRequest::FileHashMismatch
         */
        FileHashMismatch(14),
        /**
         * Representing QWebEngineDownloadRequest::NetworkFailed
         */
        NetworkFailed(20),
        /**
         * Representing QWebEngineDownloadRequest::NetworkTimeout
         */
        NetworkTimeout(21),
        /**
         * Representing QWebEngineDownloadRequest::NetworkDisconnected
         */
        NetworkDisconnected(22),
        /**
         * Representing QWebEngineDownloadRequest::NetworkServerDown
         */
        NetworkServerDown(23),
        /**
         * Representing QWebEngineDownloadRequest::NetworkInvalidRequest
         */
        NetworkInvalidRequest(24),
        /**
         * Representing QWebEngineDownloadRequest::ServerFailed
         */
        ServerFailed(30),
        /**
         * Representing QWebEngineDownloadRequest::ServerBadContent
         */
        ServerBadContent(33),
        /**
         * Representing QWebEngineDownloadRequest::ServerUnauthorized
         */
        ServerUnauthorized(34),
        /**
         * Representing QWebEngineDownloadRequest::ServerCertProblem
         */
        ServerCertProblem(35),
        /**
         * Representing QWebEngineDownloadRequest::ServerForbidden
         */
        ServerForbidden(36),
        /**
         * Representing QWebEngineDownloadRequest::ServerUnreachable
         */
        ServerUnreachable(37),
        /**
         * Representing QWebEngineDownloadRequest::UserCanceled
         */
        UserCanceled(40);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

        private DownloadInterruptReason(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 DownloadInterruptReason resolve(int value) {
            switch (value) {
            case 0: return NoReason;
            case 1: return FileFailed;
            case 2: return FileAccessDenied;
            case 3: return FileNoSpace;
            case 5: return FileNameTooLong;
            case 6: return FileTooLarge;
            case 7: return FileVirusInfected;
            case 10: return FileTransientError;
            case 11: return FileBlocked;
            case 12: return FileSecurityCheckFailed;
            case 13: return FileTooShort;
            case 14: return FileHashMismatch;
            case 20: return NetworkFailed;
            case 21: return NetworkTimeout;
            case 22: return NetworkDisconnected;
            case 23: return NetworkServerDown;
            case 24: return NetworkInvalidRequest;
            case 30: return ServerFailed;
            case 33: return ServerBadContent;
            case 34: return ServerUnauthorized;
            case 35: return ServerCertProblem;
            case 36: return ServerForbidden;
            case 37: return ServerUnreachable;
            case 40: return UserCanceled;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * Java wrapper for Qt enum QWebEngineDownloadRequest::DownloadState
     */
    public enum DownloadState implements QtEnumerator {
        /**
         * Representing QWebEngineDownloadRequest::DownloadRequested
         */
        DownloadRequested(0),
        /**
         * Representing QWebEngineDownloadRequest::DownloadInProgress
         */
        DownloadInProgress(1),
        /**
         * Representing QWebEngineDownloadRequest::DownloadCompleted
         */
        DownloadCompleted(2),
        /**
         * Representing QWebEngineDownloadRequest::DownloadCancelled
         */
        DownloadCancelled(3),
        /**
         * Representing QWebEngineDownloadRequest::DownloadInterrupted
         */
        DownloadInterrupted(4);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

        private DownloadState(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 DownloadState resolve(int value) {
            switch (value) {
            case 0: return DownloadRequested;
            case 1: return DownloadInProgress;
            case 2: return DownloadCompleted;
            case 3: return DownloadCancelled;
            case 4: return DownloadInterrupted;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * Java wrapper for Qt enum QWebEngineDownloadRequest::SavePageFormat
     */
    public enum SavePageFormat implements QtEnumerator {
        /**
         * Representing QWebEngineDownloadRequest::UnknownSaveFormat
         */
        UnknownSaveFormat(-1),
        /**
         * Representing QWebEngineDownloadRequest::SingleHtmlSaveFormat
         */
        SingleHtmlSaveFormat(0),
        /**
         * Representing QWebEngineDownloadRequest::CompleteHtmlSaveFormat
         */
        CompleteHtmlSaveFormat(1),
        /**
         * Representing QWebEngineDownloadRequest::MimeHtmlSaveFormat
         */
        MimeHtmlSaveFormat(2);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

        private SavePageFormat(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 SavePageFormat resolve(int value) {
            switch (value) {
            case -1: return UnknownSaveFormat;
            case 0: return SingleHtmlSaveFormat;
            case 1: return CompleteHtmlSaveFormat;
            case 2: return MimeHtmlSaveFormat;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    

    /**
     * See QWebEngineDownloadRequest::downloadDirectoryChanged()
     */
    @QtPropertyNotify(name="downloadDirectory")
    public final @NonNull Signal0 downloadDirectoryChanged = new Signal0();

    /**
     * See QWebEngineDownloadRequest::downloadFileNameChanged()
     */
    @QtPropertyNotify(name="downloadFileName")
    public final @NonNull Signal0 downloadFileNameChanged = new Signal0();

    /**
     * See QWebEngineDownloadRequest::interruptReasonChanged()
     */
    @QtPropertyNotify(name="interruptReason")
    public final @NonNull Signal0 interruptReasonChanged = new Signal0();

    /**
     * See QWebEngineDownloadRequest::isFinishedChanged()
     */
    @QtPropertyNotify(name="isFinished")
    public final @NonNull Signal0 isFinishedChanged = new Signal0();

    /**
     * See QWebEngineDownloadRequest::isPausedChanged()
     */
    @QtPropertyNotify(name="isPaused")
    public final @NonNull Signal0 isPausedChanged = new Signal0();

    /**
     * See QWebEngineDownloadRequest::receivedBytesChanged()
     */
    @QtPropertyNotify(name="receivedBytes")
    public final @NonNull Signal0 receivedBytesChanged = new Signal0();

    /**
     * See QWebEngineDownloadRequest::savePageFormatChanged()
     */
    @QtPropertyNotify(name="savePageFormat")
    public final @NonNull Signal0 savePageFormatChanged = new Signal0();

    /**
     * See QWebEngineDownloadRequest::stateChanged(QWebEngineDownloadRequest::DownloadState)
     */
    @QtPropertyNotify(name="state")
    public final @NonNull Signal1 stateChanged = new Signal1<>();

    /**
     * See QWebEngineDownloadRequest::totalBytesChanged()
     */
    @QtPropertyNotify(name="totalBytes")
    public final @NonNull Signal0 totalBytesChanged = new Signal0();
    
    /**
     * See QWebEngineDownloadRequest::accept()
     */
    public final void accept(){
        accept_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void accept_native(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::cancel()
     */
    public final void cancel(){
        cancel_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void cancel_native(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::downloadDirectory()const
     * @return
     */
    @QtPropertyReader(name="downloadDirectory")
    @QtUninvokable
    public final java.lang.@NonNull String downloadDirectory(){
        return downloadDirectory_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String downloadDirectory_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::downloadFileName()const
     * @return
     */
    @QtPropertyReader(name="downloadFileName")
    @QtUninvokable
    public final java.lang.@NonNull String downloadFileName(){
        return downloadFileName_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String downloadFileName_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::id()const
     * @return
     */
    @QtPropertyReader(name="id")
    @QtPropertyConstant
    @QtUninvokable
    public final int id(){
        return id_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native int id_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::interruptReason()const
     * @return
     */
    @QtPropertyReader(name="interruptReason")
    @QtUninvokable
    public final io.qt.webengine.core.QWebEngineDownloadRequest.@NonNull DownloadInterruptReason interruptReason(){
        return io.qt.webengine.core.QWebEngineDownloadRequest.DownloadInterruptReason.resolve(interruptReason_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int interruptReason_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::interruptReasonString()const
     * @return
     */
    @QtPropertyReader(name="interruptReasonString")
    @QtUninvokable
    public final java.lang.@NonNull String interruptReasonString(){
        return interruptReasonString_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String interruptReasonString_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::isFinished()const
     * @return
     */
    @QtPropertyReader(name="isFinished")
    @QtUninvokable
    public final boolean isFinished(){
        return isFinished_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isFinished_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::isPaused()const
     * @return
     */
    @QtPropertyReader(name="isPaused")
    @QtUninvokable
    public final boolean isPaused(){
        return isPaused_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isPaused_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::isSavePageDownload()const
     * @return
     */
    @QtPropertyReader(name="isSavePageDownload")
    @QtPropertyConstant
    @QtUninvokable
    public final boolean isSavePageDownload(){
        return isSavePageDownload_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isSavePageDownload_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::mimeType()const
     * @return
     */
    @QtPropertyReader(name="mimeType")
    @QtUninvokable
    public final java.lang.@NonNull String mimeType(){
        return mimeType_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String mimeType_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::page()const
     * @return
     */
    @QtUninvokable
    public final io.qt.webengine.core.@Nullable QWebEnginePage page(){
        return page_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.webengine.core.QWebEnginePage page_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::pause()
     */
    public final void pause(){
        pause_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void pause_native(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::receivedBytes()const
     * @return
     */
    @QtPropertyReader(name="receivedBytes")
    @QtUninvokable
    public final long receivedBytes(){
        return receivedBytes_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native long receivedBytes_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::resume()
     */
    public final void resume(){
        resume_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    private native void resume_native(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::savePageFormat()const
     * @return
     */
    @QtPropertyReader(name="savePageFormat")
    @QtUninvokable
    public final io.qt.webengine.core.QWebEngineDownloadRequest.@NonNull SavePageFormat savePageFormat(){
        return io.qt.webengine.core.QWebEngineDownloadRequest.SavePageFormat.resolve(savePageFormat_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int savePageFormat_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::setDownloadDirectory(QString)
     * @param directory
     */
    @QtPropertyWriter(name="downloadDirectory")
    @QtUninvokable
    public final void setDownloadDirectory(java.lang.@NonNull String directory){
        setDownloadDirectory_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), directory);
    }
    
    @QtUninvokable
    private native void setDownloadDirectory_native_cref_QString(long __this__nativeId, java.lang.String directory);
    
    /**
     * See QWebEngineDownloadRequest::setDownloadFileName(QString)
     * @param fileName
     */
    @QtPropertyWriter(name="downloadFileName")
    @QtUninvokable
    public final void setDownloadFileName(java.lang.@NonNull String fileName){
        setDownloadFileName_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), fileName);
    }
    
    @QtUninvokable
    private native void setDownloadFileName_native_cref_QString(long __this__nativeId, java.lang.String fileName);
    
    /**
     * See QWebEngineDownloadRequest::setSavePageFormat(QWebEngineDownloadRequest::SavePageFormat)
     * @param format
     */
    @QtPropertyWriter(name="savePageFormat")
    @QtUninvokable
    public final void setSavePageFormat(io.qt.webengine.core.QWebEngineDownloadRequest.@NonNull SavePageFormat format){
        setSavePageFormat_native_QWebEngineDownloadRequest_SavePageFormat(QtJambi_LibraryUtilities.internal.nativeId(this), format.value());
    }
    
    @QtUninvokable
    private native void setSavePageFormat_native_QWebEngineDownloadRequest_SavePageFormat(long __this__nativeId, int format);
    
    /**
     * See QWebEngineDownloadRequest::state()const
     * @return
     */
    @QtPropertyReader(name="state")
    @QtUninvokable
    public final io.qt.webengine.core.QWebEngineDownloadRequest.@NonNull DownloadState state(){
        return io.qt.webengine.core.QWebEngineDownloadRequest.DownloadState.resolve(state_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int state_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::suggestedFileName()const
     * @return
     */
    @QtPropertyReader(name="suggestedFileName")
    @QtPropertyConstant
    @QtUninvokable
    public final java.lang.@NonNull String suggestedFileName(){
        return suggestedFileName_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String suggestedFileName_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::totalBytes()const
     * @return
     */
    @QtPropertyReader(name="totalBytes")
    @QtUninvokable
    public final long totalBytes(){
        return totalBytes_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native long totalBytes_native_constfct(long __this__nativeId);
    
    /**
     * See QWebEngineDownloadRequest::url()const
     * @return
     */
    @QtPropertyReader(name="url")
    @QtPropertyConstant
    @QtUninvokable
    public final io.qt.core.@NonNull QUrl url(){
        return url_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QUrl url_native_constfct(long __this__nativeId);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QWebEngineDownloadRequest(QPrivateConstructor p) { super(p); } 
    
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #downloadDirectory()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getDownloadDirectory() {
        return downloadDirectory();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #downloadFileName()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getDownloadFileName() {
        return downloadFileName();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #id()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final int getId() {
        return id();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #interruptReason()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.webengine.core.QWebEngineDownloadRequest.@NonNull DownloadInterruptReason getInterruptReason() {
        return interruptReason();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #interruptReasonString()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getInterruptReasonString() {
        return interruptReasonString();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #mimeType()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getMimeType() {
        return mimeType();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #receivedBytes()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final long getReceivedBytes() {
        return receivedBytes();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #savePageFormat()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.webengine.core.QWebEngineDownloadRequest.@NonNull SavePageFormat getSavePageFormat() {
        return savePageFormat();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #state()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.webengine.core.QWebEngineDownloadRequest.@NonNull DownloadState getState() {
        return state();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #suggestedFileName()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final java.lang.@NonNull String getSuggestedFileName() {
        return suggestedFileName();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #totalBytes()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final long getTotalBytes() {
        return totalBytes();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #url()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.core.@NonNull QUrl getUrl() {
        return url();
    }
}