MD::ListItem Class
template <typename Trait> class MD::ListItemList item in a list. More...
| Header: | #include <md4qt/doc.h> |
| CMake: | find_package(md4qt REQUIRED COMPONENTS md4qt)target_link_libraries(mytarget PRIVATE md4qt::md4qt) |
| Inherits: | MD::Block |
Public Types
| enum | ListType { Ordered, Unordered } |
| enum | OrderedListPreState { Start, Continue } |
Public Functions
| std::shared_ptr<MD::Item<Trait>> | clone(MD::Document<Trait> *doc = nullptr) const override |
| const MD::WithPosition & | delim() const |
| bool | isChecked() const |
| bool | isTaskList() const |
| MD::ListItem<Trait>::ListType | listType() const |
| MD::ListItem<Trait>::OrderedListPreState | orderedListPreState() const |
| void | setChecked(bool on = true) |
| void | setDelim(const MD::WithPosition &d) |
| void | setListType(MD::ListItem<Trait>::ListType t) |
| void | setOrderedListPreState(MD::ListItem<Trait>::OrderedListPreState s) |
| void | setStartNumber(int n) |
| void | setTaskDelim(const MD::WithPosition &d) |
| void | setTaskList(bool on = true) |
| int | startNumber() const |
| const MD::WithPosition & | taskDelim() const |
| MD::ItemType | type() const override |
Detailed Description
Member Type Documentation
enum ListItem::ListType
Type of the list.
| Constant | Value | Description |
|---|---|---|
MD::ListItem::Ordered | 0 | Ordered. |
MD::ListItem::Unordered | 0 | Unordered. |
enum ListItem::OrderedListPreState
Preliminary state of the ordered list.
| Constant | Value | Description |
|---|---|---|
MD::ListItem::Start | 0 | Start item. |
MD::ListItem::Continue | 0 | Continue of the list. |
Member Function Documentation
std::shared_ptr<MD::Item<Trait>> ListItem::clone(MD::Document<Trait> *doc = nullptr) const
Clone this list item.
doc Parent of new item.
const MD::WithPosition &ListItem::delim() const
Returns service character position.
See also setDelim().
bool ListItem::isChecked() const
Returns whether this task list item checked?
bool ListItem::isTaskList() const
Returns whether this list item a task list item?
MD::ListItem<Trait>::ListType ListItem::listType() const
Returns type of the list.
See also setListType().
MD::ListItem<Trait>::OrderedListPreState ListItem::orderedListPreState() const
Returns preliminary state of the ordered list.
See also setOrderedListPreState().
void ListItem::setChecked(bool on = true)
Set this task list item to be checked.
on New value.
See also isChecked().
void ListItem::setDelim(const MD::WithPosition &d)
Set service character position.
d New value.
See also delim().
void ListItem::setListType(MD::ListItem<Trait>::ListType t)
Set type of the list.
t New value.
See also listType().
void ListItem::setOrderedListPreState(MD::ListItem<Trait>::OrderedListPreState s)
Set preliminary state of the ordered list.
s New value.
See also orderedListPreState().
void ListItem::setStartNumber(int n)
Set start number of the ordered list.
n New value.
See also startNumber().
void ListItem::setTaskDelim(const MD::WithPosition &d)
Set position of the task list "checkbox" in Markdown.
d New value.
See also taskDelim().
void ListItem::setTaskList(bool on = true)
Set this list item to be a tsk list item.
on New value.
See also isTaskList().
int ListItem::startNumber() const
Returns start number of the ordered list.
See also setStartNumber().
const MD::WithPosition &ListItem::taskDelim() const
Returns position of the task list "checkbox" in Markdown.
See also setTaskDelim().
MD::ItemType ListItem::type() const
Returns type of the item.