io.qt.gui.QImageIOPlugin Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of qtjambi-jre8 Show documentation
There is a newer version: 6.3.0
package io.qt.gui;


/**
 * Defines an interface for writing an image format plugin
 * Java wrapper for Qt class QImageIOPlugin
 */
public abstract class QImageIOPlugin extends io.qt.core.QObject
{
    static {
        QtJambi_LibraryUtilities.initialize();
    }
    
    /**
     * This variable stores the meta-object for the class.
     */
    public static final io.qt.core.QMetaObject staticMetaObject = io.qt.core.QMetaObject.forType(QImageIOPlugin.class);
    
    @io.qt.NativeAccess
    private static final class ConcreteWrapper extends QImageIOPlugin {
        
        @io.qt.NativeAccess
        private ConcreteWrapper(QPrivateConstructor p) { super(p); }
        
        @Override
        @io.qt.QtUninvokable
        public io.qt.gui.QImageIOPlugin.Capabilities capabilities(io.qt.core.QIODevice device, io.qt.core.QByteArray format){
            return new io.qt.gui.QImageIOPlugin.Capabilities(capabilities_native_QIODevice_ptr_cref_QByteArray_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(device), QtJambi_LibraryUtilities.internal.checkedNativeId(format)));
        }
        @io.qt.QtUninvokable
        private native int capabilities_native_QIODevice_ptr_cref_QByteArray_constfct(long __this__nativeId, long device, long format);
        
        
        @Override
        @io.qt.QtUninvokable
        public io.qt.gui.QImageIOHandler create(io.qt.core.QIODevice device, io.qt.core.QByteArray format){
            return create_native_QIODevice_ptr_cref_QByteArray_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(device), QtJambi_LibraryUtilities.internal.checkedNativeId(format));
        }
        @io.qt.QtUninvokable
        private native io.qt.gui.QImageIOHandler create_native_QIODevice_ptr_cref_QByteArray_constfct(long __this__nativeId, long device, long format);
        
    }
    
    /**
     * Java wrapper for Qt enum QImageIOPlugin::Capability
     * 
     * @see Capabilities
     */
    public enum Capability implements io.qt.QtFlagEnumerator {
        CanRead(1),
        CanWrite(2),
        CanReadIncremental(4);

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

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

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

        /**
         * Combines this entry with other enum entry.
         * @param e enum entry
         * @return new flag
         */
        public Capabilities combined(Capability e) {
            return new Capabilities(this, e);
        }

        /**
         * Creates a new {@link Capabilities} from the entries.
         * @param values entries
         * @return new flag
         */
        public static Capabilities flags(Capability ... values) {
            return new Capabilities(values);
        }

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static Capability resolve(int value) {
            switch (value) {
            case 1: return CanRead;
            case 2: return CanWrite;
            case 4: return CanReadIncremental;
            default: throw new io.qt.QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * QFlags type for enum {@link Capability}
     */
    public static final class Capabilities extends io.qt.QFlags implements Comparable {
        private static final long serialVersionUID = 0x956707b38f6e6caeL;

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

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

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

        /**
         * Sets the flag e
         * @param e enum entry
         * @return this
         */
        public final Capabilities setFlag(Capability e){
            super.setFlag(e);
            return this;
        }

        /**
         * Sets or clears the flag flag
         * @param e enum entry
         * @param on set (true) or clear (false)
         * @return this
         */
        public final Capabilities setFlag(Capability e, boolean on){
            super.setFlag(e, on);
            return this;
        }

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

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

        /**
         * {@inheritDoc}
         */
        @Override
        public final int compareTo(Capabilities other){
            return Integer.compare(value(), other.value());
        }
    }
    
    
    /**
     * Overloaded constructor for {@link #QImageIOPlugin(io.qt.core.QObject)}
     *  with parent = null.
     */
    public QImageIOPlugin() {
        this((io.qt.core.QObject)null);
    }
    
    /**
     * See QImageIOPlugin::QImageIOPlugin(QObject*)
     */
    public QImageIOPlugin(io.qt.core.QObject parent){
        super((QPrivateConstructor)null);
        initialize_native(this, parent);
    }
    
    private native static void initialize_native(QImageIOPlugin instance, io.qt.core.QObject parent);
    
    /**
     * See QImageIOPlugin::capabilities(QIODevice*,QByteArray)const
     */
    @io.qt.QtUninvokable
    public abstract io.qt.gui.QImageIOPlugin.Capabilities capabilities(io.qt.core.QIODevice device, io.qt.core.QByteArray format);
    
    @io.qt.QtUninvokable
    private native int capabilities_native_QIODevice_ptr_cref_QByteArray_constfct(long __this__nativeId, long device, long format);
    
    /**
     * Overloaded function for {@link #create(io.qt.core.QIODevice, io.qt.core.QByteArray)}
     *  with format = new io.qt.core.QByteArray().
     */
    @io.qt.QtUninvokable
    public final io.qt.gui.QImageIOHandler create(io.qt.core.QIODevice device) {
        return create(device, new io.qt.core.QByteArray());
    }
    
    /**
     * See QImageIOPlugin::create(QIODevice*,QByteArray)const
     */
    @io.qt.QtUninvokable
    public abstract io.qt.gui.QImageIOHandler create(io.qt.core.QIODevice device, io.qt.core.QByteArray format);
    
    @io.qt.QtUninvokable
    private native io.qt.gui.QImageIOHandler create_native_QIODevice_ptr_cref_QByteArray_constfct(long __this__nativeId, long device, long format);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     */
    @io.qt.NativeAccess
    protected QImageIOPlugin(QPrivateConstructor p) { super(p); } 
    
    /**
     * Constructor for internal use only.
     * It is not allowed to call the declarative constructor from inside Java.
     */
    @io.qt.NativeAccess
    protected QImageIOPlugin(QDeclarativeConstructor constructor) {
        super((QPrivateConstructor)null);
        initialize_native(this, constructor);
    } 
    
    @io.qt.QtUninvokable
    private static native void initialize_native(QImageIOPlugin instance, QDeclarativeConstructor constructor);
    
}