A piece of highlighted text.
<mrdocs/Metadata/DocComment/Inline/HighlightInline.hpp>
struct HighlightInline final
: InlineCommonBase<InlineKind::Highlight>
, InlineContainer
| Name | Description |
|---|---|
InlineCommonBase<InlineKind::Highlight> | Base class for providing variant discriminator functions. |
InlineContainer | An internal node in the inline element tree |
| Name | Description |
|---|---|
operator= | Assign an InlineContainer with a single TextInline child. |
append | append overloads |
asInlineContainer | Helper function so that derived classes can get a reference to the base class. |
back | Get the last inline child. |
begin | Begin iterator forwarding to children |
clear | Clear all inline children. |
emplace_back | Append a child of the specified type. |
empty | Determine if there are no inline children. |
end | End iterator forwarding to children |
erase | Erase from children |
front | Get the first inline child. |
insert | Erase from children |
operator+= | Addition assignment operators |
size | Get the number of inline children. |
operator== | Compare two InlineContainers. |
operator<=> | Compare two InlineContainers. |
| Name |
|---|
isCode |
isCopyDetails |
isEmph |
isFootnoteReference |
isHighlight |
isImage |
isLineBreak |
isLink |
isMath |
isReference |
isSoftBreak |
isStrikethrough |
isStrong |
isSubscript |
isSuperscript |
isText |
| Name |
|---|
children |
| Name |
|---|
kind_id |
| Name | Description |
|---|---|
getAsPlainText | Flatten an InlineContainer to plain text. |
getAsPlainText | Flatten an InlineContainer to plain text. |
getAsPlainText | Get the plain text representation of an inline element tree. |
getAsPlainText | Get the plain text representation of an inline element tree. |
ltrim | Removes leading whitespace from the first text element in the given InlineContainer. |
rtrim | Removes trailing whitespace from the last text element in the given InlineContainer. |
trim | Removes leading and trailing whitespace from the text elements in the given InlineContainer. |