#include "poppler/cpp/poppler-toc.h"
Inheritance diagram for poppler::toc_item:
Public Types | |
| typedef std::vector< toc_item * >::const_iterator | iterator |
Public Member Functions | |
| ~toc_item () | |
| std::vector< toc_item * > | children () const |
| iterator | children_begin () const |
| iterator | children_end () const |
| bool | is_open () const |
| ustring | title () const |
Detailed Description
Represents an item of the TOC (Table of Contents) of a PDF document.
Member Typedef Documentation
◆ iterator
| std::vector< toc_item * >::const_iterator poppler::toc_item::iterator |
An iterator for the children of a TOC item.
Constructor & Destructor Documentation
◆ ~toc_item()
| toc_item::~toc_item | ( | ) |
Destroys the TOC item.
Member Function Documentation
◆ children()
| std::vector< toc_item * > toc_item::children | ( | ) | const |
- Returns
- the children of the TOC item
◆ children_begin()
| toc_item::iterator toc_item::children_begin | ( | ) | const |
- Returns
- an iterator to the being of the list of children of the TOC item
◆ children_end()
| toc_item::iterator toc_item::children_end | ( | ) | const |
- Returns
- an iterator to the end of the list of children of the TOC item
◆ is_open()
| bool toc_item::is_open | ( | ) | const |
Returns whether the TOC item should be represented as open when showing the TOC.
This is not a functional behaviour, but a visualisation hint of the item. Regardless of this state, the item can be expanded and collapsed freely when represented in a TOC view of a PDF viewer.
- Returns
- whether the TOC item should be open
◆ title()
| ustring toc_item::title | ( | ) | const |
- Returns
- the title of the TOC item
