io.qt.pdf.QPdfPageRenderer Maven / Gradle / Ivy

Show more of this group Show more artifacts with this name
Show all versions of qtjambi-pdf Show documentation
Classes and functions for rendering PDF documents.
There is a newer version: 6.7.2
package io.qt.pdf;

import io.qt.*;


/**
 * Encapsulates the rendering of pages of a PDF document
 * Java wrapper for Qt class QPdfPageRenderer
 */
public class QPdfPageRenderer extends io.qt.core.QObject
{
    static {
        QtJambi_LibraryUtilities.initialize();
    }
    
    @QtPropertyMember(enabled=false)
    private Object __rcDocument = null;
    
    /**
     * This variable stores the meta-object for the class.
     */
    public static final io.qt.core.@NonNull QMetaObject staticMetaObject = io.qt.core.QMetaObject.forType(QPdfPageRenderer.class);
    
    /**
     * Java wrapper for Qt enum QPdfPageRenderer::RenderMode
     */
    public enum RenderMode implements QtEnumerator {
        /**
         * Representing QPdfPageRenderer::RenderMode::MultiThreaded
         */
        MultiThreaded(0),
        /**
         * Representing QPdfPageRenderer::RenderMode::SingleThreaded
         */
        SingleThreaded(1);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

        private RenderMode(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 RenderMode resolve(int value) {
            switch (value) {
            case 0: return MultiThreaded;
            case 1: return SingleThreaded;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    

    /**
     * See QPdfPageRenderer::documentChanged(QPdfDocument*)
     */
    @QtPropertyNotify(name="document")
    public final @NonNull Signal1 documentChanged = new Signal1<>();

    /**
     * See QPdfPageRenderer::pageRendered(int,QSize,QImage,QPdfDocumentRenderOptions,quint64)
     */
    public final @NonNull Signal5 pageRendered = new Signal5<>();

    /**
     * See QPdfPageRenderer::renderModeChanged(QPdfPageRenderer::RenderMode)
     */
    @QtPropertyNotify(name="renderMode")
    public final @NonNull Signal1 renderModeChanged = new Signal1<>();
    
    /**
     * See QPdfPageRenderer::QPdfPageRenderer()
     */
    public QPdfPageRenderer(){
        super((QPrivateConstructor)null);
        initialize_native(this);
    }
    
    private native static void initialize_native(QPdfPageRenderer instance);
    
    /**
     * See QPdfPageRenderer::QPdfPageRenderer(QObject*)
     */
    public QPdfPageRenderer(io.qt.core.@Nullable QObject parent){
        super((QPrivateConstructor)null);
        initialize_native(this, parent);
    }
    
    private native static void initialize_native(QPdfPageRenderer instance, io.qt.core.QObject parent);
    
    /**
     * See QPdfPageRenderer::document()const
     */
    @QtPropertyReader(name="document")
    @QtUninvokable
    public final io.qt.pdf.@Nullable QPdfDocument document(){
        return document_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.pdf.QPdfDocument document_native_constfct(long __this__nativeId);
    
    /**
     * See QPdfPageRenderer::renderMode()const
     */
    @QtPropertyReader(name="renderMode")
    @QtUninvokable
    public final io.qt.pdf.QPdfPageRenderer.@NonNull RenderMode renderMode(){
        return io.qt.pdf.QPdfPageRenderer.RenderMode.resolve(renderMode_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int renderMode_native_constfct(long __this__nativeId);
    
    /**
     * See QPdfPageRenderer::requestPage(int,QSize,QPdfDocumentRenderOptions)
     */
    @QtUninvokable
    public final long requestPage(int pageNumber, io.qt.core.@NonNull QSize imageSize, io.qt.pdf.@NonNull QPdfDocumentRenderOptions options){
        return requestPage_native_int_QSize_QPdfDocumentRenderOptions(QtJambi_LibraryUtilities.internal.nativeId(this), pageNumber, QtJambi_LibraryUtilities.internal.checkedNativeId(imageSize), QtJambi_LibraryUtilities.internal.checkedNativeId(options));
    }
    
    @QtUninvokable
    private native long requestPage_native_int_QSize_QPdfDocumentRenderOptions(long __this__nativeId, int pageNumber, long imageSize, long options);
    
    /**
     * See QPdfPageRenderer::setDocument(QPdfDocument*)
     */
    @QtPropertyWriter(name="document")
    @QtUninvokable
    public final void setDocument(io.qt.pdf.@Nullable QPdfDocument document){
        setDocument_native_QPdfDocument_ptr(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(document));
        __rcDocument = document;
    }
    
    @QtUninvokable
    private native void setDocument_native_QPdfDocument_ptr(long __this__nativeId, long document);
    
    /**
     * See QPdfPageRenderer::setRenderMode(QPdfPageRenderer::RenderMode)
     */
    @QtPropertyWriter(name="renderMode")
    @QtUninvokable
    public final void setRenderMode(io.qt.pdf.QPdfPageRenderer.@NonNull RenderMode mode){
        setRenderMode_native_QPdfPageRenderer_RenderMode(QtJambi_LibraryUtilities.internal.nativeId(this), mode.value());
    }
    
    @QtUninvokable
    private native void setRenderMode_native_QPdfPageRenderer_RenderMode(long __this__nativeId, int mode);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QPdfPageRenderer(QPrivateConstructor p) { super(p); } 
    
    /**
     * Constructor for internal use only.
     * It is not allowed to call the declarative constructor from inside Java.
     * @hidden
     */
    @NativeAccess
    protected QPdfPageRenderer(QDeclarativeConstructor constructor) {
        super((QPrivateConstructor)null);
        initialize_native(this, constructor);
    } 
    
    @QtUninvokable
    private static native void initialize_native(QPdfPageRenderer instance, QDeclarativeConstructor constructor);
    
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #document()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.pdf.@Nullable QPdfDocument getDocument() {
        return document();
    }
    
    /**
     * @hidden
     * Kotlin property getter. In Java use {@link #renderMode()} instead.
     */
    @QtPropertyReader(enabled=false)
    @QtUninvokable
    public final io.qt.pdf.QPdfPageRenderer.@NonNull RenderMode getRenderMode() {
        return renderMode();
    }
    
    /**
     * Overloaded function for {@link #requestPage(int, io.qt.core.QSize, io.qt.pdf.QPdfDocumentRenderOptions)}
     *  with options = new io.qt.pdf.QPdfDocumentRenderOptions().
     */
    @QtUninvokable
    public final long requestPage(int pageNumber, io.qt.core.@NonNull QSize imageSize) {
        return requestPage(pageNumber, imageSize, new io.qt.pdf.QPdfDocumentRenderOptions());
    }
}