MD Namespace

Function Documentation

void MD::forEach(const QVector<MD::ItemType> &types, QSharedPointer<MD::Document> doc, MD::ItemFunctor func, unsigned int maxNestingLevel = 0)

Calls function for each item in the document with the given type.

types Vector of item's types to be processed.

doc Document.

func Functor object.

maxNestingLevel Maximun nesting level. 0 means infinity, 1 - only top level items...

QString MD::getMarkdownContent(MD::ParagraphStream &stream, qsizetype startPos, qsizetype startLine, qsizetype endPos, qsizetype endLine)

Get Markdown string from paragraph stream.

stream Stream.

startPos Start position.

startLine Start line.

endPos End position.

endLine End line.

int MD::htmlTagRule(MD::Line &line)

Returns HTML tag rule.

line Line.

qsizetype MD::indentFromColumn(int c)

Returns indent from column.

c Column.

bool MD::isAsciiControl(const QChar &ch)

Returns whether the give symbol is ASCII control character.

ch Symbol.

bool MD::isAsciiLetter(const QChar &c)

Returns whether the given character is an ASCII letter.

c Character.

bool MD::isClosed(MD::Line &line, int rule, bool onSameLine)

Returns whether the HTML tag was closed.

line Line.

rule HTML tag rule.

onSameLine Flags that check is going on the same line as opening "<" character.

bool MD::isCommonMarkAutolinkUri(const QString &uri)

Returns whether the given string is an absolute URI according to CommonMark's autolink grammar.

uri String for checking.

bool MD::isEmail(const QString &url)

Returns whether the given string a valid email?

url String for checking.

bool MD::isEmptyLine(MD::Line &line)

Return whether the given line is empty starting at the current position.

line Line.

bool MD::isHorizontalLine(MD::Line &s)

Returns whether string a horizontal line?

s String for checking.

bool MD::isHtmlTag(const QString &tag, MD::Line &line, bool closed)

Returns whether the HTML tag was read.

tag HTML tag name.

line Line.

closed Flags whether closing ">" was presented.

bool MD::isIn(const MD::WithPosition &where, const MD::WithPosition &what)

Returns whether the give object is in the given place.

where Place where to check if object is in.

what Object to check.

bool MD::isValidTagName(const QString &tag)

Returns whether the given string a valid HTML tag.

tag String for checking.

bool MD::isValidUrl(const QString &url)

Returns whether the given string a valid URL?

url String for checking.

QString MD::readEscapedSequence(MD::Line &line, qsizetype *endPos = nullptr)

Skip escaped sequence of characters till first space.

line String for reading.

endPos Receiver of last character's position in sequence.

bool MD::readHtmlAttrName(MD::Line &line)

Returns whether the HTML attribute name was read.

line Line.

bool MD::readHtmlAttrValue(MD::Line &line)

Returns whether the HTML attribute value was read.

line Line.

bool MD::readHtmlAttributes(MD::Line &line)

Returns whether the HTML attributes was read.

line Line.

QString MD::readLinkDestination(MD::Line &line)

Read link's destination.

line Line

QString MD::readLinkTitle(MD::Line &line, QChar &startChar, int &startParenthesisCount, qsizetype &startPos, bool &endStarted)

Read link's title.

line Line.

startChar Receiver for surrounding of title character.

startParenthesisCount Receiver for count of start parenthesis.

startPos Receiver for a start position.

endStarted Receiver for flag means that title is ended.

void MD::removeBackslashes(QString &str)

Remove backslashes from string.

str String.

void MD::replaceEntity(QString &str)

Replace entities in the string with corresponding character.

str String for modifications.

template <typename Pred> void MD::skipIf(MD::Line &line, Pred pred)

Skip characters by the given predicate.

line String.

pred Predicate.

template <typename Pred> qsizetype MD::skipIf(qsizetype startPos, const QString &line, Pred pred, qsizetype endPos = -1)

Returns first position of character not satisfying to predicate.

startPos Start position.

line String.

pred Predicate.

endPos End position. -1 means last character in the string.

See also MD::skipIfBackward.

template <typename Pred> qsizetype MD::skipIfBackward(qsizetype startPos, const QString &line, Pred pred, qsizetype endPos = -1)

Returns first position of character not satisfying to predicate moving in backward order.

startPos Start position.

line String.

pred Predicate.

endPos End position. -1 means first character in the string. End position is inclusive.

See also MD::skipIf.

void MD::skipSpaces(MD::Line &line)

Skip space characters.

line String.

template <typename HtmlVisitor = MD::details::HtmlVisitor> QString MD::toHtml(QSharedPointer<MD::Document> doc, bool wrapInBodyTag = true, const QString &footnoteBackLinkContent = {}, bool wrapInArticle = true, const details::IdsMap *idsMap = nullptr)

Convert Document to HTML.

doc Markdown document.

wrapInBodyTag Wrap HTML into <body> tag?

footnoteBackLinkContent String that will be applied as content of back link from footnote. As an example, you can use "<img src="..." />".

wrapInArticle Wrap HTML with <article> tag?

idsMap Map of IDs to set to items.

void MD::writeMultiline(const QString &text, QTextStream &stream, MD::SerialiseHelper *helper)

Serialise multi-lined content.

text Multi-line data.

stream Stream.

helper Serialiser helper.

bool MD::operator<(const MD::StyleDelim &s1, const MD::StyleDelim &s2)

Returns compare state of two style delimiters by theirs positions.

s1 Left operand.

s2 Right operand.

QTextStream &MD::operator<<(QTextStream &stream, const MD::Item &item)

Serialise item into Markdown.

stream Stream.

item Item.

bool operator==(const MD::WithPosition &l, const MD::WithPosition &r)

Returns whether both are equal.

l Left operand.

r Right operand.

bool operator==(const MD::StyleDelim &l, const MD::StyleDelim &r)

Returns whether both are equal.

l Left operand.

r Right operand.