okular
#include <document.h>
Inherits QDomDocument.
Public Member Functions | |
DocumentSynopsis () | |
DocumentSynopsis (const QDomDocument &document) | |
Detailed Description
A DOM tree that describes the Table of Contents.
The Synopsis (TOC or Table Of Contents for friends) is represented via a dom tree where each node has an internal name (displayed in the TOC) and one or more attributes.
In the tree the tag name is the 'screen' name of the entry. A tag can have attributes. Here follows the list of tag attributes with meaning:
- Destination: A string description of the referred viewport
- DestinationName: A 'named reference' to the viewport that must be converted using metaData( "NamedViewport", viewport_name )
- ExternalFileName: A document to be opened, whose destination is specified with Destination or DestinationName
- Open: a boolean saying whether its TOC branch is open or not (default: false)
- URL: a URL to be open as destination; if set, no other Destination* or ExternalFileName entry is used
Definition at line 1154 of file document.h.
Constructor & Destructor Documentation
DocumentSynopsis::DocumentSynopsis | ( | ) |
Creates a new document synopsis object.
Definition at line 4786 of file document.cpp.
DocumentSynopsis::DocumentSynopsis | ( | const QDomDocument & | document | ) |
Creates a new document synopsis object with the given document
as parent node.
Definition at line 4792 of file document.cpp.
The documentation for this class was generated from the following files:
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:45:03 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.