KDE 4.2 API Reference okular
Okular::HighlightAnnotation Class Reference
#include <annotations.h>
Detailed Description
Definition at line 1017 of file annotations.h.
Public Types | |
| enum | HighlightType { Highlight, Squiggly, Underline, StrikeOut } |
Public Member Functions | |
| HighlightAnnotation (const QDomNode &description) | |
| HighlightAnnotation () | |
| QList< Quad > & | highlightQuads () |
| HighlightType | highlightType () const |
| void | setHighlightType (HighlightType type) |
| void | store (QDomNode &node, QDomDocument &document) const |
| SubType | subType () const |
| ~HighlightAnnotation () | |
Classes | |
| class | Quad |
| The Quad class contains 8 coordinates and style definitions which describe a line part of the whole highlight annotation. More... | |
Member Enumeration Documentation
Describes the highlighting style of the annotation.
- Enumerator:
-
Highlight Highlights the text. Squiggly Squiggles the text. Underline Underlines the text. StrikeOut Strikes out the text.
Definition at line 1023 of file annotations.h.
Constructor & Destructor Documentation
| HighlightAnnotation::HighlightAnnotation | ( | ) |
| HighlightAnnotation::HighlightAnnotation | ( | const QDomNode & | description | ) | [explicit] |
Creates a new highlight annotation from the xml description.
Definition at line 1685 of file annotations.cpp.
| HighlightAnnotation::~HighlightAnnotation | ( | ) |
Member Function Documentation
| QList< HighlightAnnotation::Quad > & HighlightAnnotation::highlightQuads | ( | ) |
Returns a reference to the quad list of the highlight annotation.
Definition at line 1745 of file annotations.cpp.
| HighlightAnnotation::HighlightType HighlightAnnotation::highlightType | ( | ) | const |
| void HighlightAnnotation::setHighlightType | ( | HighlightType | type | ) |
Sets the type of the highlight annotation.
- See also:
- HighlightType
Definition at line 1733 of file annotations.cpp.
| void HighlightAnnotation::store | ( | QDomNode & | node, | |
| QDomDocument & | document | |||
| ) | const [virtual] |
Stores the highlight annotation as xml in document under the given parent node.
Reimplemented from Okular::Annotation.
Definition at line 1751 of file annotations.cpp.
| Annotation::SubType HighlightAnnotation::subType | ( | ) | const [virtual] |
Returns the sub type of the highlight annotation.
Implements Okular::Annotation.
Definition at line 1789 of file annotations.cpp.
The documentation for this class was generated from the following files:
