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


/**
 * Formatting information for frames in a QTextDocument
 * Java wrapper for Qt class QTextFrameFormat
 */
public class QTextFrameFormat extends io.qt.gui.QTextFormat
    implements java.lang.Cloneable
{
    /**
     * Java wrapper for Qt enum QTextFrameFormat::BorderStyle
     */
    public enum BorderStyle implements QtEnumerator {
        /**
         * Representing QTextFrameFormat::BorderStyle_None
         */
        BorderStyle_None(0),
        /**
         * Representing QTextFrameFormat::BorderStyle_Dotted
         */
        BorderStyle_Dotted(1),
        /**
         * Representing QTextFrameFormat::BorderStyle_Dashed
         */
        BorderStyle_Dashed(2),
        /**
         * Representing QTextFrameFormat::BorderStyle_Solid
         */
        BorderStyle_Solid(3),
        /**
         * Representing QTextFrameFormat::BorderStyle_Double
         */
        BorderStyle_Double(4),
        /**
         * Representing QTextFrameFormat::BorderStyle_DotDash
         */
        BorderStyle_DotDash(5),
        /**
         * Representing QTextFrameFormat::BorderStyle_DotDotDash
         */
        BorderStyle_DotDotDash(6),
        /**
         * Representing QTextFrameFormat::BorderStyle_Groove
         */
        BorderStyle_Groove(7),
        /**
         * Representing QTextFrameFormat::BorderStyle_Ridge
         */
        BorderStyle_Ridge(8),
        /**
         * Representing QTextFrameFormat::BorderStyle_Inset
         */
        BorderStyle_Inset(9),
        /**
         * Representing QTextFrameFormat::BorderStyle_Outset
         */
        BorderStyle_Outset(10);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

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

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

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull BorderStyle resolve(int value) {
            switch (value) {
            case 0: return BorderStyle_None;
            case 1: return BorderStyle_Dotted;
            case 2: return BorderStyle_Dashed;
            case 3: return BorderStyle_Solid;
            case 4: return BorderStyle_Double;
            case 5: return BorderStyle_DotDash;
            case 6: return BorderStyle_DotDotDash;
            case 7: return BorderStyle_Groove;
            case 8: return BorderStyle_Ridge;
            case 9: return BorderStyle_Inset;
            case 10: return BorderStyle_Outset;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    /**
     * Java wrapper for Qt enum QTextFrameFormat::Position
     */
    public enum Position implements QtEnumerator {
        /**
         * Representing QTextFrameFormat::InFlow
         */
        InFlow(0),
        /**
         * Representing QTextFrameFormat::FloatLeft
         */
        FloatLeft(1),
        /**
         * Representing QTextFrameFormat::FloatRight
         */
        FloatRight(2);

        static {
            QtJambi_LibraryUtilities.initialize();
        }

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

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

        /**
         * Returns the corresponding enum entry for the given value.
         * @param value
         * @return enum entry
         */
        public static @NonNull Position resolve(int value) {
            switch (value) {
            case 0: return InFlow;
            case 1: return FloatLeft;
            case 2: return FloatRight;
            default: throw new QNoSuchEnumValueException(value);
            }
        }


        private final int value;
    }
    
    
    /**
     * See QTextFrameFormat::QTextFrameFormat()
     */
    public QTextFrameFormat(){
        super((QPrivateConstructor)null);
        initialize_native(this);
    }
    
    private native static void initialize_native(QTextFrameFormat instance);
    
    /**
     * See QTextFrameFormat::QTextFrameFormat(QTextFormat)
     */
    protected QTextFrameFormat(io.qt.gui.@NonNull QTextFormat fmt){
        super((QPrivateConstructor)null);
        initialize_native(this, fmt);
    }
    
    private native static void initialize_native(QTextFrameFormat instance, io.qt.gui.QTextFormat fmt);
    
    /**
     * See QTextFrameFormat::QTextFrameFormat(QTextFrameFormat)
     */
    public QTextFrameFormat(io.qt.gui.@NonNull QTextFrameFormat other){
        super((QPrivateConstructor)null);
        initialize_native(this, other);
    }
    
    private native static void initialize_native(QTextFrameFormat instance, io.qt.gui.QTextFrameFormat other);
    
    /**
     * See QTextFrameFormat::border()const
     */
    @QtUninvokable
    public final double border(){
        return border_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native double border_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::borderBrush()const
     */
    @QtUninvokable
    public final io.qt.gui.@NonNull QBrush borderBrush(){
        return borderBrush_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.gui.QBrush borderBrush_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::borderStyle()const
     */
    @QtUninvokable
    public final io.qt.gui.QTextFrameFormat.@NonNull BorderStyle borderStyle(){
        return io.qt.gui.QTextFrameFormat.BorderStyle.resolve(borderStyle_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int borderStyle_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::bottomMargin()const
     */
    @QtUninvokable
    public final double bottomMargin(){
        return bottomMargin_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native double bottomMargin_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::height()const
     */
    @QtUninvokable
    public final io.qt.gui.@NonNull QTextLength height(){
        return height_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.gui.QTextLength height_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFormat::isValid()const
     */
    @QtDeclaredFinal
    @QtUninvokable
    public boolean isValid(){
        return isValid_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native boolean isValid_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::leftMargin()const
     */
    @QtUninvokable
    public final double leftMargin(){
        return leftMargin_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native double leftMargin_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::margin()const
     */
    @QtUninvokable
    public final double margin(){
        return margin_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native double margin_native_constfct(long __this__nativeId);
    
    /**
     * See operator<<(QDataStream&,QTextFrameFormat)
     */
    @QtUninvokable
    public void writeTo(io.qt.core.@StrictNonNull QDataStream arg__1){
        java.util.Objects.requireNonNull(arg__1, "Argument 'arg__1': null not expected.");
        writeTo_native_ref_QDataStream(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(arg__1));
    }
    
    @QtUninvokable
    private native void writeTo_native_ref_QDataStream(long __this__nativeId, long arg__1);
    
    /**
     * See operator>>(QDataStream&,QTextFrameFormat&)
     */
    @QtUninvokable
    public void readFrom(io.qt.core.@StrictNonNull QDataStream arg__1){
        java.util.Objects.requireNonNull(arg__1, "Argument 'arg__1': null not expected.");
        readFrom_native_ref_QDataStream(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(arg__1));
    }
    
    @QtUninvokable
    private native void readFrom_native_ref_QDataStream(long __this__nativeId, long arg__1);
    
    /**
     * See QTextFrameFormat::padding()const
     */
    @QtUninvokable
    public final double padding(){
        return padding_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native double padding_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::pageBreakPolicy()const
     */
    @QtUninvokable
    public final io.qt.gui.QTextFormat.@NonNull PageBreakFlags pageBreakPolicy(){
        return new io.qt.gui.QTextFormat.PageBreakFlags(pageBreakPolicy_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int pageBreakPolicy_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::position()const
     */
    @QtUninvokable
    public final io.qt.gui.QTextFrameFormat.@NonNull Position position(){
        return io.qt.gui.QTextFrameFormat.Position.resolve(position_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this)));
    }
    
    @QtUninvokable
    private native int position_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::rightMargin()const
     */
    @QtUninvokable
    public final double rightMargin(){
        return rightMargin_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native double rightMargin_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::setBorder(qreal)
     */
    @QtUninvokable
    public final void setBorder(double border){
        setBorder_native_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), border);
    }
    
    @QtUninvokable
    private native void setBorder_native_qreal(long __this__nativeId, double border);
    
    /**
     * See QTextFrameFormat::setBorderBrush(QBrush)
     */
    @QtUninvokable
    public final void setBorderBrush(io.qt.gui.@NonNull QBrush brush){
        setBorderBrush_native_cref_QBrush(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(brush));
    }
    
    @QtUninvokable
    private native void setBorderBrush_native_cref_QBrush(long __this__nativeId, long brush);
    
    /**
     * See QTextFrameFormat::setBorderStyle(QTextFrameFormat::BorderStyle)
     */
    @QtUninvokable
    public final void setBorderStyle(io.qt.gui.QTextFrameFormat.@NonNull BorderStyle style){
        setBorderStyle_native_QTextFrameFormat_BorderStyle(QtJambi_LibraryUtilities.internal.nativeId(this), style.value());
    }
    
    @QtUninvokable
    private native void setBorderStyle_native_QTextFrameFormat_BorderStyle(long __this__nativeId, int style);
    
    /**
     * See QTextFrameFormat::setBottomMargin(qreal)
     */
    @QtUninvokable
    public final void setBottomMargin(double margin){
        setBottomMargin_native_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), margin);
    }
    
    @QtUninvokable
    private native void setBottomMargin_native_qreal(long __this__nativeId, double margin);
    
    /**
     * See QTextFrameFormat::setHeight(QTextLength)
     */
    @QtUninvokable
    public final void setHeight(io.qt.gui.@NonNull QTextLength height){
        setHeight_native_cref_QTextLength(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(height));
    }
    
    @QtUninvokable
    private native void setHeight_native_cref_QTextLength(long __this__nativeId, long height);
    
    /**
     * See QTextFrameFormat::setHeight(qreal)
     */
    @QtUninvokable
    public final void setHeight(double height){
        setHeight_native_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), height);
    }
    
    @QtUninvokable
    private native void setHeight_native_qreal(long __this__nativeId, double height);
    
    /**
     * See QTextFrameFormat::setLeftMargin(qreal)
     */
    @QtUninvokable
    public final void setLeftMargin(double margin){
        setLeftMargin_native_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), margin);
    }
    
    @QtUninvokable
    private native void setLeftMargin_native_qreal(long __this__nativeId, double margin);
    
    /**
     * See QTextFrameFormat::setMargin(qreal)
     */
    @QtUninvokable
    public final void setMargin(double margin){
        setMargin_native_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), margin);
    }
    
    @QtUninvokable
    private native void setMargin_native_qreal(long __this__nativeId, double margin);
    
    /**
     * See QTextFrameFormat::setPadding(qreal)
     */
    @QtUninvokable
    public final void setPadding(double padding){
        setPadding_native_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), padding);
    }
    
    @QtUninvokable
    private native void setPadding_native_qreal(long __this__nativeId, double padding);
    
    /**
     * See QTextFrameFormat::setPageBreakPolicy(QTextFormat::PageBreakFlags)
     */
    @QtUninvokable
    public final void setPageBreakPolicy(io.qt.gui.QTextFormat.@NonNull PageBreakFlags flags){
        setPageBreakPolicy_native_QTextFormat_PageBreakFlags(QtJambi_LibraryUtilities.internal.nativeId(this), flags.value());
    }
    
    @QtUninvokable
    private native void setPageBreakPolicy_native_QTextFormat_PageBreakFlags(long __this__nativeId, int flags);
    
    /**
     * See QTextFrameFormat::setPosition(QTextFrameFormat::Position)
     */
    @QtUninvokable
    public final void setPosition(io.qt.gui.QTextFrameFormat.@NonNull Position f){
        setPosition_native_QTextFrameFormat_Position(QtJambi_LibraryUtilities.internal.nativeId(this), f.value());
    }
    
    @QtUninvokable
    private native void setPosition_native_QTextFrameFormat_Position(long __this__nativeId, int f);
    
    /**
     * See QTextFrameFormat::setRightMargin(qreal)
     */
    @QtUninvokable
    public final void setRightMargin(double margin){
        setRightMargin_native_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), margin);
    }
    
    @QtUninvokable
    private native void setRightMargin_native_qreal(long __this__nativeId, double margin);
    
    /**
     * See QTextFrameFormat::setTopMargin(qreal)
     */
    @QtUninvokable
    public final void setTopMargin(double margin){
        setTopMargin_native_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), margin);
    }
    
    @QtUninvokable
    private native void setTopMargin_native_qreal(long __this__nativeId, double margin);
    
    /**
     * See QTextFrameFormat::setWidth(QTextLength)
     */
    @QtUninvokable
    public final void setWidth(io.qt.gui.@NonNull QTextLength length){
        setWidth_native_cref_QTextLength(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(length));
    }
    
    @QtUninvokable
    private native void setWidth_native_cref_QTextLength(long __this__nativeId, long length);
    
    /**
     * See QTextFrameFormat::setWidth(qreal)
     */
    @QtUninvokable
    public final void setWidth(double width){
        setWidth_native_qreal(QtJambi_LibraryUtilities.internal.nativeId(this), width);
    }
    
    @QtUninvokable
    private native void setWidth_native_qreal(long __this__nativeId, double width);
    
    /**
     * See swap(QTextFrameFormat&,QTextFrameFormat&)
     */
    @QtUninvokable
    public final void swap(io.qt.gui.@StrictNonNull QTextFrameFormat value2){
        java.util.Objects.requireNonNull(value2, "Argument 'value2': null not expected.");
        swap_native_ref_QTextFrameFormat(QtJambi_LibraryUtilities.internal.nativeId(this), QtJambi_LibraryUtilities.internal.checkedNativeId(value2));
    }
    
    @QtUninvokable
    private native void swap_native_ref_QTextFrameFormat(long __this__nativeId, long value2);
    
    /**
     * See QTextFrameFormat::topMargin()const
     */
    @QtUninvokable
    public final double topMargin(){
        return topMargin_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native double topMargin_native_constfct(long __this__nativeId);
    
    /**
     * See QTextFrameFormat::width()const
     */
    @QtUninvokable
    public final io.qt.gui.@NonNull QTextLength width(){
        return width_native_constfct(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    
    @QtUninvokable
    private native io.qt.gui.QTextLength width_native_constfct(long __this__nativeId);
    
    /**
     * Constructor for internal use only.
     * @param p expected to be null.
     * @hidden
     */
    @NativeAccess
    protected QTextFrameFormat(QPrivateConstructor p) { super(p); } 
    
    
    /**
     * Creates and returns a copy of this object.
    See QTextFrameFormat::QTextFrameFormat(QTextFrameFormat)
     */
    @QtUninvokable
    @Override
    public QTextFrameFormat clone() {
        return clone_native(QtJambi_LibraryUtilities.internal.nativeId(this));
    }
    private static native QTextFrameFormat clone_native(long __this_nativeId);
    
    /**
     * Overloaded function for {@link #setBorderBrush(io.qt.gui.QBrush)}.
     */
    @QtUninvokable
    public final void setBorderBrush(io.qt.core.Qt.@NonNull BrushStyle brush) {
        setBorderBrush(new io.qt.gui.QBrush(brush));
    }
    
    /**
     * Overloaded function for {@link #setBorderBrush(io.qt.gui.QBrush)}.
     */
    @QtUninvokable
    public final void setBorderBrush(io.qt.gui.@NonNull QColor brush) {
        setBorderBrush(new io.qt.gui.QBrush(brush));
    }
    
    /**
     * Overloaded function for {@link #setBorderBrush(io.qt.gui.QBrush)}.
     */
    @QtUninvokable
    public final void setBorderBrush(io.qt.core.Qt.@NonNull GlobalColor brush) {
        setBorderBrush(new io.qt.gui.QBrush(brush));
    }
    
    /**
     * Overloaded function for {@link #setBorderBrush(io.qt.gui.QBrush)}.
     */
    @QtUninvokable
    public final void setBorderBrush(io.qt.gui.@NonNull QPixmap brush) {
        setBorderBrush(new io.qt.gui.QBrush(brush));
    }
    
    /**
     * Overloaded function for {@link #setBorderBrush(io.qt.gui.QBrush)}.
     */
    @QtUninvokable
    public final void setBorderBrush(io.qt.gui.@NonNull QImage brush) {
        setBorderBrush(new io.qt.gui.QBrush(brush));
    }
    
    /**
     * Overloaded function for {@link #setBorderBrush(io.qt.gui.QBrush)}.
     */
    @QtUninvokable
    public final void setBorderBrush(io.qt.gui.@NonNull QGradient brush) {
        setBorderBrush(new io.qt.gui.QBrush(brush));
    }
    
    /**
     * Overloaded function for {@link #setPageBreakPolicy(io.qt.gui.QTextFormat.PageBreakFlags)}.
     */
    @QtUninvokable
    public final void setPageBreakPolicy(io.qt.gui.QTextFormat.@NonNull PageBreakFlag @NonNull... flags) {
        setPageBreakPolicy(new io.qt.gui.QTextFormat.PageBreakFlags(flags));
    }
}