io.qt.gui.QGlyphRun 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.gui;

import io.qt.*;


/**
 * Direct access to the internal glyphs in a font
 * Java wrapper for Qt class QGlyphRun
 */
public class QGlyphRun extends QtObject
    implements java.lang.Cloneable
{
    static {
        QtJambi_LibraryUtilities.initialize();
    }
    
    /**
     * Java wrapper for Qt enum QGlyphRun::GlyphRunFlag
     * 
     * @see GlyphRunFlags
     */
    public enum GlyphRunFlag implements QtFlagEnumerator {
        /**
         * Representing QGlyphRun::Overline
         */
        Overline(1),
        /**
         * Representing QGlyphRun::Underline
         */
        Underline(2),
        /**
         * Representing QGlyphRun::StrikeOut
         */
        StrikeOut(4),
        /**
         * Representing QGlyphRun::RightToLeft
         */
        RightToLeft(8),
        /**
         * Representing QGlyphRun::SplitLigature
         */
        SplitLigature(16);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

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

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

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

        /**
         * Combines this entry with other enum entry.
         * @param e enum entry
         * @return new flag
         */
        public @NonNull GlyphRunFlags combined(@NonNull GlyphRunFlag e) {
            return asFlags().setFlag(e, true);
        }

        /**
         * Excludes other enum entry from a flag of this entry.
         * @param e enum entry
         * @return new flag
         */
        public @NonNull GlyphRunFlags cleared(@NonNull GlyphRunFlag e) {
            return asFlags().setFlag(e, false);
        }

        /**
         * Creates a new {@link GlyphRunFlags} from the entries.
         * @param values entries
         * @return new flag
         */
        public static @NonNull GlyphRunFlags flags(@Nullable GlyphRunFlag @NonNull... values) {
            return new GlyphRunFlags(values);
        }

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull GlyphRunFlag resolve(int value) {
            switch (value) {
            case 1: return Overline;
            case 2: return Underline;
            case 4: return StrikeOut;
            case 8: return RightToLeft;
            case 16: return SplitLigature;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * {@link QFlags} type for enum {@link GlyphRunFlag}
     */
    public static final class GlyphRunFlags extends QFlags implements Comparable {
        private static final long serialVersionUID = 0xa419c125c5963657L;
        static {
            QtJambi_LibraryUtilities.initialize();
        }

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

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

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

        /**
         * Sets the flag e
         * @param e enum entry
         * @return this
         */
        public final @NonNull GlyphRunFlags setFlag(@Nullable GlyphRunFlag e){
            return setFlag(e, true);
        }

        /**
         * Sets or clears the flag flag
         * @param e enum entry
         * @param on set (true) or clear (false)
         * @return this
         */
        public final @NonNull GlyphRunFlags setFlag(@Nullable GlyphRunFlag e, boolean on){
            if (on) {
            	setValue(value() | e.value());
            }else {
            	setValue(value() & ~e.value());
            }
            return this;
        }

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

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

        /**
         * {@inheritDoc}
         */
        @Override
        public final int compareTo(@StrictNonNull GlyphRunFlags other){
            return Integer.compare(value(), other.value());
        }
    }
    
    
    /**
     * See QGlyphRun::QGlyphRun()
     */
    public QGlyphRun(){
        super((QPrivateConstructor)null);
        initialize_native(this);
    }
    
    private native static void initialize_native(QGlyphRun instance);
    
    /**
     * See QGlyphRun::QGlyphRun(QGlyphRun)
     */
    public QGlyphRun(io.qt.gui.@NonNull QGlyphRun other){
        super((QPrivateConstructor)null);
        initialize_native(this, other);
    }
    
    private native static void initialize_native(QGlyphRun instance, io.qt.gui.QGlyphRun other);
    
    /**
     * See QGlyphRun::boundingRect()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QRectF boundingRect(){
        return boundingRect_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QRectF boundingRect_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::clear()
     */
    @QtUninvokable
    public final void clear(){
        clear_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native void clear_native(long __this__nativeId);
    
    /**
     * See QGlyphRun::flags()const
     */
    @QtUninvokable
    public final io.qt.gui.QGlyphRun.@NonNull GlyphRunFlags flags(){
        return new io.qt.gui.QGlyphRun.GlyphRunFlags(flags_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int flags_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::glyphIndexes()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList glyphIndexes(){
        return glyphIndexes_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QList glyphIndexes_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::isEmpty()const
     */
    @QtUninvokable
    public final boolean isEmpty(){
        return isEmpty_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isEmpty_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::isRightToLeft()const
     */
    @QtUninvokable
    public final boolean isRightToLeft(){
        return isRightToLeft_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isRightToLeft_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::operator=(QGlyphRun)
     */
    @QtUninvokable
    public final void assign(io.qt.gui.@NonNull QGlyphRun other){
        assign_native_cref_QGlyphRun(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(other));
    }
    
    @QtUninvokable
    private native void assign_native_cref_QGlyphRun(long __this__nativeId, long other);
    
    /**
     * See QGlyphRun::operator==(QGlyphRun)const
     */
    @QtUninvokable
    public final boolean equals(io.qt.gui.@NonNull QGlyphRun other){
        return equals_native_cref_QGlyphRun_constfct(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(other));
    }
    
    @QtUninvokable
    private native boolean equals_native_cref_QGlyphRun_constfct(long __this__nativeId, long other);
    
    /**
     * See QGlyphRun::overline()const
     */
    @QtUninvokable
    public final boolean overline(){
        return overline_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean overline_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::positions()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList positions(){
        return positions_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QList positions_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::rawFont()const
     */
    @QtUninvokable
    public final io.qt.gui.@NonNull QRawFont rawFont(){
        return rawFont_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.gui.QRawFont rawFont_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::setBoundingRect(QRectF)
     */
    @QtUninvokable
    public final void setBoundingRect(io.qt.core.@NonNull QRectF boundingRect){
        setBoundingRect_native_cref_QRectF(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(boundingRect));
    }
    
    @QtUninvokable
    private native void setBoundingRect_native_cref_QRectF(long __this__nativeId, long boundingRect);
    
    /**
     * See QGlyphRun::setFlag(QGlyphRun::GlyphRunFlag,bool)
     */
    @QtUninvokable
    public final void setFlag(io.qt.gui.QGlyphRun.@NonNull GlyphRunFlag flag, boolean enabled){
        setFlag_native_QGlyphRun_GlyphRunFlag_bool(QtJambi_LibraryUtilities.internal.nativeId(this), flag.value(), enabled);
    }
    
    @QtUninvokable
    private native void setFlag_native_QGlyphRun_GlyphRunFlag_bool(long __this__nativeId, int flag, boolean enabled);
    
    /**
     * See QGlyphRun::setFlags(QGlyphRun::GlyphRunFlags)
     */
    @QtUninvokable
    public final void setFlags(io.qt.gui.QGlyphRun.@NonNull GlyphRunFlags flags){
        setFlags_native_QGlyphRun_GlyphRunFlags(QtJambi_LibraryUtilities.internal.nativeId(this), flags.value());
    }
    
    @QtUninvokable
    private native void setFlags_native_QGlyphRun_GlyphRunFlags(long __this__nativeId, int flags);
    
    /**
     * See QGlyphRun::setGlyphIndexes(QList<quint32>)
     */
    @QtUninvokable
    public final void setGlyphIndexes(java.util.@NonNull Collection glyphIndexes){
        setGlyphIndexes_native_cref_QList(QtJambi_LibraryUtilities.internal.nativeId(this), glyphIndexes);
    }
    
    @QtUninvokable
    private native void setGlyphIndexes_native_cref_QList(long __this__nativeId, java.util.Collection glyphIndexes);
    
    /**
     * See QGlyphRun::setOverline(bool)
     */
    @QtUninvokable
    public final void setOverline(boolean overline){
        setOverline_native_bool(QtJambi_LibraryUtilities.internal.nativeId(this), overline);
    }
    
    @QtUninvokable
    private native void setOverline_native_bool(long __this__nativeId, boolean overline);
    
    /**
     * See QGlyphRun::setPositions(QList<QPointF>)
     */
    @QtUninvokable
    public final void setPositions(java.util.@NonNull Collection positions){
        setPositions_native_cref_QList(QtJambi_LibraryUtilities.internal.nativeId(this), positions);
    }
    
    @QtUninvokable
    private native void setPositions_native_cref_QList(long __this__nativeId, java.util.Collection positions);
    
    /**
     * See QGlyphRun::setRawFont(QRawFont)
     */
    @QtUninvokable
    public final void setRawFont(io.qt.gui.@NonNull QRawFont rawFont){
        setRawFont_native_cref_QRawFont(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(rawFont));
    }
    
    @QtUninvokable
    private native void setRawFont_native_cref_QRawFont(long __this__nativeId, long rawFont);
    
    /**
     * See QGlyphRun::setRightToLeft(bool)
     */
    @QtUninvokable
    public final void setRightToLeft(boolean on){
        setRightToLeft_native_bool(QtJambi_LibraryUtilities.internal.nativeId(this), on);
    }
    
    @QtUninvokable
    private native void setRightToLeft_native_bool(long __this__nativeId, boolean on);
    
    /**
     * See QGlyphRun::setSourceString(QString)
     */
    @QtUninvokable
    public final void setSourceString(java.lang.@NonNull String sourceString){
        setSourceString_native_cref_QString(QtJambi_LibraryUtilities.internal.nativeId(this), sourceString);
    }
    
    @QtUninvokable
    private native void setSourceString_native_cref_QString(long __this__nativeId, java.lang.String sourceString);
    
    /**
     * See QGlyphRun::setStrikeOut(bool)
     */
    @QtUninvokable
    public final void setStrikeOut(boolean strikeOut){
        setStrikeOut_native_bool(QtJambi_LibraryUtilities.internal.nativeId(this), strikeOut);
    }
    
    @QtUninvokable
    private native void setStrikeOut_native_bool(long __this__nativeId, boolean strikeOut);
    
    /**
     * See QGlyphRun::setStringIndexes(QList<qsizetype>)
     */
    @QtUninvokable
    public final void setStringIndexes(java.util.@NonNull Collection stringIndexes){
        setStringIndexes_native_cref_QList(QtJambi_LibraryUtilities.internal.nativeId(this), stringIndexes);
    }
    
    @QtUninvokable
    private native void setStringIndexes_native_cref_QList(long __this__nativeId, java.util.Collection stringIndexes);
    
    /**
     * See QGlyphRun::setUnderline(bool)
     */
    @QtUninvokable
    public final void setUnderline(boolean underline){
        setUnderline_native_bool(QtJambi_LibraryUtilities.internal.nativeId(this), underline);
    }
    
    @QtUninvokable
    private native void setUnderline_native_bool(long __this__nativeId, boolean underline);
    
    /**
     * See QGlyphRun::sourceString()const
     */
    @QtUninvokable
    public final java.lang.@NonNull String sourceString(){
        return sourceString_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native java.lang.String sourceString_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::strikeOut()const
     */
    @QtUninvokable
    public final boolean strikeOut(){
        return strikeOut_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean strikeOut_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::stringIndexes()const
     */
    @QtUninvokable
    public final io.qt.core.@NonNull QList stringIndexes(){
        return stringIndexes_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.core.QList stringIndexes_native_constfct(long __this__nativeId);
    
    /**
     * See QGlyphRun::swap(QGlyphRun&)
     */
    @QtUninvokable
    public final void swap(io.qt.gui.@StrictNonNull QGlyphRun other){
        java.util.Objects.requireNonNull(other, "Argument 'other': null not expected.");
        swap_native_ref_QGlyphRun(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(other));
    }
    
    @QtUninvokable
    private native void swap_native_ref_QGlyphRun(long __this__nativeId, long other);
    
    /**
     * See QGlyphRun::underline()const
     */
    @QtUninvokable
    public final boolean underline(){
        return underline_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean underline_native_constfct(long __this__nativeId);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QGlyphRun(QPrivateConstructor p) { super(p); } 
    

    /**
     * See QGlyphRun::operator==(QGlyphRun)const
     */
    @Override
    @QtUninvokable
    public boolean equals(Object other) {
        if (other instanceof io.qt.gui.QGlyphRun) {
            return equals((io.qt.gui.QGlyphRun) other);
        }

        return false;
    }


    /**
     * Returns the objects's hash code computed by qHash(QGlyphRun).
     */
    @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 QGlyphRun::QGlyphRun(QGlyphRun)
     */
    @QtUninvokable
    @Override
    public QGlyphRun clone() {
        return clone_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    private static native QGlyphRun clone_native(long __this_nativeId);
    
    /**
     * Overloaded function for {@link #setBoundingRect(io.qt.core.QRectF)}.
     */
    @QtUninvokable
    public final void setBoundingRect(io.qt.core.@NonNull QRect boundingRect) {
        setBoundingRect(new io.qt.core.QRectF(boundingRect));
    }
    
    /**
     * Overloaded function for {@link #setFlag(io.qt.gui.QGlyphRun.GlyphRunFlag, boolean)}
     *  with enabled = true.
     */
    @QtUninvokable
    public final void setFlag(io.qt.gui.QGlyphRun.@NonNull GlyphRunFlag flag) {
        setFlag(flag, (boolean)true);
    }
    
    /**
     * Overloaded function for {@link #setFlags(io.qt.gui.QGlyphRun.GlyphRunFlags)}.
     */
    @QtUninvokable
    public final void setFlags(io.qt.gui.QGlyphRun.@NonNull GlyphRunFlag @NonNull... flags) {
        setFlags(new io.qt.gui.QGlyphRun.GlyphRunFlags(flags));
    }
}