Poppler::TextAnnotation Class Reference

#include <poppler-annotation.h>

Inheritance diagram for Poppler::TextAnnotation:

Collaboration diagram for Poppler::TextAnnotation:

Public Types
enum	InplaceIntent { Unknown , Callout , TypeWriter }
enum	TextType { Linked , InPlace }
Public Types inherited from Poppler::Annotation
enum	AdditionalActionType {   CursorEnteringAction , CursorLeavingAction , MousePressedAction , MouseReleasedAction ,   FocusInAction , FocusOutAction , PageOpeningAction , PageClosingAction ,   PageVisibleAction , PageInvisibleAction }
enum	Flag {   Hidden = 1 , FixedSize = 2 , FixedRotation = 4 , DenyPrint = 8 ,   DenyWrite = 16 , DenyDelete = 32 , ToggleHidingOnMouse = 64 , External = 128 }
enum	LineEffect { NoEffect = 1 , Cloudy = 2 }
enum	LineStyle {   Solid = 1 , Dashed = 2 , Beveled = 4 , Inset = 8 ,   Underline = 16 }
enum	RevScope { Root = 0 , Reply = 1 , Group = 2 , Delete = 4 }
enum	RevType {   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 , ALink = 7 , ACaret = 8 ,   AFileAttachment = 9 , ASound = 10 , AMovie = 11 , AScreen = 12 ,   AWidget = 13 , ARichMedia = 14 , A_BASE = 0 }

Public Member Functions
QPointF	calloutPoint (int id) const
QVector< QPointF >	calloutPoints () const
int	inplaceAlign () const
InplaceIntent	inplaceIntent () const
void	setCalloutPoints (const QVector< QPointF > &points)
void	setInplaceAlign (int align)
void	setInplaceIntent (InplaceIntent intent)
void	setTextColor (const QColor &color)
void	setTextFont (const QFont &font)
void	setTextIcon (const QString &icon)
SubType	subType () const override
	TextAnnotation (TextType type)
QColor	textColor () const
QFont	textFont () const
QString	textIcon () const
TextType	textType () const
Public Member Functions inherited from Poppler::Annotation
std::unique_ptr< AnnotationAppearance >	annotationAppearance () const
QString	author () const
QRectF	boundary () const
QString	contents () const
QDateTime	creationDate () const
int	flags () const
QDateTime	modificationDate () const
Popup	popup () const
QList< Annotation * >	revisions () const
RevScope	revisionScope () const
RevType	revisionType () const
void	setAnnotationAppearance (const AnnotationAppearance &annotationAppearance)
void	setAuthor (const QString &author)
void	setBoundary (const QRectF &boundary)
void	setContents (const QString &contents)
void	setCreationDate (const QDateTime &date)
void	setFlags (int flags)
void	setModificationDate (const QDateTime &date)
void	setPopup (const Popup &popup)
void	setStyle (const Style &style)
void	setUniqueName (const QString &uniqueName)
Style	style () const
QString	uniqueName () const
virtual	~Annotation ()

Detailed Description

Annotation containing text.

A text annotation is an object showing some text directly on the page, or linked to the contents using an icon shown on a page.

Member Function Documentation

calloutPoints()

QVector< QPointF > Poppler::TextAnnotation::calloutPoints

(

)

const

Since

0.20

setCalloutPoints()

void Poppler::TextAnnotation::setCalloutPoints

(

const QVector< QPointF > &

points

)

Since

0.20

setTextColor()

void Poppler::TextAnnotation::setTextColor

(

const QColor &

color

)

Since

0.69

setTextIcon()

void Poppler::TextAnnotation::setTextIcon

(

const QString &

icon

)

Set the name of the icon to use for this text annotation.

See also

textIcon for the list of standard names

subType()

SubType Poppler::TextAnnotation::subType ( ) const

overridevirtual

The type of the annotation.

Implements Poppler::Annotation.

textColor()

QColor Poppler::TextAnnotation::textColor

(

)

const

Default text color is black.

Since

0.69

textIcon()

QString Poppler::TextAnnotation::textIcon

(

)

const

The name of the icon for this text annotation.

Standard names for text annotation icons are:

• Comment
• Help
• Insert
• Key
• NewParagraph
• Note (this is the default icon to use)
• Paragraph

---

The documentation for this class was generated from the following file:

• poppler-annotation.h