MD::Heading

Search for usage in LXR

MD::Heading< Trait > Class Template Referencefinal

#include <doc.h>

Inheritance diagram for MD::Heading< Trait >:

Public Types

using Delims = typename Trait::template Vector<WithPosition>
 
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 Delimsdelims () const
 
bool isLabeled () const
 
const Trait::String & label () const
 
const WithPositionlabelPos () const
 
int level () const
 
void setDelims (const Delims &d)
 
void setLabel (const typename Trait::String &l)
 
void setLabelPos (const WithPosition &p)
 
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 709 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 720 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 746 of file doc.h.

Constructor & Destructor Documentation

◆ Heading()

template<class Trait >
MD::Heading< Trait >::Heading ( )
inline

Definition at line 712 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 723 of file doc.h.

◆ delims()

template<class Trait >
const Delims & MD::Heading< Trait >::delims ( ) const
inline
Returns
List of service characters.

Definition at line 791 of file doc.h.

◆ isLabeled()

template<class Trait >
bool MD::Heading< Trait >::isLabeled ( ) const
inline
Returns
Is this heading has label?

Definition at line 773 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 779 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 803 of file doc.h.

◆ level()

template<class Trait >
int MD::Heading< Trait >::level ( ) const
inline
Returns
Level of the heading.

Definition at line 761 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 797 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 785 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 809 of file doc.h.

◆ setLevel()

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

Set level of the heading.

Definition at line 767 of file doc.h.

◆ setText()

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

Set content of the heading.

Definition at line 755 of file doc.h.

◆ text()

template<class Trait >
ParagraphSharedPointer MD::Heading< Trait >::text ( ) const
inline
Returns
Content of the heading.

Definition at line 749 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 740 of file doc.h.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Sat Dec 21 2024 17:04:36 by doxygen 1.12.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.