|
#include <ContentTree.h>
Inheritance diagram for pdftron::Layout::List:Public Types | |
| enum | NumberFormat { e_none = 0, e_decimal, e_lower_roman, e_upper_roman, e_lower_letter, e_upper_letter, e_ordinal, e_ordinal_text, e_chinese_counting, e_chinese_counting_thousand, e_cardinal_text, e_decimal_zero } |
Public Attributes | |
| TRN_List | m_impl |
| Public Attributes inherited from pdftron::Layout::ContentElement | |
| TRN_ContentElement | m_impl |
Friends | |
| class | ContentContainer |
| class | ListItem |
| class | ElementRef< List > |
Additional Inherited Members | |
| Protected Member Functions inherited from pdftron::Layout::ContentNode | |
| ContentNode (TRN_ContentNode impl) | |
| Protected Member Functions inherited from pdftron::Layout::ContentElement | |
| ContentElement (TRN_ContentElement impl) | |
A class representing a list in the document content tree.
Definition at line 1648 of file ContentTree.h.
| Enumerator | |
|---|---|
| e_none | |
| e_decimal | |
| e_lower_roman | |
| e_upper_roman | |
| e_lower_letter | |
| e_upper_letter | |
| e_ordinal | |
| e_ordinal_text | |
| e_chinese_counting | |
| e_chinese_counting_thousand | |
| e_cardinal_text | |
| e_decimal_zero | |
Definition at line 1659 of file ContentTree.h.
| pdftron::Layout::List::~List | ( | ) |
| ListItem pdftron::Layout::List::AddItem | ( | ) |
Add a new list item to the list.
| void pdftron::Layout::List::ContinueList | ( | ) |
Continues the logical continuation of a particular list, even if other non-list content items have been created since the last call to AddItem(). This method is useful when splitting a sublist and wanting to continue the new items as part of the original sublist hierarchy.
Note: Without calling ContinueList(), new list items created after a split (e.g., a split paragraph) would be added to the main list structure (above the split) based on their natural positions in the list/sublist hierarchy.
Example usage: To continue a root-level list after a split, call ContinueList() on the root-level list.
| int pdftron::Layout::List::GetIndentationLevel | ( | ) |
Get the indentation level of the list.
| TextStyledElement pdftron::Layout::List::GetLabelStyle | ( | ) |
Get the text style element for the list item labels.
| int pdftron::Layout::List::GetListIdentifier | ( | ) |
Get the identifier of the list.
| void pdftron::Layout::List::SetNumberFormat | ( | const NumberFormat | format | ) |
Set the number format of the list.
| format | The number format to set for the list. |
| void pdftron::Layout::List::SetNumberFormat | ( | const NumberFormat | format, |
| const UString & | suffix, | ||
| bool | cascade | ||
| ) |
Set the number format of the list with a custom suffix and cascade flag.
| format | The number format to set for the list. |
| suffix | The suffix to append to the list item number. |
| cascade | If true, the number format will be applied to nested lists as well. |
| void pdftron::Layout::List::SetStartIndex | ( | int | idx | ) |
Set the start index for the list items.
| idx | The start index value. |
|
friend |
Definition at line 1650 of file ContentTree.h.
|
friend |
Definition at line 1652 of file ContentTree.h.
|
friend |
Definition at line 1651 of file ContentTree.h.
| TRN_List pdftron::Layout::List::m_impl |
Definition at line 1742 of file ContentTree.h.
