Sophie

Sophie

distrib > Mandriva > 2010.0 > i586 > media > contrib-release > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 2302

qtjambi-doc-4.3.3-3mdv2008.1.i586.rpm

<class name="QTextBlockFormat" doc="/**
&lt;p&gt;The &lt;a href=&quot;QTextBlockFormat.html#QTextBlockFormat()&quot;&gt;&lt;tt&gt;QTextBlockFormat&lt;/tt&gt;&lt;/a&gt; class provides formatting information for blocks of text 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 document is composed of a list of blocks, represented by &lt;a href=&quot;QTextBlock.html&quot;&gt;&lt;tt&gt;QTextBlock&lt;/tt&gt;&lt;/a&gt; objects. Each block can contain an item of some kind, such as a paragraph of text, a table, a list, or an image. Every block has an associated &lt;a href=&quot;QTextBlockFormat.html#QTextBlockFormat()&quot;&gt;&lt;tt&gt;QTextBlockFormat&lt;/tt&gt;&lt;/a&gt; that specifies its characteristics.&lt;/p&gt;
&lt;p&gt;To cater for left-to-right and right-to-left languages you can set a block's direction with setDirection(). Paragraph alignment is set with &lt;a href=&quot;QTextBlockFormat.html#setAlignment(com.trolltech.qt.core.Qt.Alignment)&quot;&gt;&lt;tt&gt;setAlignment&lt;/tt&gt;&lt;/a&gt;. Margins are controlled by &lt;a href=&quot;QTextBlockFormat.html#setTopMargin(double)&quot;&gt;&lt;tt&gt;setTopMargin&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QTextBlockFormat.html#setBottomMargin(double)&quot;&gt;&lt;tt&gt;setBottomMargin&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QTextBlockFormat.html#setLeftMargin(double)&quot;&gt;&lt;tt&gt;setLeftMargin&lt;/tt&gt;&lt;/a&gt;, &lt;a href=&quot;QTextBlockFormat.html#setRightMargin(double)&quot;&gt;&lt;tt&gt;setRightMargin&lt;/tt&gt;&lt;/a&gt;. Overall indentation is set with &lt;a href=&quot;QTextBlockFormat.html#setIndent(int)&quot;&gt;&lt;tt&gt;setIndent&lt;/tt&gt;&lt;/a&gt;, the indentation of the first line with &lt;a href=&quot;QTextBlockFormat.html#setTextIndent(double)&quot;&gt;&lt;tt&gt;setTextIndent&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;Line breaking can be enabled and disabled with &lt;a href=&quot;QTextBlockFormat.html#setNonBreakableLines(boolean)&quot;&gt;&lt;tt&gt;setNonBreakableLines&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
&lt;p&gt;The brush used to paint the paragraph's background is set with setBackground(), and other aspects of the text's appearance can be customized by using the setProperty() function with the &lt;tt&gt;OutlinePen&lt;/tt&gt;, &lt;tt&gt;ForegroundBrush&lt;/tt&gt;, and &lt;tt&gt;BackgroundBrush&lt;/tt&gt; &lt;tt&gt;QTextFormat::Property&lt;/tt&gt; values.&lt;/p&gt;
&lt;p&gt;If a text block is part of a list, it can also have a list format that is accessible with the listFormat() function.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlock.html&quot;&gt;&lt;tt&gt;QTextBlock&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextCharFormat.html&quot;&gt;&lt;tt&gt;QTextCharFormat&lt;/tt&gt;&lt;/a&gt; */">
    <method name="public QTextBlockFormat()" doc="/**
&lt;p&gt;Constructs a new &lt;a href=&quot;QTextBlockFormat.html#QTextBlockFormat()&quot;&gt;&lt;tt&gt;QTextBlockFormat&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;
 */"/>
    <method name="public final com.trolltech.qt.core.Qt.Alignment alignment()" doc="/**
&lt;p&gt;Returns the paragraph's alignment.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#setAlignment(com.trolltech.qt.core.Qt.Alignment)&quot;&gt;&lt;tt&gt;setAlignment&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final double bottomMargin()" doc="/**
&lt;p&gt;Returns the paragraph's bottom margin.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#setBottomMargin(double)&quot;&gt;&lt;tt&gt;setBottomMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#topMargin()&quot;&gt;&lt;tt&gt;topMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final int indent()" doc="/**
&lt;p&gt;Returns the paragraph's indent.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#setIndent(int)&quot;&gt;&lt;tt&gt;setIndent&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final boolean isValid()" doc="/**
&lt;p&gt;Returns true if this block format is valid; otherwise returns false.&lt;/p&gt;
 */"/>
    <method name="public final double leftMargin()" doc="/**
&lt;p&gt;Returns the paragraph's left margin.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#setLeftMargin(double)&quot;&gt;&lt;tt&gt;setLeftMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#rightMargin()&quot;&gt;&lt;tt&gt;rightMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#indent()&quot;&gt;&lt;tt&gt;indent&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final boolean nonBreakableLines()" doc="/**
&lt;p&gt;Returns true if the lines in the paragraph are non-breakable; otherwise returns false.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#setNonBreakableLines(boolean)&quot;&gt;&lt;tt&gt;setNonBreakableLines&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 paragraph. The default is QTextFormat::PageBreak_Auto.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#setPageBreakPolicy(com.trolltech.qt.gui.QTextFormat.PageBreakFlags)&quot;&gt;&lt;tt&gt;setPageBreakPolicy&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final double rightMargin()" doc="/**
&lt;p&gt;Returns the paragraph's right margin.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#setRightMargin(double)&quot;&gt;&lt;tt&gt;setRightMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#leftMargin()&quot;&gt;&lt;tt&gt;leftMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setAlignment(com.trolltech.qt.core.Qt.Alignment alignment)" doc="/**
&lt;p&gt;Sets the paragraph's &lt;tt&gt;alignment&lt;/tt&gt;.&lt;/p&gt;

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

@see &lt;a href=&quot;QTextBlockFormat.html#bottomMargin()&quot;&gt;&lt;tt&gt;bottomMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setTopMargin(double)&quot;&gt;&lt;tt&gt;setTopMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setLeftMargin(double)&quot;&gt;&lt;tt&gt;setLeftMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setRightMargin(double)&quot;&gt;&lt;tt&gt;setRightMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setIndent(int indent)" doc="/**
&lt;p&gt;Sets the paragraph's &lt;tt&gt;indent&lt;/tt&gt;. Margins are set independently of indentation with &lt;a href=&quot;QTextBlockFormat.html#setLeftMargin(double)&quot;&gt;&lt;tt&gt;setLeftMargin&lt;/tt&gt;&lt;/a&gt; and setTextIdent().&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#indent()&quot;&gt;&lt;tt&gt;indent&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setLeftMargin(double margin)" doc="/**
&lt;p&gt;Sets the paragraph's left &lt;tt&gt;margin&lt;/tt&gt;. Indentation can be applied separately with &lt;a href=&quot;QTextBlockFormat.html#setIndent(int)&quot;&gt;&lt;tt&gt;setIndent&lt;/tt&gt;&lt;/a&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#leftMargin()&quot;&gt;&lt;tt&gt;leftMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setRightMargin(double)&quot;&gt;&lt;tt&gt;setRightMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setTopMargin(double)&quot;&gt;&lt;tt&gt;setTopMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setBottomMargin(double)&quot;&gt;&lt;tt&gt;setBottomMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setNonBreakableLines(boolean b)" doc="/**
&lt;p&gt;If &lt;tt&gt;b&lt;/tt&gt; is true, the lines in the paragraph are treated as non-breakable; otherwise they are breakable.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#nonBreakableLines()&quot;&gt;&lt;tt&gt;nonBreakableLines&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 paragraph to &lt;tt&gt;flags&lt;/tt&gt;.&lt;/p&gt;

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

@see &lt;a href=&quot;QTextBlockFormat.html#rightMargin()&quot;&gt;&lt;tt&gt;rightMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setLeftMargin(double)&quot;&gt;&lt;tt&gt;setLeftMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setTopMargin(double)&quot;&gt;&lt;tt&gt;setTopMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setBottomMargin(double)&quot;&gt;&lt;tt&gt;setBottomMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setTextIndent(double margin)" doc="/**
&lt;p&gt;Sets the &lt;tt&gt;margin&lt;/tt&gt; for the first line in the block. This allows the first line of a paragraph to be indented differently to the other lines, enhancing the readability of the text.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#textIndent()&quot;&gt;&lt;tt&gt;textIndent&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setLeftMargin(double)&quot;&gt;&lt;tt&gt;setLeftMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setRightMargin(double)&quot;&gt;&lt;tt&gt;setRightMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setTopMargin(double)&quot;&gt;&lt;tt&gt;setTopMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setBottomMargin(double)&quot;&gt;&lt;tt&gt;setBottomMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setTopMargin(double margin)" doc="/**
&lt;p&gt;Sets the paragraph's top &lt;tt&gt;margin&lt;/tt&gt;.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#topMargin()&quot;&gt;&lt;tt&gt;topMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setBottomMargin(double)&quot;&gt;&lt;tt&gt;setBottomMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setLeftMargin(double)&quot;&gt;&lt;tt&gt;setLeftMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#setRightMargin(double)&quot;&gt;&lt;tt&gt;setRightMargin&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final double textIndent()" doc="/**
&lt;p&gt;Returns the paragraph's text indent.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#setTextIndent(double)&quot;&gt;&lt;tt&gt;setTextIndent&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final double topMargin()" doc="/**
&lt;p&gt;Returns the paragraph's top margin.&lt;/p&gt;

@see &lt;a href=&quot;QTextBlockFormat.html#setTopMargin(double)&quot;&gt;&lt;tt&gt;setTopMargin&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextBlockFormat.html#bottomMargin()&quot;&gt;&lt;tt&gt;bottomMargin&lt;/tt&gt;&lt;/a&gt; */"/>
</class>