Contents

MD::YAMLHeader Class

template <typename Trait> class MD::YAMLHeader

YAML header item in the document. More...

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

Public Functions

std::shared_ptr<MD::Item<Trait>> clone(MD::Document<Trait> *doc = nullptr) const override
const MD::WithPosition &endDelim() const
void setEndDelim(const MD::WithPosition &p)
void setStartDelim(const MD::WithPosition &p)
void setYaml(const typename Trait::String &y)
const MD::WithPosition &startDelim() const
MD::ItemType type() const override
const typename Trait::String &yaml() const

Detailed Description

Member Function Documentation

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

Clone this item.

doc Parent of new item.

const MD::WithPosition &YAMLHeader::endDelim() const

Returns end delimiter position.

See also setEndDelim().

void YAMLHeader::setEndDelim(const MD::WithPosition &p)

Set end delimiter position.

p Position.

See also endDelim().

void YAMLHeader::setStartDelim(const MD::WithPosition &p)

Set start delimiter position.

p Position.

See also startDelim().

void YAMLHeader::setYaml(const typename Trait::String &y)

Set YAML content.

y YAML content.

See also yaml().

const MD::WithPosition &YAMLHeader::startDelim() const

Returns start delimiter position.

See also setStartDelim().

MD::ItemType YAMLHeader::type() const

Returns type of the item.

const typename Trait::String &YAMLHeader::yaml() const

Returns YAML content.

See also setYaml().