epub_toc_entry_t Struct Reference

One titled entry in the table of contents. More...

#include <epub.h>

Data Fields
char	title [k_epub_meta_len]
	Navigation label text ("" if none).
char	href [k_epub_max_path_len]
	Target href (rel.
uint8_t	depth
	Nesting level; 0 == top level.

Detailed Description

One titled entry in the table of contents.

href is stored exactly as the navigation document wrote it, relative to the OPF directory (the same convention as epub_book_t::chapter_paths), and may carry a #fragment that points at an anchor inside a chapter. depth is the nesting level: a top-level entry is 0, a sub-entry 1, and so on, so a renderer can indent a hierarchical TOC.

Definition at line 142 of file epub.h.

Field Documentation

depth

uint8_t epub_toc_entry_t::depth

Nesting level; 0 == top level.

Definition at line 145 of file epub.h.

Referenced by internal_toc_reserve().

href

char epub_toc_entry_t::href[k_epub_max_path_len]

Target href (rel.

to OPF dir).

Definition at line 144 of file epub.h.

Referenced by epub_toc_entry_to_chapter(), internal_nav_event_start(), and internal_ncx_event().

title

char epub_toc_entry_t::title[k_epub_meta_len]

Navigation label text ("" if none).

Definition at line 143 of file epub.h.

Referenced by etoc_read_toc(), internal_chapter_title(), internal_nav_event(), internal_nav_event_start(), internal_ncx_event(), and sh_epub_label().

---

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

• apps/shared_libs/epub/inc/epub.h