Qt Jambi Home

com.trolltech.qt.gui
Class QTextListFormat

java.lang.Object
  extended by com.trolltech.qt.QSignalEmitter
      extended by com.trolltech.qt.QtJambiObject
          extended by com.trolltech.qt.gui.QTextFormat
              extended by com.trolltech.qt.gui.QTextListFormat
All Implemented Interfaces:
QtJambiInterface

public class QTextListFormat
extends QTextFormat

The QTextListFormat class provides formatting information for lists in a QTextDocument.

A list is composed of one or more items, represented as text blocks. The list's format specifies the appearance of items in the list. In particular, it determines the indentation and the style of each item.

The indentation of the items is an integer value that causes each item to be offset from the left margin by a certain amount. This value is read with indent and set with setIndent.

The style used to decorate each item is set with setStyle and can be read with the style function. The style controls the type of bullet points and numbering scheme used for items in the list. Note that lists that use the decimal numbering scheme begin counting at 1 rather than 0.

See Also:
QTextList

Nested Class Summary
static class QTextListFormat.Style
          This enum describes the symbols used to decorate list items.
 
Nested classes/interfaces inherited from class com.trolltech.qt.gui.QTextFormat
QTextFormat.FormatType, QTextFormat.ObjectTypes, QTextFormat.PageBreakFlag, QTextFormat.PageBreakFlags, QTextFormat.Property
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
QSignalEmitter.AbstractSignal, QSignalEmitter.Signal0, QSignalEmitter.Signal1<A>, QSignalEmitter.Signal2<A,B>, QSignalEmitter.Signal3<A,B,C>, QSignalEmitter.Signal4<A,B,C,D>, QSignalEmitter.Signal5<A,B,C,D,E>, QSignalEmitter.Signal6<A,B,C,D,E,F>, QSignalEmitter.Signal7<A,B,C,D,E,F,G>, QSignalEmitter.Signal8<A,B,C,D,E,F,G,H>, QSignalEmitter.Signal9<A,B,C,D,E,F,G,H,I>
 
Constructor Summary
QTextListFormat()
          Constructs a new list format object.
 
Method Summary
static QTextListFormat fromNativePointer(QNativePointer nativePointer)
          This function returns the QTextListFormat instance pointed to by nativePointer
 int indent()
          Returns the list format's indentation.
 boolean isValid()
          Returns true if this list format is valid; otherwise returns false.
static QNativePointer nativePointerArray(QTextListFormat[] array)
          This function returns a QNativePointer that is pointing to the specified QTextListFormat array.
 void setIndent(int indent)
          Sets the list format's indent.
 void setStyle(QTextListFormat.Style style)
          Sets the list format's style.
 QTextListFormat.Style style()
          Returns the list format's style.
 
Methods inherited from class com.trolltech.qt.gui.QTextFormat
background, boolProperty, brushProperty, clearBackground, clearForeground, clearProperty, colorProperty, doubleProperty, equals, foreground, hasProperty, intProperty, isBlockFormat, isCharFormat, isFrameFormat, isImageFormat, isListFormat, isTableFormat, layoutDirection, lengthProperty, lengthVectorProperty, merge, nativePointerArray, objectIndex, objectType, penProperty, properties, property, propertyCount, readFrom, setBackground, setForeground, setLayoutDirection, setObjectIndex, setObjectType, setProperty, setProperty, stringProperty, toBlockFormat, toCharFormat, toFrameFormat, toImageFormat, toListFormat, toTableFormat, type, writeTo
 
Methods inherited from class com.trolltech.qt.QtJambiObject
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr
 
Methods inherited from class com.trolltech.qt.QSignalEmitter
blockSignals, disconnect, disconnect, signalsBlocked, signalSender, thread
 
Methods inherited from class java.lang.Object
clone, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QTextListFormat

public QTextListFormat()

Constructs a new list format object.

Method Detail

indent

public final int indent()

Returns the list format's indentation.

See Also:
setIndent

isValid

public final boolean isValid()

Returns true if this list format is valid; otherwise returns false.

Overrides:
isValid in class QTextFormat

setIndent

public final void setIndent(int indent)

Sets the list format's indent.

See Also:
indent

setStyle

public final void setStyle(QTextListFormat.Style style)

Sets the list format's style. See Style for the available styles.

See Also:
style

style

public final QTextListFormat.Style style()

Returns the list format's style. See Style.

See Also:
setStyle

fromNativePointer

public static QTextListFormat fromNativePointer(QNativePointer nativePointer)
This function returns the QTextListFormat instance pointed to by nativePointer

Parameters:
nativePointer - the QNativePointer of which object should be returned.

nativePointerArray

public static QNativePointer nativePointerArray(QTextListFormat[] array)
This function returns a QNativePointer that is pointing to the specified QTextListFormat array.

Parameters:
array - the array that the returned pointer will point to.
Returns:
a QNativePointer that is pointing to the specified array.

Qt Jambi Home