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

okular

  • Okular
  • DocumentSynopsis
Public Member Functions | List of all members
Okular::DocumentSynopsis Class Reference

#include <document.h>

Inheritance diagram for Okular::DocumentSynopsis:
Inheritance graph
[legend]

Public Member Functions

 DocumentSynopsis ()
 
 DocumentSynopsis (const QDomDocument &document)
 
- Public Member Functions inherited from QDomDocument
 QDomDocument ()
 
 QDomDocument (const QString &name)
 
 QDomDocument (const QDomDocument &x)
 
 QDomDocument (const QDomDocumentType &doctype)
 
 ~QDomDocument ()
 
QDomAttr createAttribute (const QString &name)
 
QDomAttr createAttributeNS (const QString &nsURI, const QString &qName)
 
QDomCDATASection createCDATASection (const QString &value)
 
QDomComment createComment (const QString &value)
 
QDomDocumentFragment createDocumentFragment ()
 
QDomElement createElement (const QString &tagName)
 
QDomElement createElementNS (const QString &nsURI, const QString &qName)
 
QDomEntityReference createEntityReference (const QString &name)
 
QDomProcessingInstruction createProcessingInstruction (const QString &target, const QString &data)
 
QDomText createTextNode (const QString &value)
 
QDomDocumentType doctype () const
 
QDomElement documentElement () const
 
QDomElement elementById (const QString &elementId)
 
QDomNodeList elementsByTagName (const QString &tagname) const
 
QDomNodeList elementsByTagNameNS (const QString &nsURI, const QString &localName)
 
QDomImplementation implementation () const
 
QDomNode importNode (const QDomNode &importedNode, bool deep)
 
QDomNode::NodeType nodeType () const
 
QDomDocument & operator= (const QDomDocument &x)
 
bool setContent (QXmlInputSource *source, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)
 
bool setContent (const QByteArray &buffer, QString *errorMsg, int *errorLine, int *errorColumn)
 
bool setContent (QIODevice *dev, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)
 
bool setContent (QIODevice *dev, QString *errorMsg, int *errorLine, int *errorColumn)
 
bool setContent (const QString &text, QString *errorMsg, int *errorLine, int *errorColumn)
 
bool setContent (const QByteArray &data, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)
 
bool setContent (const QString &text, bool namespaceProcessing, QString *errorMsg, int *errorLine, int *errorColumn)
 
bool setContent (QXmlInputSource *source, QXmlReader *reader, QString *errorMsg, int *errorLine, int *errorColumn)
 
QByteArray toByteArray (int indent) const
 
QString toString (int indent) const
 
- Public Member Functions inherited from QDomNode
 QDomNode ()
 
 QDomNode (const QDomNode &n)
 
 ~QDomNode ()
 
QDomNode appendChild (const QDomNode &newChild)
 
QDomNamedNodeMap attributes () const
 
QDomNodeList childNodes () const
 
void clear ()
 
QDomNode cloneNode (bool deep) const
 
int columnNumber () const
 
QDomNode firstChild () const
 
QDomElement firstChildElement (const QString &tagName) const
 
bool hasAttributes () const
 
bool hasChildNodes () const
 
QDomNode insertAfter (const QDomNode &newChild, const QDomNode &refChild)
 
QDomNode insertBefore (const QDomNode &newChild, const QDomNode &refChild)
 
bool isAttr () const
 
bool isCDATASection () const
 
bool isCharacterData () const
 
bool isComment () const
 
bool isDocument () const
 
bool isDocumentFragment () const
 
bool isDocumentType () const
 
bool isElement () const
 
bool isEntity () const
 
bool isEntityReference () const
 
bool isNotation () const
 
bool isNull () const
 
bool isProcessingInstruction () const
 
bool isSupported (const QString &feature, const QString &version) const
 
bool isText () const
 
QDomNode lastChild () const
 
QDomElement lastChildElement (const QString &tagName) const
 
int lineNumber () const
 
QString localName () const
 
QDomNode namedItem (const QString &name) const
 
QString namespaceURI () const
 
QDomNode nextSibling () const
 
QDomElement nextSiblingElement (const QString &tagName) const
 
QString nodeName () const
 
NodeType nodeType () const
 
QString nodeValue () const
 
void normalize ()
 
bool operator!= (const QDomNode &n) const
 
QDomNode & operator= (const QDomNode &n)
 
bool operator== (const QDomNode &n) const
 
QDomDocument ownerDocument () const
 
QDomNode parentNode () const
 
QString prefix () const
 
QDomNode previousSibling () const
 
QDomElement previousSiblingElement (const QString &tagName) const
 
QDomNode removeChild (const QDomNode &oldChild)
 
QDomNode replaceChild (const QDomNode &newChild, const QDomNode &oldChild)
 
void save (QTextStream &str, int indent) const
 
void save (QTextStream &str, int indent, EncodingPolicy encodingPolicy) const
 
void setNodeValue (const QString &v)
 
void setPrefix (const QString &pre)
 
QDomAttr toAttr () const
 
QDomCDATASection toCDATASection () const
 
QDomCharacterData toCharacterData () const
 
QDomComment toComment () const
 
QDomDocument toDocument () const
 
QDomDocumentFragment toDocumentFragment () const
 
QDomDocumentType toDocumentType () const
 
QDomElement toElement () const
 
QDomEntity toEntity () const
 
QDomEntityReference toEntityReference () const
 
QDomNotation toNotation () const
 
QDomProcessingInstruction toProcessingInstruction () const
 
QDomText toText () const
 

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 1167 of file document.h.

Constructor & Destructor Documentation

DocumentSynopsis::DocumentSynopsis ( )

Creates a new document synopsis object.

DocumentSynopsis.

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


The documentation for this class was generated from the following files:
  • document.h
  • document.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Mon Jun 22 2020 13:19:26 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

okular

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

kdegraphics API Reference

Skip menu "kdegraphics API Reference"
  •     libkdcraw
  •     libkexiv2
  •     libkipi
  •     libksane
  • okular

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal