• Skip to content
  • Skip to link menu
KDE 4.0 API Reference
  • KDE API Reference
  • kdegraphics
  • Sitemap
  • Contact Us
 

okular

Okular::DocumentSynopsis

Okular::DocumentSynopsis Class Reference

#include <document.h>

Inheritance diagram for Okular::DocumentSynopsis:

Inheritance graph
[legend]

List of all members.


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 listview) 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:

  • Icon: An icon to be set in the Lisview for the node
  • Viewport: A string description of the referred viewport
  • ViewportName: A 'named reference' to the viewport that must be converted using metaData( "NamedViewport", *viewport_name* )

Definition at line 761 of file document.h.


Public Member Functions

 DocumentSynopsis ()
 DocumentSynopsis (const QDomDocument &document)

Constructor & Destructor Documentation

DocumentSynopsis::DocumentSynopsis (  ) 

Creates a new document synopsis object.

DocumentSynopsis.

Definition at line 2931 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 2937 of file document.cpp.


The documentation for this class was generated from the following files:
  • document.h
  • document.cpp

okular

Skip menu "okular"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdegraphics

Skip menu "kdegraphics"
  • okular
Generated for kdegraphics by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal