Qt
Internal/Contributor docs for the Qt SDK. Note: These are NOT official API docs; those are found at https://doc.qt.io/
Loading...
Searching...
No Matches
Public Member Functions | Protected Member Functions | Friends | List of all members
QTextImageFormat Class Reference

\reentrant More...

#include <qtextformat.h>

+ Inheritance diagram for QTextImageFormat:
+ Collaboration diagram for QTextImageFormat:

Public Member Functions

 QTextImageFormat ()
 Creates a new image format object.
 
bool isValid () const
 Returns true if this image format is valid; otherwise returns false.
 
void setName (const QString &name)
 Sets the name of the image.
 
QString name () const
 Returns the name of the image.
 
void setWidth (qreal width)
 Sets the width of the rectangle occupied by the image.
 
qreal width () const
 Returns the width of the rectangle occupied by the image.
 
void setMaximumWidth (QTextLength maxWidth)
 Sets the maximumWidth of the rectangle occupied by the image.
 
QTextLength maximumWidth () const
 Returns the maximum width of the rectangle occupied by the image.
 
void setHeight (qreal height)
 Sets the height of the rectangle occupied by the image.
 
qreal height () const
 Returns the height of the rectangle occupied by the image.
 
void setQuality (int quality)
 
int quality () const
 
- Public Member Functions inherited from QTextCharFormat
 QTextCharFormat ()
 Constructs a new character format object.
 
bool isValid () const
 Returns true if this character format is valid; otherwise returns false.
 
void setFont (const QFont &font, FontPropertiesInheritanceBehavior behavior=FontPropertiesAll)
 
QFont font () const
 Returns the font for this character format.
 
void setFontFamilies (const QStringList &families)
 
QStringList fontFamilies () const
 
void setFontStyleName (const QString &styleName)
 
QStringList fontStyleName () const
 
void setFontPointSize (qreal size)
 Sets the text format's font size.
 
qreal fontPointSize () const
 Returns the font size used to display text in this format.
 
void setFontWeight (int weight)
 Sets the text format's font weight to weight.
 
int fontWeight () const
 Returns the text format's font weight.
 
void setFontItalic (bool italic)
 If italic is true, sets the text format's font to be italic; otherwise the font will be non-italic.
 
bool fontItalic () const
 Returns true if the text format's font is italic; otherwise returns false.
 
void setFontCapitalization (QFont::Capitalization capitalization)
 
QFont::Capitalization fontCapitalization () const
 
void setFontLetterSpacingType (QFont::SpacingType letterSpacingType)
 
QFont::SpacingType fontLetterSpacingType () const
 
void setFontLetterSpacing (qreal spacing)
 
qreal fontLetterSpacing () const
 
void setFontWordSpacing (qreal spacing)
 
qreal fontWordSpacing () const
 
void setFontUnderline (bool underline)
 If underline is true, sets the text format's font to be underlined; otherwise it is displayed non-underlined.
 
bool fontUnderline () const
 Returns true if the text format's font is underlined; otherwise returns false.
 
void setFontOverline (bool overline)
 If overline is true, sets the text format's font to be overlined; otherwise the font is displayed non-overlined.
 
bool fontOverline () const
 Returns true if the text format's font is overlined; otherwise returns false.
 
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.
 
bool fontStrikeOut () const
 Returns true if the text format's font is struck out (has a horizontal line drawn through it); otherwise returns false.
 
void setUnderlineColor (const QColor &color)
 Sets the color used to draw underlines, overlines and strikeouts on the characters with this format to the color specified.
 
QColor underlineColor () const
 Returns the color used to draw underlines, overlines and strikeouts on the characters with this format.
 
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.
 
bool fontFixedPitch () const
 Returns true if the text format's font is fixed pitch; otherwise returns false.
 
void setFontStretch (int factor)
 
int fontStretch () const
 
void setFontStyleHint (QFont::StyleHint hint, QFont::StyleStrategy strategy=QFont::PreferDefault)
 
void setFontStyleStrategy (QFont::StyleStrategy strategy)
 
QFont::StyleHint fontStyleHint () const
 
QFont::StyleStrategy fontStyleStrategy () const
 
void setFontHintingPreference (QFont::HintingPreference hintingPreference)
 
QFont::HintingPreference fontHintingPreference () const
 
void setFontKerning (bool enable)
 
bool fontKerning () const
 
void setUnderlineStyle (UnderlineStyle style)
 
UnderlineStyle underlineStyle () const
 
void setVerticalAlignment (VerticalAlignment alignment)
 Sets the vertical alignment used for the characters with this format to the alignment specified.
 
VerticalAlignment verticalAlignment () const
 Returns the vertical alignment used for characters with this format.
 
void setTextOutline (const QPen &pen)
 Sets the pen used to draw the outlines of characters to the given pen.
 
QPen textOutline () const
 Returns the pen used to draw the outlines of characters in this format.
 
void setToolTip (const QString &tip)
 
QString toolTip () const
 
void setSuperScriptBaseline (qreal baseline)
 
qreal superScriptBaseline () const
 
void setSubScriptBaseline (qreal baseline)
 
qreal subScriptBaseline () const
 
void setBaselineOffset (qreal baseline)
 
qreal baselineOffset () const
 
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.
 
bool isAnchor () const
 Returns true if the text is formatted as an anchor; otherwise returns false.
 
void setAnchorHref (const QString &value)
 Sets the hypertext link for the text format to the given value.
 
QString anchorHref () const
 Returns the text format's hypertext link, or an empty string if none has been set.
 
void setAnchorNames (const QStringList &names)
 
QStringList anchorNames () const
 
void setTableCellRowSpan (int tableCellRowSpan)
 
int tableCellRowSpan () const
 
void setTableCellColumnSpan (int tableCellColumnSpan)
 
int tableCellColumnSpan () const
 
- Public Member Functions inherited from QTextFormat
 QTextFormat ()
 Creates a new text format with an InvalidFormat.
 
 QTextFormat (int type)
 Creates a new text format of the given type.
 
 QTextFormat (const QTextFormat &rhs)
 Creates a new text format with the same attributes as the other text format.
 
QTextFormat & operator= (const QTextFormat &rhs)
 Assigns the other text format to this text format, and returns a reference to this text format.
 
 ~QTextFormat ()
 Destroys this text format.
 
void swap (QTextFormat &other)
 
void merge (const QTextFormat &other)
 Merges the other format with this format; where there are conflicts the other format takes precedence.
 
bool isValid () const
 Returns true if the format is valid (i.e.
 
bool isEmpty () const
 
int type () const
 Returns the type of this format.
 
int objectIndex () const
 Returns the index of the format object, or -1 if the format object is invalid.
 
void setObjectIndex (int object)
 Sets the format object's object index.
 
QVariant property (int propertyId) const
 Returns the property specified by the given propertyId.
 
void setProperty (int propertyId, const QVariant &value)
 Sets the property specified by the propertyId to the given value.
 
void clearProperty (int propertyId)
 Clears the value of the property given by propertyId.
 
bool hasProperty (int propertyId) const
 Returns true if the text format has a property with the given propertyId; otherwise returns false.
 
bool boolProperty (int propertyId) const
 Returns the value of the property specified by propertyId.
 
int intProperty (int propertyId) const
 Returns the value of the property specified by propertyId.
 
qreal doubleProperty (int propertyId) const
 Returns the value of the property specified by propertyId.
 
QString stringProperty (int propertyId) const
 Returns the value of the property given by propertyId; if the property isn't of QMetaType::QString type, an empty string is returned instead.
 
QColor colorProperty (int propertyId) const
 Returns the value of the property given by propertyId; if the property isn't of QMetaType::QColor type, an invalid color is returned instead.
 
QPen penProperty (int propertyId) const
 Returns the value of the property given by propertyId; if the property isn't of QMetaType::QPen type, Qt::NoPen is returned instead.
 
QBrush brushProperty (int propertyId) const
 Returns the value of the property given by propertyId; if the property isn't of QMetaType::QBrush type, Qt::NoBrush is returned instead.
 
QTextLength lengthProperty (int propertyId) const
 Returns the value of the property given by propertyId.
 
QList< QTextLength > lengthVectorProperty (int propertyId) const
 Returns the value of the property given by propertyId.
 
void setProperty (int propertyId, const QList< QTextLength > &lengths)
 Sets the value of the property given by propertyId to value.
 
QMap< int, QVariant > properties () const
 Returns a map with all properties of this text format.
 
int propertyCount () const
 
void setObjectType (int type)
 Sets the text format's object type to type.
 
int objectType () const
 Returns the text format's object type.
 
bool isCharFormat () const
 Returns true if this text format is a CharFormat; otherwise returns false.
 
bool isBlockFormat () const
 Returns true if this text format is a BlockFormat; otherwise returns false.
 
bool isListFormat () const
 Returns true if this text format is a ListFormat; otherwise returns false.
 
bool isFrameFormat () const
 Returns true if this text format is a FrameFormat; otherwise returns false.
 
bool isImageFormat () const
 Returns true if this text format is an image format; otherwise returns false.
 
bool isTableFormat () const
 Returns true if this text format is a TableFormat; otherwise returns false.
 
bool isTableCellFormat () const
 
QTextBlockFormat toBlockFormat () const
 Returns this format as a block format.
 
QTextCharFormat toCharFormat () const
 Returns this format as a character format.
 
QTextListFormat toListFormat () const
 Returns this format as a list format.
 
QTextTableFormat toTableFormat () const
 Returns this format as a table format.
 
QTextFrameFormat toFrameFormat () const
 Returns this format as a frame format.
 
QTextImageFormat toImageFormat () const
 Returns this format as an image format.
 
QTextTableCellFormat toTableCellFormat () const
 
bool operator== (const QTextFormat &rhs) const
 Returns true if this text format is the same as the other text format.
 
bool operator!= (const QTextFormat &rhs) const
 Returns true if this text format is different from the other text format.
 
 operator QVariant () const
 Returns the text format as a QVariant.
 
void setLayoutDirection (Qt::LayoutDirection direction)
 Sets the document's layout direction to the specified direction.
 
Qt::LayoutDirection layoutDirection () const
 Returns the document's layout direction.
 
void setBackground (const QBrush &brush)
 Sets the brush use to paint the document's background to the brush specified.
 
QBrush background () const
 Returns the brush used to paint the document's background.
 
void clearBackground ()
 Clears the brush used to paint the document's background.
 
void setForeground (const QBrush &brush)
 Sets the foreground brush to the specified brush.
 
QBrush foreground () const
 Returns the brush used to render foreground details, such as text, frame outlines, and table borders.
 
void clearForeground ()
 Clears the brush used to paint the document's foreground.
 

Protected Member Functions

 QTextImageFormat (const QTextFormat &format)
 
- Protected Member Functions inherited from QTextCharFormat
 QTextCharFormat (const QTextFormat &fmt)
 

Friends

class QTextFormat
 
Q_GUI_EXPORT QDataStream & operator<< (QDataStream &stream, const QTextListFormat &fmt)
 
Q_GUI_EXPORT QDataStream & operator>> (QDataStream &stream, QTextListFormat &fmt)
 

Additional Inherited Members

- Public Types inherited from QTextCharFormat
enum  VerticalAlignment {
  AlignNormal = 0 , AlignSuperScript , AlignSubScript , AlignMiddle ,
  AlignTop , AlignBottom , AlignBaseline
}
 This enum describes the ways that adjacent characters can be vertically aligned. More...
 
enum  UnderlineStyle {
  NoUnderline , SingleUnderline , DashUnderline , DotLine ,
  DashDotLine , DashDotDotLine , WaveUnderline , SpellCheckUnderline
}
 This enum describes the different ways drawing underlined text. More...
 
enum  FontPropertiesInheritanceBehavior { FontPropertiesSpecifiedOnly , FontPropertiesAll }
 
- Public Types inherited from QTextFormat
enum  FormatType {
  InvalidFormat = -1 , BlockFormat = 1 , CharFormat = 2 , ListFormat = 3 ,
  FrameFormat = 5 , UserFormat = 100
}
 This enum describes the text item a QTextFormat object is formatting. More...
 
enum  Property {
  ObjectIndex = 0x0 , CssFloat = 0x0800 , LayoutDirection = 0x0801 , OutlinePen = 0x810 ,
  BackgroundBrush = 0x820 , ForegroundBrush = 0x821 , BackgroundImageUrl = 0x823 , BlockAlignment = 0x1010 ,
  BlockTopMargin = 0x1030 , BlockBottomMargin = 0x1031 , BlockLeftMargin = 0x1032 , BlockRightMargin = 0x1033 ,
  TextIndent = 0x1034 , TabPositions = 0x1035 , BlockIndent = 0x1040 , LineHeight = 0x1048 ,
  LineHeightType = 0x1049 , BlockNonBreakableLines = 0x1050 , BlockTrailingHorizontalRulerWidth = 0x1060 , HeadingLevel = 0x1070 ,
  BlockQuoteLevel = 0x1080 , BlockCodeLanguage = 0x1090 , BlockCodeFence = 0x1091 , BlockMarker = 0x10A0 ,
  FirstFontProperty = 0x1FE0 , FontCapitalization = FirstFontProperty , FontLetterSpacing = 0x1FE1 , FontWordSpacing = 0x1FE2 ,
  FontStyleHint = 0x1FE3 , FontStyleStrategy = 0x1FE4 , FontKerning = 0x1FE5 , FontHintingPreference = 0x1FE6 ,
  FontFamilies = 0x1FE7 , FontStyleName = 0x1FE8 , FontLetterSpacingType = 0x1FE9 , FontStretch = 0x1FEA ,
  FontPointSize = 0x2001 , FontSizeAdjustment = 0x2002 , FontSizeIncrement = FontSizeAdjustment , FontWeight = 0x2003 ,
  FontItalic = 0x2004 , FontUnderline = 0x2005 , FontOverline = 0x2006 , FontStrikeOut = 0x2007 ,
  FontFixedPitch = 0x2008 , FontPixelSize = 0x2009 , LastFontProperty = FontPixelSize , TextUnderlineColor = 0x2020 ,
  TextVerticalAlignment = 0x2021 , TextOutline = 0x2022 , TextUnderlineStyle = 0x2023 , TextToolTip = 0x2024 ,
  TextSuperScriptBaseline = 0x2025 , TextSubScriptBaseline = 0x2026 , TextBaselineOffset = 0x2027 , IsAnchor = 0x2030 ,
  AnchorHref = 0x2031 , AnchorName = 0x2032 , OldFontLetterSpacingType = 0x2033 , OldFontStretch = 0x2034 ,
  OldTextUnderlineColor = 0x2010 , OldFontFamily = 0x2000 , ObjectType = 0x2f00 , ListStyle = 0x3000 ,
  ListIndent = 0x3001 , ListNumberPrefix = 0x3002 , ListNumberSuffix = 0x3003 , ListStart = 0x3004 ,
  FrameBorder = 0x4000 , FrameMargin = 0x4001 , FramePadding = 0x4002 , FrameWidth = 0x4003 ,
  FrameHeight = 0x4004 , FrameTopMargin = 0x4005 , FrameBottomMargin = 0x4006 , FrameLeftMargin = 0x4007 ,
  FrameRightMargin = 0x4008 , FrameBorderBrush = 0x4009 , FrameBorderStyle = 0x4010 , TableColumns = 0x4100 ,
  TableColumnWidthConstraints = 0x4101 , TableCellSpacing = 0x4102 , TableCellPadding = 0x4103 , TableHeaderRowCount = 0x4104 ,
  TableBorderCollapse = 0x4105 , TableCellRowSpan = 0x4810 , TableCellColumnSpan = 0x4811 , TableCellTopPadding = 0x4812 ,
  TableCellBottomPadding = 0x4813 , TableCellLeftPadding = 0x4814 , TableCellRightPadding = 0x4815 , TableCellTopBorder = 0x4816 ,
  TableCellBottomBorder = 0x4817 , TableCellLeftBorder = 0x4818 , TableCellRightBorder = 0x4819 , TableCellTopBorderStyle = 0x481a ,
  TableCellBottomBorderStyle = 0x481b , TableCellLeftBorderStyle = 0x481c , TableCellRightBorderStyle = 0x481d , TableCellTopBorderBrush = 0x481e ,
  TableCellBottomBorderBrush = 0x481f , TableCellLeftBorderBrush = 0x4820 , TableCellRightBorderBrush = 0x4821 , ImageName = 0x5000 ,
  ImageTitle = 0x5001 , ImageAltText = 0x5002 , ImageWidth = 0x5010 , ImageHeight = 0x5011 ,
  ImageQuality = 0x5014 , ImageMaxWidth = 0x5015 , FullWidthSelection = 0x06000 , PageBreakPolicy = 0x7000 ,
  UserProperty = 0x100000
}
 This enum describes the different properties a format can have. More...
 
enum  ObjectTypes {
  NoObject , ImageObject , TableObject , TableCellObject ,
  UserObject = 0x1000
}
 This enum describes what kind of QTextObject this format is associated with. More...
 
enum  PageBreakFlag { PageBreak_Auto = 0 , PageBreak_AlwaysBefore = 0x001 , PageBreak_AlwaysAfter = 0x010 }
 

Detailed Description

\reentrant

The QTextImageFormat class provides formatting information for images in a QTextDocument. \inmodule QtGui

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 in pixels using setWidth() and setHeight(). The desired image quality may be set with setQuality().

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, QImageReader

Definition at line 785 of file qtextformat.h.

Constructor & Destructor Documentation

◆ QTextImageFormat() [1/2]

QTextImageFormat::QTextImageFormat ( )

Creates a new image format object.

Definition at line 3387 of file qtextformat.cpp.

◆ QTextImageFormat() [2/2]

QTextImageFormat::QTextImageFormat ( const QTextFormat & other)
explicitprotected

Creates a new image format with the same attributes as the given text format.

Definition at line 3396 of file qtextformat.cpp.

Member Function Documentation

◆ height()

qreal QTextImageFormat::height ( ) const
inline

Returns the height of the rectangle occupied by the image.

See also
width(), setHeight()

Definition at line 805 of file qtextformat.h.

◆ isValid()

bool QTextImageFormat::isValid ( ) const
inline

Returns true if this image format is valid; otherwise returns false.

Definition at line 790 of file qtextformat.h.

◆ maximumWidth()

QTextLength QTextImageFormat::maximumWidth ( ) const
inline

Returns the maximum width of the rectangle occupied by the image.

See also
width(), setMaximumWidth()

Definition at line 801 of file qtextformat.h.

◆ name()

QString QTextImageFormat::name ( ) const
inline

Returns the name of the image.

The name refers to an entry in the application's resources file.

See also
setName()

Definition at line 793 of file qtextformat.h.

◆ quality()

int QTextImageFormat::quality ( ) const
inline
Since
5.12

Returns the value set by setQuality().

See also
setQuality()

Definition at line 813 of file qtextformat.h.

◆ setHeight()

void QTextImageFormat::setHeight ( qreal height)
inline

Sets the height of the rectangle occupied by the image.

See also
height(), setWidth()

Definition at line 834 of file qtextformat.h.

◆ setMaximumWidth()

void QTextImageFormat::setMaximumWidth ( QTextLength maximumWidth)
inline

Sets the maximumWidth of the rectangle occupied by the image.

This can be an absolute number or a percentage of the available document size.

See also
width(), setHeight()

Definition at line 831 of file qtextformat.h.

◆ setName()

void QTextImageFormat::setName ( const QString & name)
inline

Sets the name of the image.

The name is used to locate the image in the application's resources.

See also
name()

Definition at line 825 of file qtextformat.h.

◆ setQuality()

void QTextImageFormat::setQuality ( int quality = 100)
inline
Since
5.12

Sets the quality that should be used by exporters when exporting the image. QTextDocumentWriter will export jpg images with the quality set here when exporting to ODF files if quality is set to a value between 0 and 100. Or it will export png images if quality is set to 100 (default) or greater.

See also
quality()

Definition at line 837 of file qtextformat.h.

◆ setWidth()

void QTextImageFormat::setWidth ( qreal width)
inline

Sets the width of the rectangle occupied by the image.

See also
width(), setHeight(), maximumWidth()

Definition at line 828 of file qtextformat.h.

◆ width()

qreal QTextImageFormat::width ( ) const
inline

Returns the width of the rectangle occupied by the image.

See also
height(), setWidth()

Definition at line 797 of file qtextformat.h.

Friends And Related Symbol Documentation

◆ operator<<

Q_GUI_EXPORT QDataStream & operator<< ( QDataStream & stream,
const QTextListFormat & fmt )
friend

Definition at line 484 of file qtextformat.cpp.

◆ operator>>

Q_GUI_EXPORT QDataStream & operator>> ( QDataStream & stream,
QTextListFormat & fmt )
friend

Definition at line 489 of file qtextformat.cpp.

◆ QTextFormat

friend class QTextFormat
friend

Definition at line 818 of file qtextformat.h.

The documentation for this class was generated from the following files: