diff options
Diffstat (limited to 'src/gui/text/qtextformat.cpp')
| -rw-r--r-- | src/gui/text/qtextformat.cpp | 344 |
1 files changed, 343 insertions, 1 deletions
diff --git a/src/gui/text/qtextformat.cpp b/src/gui/text/qtextformat.cpp index 4a2985f74c..e3bd49a15e 100644 --- a/src/gui/text/qtextformat.cpp +++ b/src/gui/text/qtextformat.cpp @@ -564,6 +564,18 @@ Q_GUI_EXPORT QDataStream &operator>>(QDataStream &stream, QTextFormat &fmt) \value BlockTrailingHorizontalRulerWidth The width of a horizontal ruler element. \value HeadingLevel The level of a heading, for example 1 corresponds to an HTML H1 tag; otherwise 0. This enum value has been added in Qt 5.12. + \value BlockCodeFence The character that was used in the "fences" around a Markdown code block. + If the code block was indented rather than fenced, the block should not have this property. + This enum value has been added in Qt 5.14. + + \value BlockQuoteLevel The depth of nested quoting on this block: 1 means the block is a top-level block quote. + Blocks that are not block quotes should not have this property. + This enum value has been added in Qt 5.14. + \value BlockCodeLanguage The programming language in a preformatted or code block. + Blocks that do not contain code should not have this property. + This enum value has been added in Qt 5.14. + \value BlockMarker The \l{QTextBlockFormat::MarkerType}{type of adornment} to be shown alongside the block. + This enum value has been added in Qt 5.14. Character properties @@ -638,6 +650,7 @@ Q_GUI_EXPORT QDataStream &operator>>(QDataStream &stream, QTextFormat &fmt) \value TableColumns \value TableColumnWidthConstraints \value TableHeaderRowCount + \value TableBorderCollapse Specifies the \l QTextTableFormat::borderCollapse property. Table cell properties @@ -648,9 +661,32 @@ Q_GUI_EXPORT QDataStream &operator>>(QDataStream &stream, QTextFormat &fmt) \value TableCellTopPadding \value TableCellBottomPadding + Table cell properties intended for use with \l QTextTableFormat::borderCollapse enabled + + \value TableCellTopBorder + \value TableCellBottomBorder + \value TableCellLeftBorder + \value TableCellRightBorder + + \value TableCellTopBorderStyle + \value TableCellBottomBorderStyle + \value TableCellLeftBorderStyle + \value TableCellRightBorderStyle + + \value TableCellTopBorderBrush + \value TableCellBottomBorderBrush + \value TableCellLeftBorderBrush + \value TableCellRightBorderBrush + Image properties - \value ImageName + \value ImageName The filename or source of the image. + \value ImageTitle The title attribute of an HTML image tag, or + the quoted string that comes after the URL in a Markdown image link. + This enum value has been added in Qt 5.14. + \value ImageAltText The alt attribute of an HTML image tag, or + the image description in a Markdown image link. + This enum value has been added in Qt 5.14. \value ImageWidth \value ImageHeight \value ImageQuality @@ -2329,6 +2365,50 @@ QList<QTextOption::Tab> QTextBlockFormat::tabPositions() const /*! + \fn void QTextBlockFormat::setMarker(MarkerType marker) + \since 5.14 + + Sets the type of adornment that should be rendered alongside the paragraph to \a marker. + For example, a list item can be adorned with a checkbox, either checked + or unchecked, as a replacement for its bullet. The default is \c NoMarker. + + \sa marker() +*/ + + +/*! + \fn MarkerType QTextBlockFormat::marker() const + \since 5.14 + + Returns the paragraph's marker if one has been set, or \c NoMarker if not. + + \sa setMarker() +*/ + + +/*! + \since 5.14 + \enum QTextBlockFormat::MarkerType + + This enum describes the types of markers a list item can have. + If a list item (a paragraph for which \l QTextBlock::textList() returns the list) + has a marker, it is rendered instead of the normal bullet. + In this way, checkable list items can be mixed with plain list items in the + same list, overriding the type of bullet specified by the + \l QTextListFormat::style() for the entire list. + + \value NoMarker This is the default: the list item's bullet will be shown. + \value Unchecked Instead of the list item's bullet, an unchecked checkbox will be shown. + \value Checked Instead of the list item's bullet, a checked checkbox will be shown. + + In the future, this may be extended to specify other types of paragraph + decorations. + + \sa QTextListFormat::style() +*/ + + +/*! \fn void QTextBlockFormat::setLineHeight(qreal height, int heightType) \since 4.8 @@ -3038,6 +3118,8 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt) Sets the cell \a spacing for the table. This determines the distance between adjacent cells. + + This property will be ignored if \l borderCollapse is enabled. */ /*! @@ -3089,6 +3171,44 @@ QTextTableFormat::QTextTableFormat(const QTextFormat &fmt) */ /*! + \fn void QTextTableFormat::setBorderCollapse(bool borderCollapse) + \since 5.14 + + Enabling \a borderCollapse will have the following implications: + \list + \li The borders and grid of the table will be rendered following the + CSS table \c border-collapse: \c collapse rules + \li Setting the \c border property to a minimum value of \c 1 will render a + one pixel solid inner table grid using the \l borderBrush property and an + outer border as specified + \li The various border style properties of \l QTextTableCellFormat can be used to + customize the grid and have precedence over the border and grid of the table + \li The \l cellSpacing property will be ignored + \li For print pagination: + \list + \li Columns continued on a page will not have their top cell border rendered + \li Repeated header rows will always have their bottom cell border rendered + \endlist + \endlist + + With borderCollapse disabled, cell borders can still be styled + using QTextTableCellFormat but styling will be applied only within + the cell's frame, which is probably not very useful in practice. + + \sa setBorder(), setBorderBrush(), setBorderStyle() + \sa QTextTableCellFormat +*/ + +/*! + \fn bool QTextTableFormat::borderCollapse() const + \since 5.14 + + Returns true if borderCollapse is enabled. + + \sa setBorderCollapse() +*/ + +/*! \fn void QTextFormat::setBackground(const QBrush &brush) Sets the brush use to paint the document's background to the @@ -3427,6 +3547,228 @@ QTextImageFormat::QTextImageFormat(const QTextFormat &fmt) */ /*! + \fn void QTextTableCellFormat::setTopBorder(qreal width) + \since 5.14 + + Sets the top border \a width of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn qreal QTextTableCellFormat::topBorder() const + \since 5.14 + + Returns the top border width of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setBottomBorder(qreal width) + \since 5.14 + + Sets the bottom border \a width of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn qreal QTextTableCellFormat::bottomBorder() const + \since 5.14 + + Returns the bottom border width of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setLeftBorder(qreal width) + \since 5.14 + + Sets the left border \a width of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn qreal QTextTableCellFormat::leftBorder() const + \since 5.14 + + Returns the left border width of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setRightBorder(qreal width) + \since 5.14 + + Sets the right border \a width of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn qreal QTextTableCellFormat::rightBorder() const + \since 5.14 + + Returns the right border width of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setBorder(qreal width) + \since 5.14 + + Sets the left, right, top, and bottom border \a width of the table cell. + + \sa setLeftBorder(), setRightBorder(), setTopBorder(), setBottomBorder() + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn void QTextTableCellFormat::setTopBorderStyle(QTextFrameFormat::BorderStyle style) + \since 5.14 + + Sets the top border \a style of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn QTextFrameFormat::BorderStyle QTextTableCellFormat::topBorderStyle() const + \since 5.14 + + Returns the top border style of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setBottomBorderStyle(QTextFrameFormat::BorderStyle style) + \since 5.14 + + Sets the bottom border \a style of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn QTextFrameFormat::BorderStyle QTextTableCellFormat::bottomBorderStyle() const + \since 5.14 + + Returns the bottom border style of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setLeftBorderStyle(QTextFrameFormat::BorderStyle style) + \since 5.14 + + Sets the left border \a style of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn QTextFrameFormat::BorderStyle QTextTableCellFormat::leftBorderStyle() const + \since 5.14 + + Returns the left border style of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setRightBorderStyle(QTextFrameFormat::BorderStyle style) + \since 5.14 + + Sets the right border \a style of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn QTextFrameFormat::BorderStyle QTextTableCellFormat::rightBorderStyle() const + \since 5.14 + + Returns the right border style of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setBorderStyle(QTextFrameFormat::BorderStyle style) + \since 5.14 + + Sets the left, right, top, and bottom border \a style of the table cell. + + \sa setLeftBorderStyle(), setRightBorderStyle(), setTopBorderStyle(), setBottomBorderStyle() + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn void QTextTableCellFormat::setTopBorderBrush(const QBrush &brush) + \since 5.14 + + Sets the top border \a brush of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn QBrush QTextTableCellFormat::topBorderBrush() const + \since 5.14 + + Returns the top border brush of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setBottomBorderBrush(const QBrush &brush) + \since 5.14 + + Sets the bottom border \a brush of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn QBrush QTextTableCellFormat::bottomBorderBrush() const + \since 5.14 + + Returns the bottom border brush of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setLeftBorderBrush(const QBrush &brush) + \since 5.14 + + Sets the left border \a brush of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn QBrush QTextTableCellFormat::leftBorderBrush() const + \since 5.14 + + Returns the left border brush of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setRightBorderBrush(const QBrush &brush) + \since 5.14 + + Sets the right border \a brush of the table cell. + + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! + \fn QBrush QTextTableCellFormat::rightBorderBrush() const + \since 5.14 + + Returns the right border brush of the table cell. +*/ + +/*! + \fn void QTextTableCellFormat::setBorderBrush(const QBrush &brush) + \since 5.14 + + Sets the left, right, top, and bottom border \a brush of the table cell. + + \sa setLeftBorderBrush(), setRightBorderBrush(), setTopBorderBrush(), setBottomBorderBrush() + \sa QTextTableFormat::setBorderCollapse +*/ + +/*! \fn bool QTextTableCellFormat::isValid() const \since 4.4 |