KDE 4.0 API Reference okular
Okular::Annotation Class Reference
#include <annotations.h>
Detailed Description
Annotation struct holds properties shared by all annotations.An Annotation is an object (text note, highlight, sound, popup window, ..) contained by a Page in the document.
For current state in relations to pdf embedded annotations:
- See also:
- generator_pdf/README.Annotations
Definition at line 83 of file annotations.h.
Public Types | |
| enum | SubType { AText = 1, ALine = 2, AGeom = 3, AHighlight = 4, AStamp = 5, AInk = 6, A_BASE = 0 } |
| enum | Flag { Hidden = 1, FixedSize = 2, FixedRotation = 4, DenyPrint = 8, DenyWrite = 16, DenyDelete = 32, ToggleHidingOnMouse = 64, External = 128 } |
| enum | LineStyle { Solid = 1, Dashed = 2, Beveled = 4, Inset = 8, Underline = 16 } |
| enum | LineEffect { NoEffect = 1, Cloudy = 2 } |
| enum | RevisionScope { Reply = 1, Group = 2, Delete = 4 } |
| enum | RevisionType { None = 1, Marked = 2, Unmarked = 4, Accepted = 8, Rejected = 16, Cancelled = 32, Completed = 64 } |
Public Member Functions | |
| virtual | ~Annotation () |
| void | setAuthor (const QString &author) |
| QString | author () const |
| void | setContents (const QString &contents) |
| QString | contents () const |
| void | setUniqueName (const QString &name) |
| QString | uniqueName () const |
| void | setModificationDate (const QDateTime &date) |
| QDateTime | modificationDate () const |
| void | setCreationDate (const QDateTime &date) |
| QDateTime | creationDate () const |
| void | setFlags (int flags) |
| int | flags () const |
| void | setBoundingRectangle (const NormalizedRect &rectangle) |
| NormalizedRect | boundingRectangle () const |
| NormalizedRect | transformedBoundingRectangle () const |
| void | translate (const NormalizedPoint &coord) |
| Style & | style () |
| const Style & | style () const |
| Window & | window () |
| const Window & | window () const |
| QLinkedList< Revision > & | revisions () |
| const QLinkedList< Revision > & | revisions () const |
| virtual SubType | subType () const =0 |
| virtual void | store (QDomNode &node, QDomDocument &document) const |
Classes | |
| class | Revision |
| The Revision class contains all information about the revision of the annotation. More... | |
| class | Style |
| The Style class contains all information about style of the annotation. More... | |
| class | Window |
| The Window class contains all information about the popup window of the annotation that is used to edit the content and properties. More... | |
Member Enumeration Documentation
Describes the type of annotation as defined in PDF standard.
- Enumerator:
Definition at line 96 of file annotations.h.
Describes additional properties of an annotation.
- Enumerator:
Definition at line 110 of file annotations.h.
Describes possible line styles for.
- See also:
- ALine annotation.
- Enumerator:
-
Solid A solid line. Dashed A dashed line. Beveled A beveled line. Inset A inseted line. Underline An underline.
Definition at line 125 of file annotations.h.
Describes possible line effects for.
- See also:
- ALine annotation.
Definition at line 137 of file annotations.h.
Describes the scope of revision information.
- Enumerator:
-
Reply Belongs to a reply. Group Belongs to a group. Delete Belongs to a deleted paragraph.
Definition at line 146 of file annotations.h.
Describes the type of revision information.
- Enumerator:
-
None Not specified. Marked Is marked. Unmarked Is unmarked. Accepted Has been accepted. Rejected Was rejected. Cancelled Has been cancelled. Completed Has been completed.
Definition at line 156 of file annotations.h.
Constructor & Destructor Documentation
| Annotation::~Annotation | ( | ) | [virtual] |
Member Function Documentation
| void Annotation::setAuthor | ( | const QString & | author | ) |
| QString Annotation::author | ( | ) | const |
| void Annotation::setContents | ( | const QString & | contents | ) |
| QString Annotation::contents | ( | ) | const |
| void Annotation::setUniqueName | ( | const QString & | name | ) |
| QString Annotation::uniqueName | ( | ) | const |
| void Annotation::setModificationDate | ( | const QDateTime & | date | ) |
Sets the last modification date of the annotation.
The date must be before or equal to QDateTime::currentDateTime()
Definition at line 593 of file annotations.cpp.
| QDateTime Annotation::modificationDate | ( | ) | const |
Returns the last modification date of the annotation.
Definition at line 599 of file annotations.cpp.
| void Annotation::setCreationDate | ( | const QDateTime & | date | ) |
Sets the creation date of the annotation.
The date must be before or equal to
- See also:
- modificationDate()
Definition at line 605 of file annotations.cpp.
| QDateTime Annotation::creationDate | ( | ) | const |
| void Annotation::setFlags | ( | int | flags | ) |
| int Annotation::flags | ( | ) | const |
| void Annotation::setBoundingRectangle | ( | const NormalizedRect & | rectangle | ) |
| NormalizedRect Annotation::boundingRectangle | ( | ) | const |
| NormalizedRect Annotation::transformedBoundingRectangle | ( | ) | const |
Returns the transformed bounding rectangle of the annotation.
This rectangle must be used when showing annotations on screen to have them rotated correctly.
Definition at line 646 of file annotations.cpp.
| void Annotation::translate | ( | const NormalizedPoint & | coord | ) |
| Annotation::Style & Annotation::style | ( | ) |
Returns a reference to the style object of the annotation.
Definition at line 663 of file annotations.cpp.
| const Annotation::Style & Annotation::style | ( | ) | const |
Returns a const reference to the style object of the annotation.
Definition at line 669 of file annotations.cpp.
| Annotation::Window & Annotation::window | ( | ) |
Returns a reference to the window object of the annotation.
Definition at line 675 of file annotations.cpp.
| const Annotation::Window & Annotation::window | ( | ) | const |
Returns a const reference to the window object of the annotation.
Definition at line 681 of file annotations.cpp.
| QLinkedList< Annotation::Revision > & Annotation::revisions | ( | ) |
Returns a reference to the revision list of the annotation.
Definition at line 687 of file annotations.cpp.
| const QLinkedList< Annotation::Revision > & Annotation::revisions | ( | ) | const |
Returns a reference to the revision list of the annotation.
Definition at line 693 of file annotations.cpp.
| virtual SubType Okular::Annotation::subType | ( | ) | const [pure virtual] |
Returns the sub type of the annotation.
Implemented in Okular::TextAnnotation, Okular::LineAnnotation, Okular::GeomAnnotation, Okular::HighlightAnnotation, Okular::StampAnnotation, and Okular::InkAnnotation.
| void Annotation::store | ( | QDomNode & | node, | |
| QDomDocument & | document | |||
| ) | const [virtual] |
Stores the annotation as xml in document under the given parent node.
Reimplemented in Okular::TextAnnotation, Okular::LineAnnotation, Okular::GeomAnnotation, Okular::HighlightAnnotation, Okular::StampAnnotation, and Okular::InkAnnotation.
Definition at line 699 of file annotations.cpp.
The documentation for this class was generated from the following files:
