Skip to content

Commit

Permalink
Add documentation for the QTextBlockFormat::marker property
Browse files Browse the repository at this point in the history
Amends 65314b6.

Change-Id: I8f69030accb948055b0081f8a4f1daafbac824ce
Reviewed-by: Paul Wicking <[email protected]>
  • Loading branch information
ec1oud committed May 23, 2019
1 parent 28b06fc commit c85e6dc
Showing 1 changed file with 44 additions and 0 deletions.
44 changes: 44 additions & 0 deletions src/gui/text/qtextformat.cpp
Original file line number Diff line number Diff line change
Expand Up @@ -2337,6 +2337,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
Expand Down

0 comments on commit c85e6dc

Please sign in to comment.