com.trolltech.qt.gui
Class QTextObject

java.lang.Object
  com.trolltech.qt.QSignalEmitter
      com.trolltech.qt.QtJambiObject
          com.trolltech.qt.core.QObject
              com.trolltech.qt.gui.QTextObject

All Implemented Interfaces:

QtJambiInterface

Direct Known Subclasses:

QTextBlockGroup, QTextFrame

public class QTextObject
extends QObject

The QTextObject class is a base class for different kinds of objects that can group parts of a QTextDocument together. The common grouping text objects are lists (QTextList), frames (QTextFrame), and tables (QTextTable). A text object has an associated format() and document().

There are essentially two kinds of text objects: those that are used with blocks (block formats), and those that are used with characters (character formats). The first kind are derived from QTextBlockGroup, and the second kind from QTextFrame.

You rarely need to use this class directly. When creating custom text objects, you will also need to reimplement QTextDocument::createObject() which acts as a factory method for creating text objects.

See also:

QTextDocument.

Nested Class Summary

Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter

QSignalEmitter.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9

Constructor Summary

protected

QTextObject(QTextDocument doc) Creates a new QTextObject for the given document.

Method Summary

QTextDocument	document() Returns the document this object belongs to.
QTextFormat	format() Returns the text object's format.
int	formatIndex() Returns the index of the object's format in the document's internal list of formats.
static QTextObject	fromNativePointer(QNativePointer nativePointer) This method returns the QTextObject instance pointed to by nativePointer.
int	objectIndex() Returns the object index of this object.
protected void	setFormat(QTextFormat format) Sets the text object's format.

Methods inherited from class com.trolltech.qt.core.QObject

childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, indexOfProperty, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, properties, property, removeEventFilter, setObjectName, setParent, setProperty, startTimer, timerEvent, toString, userProperty

Methods inherited from class com.trolltech.qt.QtJambiObject

dispose, disposed, equals, 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, wait, wait, wait

Methods inherited from interface com.trolltech.qt.QtJambiInterface

disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership

Constructor Detail

QTextObject

protected QTextObject(QTextDocument doc)

Creates a new QTextObject for the given document.

Warning: This function should never be called directly, but only from QTextDocument::createObject().

Method Detail

document

public final QTextDocument document()

Returns the document this object belongs to.

See also:

format().

format

public final QTextFormat format()

Returns the text object's format.

See also:

setFormat(), and document().

formatIndex

public final int formatIndex()

Returns the index of the object's format in the document's internal list of formats.

See also:

QTextDocument::object().

objectIndex

public final int objectIndex()

Returns the object index of this object. This can be used together with QTextFormat::setObjectIndex().

setFormat

protected final void setFormat(QTextFormat format)

Sets the text object's format.

See also:

format().

fromNativePointer

public static QTextObject fromNativePointer(QNativePointer nativePointer)

This method returns the QTextObject instance pointed to by nativePointer.