MD::Heading Class

template <typename Trait> class MD::Heading

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

List of all members, including inherited members

Public Types

	Delims
	LabelsVector
	ParagraphSharedPointer

Public Functions

std::shared_ptr<MD::Item<Trait>>	clone(MD::Document<Trait> *doc = nullptr) const override
const MD::Heading<Trait>::Delims &	delims() const
bool	isLabeled() const
const typename Trait::String &	label() const
const MD::WithPosition &	labelPos() const
MD::Heading<Trait>::LabelsVector &	labelVariants()
const MD::Heading<Trait>::LabelsVector &	labelVariants() const
int	level() const
void	setDelims(const MD::Heading<Trait>::Delims &d)
void	setLabel(const typename Trait::String &l)
void	setLabelPos(const MD::WithPosition &p)
void	setLabelVariants(const MD::Heading<Trait>::LabelsVector &vars)
void	setLevel(int l)
void	setText(MD::Heading<Trait>::ParagraphSharedPointer t)
MD::Heading<Trait>::ParagraphSharedPointer	text() const
MD::ItemType	type() const override

Detailed Description

Member Type Documentation

`[alias]` Heading::Delims

Type of list of service chanracters.

`[alias]` Heading::LabelsVector

Type of a vector of labels.

`[alias]` Heading::ParagraphSharedPointer

Type of smart pointer to paragraph.

Member Function Documentation

std::shared_ptr<MD::Item<Trait>> Heading::clone(MD::Document<Trait> **doc* = nullptr) const

Clone this heading.

doc Parent of new item.

const MD::Heading<Trait>::Delims &Heading::delims() const

Returns list of service characters.

See also setDelims().

bool Heading::isLabeled() const

Returns whether this heading has label?

const typename Trait::String &Heading::label() const

Returns label of the heading.

See also setLabel().

const MD::WithPosition &Heading::labelPos() const

Returns position of a label in the heading.

See also setLabelPos().

MD::Heading<Trait>::LabelsVector &Heading::labelVariants()

Returns label variants.

See also setLabelVariants().

const MD::Heading<Trait>::LabelsVector &Heading::labelVariants() const

Returns label variants.

int Heading::level() const

Returns level of the heading.

See also setLevel().

void Heading::setDelims(const MD::Heading<Trait>::Delims &d)

Set list of service characters.

d New value.

See also delims().

void Heading::setLabel(const typename Trait::String &l)

Set label of the heading.

l New value.

See also label().

void Heading::setLabelPos(const MD::WithPosition &p)

Set position of a label in the heading.

p New value.

See also labelPos().

void Heading::setLabelVariants(const MD::Heading<Trait>::LabelsVector &vars)

Set label variants.

vars New value.

See also labelVariants().

void Heading::setLevel(int l)

Set level of the heading.

l New value.

See also level().

void Heading::setText(MD::Heading<Trait>::ParagraphSharedPointer t)

Set content of the heading.

t New value.

See also text().

MD::Heading<Trait>::ParagraphSharedPointer Heading::text() const

Returns content of the heading.

See also setText().

MD::ItemType Heading::type() const

Returns type of the item.

Contents