MD::HorizontalLine Class

class MD::HorizontalLine

Horizontal line. More...

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

Public Functions

HorizontalLine(MD::HorizontalLineSymbol s = HorizontalLineSymbol::Unknown)
void setSymbol(MD::HorizontalLineSymbol s)
MD::HorizontalLineSymbol symbol() const

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

Thematic break in Markdown file. In HTML this is usually a <hr /> tag.

Member Function Documentation

[explicit] HorizontalLine::HorizontalLine(MD::HorizontalLineSymbol s = HorizontalLineSymbol::Unknown)

Default constructor.

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

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

Clone this horizontal line.

doc Parent of new item.

void HorizontalLine::setSymbol(MD::HorizontalLineSymbol s)

Set horizontal line symbol.

s Symbol.

See also symbol().

MD::HorizontalLineSymbol HorizontalLine::symbol() const

Returns horizontal line sybol.

See also setSymbol().

[override virtual] MD::ItemType HorizontalLine::type() const

Reimplements: Item::type() const.

Returns type of the item.

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

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

Serialise item into Markdown.

stream Stream.

helper Serialisation helper.