mupdf
Loading...
Searching...
No Matches
fz_outline Struct Reference

#include <outline.h>

Collaboration diagram for fz_outline:

Public Attributes

int refs
char * title
char * uri
fz_location page
float x
float y
struct fz_outlinenext
struct fz_outlinedown
unsigned int is_open: 1
unsigned int flags: 7
unsigned int r: 8
unsigned int g: 8
unsigned int b: 8

Detailed Description

Structure based API fz_outline is a tree of the outline of a document (also known as table of contents).

title: Title of outline item using UTF-8 encoding. May be NULL if the outline item has no text string.

uri: Destination in the document to be displayed when this outline item is activated. May be an internal or external link, or NULL if the outline item does not have a destination.

page: The page number of an internal link, or -1 for external links or links with no destination.

next: The next outline item at the same level as this outline item. May be NULL if no more outline items exist at this level.

down: The outline items immediate children in the hierarchy. May be NULL if no children exist.

is_open: If zero, the outline element is closed in the UI. If 1, it should be open, showing any child elements.

flags: Bit 0 set -> Bold, Bit 1 set -> Italic. All other bits reserved.

r, g, b: The RGB components of the color of this entry.

Member Data Documentation

◆ b

unsigned int fz_outline::b

◆ down

struct fz_outline* fz_outline::down

◆ flags

unsigned int fz_outline::flags

◆ g

unsigned int fz_outline::g

◆ is_open

unsigned int fz_outline::is_open

◆ next

struct fz_outline* fz_outline::next

◆ page

fz_location fz_outline::page

◆ r

unsigned int fz_outline::r

◆ refs

int fz_outline::refs

◆ title

char* fz_outline::title

◆ uri

char* fz_outline::uri

◆ x

float fz_outline::x

◆ y

float fz_outline::y

The documentation for this struct was generated from the following file:
  • /home/docs/checkouts/readthedocs.org/user_builds/mupdf/checkouts/1.28.0/include/mupdf/fitz/outline.h