MD::Document Class

class MD::Document

Header:	`#include <md4qt/doc.h>`
CMake:	`find_package(md4qt REQUIRED COMPONENTS md4qt)` `target_link_libraries(mytarget PRIVATE md4qt::md4qt)`
Inherits:	MD::Block

List of all members, including inherited members

Public Types

	FootnoteSharedPointer
	Footnotes
	HeadingSharedPointer
	LabeledHeadings
	LabeledLinks
	LinkSharedPointer

Public Functions

	Document()
const MD::Document::Footnotes &	footnotesMap() const
void	insertFootnote(const QString &id, MD::Document::FootnoteSharedPointer fn)
void	insertLabeledHeading(const QString &label, MD::Document::HeadingSharedPointer h)
void	insertLabeledLink(const QString &label, MD::Document::LinkSharedPointer lnk)
const MD::Document::LabeledHeadings &	labeledHeadings() const
const MD::Document::LabeledLinks &	labeledLinks() const

Reimplemented Public Functions

virtual QSharedPointer<MD::Item>	clone(MD::Document *doc = nullptr) const override
virtual MD::ItemType	type() const override

Detailed Description

Markdown document.

Member Type Documentation

`[alias]` Document::FootnoteSharedPointer

Type of a smart pointer to footnote.

`[alias]` Document::Footnotes

Type of a map of footnotes.

`[alias]` Document::HeadingSharedPointer

Type of a smart pointer to heading.

`[alias]` Document::LabeledHeadings

Type of a map of headings.

`[alias]` Document::LabeledLinks

Type of a map of shortcut links.

`[alias]` Document::LinkSharedPointer

Type of a smart pointer to link.

Member Function Documentation

`[constexpr noexcept]` Document::Document()

Default constructor.

`[override virtual]` QSharedPointer<MD::Item> Document::clone(MD::Document **doc* = nullptr) const

Reimplements: Item::clone(MD::Document *doc) const.

Clone this document.

doc Parent of new item.

const MD::Document::Footnotes &Document::footnotesMap() const

Returns map of footnotes.

void Document::insertFootnote(const QString &id, MD::Document::FootnoteSharedPointer fn)

Insert footnote with the give ID.

id ID.

fn Footnote.

void Document::insertLabeledHeading(const QString &label, MD::Document::HeadingSharedPointer h)

Insert heading with the given label.

label Label.

h Heading.

void Document::insertLabeledLink(const QString &label, MD::Document::LinkSharedPointer lnk)

Insert shortcut link with the given label.

label Label.

lnk Link.

const MD::Document::LabeledHeadings &Document::labeledHeadings() const

Returns map of headings.

const MD::Document::LabeledLinks &Document::labeledLinks() const

Returns map of shortcut links.

`[override virtual]` MD::ItemType Document::type() const

Reimplements: Item::type() const.

Returns type of the item.

Contents