KDE 4.0 API Reference okular
Okular::TextAnnotation Class Reference
#include <annotations.h>
Detailed Description
Definition at line 590 of file annotations.h.
Public Types | |
| enum | TextType { Linked, InPlace } |
| enum | InplaceIntent { Unknown, Callout, TypeWriter } |
Public Member Functions | |
| TextAnnotation () | |
| TextAnnotation (const QDomNode &description) | |
| ~TextAnnotation () | |
| void | setTextType (TextType type) |
| TextType | textType () const |
| void | setTextIcon (const QString &icon) |
| QString | textIcon () const |
| void | setTextFont (const QFont &font) |
| QFont | textFont () const |
| void | setInplaceAlignment (int alignment) |
| int | inplaceAlignment () const |
| void | setInplaceText (const QString &text) |
| QString | inplaceText () const |
| void | setInplaceCallout (const NormalizedPoint &point, int index) |
| NormalizedPoint | inplaceCallout (int index) const |
| NormalizedPoint | transformedInplaceCallout (int index) const |
| void | setInplaceIntent (InplaceIntent intent) |
| InplaceIntent | inplaceIntent () const |
| SubType | subType () const |
| void | store (QDomNode &node, QDomDocument &document) const |
Member Enumeration Documentation
Describes the type of the text.
- Enumerator:
-
Linked The annotation is linked to a text. InPlace The annotation is located next to the text.
Definition at line 596 of file annotations.h.
Constructor & Destructor Documentation
| TextAnnotation::TextAnnotation | ( | ) |
| TextAnnotation::TextAnnotation | ( | const QDomNode & | description | ) |
Creates a new text annotation from the xml description.
Definition at line 867 of file annotations.cpp.
| TextAnnotation::~TextAnnotation | ( | ) |
Member Function Documentation
| void TextAnnotation::setTextType | ( | TextType | type | ) |
Sets the text type of the text annotation.
- See also:
- TextType
Definition at line 926 of file annotations.cpp.
| TextAnnotation::TextType TextAnnotation::textType | ( | ) | const |
| void TextAnnotation::setTextIcon | ( | const QString & | icon | ) |
| QString TextAnnotation::textIcon | ( | ) | const |
| void TextAnnotation::setTextFont | ( | const QFont & | font | ) |
| QFont TextAnnotation::textFont | ( | ) | const |
| void TextAnnotation::setInplaceAlignment | ( | int | alignment | ) |
| int TextAnnotation::inplaceAlignment | ( | ) | const |
Returns the inplace alignment of the text annotation.
Definition at line 968 of file annotations.cpp.
| void TextAnnotation::setInplaceText | ( | const QString & | text | ) |
| QString TextAnnotation::inplaceText | ( | ) | const |
| void TextAnnotation::setInplaceCallout | ( | const NormalizedPoint & | point, | |
| int | index | |||
| ) |
Sets the inplace callout point at index.
index must be between 0 and 2.
Definition at line 986 of file annotations.cpp.
| NormalizedPoint TextAnnotation::inplaceCallout | ( | int | index | ) | const |
Returns the inplace callout point for index.
index must be between 0 and 2.
Definition at line 995 of file annotations.cpp.
| NormalizedPoint TextAnnotation::transformedInplaceCallout | ( | int | index | ) | const |
Returns the transformed (e.g.
rotated) inplace callout point for index.
index must be between 0 and 2.
Definition at line 1004 of file annotations.cpp.
| void TextAnnotation::setInplaceIntent | ( | InplaceIntent | intent | ) |
Returns the inplace intent of the text annotation.
- See also:
- InplaceIntent
Definition at line 1013 of file annotations.cpp.
| TextAnnotation::InplaceIntent TextAnnotation::inplaceIntent | ( | ) | const |
| Annotation::SubType TextAnnotation::subType | ( | ) | const [virtual] |
Returns the sub type of the text annotation.
Implements Okular::Annotation.
Definition at line 1025 of file annotations.cpp.
| void TextAnnotation::store | ( | QDomNode & | node, | |
| QDomDocument & | document | |||
| ) | const [virtual] |
Stores the text annotation as xml in document under the given parent node.
Reimplemented from Okular::Annotation.
Definition at line 1030 of file annotations.cpp.
The documentation for this class was generated from the following files:
