MD::FootnoteRef Class

class MD::FootnoteRef

Footnote reference. More...

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

List of all members, including inherited members

Public Functions

	FootnoteRef(const QString &i)
const QString &	id() const
const MD::WithPosition &	idPos() const
const QString &	markdownContent() const
void	setId(const QString &i)
void	setIdPos(const MD::WithPosition &pos)
void	setMarkdownContent(const QString &md)

Reimplemented Public Functions

virtual Item::SharedPointer	clone(MD::Document *doc = nullptr) const override
virtual MD::ItemType	type() const override
virtual void	write(QTextStream &stream, MD::SerialiseHelper *helper) const override

Detailed Description

Inline footnote reference in MD::Paragraph. Ususally renders as superscript number.

Member Function Documentation

`[explicit]` FootnoteRef::FootnoteRef(const QString &i)

Initializing constructor.

i ID.

`[override virtual]` Item::SharedPointer FootnoteRef::clone(MD::Document **doc* = nullptr) const

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

Clone this footnote reference.

doc Parent of new item.

const QString &FootnoteRef::id() const

Returns ID of footnote reference.

See also setId().

const MD::WithPosition &FootnoteRef::idPos() const

Returns position of ID.

See also setIdPos().

const QString &FootnoteRef::markdownContent() const

Returns Markdown content of whole link.

See also setMarkdownContent().

void FootnoteRef::setId(const QString &i)

Set ID of footnote reference.

i ID.

See also id().

void FootnoteRef::setIdPos(const MD::WithPosition &pos)

Set position of ID.

pos Position.

See also idPos().

void FootnoteRef::setMarkdownContent(const QString &md)

Set Markdown content of whole link.

md Markdown content.

See also markdownContent().

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

Reimplements: Text::type() const.

Returns type of the item.

`[override virtual]` void FootnoteRef::write(QTextStream &stream, MD::SerialiseHelper **helper*) const

Reimplements: Text::write(QTextStream &stream, MD::SerialiseHelper *helper) const.

Serialise item into Markdown.

stream Stream.

helper Serialisation helper.

Contents