 |
Qt 4.8
|
|
Qt 4.8
|
The QTextImageFormat class provides formatting information for images in a QTextDocument. More...
#include <qtextformat.h>
Public Functions | |
| qreal | height () const |
| Returns the height of the rectangle occupied by the image. More... | |
| bool | isValid () const |
| Returns true if this image format is valid; otherwise returns false. More... | |
| QString | name () const |
| Returns the name of the image. More... | |
| QTextImageFormat () | |
| Creates a new image format object. More... | |
| void | setHeight (qreal height) |
| Sets the height of the rectangle occupied by the image. More... | |
| void | setName (const QString &name) |
| Sets the name of the image. More... | |
| void | setWidth (qreal width) |
| Sets the width of the rectangle occupied by the image. More... | |
| qreal | width () const |
| Returns the width of the rectangle occupied by the image. More... | |
 Public Functions inherited from QTextCharFormat | |
| QString | anchorHref () const |
| Returns the text format's hypertext link, or an empty string if none has been set. More... | |
| QString | anchorName () const |
| This function is deprecated. More... | |
| QStringList | anchorNames () const |
| Returns the anchor names associated with this text format, or an empty string list if none has been set. More... | |
| QFont | font () const |
| Returns the font for this character format. More... | |
| QFont::Capitalization | fontCapitalization () const |
| Returns the current capitalization type of the font. More... | |
| QString | fontFamily () const |
| Returns the text format's font family. More... | |
| bool | fontFixedPitch () const |
| Returns true if the text format's font is fixed pitch; otherwise returns false. More... | |
| QFont::HintingPreference | fontHintingPreference () const |
| Returns the hinting preference set for this text format. More... | |
| bool | fontItalic () const |
| Returns true if the text format's font is italic; otherwise returns false. More... | |
| bool | fontKerning () const |
| Returns true if the font kerning is enabled. More... | |
| qreal | fontLetterSpacing () const |
| Returns the current letter spacing percentage. More... | |
| bool | fontOverline () const |
| Returns true if the text format's font is overlined; otherwise returns false. More... | |
| qreal | fontPointSize () const |
| Returns the font size used to display text in this format. More... | |
| bool | fontStrikeOut () const |
| Returns true if the text format's font is struck out (has a horizontal line drawn through it); otherwise returns false. More... | |
| QFont::StyleHint | fontStyleHint () const |
| Returns the font style hint. More... | |
| QFont::StyleStrategy | fontStyleStrategy () const |
| Returns the current font style strategy. More... | |
| bool | fontUnderline () const |
| Returns true if the text format's font is underlined; otherwise returns false. More... | |
| int | fontWeight () const |
| Returns the text format's font weight. More... | |
| qreal | fontWordSpacing () const |
| Returns the current word spacing value. More... | |
| bool | isAnchor () const |
| Returns true if the text is formatted as an anchor; otherwise returns false. More... | |
| bool | isValid () const |
| Returns true if this character format is valid; otherwise returns false. More... | |
| QTextCharFormat () | |
| Constructs a new character format object. More... | |
| void | setAnchor (bool anchor) |
| If anchor is true, text with this format represents an anchor, and is formatted in the appropriate way; otherwise the text is formatted normally. More... | |
| void | setAnchorHref (const QString &value) |
| Sets the hypertext link for the text format to the given value. More... | |
| void | setAnchorName (const QString &name) |
| This function is deprecated. More... | |
| void | setAnchorNames (const QStringList &names) |
| Sets the text format's anchor names. More... | |
| void | setFont (const QFont &font) |
| Sets the text format's font. More... | |
| void | setFontCapitalization (QFont::Capitalization capitalization) |
| Sets the capitalization of the text that apppears in this font to capitalization. More... | |
| void | setFontFamily (const QString &family) |
| Sets the text format's font family. More... | |
| void | setFontFixedPitch (bool fixedPitch) |
| If fixedPitch is true, sets the text format's font to be fixed pitch; otherwise a non-fixed pitch font is used. More... | |
| void | setFontHintingPreference (QFont::HintingPreference hintingPreference) |
| Sets the hinting preference of the text format's font to be hintingPreference. More... | |
| void | setFontItalic (bool italic) |
| If italic is true, sets the text format's font to be italic; otherwise the font will be non-italic. More... | |
| void | setFontKerning (bool enable) |
| Enables kerning for this font if enable is true; otherwise disables it. More... | |
| void | setFontLetterSpacing (qreal spacing) |
| Sets the letter spacing of this format to the given spacing, in percent. More... | |
| void | setFontOverline (bool overline) |
| If overline is true, sets the text format's font to be overlined; otherwise the font is displayed non-overlined. More... | |
| void | setFontPointSize (qreal size) |
| Sets the text format's font size. More... | |
| void | setFontStrikeOut (bool strikeOut) |
| If strikeOut is true, sets the text format's font with strike-out enabled (with a horizontal line through it); otherwise it is displayed without strikeout. More... | |
| void | setFontStyleHint (QFont::StyleHint hint, QFont::StyleStrategy strategy=QFont::PreferDefault) |
| Sets the font style hint and strategy. More... | |
| void | setFontStyleStrategy (QFont::StyleStrategy strategy) |
| Sets the font style strategy. More... | |
| void | setFontUnderline (bool underline) |
| If underline is true, sets the text format's font to be underlined; otherwise it is displayed non-underlined. More... | |
| void | setFontWeight (int weight) |
| Sets the text format's font weight to weight. More... | |
| void | setFontWordSpacing (qreal spacing) |
| Sets the word spacing of this format to the given spacing, in pixels. More... | |
| void | setTableCellColumnSpan (int tableCellColumnSpan) |
| If this character format is applied to characters in a table cell, the cell will span tableCellColumnSpan columns. More... | |
| void | setTableCellRowSpan (int tableCellRowSpan) |
| If this character format is applied to characters in a table cell, the cell will span tableCellRowSpan rows. More... | |
| void | setTextOutline (const QPen &pen) |
| Sets the pen used to draw the outlines of characters to the given pen. More... | |
| void | setToolTip (const QString &tip) |
| Sets the tool tip for a fragment of text to the given text. More... | |
| void | setUnderlineColor (const QColor &color) |
| Sets the underline color used for the characters with this format to the color specified. More... | |
| void | setUnderlineStyle (UnderlineStyle style) |
| Sets the style of underlining the text to style. More... | |
| void | setVerticalAlignment (VerticalAlignment alignment) |
| Sets the vertical alignment used for the characters with this format to the alignment specified. More... | |
| int | tableCellColumnSpan () const |
| If this character format is applied to characters in a table cell, this function returns the number of columns spanned by the text (this may be 1); otherwise it returns 1. More... | |
| int | tableCellRowSpan () const |
| If this character format is applied to characters in a table cell, this function returns the number of rows spanned by the text (this may be 1); otherwise it returns 1. More... | |
| QPen | textOutline () const |
| Returns the pen used to draw the outlines of characters in this format. More... | |
| QString | toolTip () const |
| Returns the tool tip that is displayed for a fragment of text. More... | |
| QColor | underlineColor () const |
| Returns the color used to underline the characters with this format. More... | |
| UnderlineStyle | underlineStyle () const |
| Returns the style of underlining the text. More... | |
| VerticalAlignment | verticalAlignment () const |
| Returns the vertical alignment used for characters with this format. More... | |
| Public Functions inherited from QTextFormat | |
| QBrush | background () const |
| Returns the brush used to paint the document's background. More... | |
| bool | boolProperty (int propertyId) const |
| Returns the value of the property specified by propertyId. More... | |
| QBrush | brushProperty (int propertyId) const |
| Returns the value of the property given by propertyId; if the property isn't of QVariant::Brush type, Qt::NoBrush is returned instead. More... | |
| void | clearBackground () |
| Clears the brush used to paint the document's background. More... | |
| void | clearForeground () |
| Clears the brush used to paint the document's foreground. More... | |
| void | clearProperty (int propertyId) |
| Clears the value of the property given by propertyId. More... | |
| QColor | colorProperty (int propertyId) const |
| Returns the value of the property given by propertyId; if the property isn't of QVariant::Color type, an invalid color is returned instead. More... | |
| qreal | doubleProperty (int propertyId) const |
| Returns the value of the property specified by propertyId. More... | |
| QBrush | foreground () const |
| Returns the brush used to render foreground details, such as text, frame outlines, and table borders. More... | |
| bool | hasProperty (int propertyId) const |
| Returns true if the text format has a property with the given propertyId; otherwise returns false. More... | |
| int | intProperty (int propertyId) const |
| Returns the value of the property specified by propertyId. More... | |
| bool | isBlockFormat () const |
Returns true if this text format is a BlockFormat; otherwise returns false. More... | |
| bool | isCharFormat () const |
Returns true if this text format is a CharFormat; otherwise returns false. More... | |
| bool | isFrameFormat () const |
Returns true if this text format is a FrameFormat; otherwise returns false. More... | |
| bool | isImageFormat () const |
| Returns true if this text format is an image format; otherwise returns false. More... | |
| bool | isListFormat () const |
Returns true if this text format is a ListFormat; otherwise returns false. More... | |
| bool | isTableCellFormat () const |
Returns true if this text format is a TableCellFormat; otherwise returns false. More... | |
| bool | isTableFormat () const |
Returns true if this text format is a TableFormat; otherwise returns false. More... | |
| bool | isValid () const |
| Returns true if the format is valid (i. More... | |
| Qt::LayoutDirection | layoutDirection () const |
| Returns the document's layout direction. More... | |
| QTextLength | lengthProperty (int propertyId) const |
| Returns the value of the property given by propertyId. More... | |
| QVector< QTextLength > | lengthVectorProperty (int propertyId) const |
| Returns the value of the property given by propertyId. More... | |
| void | merge (const QTextFormat &other) |
| Merges the other format with this format; where there are conflicts the other format takes precedence. More... | |
| int | objectIndex () const |
| Returns the index of the format object, or -1 if the format object is invalid. More... | |
| int | objectType () const |
| Returns the text format's object type. More... | |
| operator QVariant () const | |
| Returns the text format as a QVariant. More... | |
| bool | operator!= (const QTextFormat &rhs) const |
| Returns true if this text format is different from the other text format. More... | |
| QTextFormat & | operator= (const QTextFormat &rhs) |
| Assigns the other text format to this text format, and returns a reference to this text format. More... | |
| bool | operator== (const QTextFormat &rhs) const |
| Returns true if this text format is the same as the other text format. More... | |
| QPen | penProperty (int propertyId) const |
| Returns the value of the property given by propertyId; if the property isn't of QVariant::Pen type, Qt::NoPen is returned instead. More... | |
| QMap< int, QVariant > | properties () const |
| Returns a map with all properties of this text format. More... | |
| QVariant | property (int propertyId) const |
| Returns the property specified by the given propertyId. More... | |
| int | propertyCount () const |
| Returns the number of properties stored in the format. More... | |
| QTextFormat () | |
Creates a new text format with an InvalidFormat. More... | |
| QTextFormat (int type) | |
| Creates a new text format of the given type. More... | |
| QTextFormat (const QTextFormat &rhs) | |
| Creates a new text format with the same attributes as the other text format. More... | |
| void | setBackground (const QBrush &brush) |
| Sets the brush use to paint the document's background to the brush specified. More... | |
| void | setForeground (const QBrush &brush) |
| Sets the foreground brush to the specified brush. More... | |
| void | setLayoutDirection (Qt::LayoutDirection direction) |
| Sets the document's layout direction to the specified direction. More... | |
| void | setObjectIndex (int object) |
| Sets the format object's object index. More... | |
| void | setObjectType (int type) |
| Sets the text format's object type to type. More... | |
| void | setProperty (int propertyId, const QVariant &value) |
| Sets the property specified by the propertyId to the given value. More... | |
| void | setProperty (int propertyId, const QVector< QTextLength > &lengths) |
| Sets the value of the property given by propertyId to value. More... | |
| QString | stringProperty (int propertyId) const |
| Returns the value of the property given by propertyId; if the property isn't of QVariant::String type, an empty string is returned instead. More... | |
| QTextBlockFormat | toBlockFormat () const |
| Returns this format as a block format. More... | |
| QTextCharFormat | toCharFormat () const |
| Returns this format as a character format. More... | |
| QTextFrameFormat | toFrameFormat () const |
| Returns this format as a frame format. More... | |
| QTextImageFormat | toImageFormat () const |
| Returns this format as an image format. More... | |
| QTextListFormat | toListFormat () const |
| Returns this format as a list format. More... | |
| QTextTableCellFormat | toTableCellFormat () const |
| Returns this format as a table cell format. More... | |
| QTextTableFormat | toTableFormat () const |
| Returns this format as a table format. More... | |
| int | type () const |
| Returns the type of this format. More... | |
| ~QTextFormat () | |
| Destroys this text format. More... | |
Protected Functions | |
| QTextImageFormat (const QTextFormat &format) | |
| Creates a new image format with the same attributes as the given text format. More... | |
| Protected Functions inherited from QTextCharFormat | |
| QTextCharFormat (const QTextFormat &fmt) | |
| Creates a new character format with the same attributes as the given text format. More... | |
Friends | |
| class | QTextFormat |
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.
Definition at line 694 of file qtextformat.h.
| QTextImageFormat::QTextImageFormat | ( | ) |
Creates a new image format object.
Definition at line 3507 of file qtextformat.cpp.
|
explicitprotected |
Creates a new image format with the same attributes as the given text format.
Definition at line 3519 of file qtextformat.cpp.
|
inline |
Returns the height of the rectangle occupied by the image.
Definition at line 710 of file qtextformat.h.
Referenced by QTextHtmlExporter::emitFragment(), getImageSize(), getPixmapSize(), and QTextOdfWriter::writeInlineCharacter().
|
inline |
Returns true if this image format is valid; otherwise returns false.
Definition at line 699 of file qtextformat.h.
|
inline |
Returns the name of the image.
The name refers to an entry in the application's resources file.
Definition at line 702 of file qtextformat.h.
Referenced by QTextHtmlExporter::emitFragment(), getImage(), getPixmap(), and QTextOdfWriter::writeInlineCharacter().
|
inline |
Sets the height of the rectangle occupied by the image.
Definition at line 724 of file qtextformat.h.
Referenced by QTextHtmlImporter::processSpecialNodes().
|
inline |
Sets the name of the image.
The name is used to locate the image in the application's resources.
Definition at line 718 of file qtextformat.h.
Referenced by QTextCursor::insertImage(), and QTextHtmlImporter::processSpecialNodes().
|
inline |
Sets the width of the rectangle occupied by the image.
Definition at line 721 of file qtextformat.h.
Referenced by QTextHtmlImporter::processSpecialNodes().
|
inline |
Returns the width of the rectangle occupied by the image.
Definition at line 706 of file qtextformat.h.
Referenced by QTextHtmlExporter::emitFragment(), getImageSize(), getPixmapSize(), and QTextOdfWriter::writeInlineCharacter().
|
friend |
Definition at line 715 of file qtextformat.h.