QTextImageFormat Class
The QTextImageFormat class provides formatting information for images in a QTextDocument. More...
| Header: | #include <QTextImageFormat> |
| qmake: | QT += gui |
| Inherits: | QTextCharFormat |
Note: All functions in this class are reentrant.
Public Functions
| QTextImageFormat() | |
| qreal | height() const |
| bool | isValid() const |
| QString | name() const |
| void | setHeight(qreal height) |
| void | setName(const QString &name) |
| void | setWidth(qreal width) |
| qreal | width() const |
- 54 public functions inherited from QTextCharFormat
- 51 public functions inherited from QTextFormat
Detailed Description
The QTextImageFormat class provides formatting information for images in a QTextDocument.
Inline images are represented by a Unicode value U+FFFC (OBJECT REPLACEMENT CHARACTER) 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.
Member Function Documentation
QTextImageFormat::QTextImageFormat()
Creates a new image format object.
qreal QTextImageFormat::height() const
Returns the height of the rectangle occupied by the image.
See also width() and setHeight().
bool QTextImageFormat::isValid() const
Returns true if this image format is valid; otherwise returns false.
QString QTextImageFormat::name() const
Returns the name of the image. The name refers to an entry in the application's resources file.
See also setName().
void QTextImageFormat::setHeight(qreal height)
Sets the height of the rectangle occupied by the image.
See also height() and setWidth().
void QTextImageFormat::setName(const QString &name)
Sets the name of the image. The name is used to locate the image in the application's resources.
See also name().
void QTextImageFormat::setWidth(qreal width)
Sets the width of the rectangle occupied by the image.
See also width() and setHeight().
qreal QTextImageFormat::width() const
Returns the width of the rectangle occupied by the image.
© 2017 The Qt Company Ltd. Documentation contributions included herein are the copyrights of their respective owners. The documentation provided herein is licensed under the terms of the GNU Free Documentation License version 1.3 as published by the Free Software Foundation. Qt and respective logos are trademarks of The Qt Company Ltd. in Finland and/or other countries worldwide. All other trademarks are property of their respective owners.