|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
java.lang.Objectcom.trolltech.qt.QSignalEmitter
com.trolltech.qt.QtJambiObject
com.trolltech.qt.core.QObject
com.trolltech.qt.gui.QAbstractTextDocumentLayout
public abstract class QAbstractTextDocumentLayout
The QAbstractTextDocumentLayout class is an abstract base class used to implement custom layouts for QTextDocuments.
The standard layout provided by Qt can handle simple word processing including inline layouts, lists and tables.
Some applications (e.g. a word processor or a DTP application) might need more features than the ones provided by Qt's layout engine, in which case you can subclass QAbstractTextDocumentLayout to provide your own custom layout behavior for your text documents.
Nested Class Summary |
---|
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> |
Field Summary | |
---|---|
QSignalEmitter.Signal1<QSizeF> |
documentSizeChanged
This signal is emitted when the size of the document changes. |
QSignalEmitter.Signal1<java.lang.Integer> |
pageCountChanged
This signal is emitted when the number of pages in the layout changes; newPages is the updated page count. |
QSignalEmitter.Signal1<QRectF> |
update
This signal is emitted when the rectangle arg__1 has been updated. |
Constructor Summary | |
---|---|
QAbstractTextDocumentLayout(QTextDocument doc)
Creates a new text document layout for the given doc. |
Method Summary | |
---|---|
java.lang.String |
anchorAt(QPointF pos)
Returns the reference of the anchor at the given pos, or an empty string if no anchor exists at that point. |
abstract QRectF |
blockBoundingRect(QTextBlock block)
Returns the bounding rectangle of block. |
QTextDocument |
document()
Returns the text document that this layout is operating on. |
protected abstract void |
documentChanged(int from,
int charsRemoved,
int charsAdded)
This function is called whenever the contents of the document change. |
abstract QSizeF |
documentSize()
Returns the total size of the document. |
abstract void |
draw(QPainter painter,
QAbstractTextDocumentLayout_PaintContext context)
Draws the layout on the given painter with the given context. |
protected void |
drawInlineObject(QPainter painter,
QRectF rect,
QTextInlineObject object,
int posInDocument,
QTextFormat format)
Called to draw the inline object object on the given painter within the rectangle specified by rect using the text format specified by format. |
protected QTextCharFormat |
format(int pos)
Returns the character format that is applicable at the given pos. |
protected int |
formatIndex(int pos)
|
abstract QRectF |
frameBoundingRect(QTextFrame frame)
Returns the bounding rectacle of frame. |
static QAbstractTextDocumentLayout |
fromNativePointer(QNativePointer nativePointer)
This function returns the QAbstractTextDocumentLayout instance pointed to by nativePointer |
QTextObjectInterface |
handlerForObject(int objectType)
Returns a handler for objects of the given objectType. |
abstract int |
hitTest(QPointF point,
Qt.HitTestAccuracy accuracy)
Returns the cursor postion for the given point with the accuracy specified. |
abstract int |
pageCount()
Returns the number of pages required by the layout. |
QPaintDeviceInterface |
paintDevice()
Returns the paint device used to render the document's layout. |
protected void |
positionInlineObject(QTextInlineObject item,
int posInDocument,
QTextFormat format)
Lays out the inline object item using the given text format. |
void |
registerHandler(int objectType,
QObject component)
Registers the given component as a handler for items of the given objectType. |
protected void |
resizeInlineObject(QTextInlineObject item,
int posInDocument,
QTextFormat format)
Sets the size of the inline object item in accordance with the text format. |
void |
setPaintDevice(QPaintDeviceInterface device)
Sets the paint device used for rendering the document's layout to the given device. |
Methods inherited from class com.trolltech.qt.core.QObject |
---|
blockSignals, childEvent, children, connectSlotsByName, customEvent, disposeLater, dumpObjectInfo, dumpObjectTree, dynamicPropertyNames, event, eventFilter, findChild, findChild, findChild, findChildren, findChildren, findChildren, findChildren, installEventFilter, isWidgetType, killTimer, moveToThread, objectName, parent, property, removeEventFilter, setObjectName, setParent, setProperty, signalsBlocked, startTimer, thread, timerEvent |
Methods inherited from class com.trolltech.qt.QtJambiObject |
---|
dispose, disposed, finalize, reassignNativeResources, tr, tr, tr |
Methods inherited from class com.trolltech.qt.QSignalEmitter |
---|
disconnect, disconnect, signalSender |
Methods inherited from class java.lang.Object |
---|
clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait |
Methods inherited from interface com.trolltech.qt.QtJambiInterface |
---|
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership |
Field Detail |
---|
public final QSignalEmitter.Signal1<QSizeF> documentSizeChanged
This signal is emitted when the size of the document changes. The new size is specified by newSize.
This information is useful to widgets that display text documents since it enables them to update their scroll bars correctly.
public final QSignalEmitter.Signal1<java.lang.Integer> pageCountChanged
This signal is emitted when the number of pages in the layout changes; newPages is the updated page count.
Changes to the page count are due to the changes to the layout or the document content itself.
public final QSignalEmitter.Signal1<QRectF> update
This signal is emitted when the rectangle arg__1 has been updated.
Constructor Detail |
---|
public QAbstractTextDocumentLayout(QTextDocument doc)
Creates a new text document layout for the given doc.
Method Detail |
---|
public final java.lang.String anchorAt(QPointF pos)
Returns the reference of the anchor at the given pos, or an empty string if no anchor exists at that point.
public final QTextDocument document()
Returns the text document that this layout is operating on.
protected final QTextCharFormat format(int pos)
Returns the character format that is applicable at the given pos.
protected final int formatIndex(int pos)
public final QTextObjectInterface handlerForObject(int objectType)
Returns a handler for objects of the given objectType.
public final QPaintDeviceInterface paintDevice()
Returns the paint device used to render the document's layout.
public final void registerHandler(int objectType, QObject component)
Registers the given component as a handler for items of the given objectType.
public final void setPaintDevice(QPaintDeviceInterface device)
Sets the paint device used for rendering the document's layout to the given device.
public abstract QRectF blockBoundingRect(QTextBlock block)
Returns the bounding rectangle of block.
protected abstract void documentChanged(int from, int charsRemoved, int charsAdded)
This function is called whenever the contents of the document change. A change occurs when text is inserted, removed, or a combination of the two types of operation. The change is specified by from, charsRemoved, and charsAdded corresponding to the starting character position of the change, the number of character removed from the document, and the number of characters added.
For example, when inserting the text "Hello" into an empty document, charsRemoved would be 0 and charsAdded would be 5 (the length of the string).
Replacing text is the combination of removal and insertion. For example, if the text "Hello" gets replaced by "Hi", charsRemoved would be 5 and charsAdded would be 2.
public abstract QSizeF documentSize()
Returns the total size of the document. This is useful to display widgets since they can use to information to update their scroll bars correctly
public abstract void draw(QPainter painter, QAbstractTextDocumentLayout_PaintContext context)
Draws the layout on the given painter with the given context.
protected void drawInlineObject(QPainter painter, QRectF rect, QTextInlineObject object, int posInDocument, QTextFormat format)
Called to draw the inline object object on the given painter within the rectangle specified by rect using the text format specified by format. posInDocument specifies the position of the object within the document.
public abstract QRectF frameBoundingRect(QTextFrame frame)
Returns the bounding rectacle of frame. Returns the bounding rectangle of frame.
public abstract int hitTest(QPointF point, Qt.HitTestAccuracy accuracy)
Returns the cursor postion for the given point with the accuracy specified. Returns -1 to indicate failure if no valid cursor position was found.
public abstract int pageCount()
Returns the number of pages required by the layout.
protected void positionInlineObject(QTextInlineObject item, int posInDocument, QTextFormat format)
Lays out the inline object item using the given text format. The base class implementation does nothing. posInDocument specifies the position of the object within the document.
protected void resizeInlineObject(QTextInlineObject item, int posInDocument, QTextFormat format)
Sets the size of the inline object item in accordance with the text format. posInDocument specifies the position of the object within the document.
public static QAbstractTextDocumentLayout fromNativePointer(QNativePointer nativePointer)
nativePointer
- the QNativePointer of which object should be returned.
|
|
||||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||||
SUMMARY: NESTED | FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |