MD::Heading< Trait > Class Template Reference

#include <doc.h>

Inheritance diagram for MD::Heading< Trait >:

Public Types
using	Delims = typename Trait::template Vector<WithPosition>
using	LabelsVector = typename Trait::template Vector<typename Trait::String>
using	ParagraphSharedPointer = std::shared_ptr<Paragraph<Trait>>

Public Member Functions
	Heading ()
	~Heading () override=default
std::shared_ptr< Item< Trait > >	clone (Document< Trait > *doc=nullptr) const override
const Delims &	delims () const
bool	isLabeled () const
const Trait::String &	label () const
const WithPosition &	labelPos () const
LabelsVector &	labelVariants ()
const LabelsVector &	labelVariants () const
int	level () const
void	setDelims (const Delims &d)
void	setLabel (const typename Trait::String &l)
void	setLabelPos (const WithPosition &p)
void	setLabelVariants (const LabelsVector &vars)
void	setLevel (int l)
void	setText (ParagraphSharedPointer t)
ParagraphSharedPointer	text () const
ItemType	type () const override
Public Member Functions inherited from MD::Item< Trait >
	~Item () override=default
Public Member Functions inherited from MD::WithPosition
	WithPosition ()=default
	WithPosition (long long int startColumn, long long int startLine, long long int endColumn, long long int endLine)
virtual	~WithPosition ()=default
void	applyPositions (const WithPosition &other)
long long int	endColumn () const
long long int	endLine () const
void	setEndColumn (long long int c)
void	setEndLine (long long int l)
void	setStartColumn (long long int c)
void	setStartLine (long long int l)
long long int	startColumn () const
long long int	startLine () const

Additional Inherited Members
Protected Member Functions inherited from MD::Item< Trait >
	Item ()=default

Detailed Description

template<class Trait>
class MD::Heading< Trait >

Heading.

Definition at line 710 of file doc.h.

Member Typedef Documentation

Delims

template<class Trait>

using MD::Heading< Trait >::Delims = typename Trait::template Vector<WithPosition>

Type of list of service chanracters.

Definition at line 721 of file doc.h.

LabelsVector

template<class Trait>

using MD::Heading< Trait >::LabelsVector = typename Trait::template Vector<typename Trait::String>

Type of a vector of labels.

Definition at line 819 of file doc.h.

ParagraphSharedPointer

template<class Trait>

using MD::Heading< Trait >::ParagraphSharedPointer = std::shared_ptr<Paragraph<Trait>>

Type of smart pointer to paragraph.

Definition at line 750 of file doc.h.

Constructor & Destructor Documentation

Heading()

template<class Trait>

MD::Heading< Trait >::Heading ( )

inline

Definition at line 713 of file doc.h.

~Heading()

template<class Trait>

MD::Heading< Trait >::~Heading ( )

overridedefault

Member Function Documentation

clone()

template<class Trait>

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

inlineoverridevirtual

Clone this heading.

Implements MD::Item< Trait >.

Definition at line 724 of file doc.h.

delims()

template<class Trait>

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

inline

Returns

List of service characters.

Definition at line 795 of file doc.h.

isLabeled()

template<class Trait>

bool MD::Heading< Trait >::isLabeled ( ) const

inline

Returns

Is this heading has label?

Definition at line 777 of file doc.h.

label()

template<class Trait>

const Trait::String & MD::Heading< Trait >::label ( ) const

inline

Returns

Label of the heading.

Definition at line 783 of file doc.h.

labelPos()

template<class Trait>

const WithPosition & MD::Heading< Trait >::labelPos ( ) const

inline

Returns

Position of a label in the heading.

Definition at line 807 of file doc.h.

labelVariants() [1/2]

template<class Trait>

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

inline

Returns

Label variants.

Definition at line 828 of file doc.h.

labelVariants() [2/2]

template<class Trait>

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

inline

Returns

Label variants.

Definition at line 822 of file doc.h.

level()

template<class Trait>

int MD::Heading< Trait >::level ( ) const

inline

Returns

Level of the heading.

Definition at line 765 of file doc.h.

setDelims()

template<class Trait>

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

inline

Set list of service characters.

Definition at line 801 of file doc.h.

setLabel()

template<class Trait>

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

inline

Set label of the heading.

Definition at line 789 of file doc.h.

setLabelPos()

template<class Trait>

void MD::Heading< Trait >::setLabelPos ( const WithPosition & p )

inline

Set position of a label in the heading.

Definition at line 813 of file doc.h.

setLabelVariants()

template<class Trait>

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

inline

Set label variants.

Definition at line 834 of file doc.h.

setLevel()

template<class Trait>

void MD::Heading< Trait >::setLevel ( int l )

inline

Set level of the heading.

Definition at line 771 of file doc.h.

setText()

template<class Trait>

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

inline

Set content of the heading.

Definition at line 759 of file doc.h.

text()

template<class Trait>

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

inline

Returns

Content of the heading.

Definition at line 753 of file doc.h.

type()

template<class Trait>

ItemType MD::Heading< Trait >::type ( ) const

inlineoverridevirtual

Returns

Type of the item.

Implements MD::Item< Trait >.

Definition at line 744 of file doc.h.

---

The documentation for this class was generated from the following file:

• doc.h