MD::ListItem< Trait > Class Template Reference

#include <doc.h>

Inheritance diagram for MD::ListItem< Trait >:

Public Types
enum	ListType { Ordered , Unordered }
enum	OrderedListPreState { Start , Continue }
Public Types inherited from MD::Block< Trait >
using	Items = typename Trait::template Vector<ItemSharedPointer>
using	ItemSharedPointer = std::shared_ptr<Item<Trait>>

Public Member Functions
	ListItem ()=default
	~ListItem () override=default
std::shared_ptr< Item< Trait > >	clone (Document< Trait > *doc=nullptr) const override
const WithPosition &	delim () const
bool	isChecked () const
bool	isTaskList () const
ListType	listType () const
OrderedListPreState	orderedListPreState () const
void	setChecked (bool on=true)
void	setDelim (const WithPosition &d)
void	setListType (ListType t)
void	setOrderedListPreState (OrderedListPreState s)
void	setStartNumber (int n)
void	setTaskDelim (const WithPosition &d)
void	setTaskList (bool on=true)
int	startNumber () const
const WithPosition &	taskDelim () const
ItemType	type () const override
Public Member Functions inherited from MD::Block< Trait >
	~Block () override=default
void	appendItem (ItemSharedPointer i)
void	applyBlock (const Block< Trait > &other, Document< Trait > *doc=nullptr)
ItemSharedPointer	getItemAt (long long int idx) const
void	insertItem (long long int idx, ItemSharedPointer i)
bool	isEmpty () const
const Items &	items () const
void	removeItemAt (long long int idx)
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::Block< Trait >
	Block ()=default
Protected Member Functions inherited from MD::Item< Trait >
	Item ()=default

Detailed Description

template<class Trait>
class MD::ListItem< Trait >

List item in a list.

Definition at line 912 of file doc.h.

Member Enumeration Documentation

ListType

template<class Trait>

enum MD::ListItem::ListType

Type of the list.

Enumerator
Ordered	Ordered.
Unordered	Unordered.

Definition at line 941 of file doc.h.

OrderedListPreState

template<class Trait>

enum MD::ListItem::OrderedListPreState

Preliminary state of the ordered list.

Enumerator
Start	Start item.
Continue	Continue of the list.

Definition at line 949 of file doc.h.

Constructor & Destructor Documentation

ListItem()

template<class Trait>

MD::ListItem< Trait >::ListItem ( )

default

~ListItem()

template<class Trait>

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

overridedefault

Member Function Documentation

clone()

template<class Trait>

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

inlineoverridevirtual

Clone this list item.

Implements MD::Item< Trait >.

Definition at line 919 of file doc.h.

delim()

template<class Trait>

const WithPosition & MD::ListItem< Trait >::delim ( ) const

inline

Returns

Service character position.

Definition at line 1017 of file doc.h.

isChecked()

template<class Trait>

bool MD::ListItem< Trait >::isChecked ( ) const

inline

Returns

Is this task list item checked?

Definition at line 1005 of file doc.h.

isTaskList()

template<class Trait>

bool MD::ListItem< Trait >::isTaskList ( ) const

inline

Returns

Is this list item a task list item?

Definition at line 993 of file doc.h.

listType()

template<class Trait>

ListType MD::ListItem< Trait >::listType ( ) const

inline

Returns

Type of the list.

Definition at line 957 of file doc.h.

orderedListPreState()

template<class Trait>

OrderedListPreState MD::ListItem< Trait >::orderedListPreState ( ) const

inline

Returns

Preliminary state of the ordered list.

Definition at line 969 of file doc.h.

setChecked()

template<class Trait>

void MD::ListItem< Trait >::setChecked ( bool on = true )

inline

Set this task list item to be checked.

Definition at line 1011 of file doc.h.

setDelim()

template<class Trait>

void MD::ListItem< Trait >::setDelim ( const WithPosition & d )

inline

Set service character position.

Definition at line 1023 of file doc.h.

setListType()

template<class Trait>

void MD::ListItem< Trait >::setListType ( ListType t )

inline

Set type of the list.

Definition at line 963 of file doc.h.

setOrderedListPreState()

template<class Trait>

void MD::ListItem< Trait >::setOrderedListPreState ( OrderedListPreState s )

inline

Set preliminary state of the ordered list.

Definition at line 975 of file doc.h.

setStartNumber()

template<class Trait>

void MD::ListItem< Trait >::setStartNumber ( int n )

inline

Set start number of the ordered list.

Definition at line 987 of file doc.h.

setTaskDelim()

template<class Trait>

void MD::ListItem< Trait >::setTaskDelim ( const WithPosition & d )

inline

Set position of the task list "checkbox" in Markdown.

Definition at line 1035 of file doc.h.

setTaskList()

template<class Trait>

void MD::ListItem< Trait >::setTaskList ( bool on = true )

inline

Set this list item to be a tsk list item.

Definition at line 999 of file doc.h.

startNumber()

template<class Trait>

int MD::ListItem< Trait >::startNumber ( ) const

inline

Returns

Start number of the ordered list

Definition at line 981 of file doc.h.

taskDelim()

template<class Trait>

const WithPosition & MD::ListItem< Trait >::taskDelim ( ) const

inline

Returns

Position of the task list "checkbox" in Markdown.

Definition at line 1029 of file doc.h.

type()

template<class Trait>

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

inlineoverridevirtual

Returns

Type of the item.

Implements MD::Item< Trait >.

Definition at line 935 of file doc.h.

---

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

• doc.h