MD::details::HtmlVisitor Class

class HtmlVisitor : public MD::details::HtmlVisitor<MD::QStringTrait>
{
protected:
    QString prepareTextForHtml(const QString &t) override
    {
        auto tmp = MD::details::HtmlVisitor<MD::QStringTrait>::prepareTextForHtml(t);
        tmp.replace(QLatin1Char('$'), QStringLiteral("<span>$</span>"));

        return tmp;
    }
};

Member Function Documentation

[constexpr noexcept] HtmlVisitor::HtmlVisitor()

Default constructor.

[virtual protected] void HtmlVisitor::closeStyle(const typename MD::ItemWithOpts::Styles &styles)

Insert into HTML tags for closing styles.

styles Styles.

[virtual protected] QString HtmlVisitor::getId(MD::Item *item) const

Returns ID of item if it's set.

item Item.

[virtual protected] QString HtmlVisitor::headingIdToHtml(MD::Heading *h)

Returns HTML content for heading's ID.

h Heading.

[override virtual protected] void HtmlVisitor::onAddLineEnding()

Reimplements: Visitor::onAddLineEnding().

Handle new line in HTML.

[override virtual protected] void HtmlVisitor::onAnchor(MD::Anchor *a)

Reimplements: Visitor::onAnchor(MD::Anchor *a).

Handle anchor.

a Anchor.

[override virtual protected] void HtmlVisitor::onBlockquote(MD::Blockquote *b)

Reimplements: Visitor::onBlockquote(MD::Blockquote *b).

Handle blockquote.

b Blockquote.

[override virtual protected] void HtmlVisitor::onCode(MD::Code *c)

Reimplements: Visitor::onCode(MD::Code *c).

Handle code block.

c Code.

[override virtual protected] void HtmlVisitor::onFootnoteRef(MD::FootnoteRef *ref)

Reimplements: Visitor::onFootnoteRef(MD::FootnoteRef *ref).

Handle footnote reference.

ref Footnote reference.

[virtual protected] void HtmlVisitor::onFootnotes(const QString &footnoteBackLinkContent)

Handle footnotes.

footnoteBackLinkContent String that will be applied as content of back link from footnote. As an example, you can use "<img src="..." />".

[override virtual protected] void HtmlVisitor::onHeading(MD::Heading *h)

Reimplements: Visitor::onHeading(MD::Heading *h).

Handle heading.

h Heading.

[virtual protected] void HtmlVisitor::onHeading(MD::Heading *h, const QString &ht)

Handle heading.

h Heading.

ht Heading tag.

[override virtual protected] void HtmlVisitor::onHorizontalLine(MD::HorizontalLine *)

Reimplements: Visitor::onHorizontalLine(MD::HorizontalLine *l).

Handle horizontal line.

[override virtual protected] void HtmlVisitor::onImage(MD::Image *i)

Reimplements: Visitor::onImage(MD::Image *i).

Handle image.

i Image.

[override virtual protected] void HtmlVisitor::onInlineCode(MD::Code *c)

Reimplements: Visitor::onInlineCode(MD::Code *c).

Handle inline code.

c Code.

[override virtual protected] void HtmlVisitor::onLineBreak(MD::LineBreak *)

Reimplements: Visitor::onLineBreak(MD::LineBreak *b).

Handle line break.

[override virtual protected] void HtmlVisitor::onLink(MD::Link *l)

Reimplements: Visitor::onLink(MD::Link *l).

Handle link.

l Link.

[override virtual protected] void HtmlVisitor::onList(MD::List *l)

Reimplements: Visitor::onList(MD::List *l).

Handle list.

l List.

[override virtual protected] void HtmlVisitor::onListItem(MD::ListItem *i, bool first, bool skipOpeningWrap = false)

Reimplements: Visitor::onListItem(MD::ListItem *i, bool first, bool skipOpeningWrap).

Handle list item.

i List item.

first Is this item first in the list?

skipOpeningWrap Indicates that opening wrap should be added or no.

[override virtual protected] void HtmlVisitor::onMath(MD::Math *m)

Reimplements: Visitor::onMath(MD::Math *m).

Handle LaTeX math expression.

m Math.

[override virtual protected] void HtmlVisitor::onParagraph(MD::Paragraph *p, bool wrap, bool skipOpeningWrap = false)

Reimplements: Visitor::onParagraph(MD::Paragraph *p, bool wrap, bool skipOpeningWrap).

Handle paragraph.

p Paragraph.

wrap Wrap this paragraph with something or no? It's useful to not wrap standalone paragraph in list item, for example.

skipOpeningWrap Indicates that opening wrap should be added or no.

[override virtual protected] void HtmlVisitor::onRawHtml(MD::RawHtml *h)

Reimplements: Visitor::onRawHtml(MD::RawHtml *h).

Handle raw HTML.

h Raw HTML.

[override virtual protected] void HtmlVisitor::onTable(MD::Table *t)

Reimplements: Visitor::onTable(MD::Table *t).

Handle table.

t Table.

[override virtual protected] void HtmlVisitor::onText(MD::Text *t)

Reimplements: Visitor::onText(MD::Text *t).

Handle text item.

t Text.

[virtual protected] void HtmlVisitor::openStyle(const typename MD::ItemWithOpts::Styles &styles)

Insert into HTML tags for opening styles.

styles Styles.

[virtual protected] QString HtmlVisitor::prepareTextForHtml(const QString &t)

Prepare text to insert into HTML content.

t String.

[virtual protected] void HtmlVisitor::printId(MD::Item *item)

Append ID into HTML.

item Item.

[virtual protected] QString HtmlVisitor::tableAlignmentToHtml(typename MD::Table::Alignment a)

Returns HTML content for table alignment.

a Alignment.

[virtual] QString HtmlVisitor::toHtml(QSharedPointer<MD::Document> doc, const QString &footnoteBackLinkContent, bool wrappedInArticle = true, const MD::details::IdsMap *idsMap = nullptr)

Walk through the document.

doc Document.

footnoteBackLinkContent String that will be applied as content of back link from footnote. As an example, you can use "<img src="..." />".

wrappedInArticle Wrap HTML with <article> tag?

idsMap Map of IDs to set to corresonding items.