<class name="QTextFrameFormat" doc="/**
&lt;p&gt;The &lt;a href=&quot;QTextFrameFormat.html#QTextFrameFormat()&quot;&gt;&lt;tt&gt;QTextFrameFormat&lt;/tt&gt;&lt;/a&gt; class provides formatting information for frames in a &lt;a href=&quot;QTextDocument.html&quot;&gt;&lt;tt&gt;QTextDocument&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;A text frame groups together one or more blocks of text, providing a layer of structure larger than the paragraph. The format of a frame specifies how it is rendered and positioned on the screen. It does not directly specify the behavior of the text formatting within, but provides constraints on the layout of its children.&lt;/p&gt;
&lt;p&gt;The frame format defines the &lt;a href=&quot;QTextFrameFormat.html#width()&quot;&gt;&lt;tt&gt;width&lt;/tt&gt;&lt;/a&gt; and &lt;a href=&quot;QTextFrameFormat.html#height()&quot;&gt;&lt;tt&gt;height&lt;/tt&gt;&lt;/a&gt; of the frame on the screen. Each frame can have a &lt;a href=&quot;QTextFrameFormat.html#border()&quot;&gt;&lt;tt&gt;border&lt;/tt&gt;&lt;/a&gt; that surrounds its contents with a rectangular box. The border is surrounded by a &lt;a href=&quot;QTextFrameFormat.html#margin()&quot;&gt;&lt;tt&gt;margin&lt;/tt&gt;&lt;/a&gt; around the frame, and the contents of the frame are kept separate from the border by the frame's &lt;a href=&quot;QTextFrameFormat.html#padding()&quot;&gt;&lt;tt&gt;padding&lt;/tt&gt;&lt;/a&gt;. This scheme is similar to the box model used by Cascading Style Sheets for HTML pages.&lt;/p&gt;
&lt;p align=&quot;center&quot;&gt;&lt;img src=&quot;%2E%2E/images/qtextframe-style.png&quot; /&gt;&lt;/p&gt;&lt;p&gt;The &lt;a href=&quot;QTextFrameFormat.html#position()&quot;&gt;&lt;tt&gt;position&lt;/tt&gt;&lt;/a&gt; of a frame is set using &lt;a href=&quot;QTextFrameFormat.html#setPosition(com.trolltech.qt.gui.QTextFrameFormat.Position)&quot;&gt;&lt;tt&gt;setPosition&lt;/tt&gt;&lt;/a&gt; and determines how it is located relative to the surrounding text.&lt;/p&gt;
&lt;p&gt;The validity of a &lt;a href=&quot;QTextFrameFormat.html#QTextFrameFormat()&quot;&gt;&lt;tt&gt;QTextFrameFormat&lt;/tt&gt;&lt;/a&gt; object can be determined with the &lt;a href=&quot;QTextFrameFormat.html#isValid()&quot;&gt;&lt;tt&gt;isValid&lt;/tt&gt;&lt;/a&gt; function.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrame.html&quot;&gt;&lt;tt&gt;QTextFrame&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html&quot;&gt;&lt;tt&gt;QTextBlockFormat&lt;/tt&gt;&lt;/a&gt; */">
    <method name="public QTextFrameFormat()" doc="/**
&lt;p&gt;Constructs a text frame format object with the default properties.&lt;/p&gt;
 */"/>
    <method name="public final double border()" doc="/**
&lt;p&gt;Returns the width of the border in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setBorder(double)&quot;&gt;&lt;tt&gt;setBorder&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QBrush borderBrush()" doc="/**
&lt;p&gt;Returns the brush used for the frame's border.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setBorderBrush(com.trolltech.qt.gui.QBrush)&quot;&gt;&lt;tt&gt;setBorderBrush&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QTextFrameFormat.BorderStyle borderStyle()" doc="/**
&lt;p&gt;Returns the style of the frame's border.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setBorderStyle(com.trolltech.qt.gui.QTextFrameFormat.BorderStyle)&quot;&gt;&lt;tt&gt;setBorderStyle&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final double bottomMargin()" doc="/**
&lt;p&gt;Returns the width of the frame's bottom margin in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setBottomMargin(double)&quot;&gt;&lt;tt&gt;setBottomMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QTextLength height()" doc="/**
&lt;p&gt;Returns the height of the frame's border rectangle.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setHeight(com.trolltech.qt.gui.QTextLength)&quot;&gt;&lt;tt&gt;setHeight&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public boolean isValid()" doc="/**
&lt;p&gt;Returns true if the format description is valid; otherwise returns false.&lt;/p&gt;
 */"/>
    <method name="public final double leftMargin()" doc="/**
&lt;p&gt;Returns the width of the frame's left margin in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setLeftMargin(double)&quot;&gt;&lt;tt&gt;setLeftMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final double margin()" doc="/**
&lt;p&gt;Returns the width of the frame's external margin in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setMargin(double)&quot;&gt;&lt;tt&gt;setMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final double padding()" doc="/**
&lt;p&gt;Returns the width of the frame's internal padding in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setPadding(double)&quot;&gt;&lt;tt&gt;setPadding&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QTextFormat.PageBreakFlags pageBreakPolicy()" doc="/**
&lt;p&gt;Returns the currently set page break policy for the frame/table. The default is QTextFormat::PageBreak_Auto.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setPageBreakPolicy(com.trolltech.qt.gui.QTextFormat.PageBreakFlags)&quot;&gt;&lt;tt&gt;setPageBreakPolicy&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QTextFrameFormat.Position position()" doc="/**
&lt;p&gt;Returns the positioning policy for frames with this frame format.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setPosition(com.trolltech.qt.gui.QTextFrameFormat.Position)&quot;&gt;&lt;tt&gt;setPosition&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final double rightMargin()" doc="/**
&lt;p&gt;Returns the width of the frame's right margin in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setRightMargin(double)&quot;&gt;&lt;tt&gt;setRightMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setBorder(double border)" doc="/**
&lt;p&gt;Sets the &lt;tt&gt;border&lt;/tt&gt; (in pixels) of the frame's border.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#border()&quot;&gt;&lt;tt&gt;border&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setBorderBrush(com.trolltech.qt.gui.QBrush brush)" doc="/**
&lt;p&gt;Sets the &lt;tt&gt;brush&lt;/tt&gt; used for the frame's border.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#borderBrush()&quot;&gt;&lt;tt&gt;borderBrush&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setBorderStyle(com.trolltech.qt.gui.QTextFrameFormat.BorderStyle style)" doc="/**
&lt;p&gt;Sets the &lt;tt&gt;style&lt;/tt&gt; of the frame's border.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#borderStyle()&quot;&gt;&lt;tt&gt;borderStyle&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setBottomMargin(double margin)" doc="/**
&lt;p&gt;Sets the frame's bottom &lt;tt&gt;margin&lt;/tt&gt; in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#bottomMargin()&quot;&gt;&lt;tt&gt;bottomMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setHeight(double height)" doc="/**
&lt;p&gt;Sets the frame's &lt;tt&gt;height&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public final void setHeight(com.trolltech.qt.gui.QTextLength height)" doc="/**
&lt;p&gt;Sets the frame's &lt;tt&gt;height&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#height()&quot;&gt;&lt;tt&gt;height&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setLeftMargin(double margin)" doc="/**
&lt;p&gt;Sets the frame's left &lt;tt&gt;margin&lt;/tt&gt; in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#leftMargin()&quot;&gt;&lt;tt&gt;leftMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setMargin(double margin)" doc="/**
&lt;p&gt;Sets the frame's &lt;tt&gt;margin&lt;/tt&gt; in pixels. This method also sets the left, right, top and bottom margins of the frame to the same value. The individual margins override the general margin.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#margin()&quot;&gt;&lt;tt&gt;margin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setPadding(double padding)" doc="/**
&lt;p&gt;Sets the &lt;tt&gt;padding&lt;/tt&gt; of the frame's internal padding in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#padding()&quot;&gt;&lt;tt&gt;padding&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setPageBreakPolicy(com.trolltech.qt.gui.QTextFormat.PageBreakFlags flags)" doc="/**
&lt;p&gt;Sets the page break policy for the frame/table to &lt;tt&gt;flags&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#pageBreakPolicy()&quot;&gt;&lt;tt&gt;pageBreakPolicy&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setPosition(com.trolltech.qt.gui.QTextFrameFormat.Position f)" doc="/**
&lt;p&gt;Sets the &lt;tt&gt;f&lt;/tt&gt; for positioning frames with this frame format.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#position()&quot;&gt;&lt;tt&gt;position&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setRightMargin(double margin)" doc="/**
&lt;p&gt;Sets the frame's right &lt;tt&gt;margin&lt;/tt&gt; in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#rightMargin()&quot;&gt;&lt;tt&gt;rightMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setTopMargin(double margin)" doc="/**
&lt;p&gt;Sets the frame's top &lt;tt&gt;margin&lt;/tt&gt; in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#topMargin()&quot;&gt;&lt;tt&gt;topMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setWidth(com.trolltech.qt.gui.QTextLength length)" doc="/**
&lt;p&gt;Sets the frame's border rectangle's &lt;tt&gt;length&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QTextLength.html&quot;&gt;&lt;tt&gt;QTextLength&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setWidth(double width)" doc="/**
&lt;p&gt;Convenience method that sets the width of the frame's border rectangle's width to the specified fixed &lt;tt&gt;width&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#width()&quot;&gt;&lt;tt&gt;width&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final double topMargin()" doc="/**
&lt;p&gt;Returns the width of the frame's top margin in pixels.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setTopMargin(double)&quot;&gt;&lt;tt&gt;setTopMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QTextLength width()" doc="/**
&lt;p&gt;Returns the width of the frame's border rectangle.&lt;/p&gt;

@see &lt;a href=&quot;QTextFrameFormat.html#setWidth(double)&quot;&gt;&lt;tt&gt;setWidth&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextLength.html&quot;&gt;&lt;tt&gt;QTextLength&lt;/tt&gt;&lt;/a&gt; */"/>
    <enum name="Position">
        <enum-value name="InFlow" doc="/**
Internal. */"/>
        <enum-value name="FloatLeft" doc="/**
Internal. */"/>
        <enum-value name="FloatRight" doc="/**
Internal. */"/>
</enum>
    <enum name="BorderStyle">
        <enum-value name="BorderStyle_None" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_Dotted" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_Dashed" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_Solid" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_Double" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_DotDash" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_DotDotDash" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_Groove" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_Ridge" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_Inset" doc="/**
Internal. */"/>
        <enum-value name="BorderStyle_Outset" doc="/**
Internal. */"/>
</enum>
</class>
