com.trolltech.qt.gui
Class QTextImageFormat

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.QTextCharFormat
                  extended by com.trolltech.qt.gui.QTextImageFormat
All Implemented Interfaces:
QtJambiInterface, java.lang.Cloneable

public class QTextImageFormat
extends QTextCharFormat
implements java.lang.Cloneable

The QTextImageFormat class provides formatting information for images in a QTextDocument. Inline images are represented by an object replacement character (0xFFFC in Unicode) which has an associated QTextImageFormat. The image format specifies a name with setName() that is used to locate the image. The size of the rectangle that the image will occupy is specified using setWidth() and setHeight().

Images can be supplied in any format for which Qt has an image reader, so SVG drawings can be included alongside PNG, TIFF and other bitmap formats.

See also:
QImage, and QImageReader.


Nested Class Summary
 
Nested classes/interfaces inherited from class com.trolltech.qt.gui.QTextCharFormat
QTextCharFormat.UnderlineStyle, QTextCharFormat.VerticalAlignment
 
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.Signal0, QSignalEmitter.Signal1, QSignalEmitter.Signal2, QSignalEmitter.Signal3, QSignalEmitter.Signal4, QSignalEmitter.Signal5, QSignalEmitter.Signal6, QSignalEmitter.Signal7, QSignalEmitter.Signal8, QSignalEmitter.Signal9
 
Constructor Summary
QTextImageFormat()
          Creates a new image format object.
 
Method Summary
 QTextImageFormat clone()
          This method is reimplemented for internal reasons
static QTextImageFormat fromNativePointer(QNativePointer nativePointer)
          This method returns the QTextImageFormat instance pointed to by nativePointer.
 double height()
          Returns the height of the rectangle occupied by the image.
 java.lang.String name()
          Returns the name of the image.
static QNativePointer nativePointerArray(QTextImageFormat[] array)
          This function returns a QNativePointer that is pointing to the specified QTextImageFormat array.
 void setHeight(double height)
          Sets the height of the rectangle occupied by the image.
 void setName(java.lang.String name)
          Sets the name of the image.
 void setWidth(double width)
          Sets the width of the rectangle occupied by the image.
 double width()
          Returns the width of the rectangle occupied by the image.
 
Methods inherited from class com.trolltech.qt.gui.QTextCharFormat
anchorHref, anchorNames, font, fontCapitalization, fontFamily, fontFixedPitch, fontItalic, fontLetterSpacing, fontOverline, fontPointSize, fontStrikeOut, fontUnderline, fontWeight, fontWordSpacing, isAnchor, nativePointerArray, setAnchor, setAnchorHref, setAnchorNames, setFont, setFontCapitalization, setFontFamily, setFontFixedPitch, setFontItalic, setFontLetterSpacing, setFontOverline, setFontPointSize, setFontStrikeOut, setFontUnderline, setFontWeight, setFontWordSpacing, setTextOutline, setToolTip, setUnderlineColor, setUnderlineStyle, setVerticalAlignment, textOutline, toolTip, underlineColor, underlineStyle, verticalAlignment
 
Methods inherited from class com.trolltech.qt.gui.QTextFormat
background, boolProperty, brushProperty, clearBackground, clearForeground, clearProperty, colorProperty, doubleProperty, foreground, hasProperty, intProperty, isBlockFormat, isCharFormat, isFrameFormat, isImageFormat, isListFormat, isTableCellFormat, isTableFormat, isValid, 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, toTableCellFormat, toTableFormat, type, writeTo
 
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
getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 
Methods inherited from interface com.trolltech.qt.QtJambiInterface
disableGarbageCollection, nativeId, nativePointer, reenableGarbageCollection, setJavaOwnership
 

Constructor Detail

QTextImageFormat

public QTextImageFormat()
Creates a new image format object.

Method Detail

height

public final double height()
Returns the height of the rectangle occupied by the image.

See also:
width(), and setHeight().


name

public final java.lang.String name()
Returns the name of the image. The name refers to an entry in the application's resources file.

See also:
setName().


setHeight

public final void setHeight(double height)
Sets the height of the rectangle occupied by the image.

See also:
height(), and setWidth().


setName

public final void setName(java.lang.String name)
Sets the name of the image. The name is used to locate the image in the application's resources.

See also:
name().


setWidth

public final void setWidth(double width)
Sets the width of the rectangle occupied by the image.

See also:
width(), and setHeight().


width

public final double width()
Returns the width of the rectangle occupied by the image.

See also:
height(), and setWidth().


fromNativePointer

public static QTextImageFormat fromNativePointer(QNativePointer nativePointer)
This method returns the QTextImageFormat instance pointed to by nativePointer.


nativePointerArray

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


clone

public QTextImageFormat clone()
This method is reimplemented for internal reasons

Overrides:
clone in class QTextCharFormat