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

okular

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

#include <annotations.h>

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

Public Types

enum  GeomType { InscribedSquare, InscribedCircle }
 
- Public Types inherited from Okular::Annotation
enum  AdditionalActionType { PageOpening, PageClosing }
 
typedef void(* DisposeDataFunction )(const Okular::Annotation *)
 
enum  Flag {
  Hidden = 1, FixedSize = 2, FixedRotation = 4, DenyPrint = 8,
  DenyWrite = 16, DenyDelete = 32, ToggleHidingOnMouse = 64, External = 128,
  ExternallyDrawn = 256, BeingMoved = 512
}
 
enum  LineEffect { NoEffect = 1, Cloudy = 2 }
 
enum  LineStyle {
  Solid = 1, Dashed = 2, Beveled = 4, Inset = 8,
  Underline = 16
}
 
enum  RevisionScope { Reply = 1, Group = 2, Delete = 4 }
 
enum  RevisionType {
  None = 1, Marked = 2, Unmarked = 4, Accepted = 8,
  Rejected = 16, Cancelled = 32, Completed = 64
}
 
enum  SubType {
  AText = 1, ALine = 2, AGeom = 3, AHighlight = 4,
  AStamp = 5, AInk = 6, ACaret = 8, AFileAttachment = 9,
  ASound = 10, AMovie = 11, AScreen = 12, AWidget = 13,
  A_BASE = 0
}
 

Public Member Functions

 GeomAnnotation ()
 
 GeomAnnotation (const QDomNode &description)
 
 ~GeomAnnotation ()
 
QColor geometricalInnerColor () const
 
GeomType geometricalType () const
 
void setGeometricalInnerColor (const QColor &color)
 
void setGeometricalType (GeomType type)
 
void store (QDomNode &node, QDomDocument &document) const
 
SubType subType () const
 
- Public Member Functions inherited from Okular::Annotation
virtual ~Annotation ()
 
QString author () const
 
NormalizedRect boundingRectangle () const
 
bool canBeMoved () const
 
QString contents () const
 
QDateTime creationDate () const
 
int flags () const
 
QDomNode getAnnotationPropertiesDomNode () const
 
QDateTime modificationDate () const
 
QVariant nativeId () const
 
bool openDialogAfterCreation () const
 
QLinkedList< Revision > & revisions ()
 
const QLinkedList< Revision > & revisions () const
 
void setAnnotationProperties (const QDomNode &node)
 
void setAuthor (const QString &author)
 
void setBoundingRectangle (const NormalizedRect &rectangle)
 
void setContents (const QString &contents)
 
void setCreationDate (const QDateTime &date)
 
void setDisposeDataFunction (DisposeDataFunction func)
 
void setFlags (int flags)
 
void setModificationDate (const QDateTime &date)
 
void setNativeId (const QVariant &id)
 
void setUniqueName (const QString &name)
 
Style & style ()
 
const Style & style () const
 
NormalizedRect transformedBoundingRectangle () const
 
void translate (const NormalizedPoint &coord)
 
QString uniqueName () const
 
Window & window ()
 
const Window & window () const
 

Detailed Description

Definition at line 1016 of file annotations.h.

Member Enumeration Documentation

enum Okular::GeomAnnotation::GeomType
Enumerator
InscribedSquare 

Draw a square.

InscribedCircle 

Draw a circle.

Definition at line 1020 of file annotations.h.

Constructor & Destructor Documentation

GeomAnnotation::GeomAnnotation ( )

Creates a new geometrical annotation.

Definition at line 1599 of file annotations.cpp.

GeomAnnotation::GeomAnnotation ( const QDomNode &  description)

Creates a new geometrical annotation from the xml description.

Definition at line 1604 of file annotations.cpp.

GeomAnnotation::~GeomAnnotation ( )

Destroys the geometrical annotation.

Definition at line 1609 of file annotations.cpp.

Member Function Documentation

QColor GeomAnnotation::geometricalInnerColor ( ) const

Returns the inner color of the geometrical annotation.

Definition at line 1631 of file annotations.cpp.

GeomAnnotation::GeomType GeomAnnotation::geometricalType ( ) const

Returns the geometrical type of the geometrical annotation.

Definition at line 1619 of file annotations.cpp.

void GeomAnnotation::setGeometricalInnerColor ( const QColor &  color)

Sets the inner color of the geometrical annotation.

Definition at line 1625 of file annotations.cpp.

void GeomAnnotation::setGeometricalType ( GeomType  type)

Sets the geometrical type of the geometrical annotation.

See also
GeomType

Definition at line 1613 of file annotations.cpp.

void GeomAnnotation::store ( QDomNode &  node,
QDomDocument &  document 
) const
virtual

Stores the geometrical annotation as xml in document under the given parent node.

Reimplemented from Okular::Annotation.

Definition at line 1642 of file annotations.cpp.

Annotation::SubType GeomAnnotation::subType ( ) const
virtual

Returns the sub type of the geometrical annotation.

Implements Okular::Annotation.

Definition at line 1637 of file annotations.cpp.


The documentation for this class was generated from the following files:
  • annotations.h
  • annotations.cpp
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:45:03 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