com.trolltech.qt.gui
Class QTextInlineObject

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

public class QTextInlineObject
extends QtJambiObject

The QTextInlineObject class represents an inline object in a QTextLayout.

This class is only used if the text layout is used to lay out parts of a QTextDocument.

The inline object has various attributes that can be set, for example using, setWidth, setAscent, and setDescent. The rectangle it occupies is given by rect, and its direction by isRightToLeft(). Its position in the text layout is given by at(), and its format is given by format.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.QSignalEmitter
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
QTextInlineObject()
          This method is used internally by Qt Jambi.
 
Method Summary
 double ascent()
          Returns the inline object's ascent.
 double descent()
          Returns the inline object's descent.
 QTextFormat format()
          Returns format of the inline object within the text layout.
 int formatIndex()
          Returns an integer describing the format of the inline object within the text layout.
static QTextInlineObject fromNativePointer(QNativePointer nativePointer)
          This function returns the QTextInlineObject instance pointed to by nativePointer
 double height()
          Returns the inline object's total height.
 boolean isValid()
          Returns true if this inline object is valid; otherwise returns false.
static QNativePointer nativePointerArray(QTextInlineObject[] array)
          This function returns a QNativePointer that is pointing to the specified QTextInlineObject array.
 QRectF rect()
          Returns the inline object's rectangle.
 void setAscent(double a)
          Sets the inline object's ascent to a.
 void setDescent(double d)
          Sets the inline object's decent to d.
 void setWidth(double w)
          Sets the inline object's width to w.
 Qt.LayoutDirection textDirection()
          Returns if the object should be laid out right-to-left or left-to-right.
 int textPosition()
          The position of the inline object within the text layout.
 double width()
          Returns the inline object's width.
 
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, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QTextInlineObject

public QTextInlineObject()

This method is used internally by Qt Jambi. Do not use it in your applications.

Method Detail

ascent

public final double ascent()

Returns the inline object's ascent.

See Also:
setAscent, descent, width, rect

descent

public final double descent()

Returns the inline object's descent.

See Also:
setDescent, ascent, width, rect

format

public final QTextFormat format()

Returns format of the inline object within the text layout.


formatIndex

public final int formatIndex()

Returns an integer describing the format of the inline object within the text layout.


height

public final double height()

Returns the inline object's total height. This is equal to ascent + descent + 1.

See Also:
ascent, descent, width, rect

isValid

public final boolean isValid()

Returns true if this inline object is valid; otherwise returns false.


rect

public final QRectF rect()

Returns the inline object's rectangle.

See Also:
ascent, descent, width

setAscent

public final void setAscent(double a)

Sets the inline object's ascent to a.

See Also:
ascent, setDescent, width, rect

setDescent

public final void setDescent(double d)

Sets the inline object's decent to d.

See Also:
descent, setAscent, width, rect

setWidth

public final void setWidth(double w)

Sets the inline object's width to w.

See Also:
width, ascent, descent, rect

textDirection

public final Qt.LayoutDirection textDirection()

Returns if the object should be laid out right-to-left or left-to-right.


textPosition

public final int textPosition()

The position of the inline object within the text layout.


width

public final double width()

Returns the inline object's width.

See Also:
setWidth, ascent, descent, rect

fromNativePointer

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

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

nativePointerArray

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

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