Sophie

Sophie

distrib > * > 2009.0 > i586 > by-pkgid > a6711891ce757817bba854bf3f25205a > files > 2328

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

<class name="QTextList" doc="/**
&lt;p&gt;The &lt;a href=&quot;QTextList.html#QTextList(com.trolltech.qt.gui.QTextDocument)&quot;&gt;&lt;tt&gt;QTextList&lt;/tt&gt;&lt;/a&gt; class provides a decorated list of items 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 list contains a sequence of text blocks, each of which is marked with a bullet point or other symbol. Multiple levels of lists can be used, and the automatic numbering feature provides support for ordered numeric and alphabetical lists.&lt;/p&gt;
&lt;p&gt;Lists are created by using a text cursor to insert an empty list at the current position or by moving existing text into a new list. The &lt;tt&gt;QTextCursor::insertList&lt;/tt&gt; function inserts an empty block into the document at the cursor position, and makes it the first item in a list.&lt;/p&gt;
&lt;pre&gt;        QTextListFormat listFormat;
        if (list) {
            listFormat = list-&amp;gt;format();
            listFormat.setIndent(listFormat.indent() + 1);
        }

        listFormat.setStyle(QTextListFormat::ListDisc);
        cursor.insertList(listFormat);&lt;/pre&gt;
&lt;p&gt;The &lt;tt&gt;QTextCursor::createList&lt;/tt&gt; function takes the contents of the cursor's current block and turns it into the first item of a new list.&lt;/p&gt;
&lt;p&gt;The cursor's current list is found with &lt;tt&gt;QTextCursor::currentList&lt;/tt&gt;.&lt;/p&gt;
&lt;p&gt;The number of items in a list is given by &lt;a href=&quot;QTextList.html#count()&quot;&gt;&lt;tt&gt;count&lt;/tt&gt;&lt;/a&gt;. Each item can be obtained by its index in the list with the &lt;a href=&quot;QTextList.html#item(int)&quot;&gt;&lt;tt&gt;item&lt;/tt&gt;&lt;/a&gt; function. Similarly, the index of a given item can be found with &lt;a href=&quot;QTextList.html#itemNumber(com.trolltech.qt.gui.QTextBlock)&quot;&gt;&lt;tt&gt;itemNumber&lt;/tt&gt;&lt;/a&gt;. The text of each item can be found with the &lt;a href=&quot;QTextList.html#itemText(com.trolltech.qt.gui.QTextBlock)&quot;&gt;&lt;tt&gt;itemText&lt;/tt&gt;&lt;/a&gt; function.&lt;/p&gt;
&lt;p&gt;Note that the items in the list may not be adjacent elements in the document. For example, the top-level items in a multi-level list will be separated by the items in lower levels of the list.&lt;/p&gt;
&lt;p&gt;List items can be deleted by index with the &lt;a href=&quot;QTextList.html#removeItem(int)&quot;&gt;&lt;tt&gt;removeItem&lt;/tt&gt;&lt;/a&gt; function. &lt;a href=&quot;QTextList.html#remove(com.trolltech.qt.gui.QTextBlock)&quot;&gt;&lt;tt&gt;remove&lt;/tt&gt;&lt;/a&gt; deletes the specified item in the list.&lt;/p&gt;
&lt;p&gt;The list's format is set with &lt;a href=&quot;QTextList.html#setFormat(com.trolltech.qt.gui.QTextListFormat)&quot;&gt;&lt;tt&gt;setFormat&lt;/tt&gt;&lt;/a&gt; and read with &lt;a href=&quot;QTextObject.html#format()&quot;&gt;&lt;tt&gt;format&lt;/tt&gt;&lt;/a&gt;. The format describes the decoration of the list itself, and not the individual items.&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;QTextListFormat.html&quot;&gt;&lt;tt&gt;QTextListFormat&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextCursor.html&quot;&gt;&lt;tt&gt;QTextCursor&lt;/tt&gt;&lt;/a&gt; */">
    <method name="public QTextList(com.trolltech.qt.gui.QTextDocument doc)" doc="/**
&lt;p&gt;This method is used internally by Qt Jambi.
Do not use it in your applications.&lt;/p&gt;
 */"/>
    <method name="public final void add(com.trolltech.qt.gui.QTextBlock block)" doc="/**
&lt;p&gt;Makes the given &lt;tt&gt;block&lt;/tt&gt; part of the list.&lt;/p&gt;

@see &lt;a href=&quot;QTextList.html#remove(com.trolltech.qt.gui.QTextBlock)&quot;&gt;&lt;tt&gt;remove&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextList.html#removeItem(int)&quot;&gt;&lt;tt&gt;removeItem&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final int count()" doc="/**
&lt;p&gt;Returns the number of items in the list.&lt;/p&gt;

@see &lt;tt&gt;isEmpty&lt;/tt&gt; */"/>
    <method name="public final com.trolltech.qt.gui.QTextListFormat textListFormat()" doc="/**
&lt;p&gt;Returns the list's format.&lt;/p&gt;
 */"/>
    <method name="public final com.trolltech.qt.gui.QTextBlock item(int i)" doc="/**
&lt;p&gt;Returns the &lt;tt&gt;i&lt;/tt&gt;-th text block in the list.&lt;/p&gt;

@see &lt;a href=&quot;QTextList.html#count()&quot;&gt;&lt;tt&gt;count&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextList.html#itemText(com.trolltech.qt.gui.QTextBlock)&quot;&gt;&lt;tt&gt;itemText&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final int itemNumber(com.trolltech.qt.gui.QTextBlock arg__1)" doc="/**
&lt;p&gt;Returns the index of the list item that corresponds to the given &lt;tt&gt;arg__1&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public final java.lang.String itemText(com.trolltech.qt.gui.QTextBlock arg__1)" doc="/**
&lt;p&gt;Returns the text of the list item that corresponds to the given &lt;tt&gt;arg__1&lt;/tt&gt;.&lt;/p&gt;
 */"/>
    <method name="public final void remove(com.trolltech.qt.gui.QTextBlock arg__1)" doc="/**
&lt;p&gt;Removes the given &lt;tt&gt;arg__1&lt;/tt&gt; from the list.&lt;/p&gt;

@see &lt;a href=&quot;QTextList.html#add(com.trolltech.qt.gui.QTextBlock)&quot;&gt;&lt;tt&gt;add&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextList.html#removeItem(int)&quot;&gt;&lt;tt&gt;removeItem&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void removeItem(int i)" doc="/**
&lt;p&gt;Removes the item at item position &lt;tt&gt;i&lt;/tt&gt; from the list. When the last item in the list is removed, the list is automatically deleted by the &lt;a href=&quot;QTextDocument.html&quot;&gt;&lt;tt&gt;QTextDocument&lt;/tt&gt;&lt;/a&gt; that owns it.&lt;/p&gt;

@see &lt;a href=&quot;QTextList.html#add(com.trolltech.qt.gui.QTextBlock)&quot;&gt;&lt;tt&gt;add&lt;/tt&gt;&lt;/a&gt;
@see &lt;a href=&quot;QTextList.html#remove(com.trolltech.qt.gui.QTextBlock)&quot;&gt;&lt;tt&gt;remove&lt;/tt&gt;&lt;/a&gt; */"/>
    <method name="public final void setFormat(com.trolltech.qt.gui.QTextListFormat format)" doc="/**
&lt;p&gt;Sets the list's format to &lt;tt&gt;format&lt;/tt&gt;.&lt;/p&gt;
 */"/>
</class>