33#ifndef _POPPLER_ANNOTATION_H_
34#define _POPPLER_ANNOTATION_H_
36#include <QtCore/QDateTime>
37#include <QtCore/QSharedDataPointer>
38#include <QtCore/QList>
39#include <QtCore/QPointF>
40#include <QtCore/QRectF>
41#include <QtCore/QScopedPointer>
42#include <QtCore/QVector>
43#include <QtGui/QColor>
45#include "poppler-export.h"
52class AnnotationPrivate;
53class AnnotationAppearancePrivate;
54class TextAnnotationPrivate;
55class LineAnnotationPrivate;
56class GeomAnnotationPrivate;
57class HighlightAnnotationPrivate;
58class StampAnnotationPrivate;
59class InkAnnotationPrivate;
60class LinkAnnotationPrivate;
61class CaretAnnotationPrivate;
62class FileAttachmentAnnotationPrivate;
63class SoundAnnotationPrivate;
64class MovieAnnotationPrivate;
65class ScreenAnnotationPrivate;
66class WidgetAnnotationPrivate;
67class RichMediaAnnotationPrivate;
96 AnnotationAppearancePrivate *d;
220 ToggleHidingOnMouse = 64,
223 Q_DECLARE_FLAGS(Flags, Flag)
265 QString contents()
const;
266 void setContents(
const QString &contents);
279 QDateTime modificationDate()
const;
280 void setModificationDate(
const QDateTime &date);
282 QDateTime creationDate()
const;
283 void setCreationDate(
const QDateTime &date);
328 QColor color()
const;
329 void setColor(
const QColor &color);
330 double opacity()
const;
331 void setOpacity(
double opacity);
334 double width()
const;
335 void setWidth(
double width);
336 LineStyle lineStyle()
const;
337 void setLineStyle(LineStyle style);
338 double xCorners()
const;
339 void setXCorners(
double radius);
340 double yCorners()
const;
341 void setYCorners(
double radius);
342 const QVector<double> &dashArray()
const;
343 void setDashArray(
const QVector<double> &array);
346 LineEffect lineEffect()
const;
347 void setLineEffect(LineEffect effect);
348 double effectIntensity()
const;
349 void setEffectIntensity(
double intens);
353 QSharedDataPointer<Private> d;
357 void setStyle(
const Style &style);
372 void setFlags(
int flags);
375 QRectF geometry()
const;
376 void setGeometry(
const QRectF &geom);
379 QString title()
const;
380 void setTitle(
const QString &title);
381 QString summary()
const;
382 void setSummary(
const QString &summary);
383 QString text()
const;
384 void setText(
const QString &text);
388 QSharedDataPointer<Private> d;
395 RevScope revisionScope()
const;
397 RevType revisionType()
const;
402 std::vector<std::unique_ptr<Annotation>>
revisions()
const;
452 QExplicitlySharedDataPointer<AnnotationPrivate> d_ptr;
467 friend class AnnotationPrivate;
482 enum InplaceAlignPosition
519 QFont textFont()
const;
520 void setTextFont(
const QFont &font);
523 void setTextColor(
const QColor &color);
525 InplaceAlignPosition inplaceAlign()
const;
526 void setInplaceAlign(InplaceAlignPosition align);
528 QPointF calloutPoint(
int id)
const;
529 QVector<QPointF> calloutPoints()
const;
530 void setCalloutPoints(
const QVector<QPointF> &points);
532 InplaceIntent inplaceIntent()
const;
533 void setInplaceIntent(InplaceIntent intent);
537 void setTextType(TextType type);
549 friend class AnnotationPrivate;
583 LineType lineType()
const;
585 QVector<QPointF> linePoints()
const;
586 void setLinePoints(
const QVector<QPointF> &points);
588 TermStyle lineStartStyle()
const;
589 void setLineStartStyle(TermStyle style);
591 TermStyle lineEndStyle()
const;
592 void setLineEndStyle(TermStyle style);
594 bool isLineClosed()
const;
595 void setLineClosed(
bool closed);
597 QColor lineInnerColor()
const;
598 void setLineInnerColor(
const QColor &color);
600 double lineLeadingForwardPoint()
const;
601 void setLineLeadingForwardPoint(
double point);
603 double lineLeadingBackPoint()
const;
604 void setLineLeadingBackPoint(
double point);
606 bool lineShowCaption()
const;
607 void setLineShowCaption(
bool show);
609 LineIntent lineIntent()
const;
610 void setLineIntent(LineIntent intent);
614 void setLineType(LineType type);
627 friend class AnnotationPrivate;
641 GeomType geomType()
const;
642 void setGeomType(GeomType type);
644 QColor geomInnerColor()
const;
645 void setGeomInnerColor(
const QColor &color);
660 friend class AnnotationPrivate;
726 friend class AnnotationPrivate;
781 friend class AnnotationPrivate;
788 QList<QVector<QPointF>> inkPaths()
const;
789 void setInkPaths(
const QList<QVector<QPointF>> &paths);
799 friend class AnnotationPrivate;
814 Link *linkDestination()
const;
815 void setLinkDestination(std::unique_ptr<Link> &&link);
817 HighlightMode linkHighlightMode()
const;
818 void setLinkHighlightMode(HighlightMode mode);
820 QPointF linkRegionPoint(
int id)
const;
821 void setLinkRegionPoint(
int id,
const QPointF point);
837 friend class AnnotationPrivate;
853 CaretSymbol caretSymbol()
const;
854 void setCaretSymbol(CaretSymbol symbol);
869 friend class AnnotationPrivate;
909 friend class AnnotationPrivate;
949 friend class AnnotationPrivate;
989 friend class AnnotationPrivate;
1041 friend class AnnotationPrivate;
1068 friend class AnnotationPrivate;
1085 friend class AnnotationPrivate;
1097 void setFlashVars(
const QString &flashVars);
1100 QScopedPointer<Private> d;
1112 friend class AnnotationPrivate;
1140 void setType(
Type type);
1144 QScopedPointer<Private> d;
1155 friend class AnnotationPrivate;
1188 void setType(
Type type);
1189 void setName(
const QString &name);
1190 void setInstances(
const QList<RichMediaAnnotation::Instance *> &instances);
1193 QScopedPointer<Private> d;
1205 friend class AnnotationPrivate;
1222 void setName(
const QString &name);
1226 QScopedPointer<Private> d;
1237 friend class AnnotationPrivate;
1251 QList<RichMediaAnnotation::Asset *>
assets()
const;
1254 void setConfigurations(
const QList<RichMediaAnnotation::Configuration *> &configurations);
1255 void setAssets(
const QList<RichMediaAnnotation::Asset *> &assets);
1258 QScopedPointer<Private> d;
1269 friend class AnnotationPrivate;
1294 QScopedPointer<Private> d;
1305 friend class AnnotationPrivate;
1330 QScopedPointer<Private> d;
1341 friend class AnnotationPrivate;
1362 QScopedPointer<Private> d;
AnnotationAppearance class wrapping Poppler's AP stream object.
Definition poppler-annotation.h:88
Container class for Annotation style information.
Definition poppler-annotation.h:320
Annotation class holding properties shared by all annotations.
Definition poppler-annotation.h:174
void setFlags(Flags flags)
Sets this annotation's flags.
std::unique_ptr< AnnotationAppearance > annotationAppearance() const
Returns the current appearance stream of this annotation.
SubType
Annotation subclasses.
Definition poppler-annotation.h:187
void setAuthor(const QString &author)
Sets a new author for the annotation.
void setPopup(const Popup &popup)
QRectF boundary() const
Returns this annotation's boundary rectangle in normalized coordinates.
void setAnnotationAppearance(const AnnotationAppearance &annotationAppearance)
Sets the annotation's appearance stream with the annotationAppearance.
std::vector< std::unique_ptr< Annotation > > revisions() const
Returns the revisions of this annotation.
Flag
Annotation flags.
Definition poppler-annotation.h:213
QString author() const
Returns the author of the annotation.
void setUniqueName(const QString &uniqueName)
Sets a new unique name for the annotation.
Flags flags() const
Returns this annotation's flags.
virtual ~Annotation()
Destructor.
QString uniqueName() const
Returns the unique name (ID) of the annotation.
void setBoundary(const QRectF &boundary)
Sets this annotation's boundary rectangle.
AdditionalActionType
Describes the flags from an annotations 'AA' dictionary.
Definition poppler-annotation.h:435
@ MouseReleasedAction
Performed when the mouse button is released inside the annotation's active area.
Definition poppler-annotation.h:439
@ FocusInAction
Performed when the annotation receives the input focus.
Definition poppler-annotation.h:440
@ PageOpeningAction
Performed when the page containing the annotation is opened.
Definition poppler-annotation.h:442
@ MousePressedAction
Performed when the mouse button is pressed inside the annotation's active area.
Definition poppler-annotation.h:438
@ FocusOutAction
Performed when the annotation loses the input focus.
Definition poppler-annotation.h:441
@ PageClosingAction
Performed when the page containing the annotation is closed.
Definition poppler-annotation.h:443
@ CursorLeavingAction
Performed when the cursor exists the annotation's active area.
Definition poppler-annotation.h:437
@ PageVisibleAction
Performed when the page containing the annotation becomes visible.
Definition poppler-annotation.h:444
@ CursorEnteringAction
Performed when the cursor enters the annotation's active area.
Definition poppler-annotation.h:436
virtual SubType subType() const =0
The type of the annotation.
Caret annotation.
Definition poppler-annotation.h:836
SubType subType() const override
The type of the annotation.
CaretSymbol
The symbols for the caret annotation.
Definition poppler-annotation.h:848
Container class for an embedded file with a PDF document.
Definition poppler-qt6.h:337
File attachment annotation.
Definition poppler-annotation.h:868
void setFileIconName(const QString &icon)
Sets a new name for the icon of this annotation.
QString fileIconName() const
Returns the name of the icon of this annotation.
void setEmbeddedFile(EmbeddedFile *ef)
Sets a new EmbeddedFile for this annotation.
EmbeddedFile * embeddedFile() const
Returns the EmbeddedFile of this annotation.
SubType subType() const override
The type of the annotation.
Geometric annotation.
Definition poppler-annotation.h:626
SubType subType() const override
The type of the annotation.
Text highlight annotation.
Definition poppler-annotation.h:659
void setHighlightQuads(const QList< Quad > &quads)
Set the areas to highlight.
QList< Quad > highlightQuads() const
The list of areas to highlight.
void setHighlightType(HighlightType type)
Set the type of highlighting to use for the given area or areas.
SubType subType() const override
The type of the annotation.
HighlightType highlightType() const
The type (style) of highlighting to use for this area or these areas.
HighlightType
The type of highlight.
Definition poppler-annotation.h:671
@ Squiggly
jagged or squiggly underline
Definition poppler-annotation.h:673
@ Underline
straight line underline
Definition poppler-annotation.h:674
@ Highlight
highlighter pen style annotation
Definition poppler-annotation.h:672
Ink Annotation.
Definition poppler-annotation.h:780
SubType subType() const override
The type of the annotation.
Polygon/polyline annotation.
Definition poppler-annotation.h:548
SubType subType() const override
The type of the annotation.
Definition poppler-annotation.h:798
SubType subType() const override
The type of the annotation.
Movie: a movie to be played.
Definition poppler-link.h:559
Rendition: Rendition link.
Definition poppler-link.h:468
Encapsulates data that describes a link.
Definition poppler-link.h:178
Movie annotation.
Definition poppler-annotation.h:948
void setMovieTitle(const QString &title)
Sets a new title for the movie of this annotation.
MovieObject * movie() const
Returns the MovieObject of this annotation.
SubType subType() const override
The type of the annotation.
void setMovie(MovieObject *movie)
Sets a new MovieObject for this annotation.
QString movieTitle() const
Returns the title of the movie of this annotation.
Container class for a movie object in a PDF document.
Definition poppler-qt6.h:2239
A page in a document.
Definition poppler-qt6.h:423
The content object of a RichMediaAnnotation.
Definition poppler-annotation.h:1236
QList< RichMediaAnnotation::Configuration * > configurations() const
Returns the list of configuration objects of the content object.
QList< RichMediaAnnotation::Asset * > assets() const
Returns the list of asset objects of the content object.
Screen annotation.
Definition poppler-annotation.h:988
LinkRendition * action() const
Returns the LinkRendition of this annotation.
SubType subType() const override
The type of the annotation.
void setAction(LinkRendition *action)
Sets a new LinkRendition for this annotation.
std::unique_ptr< Link > additionalAction(AdditionalActionType type) const
Returns the additional action of the given type for the annotation or 0 if no action has been defined...
void setScreenTitle(const QString &title)
Sets a new title for the screen of this annotation.
QString screenTitle() const
Returns the title of the screen of this annotation.
Sound annotation.
Definition poppler-annotation.h:908
SubType subType() const override
The type of the annotation.
void setSound(SoundObject *s)
Sets a new SoundObject for this annotation.
void setSoundIconName(const QString &icon)
Sets a new name for the icon of this annotation.
QString soundIconName() const
Returns the name of the icon of this annotation.
SoundObject * sound() const
Returns the SoundObject of this annotation.
Container class for a sound file in a PDF document.
Definition poppler-qt6.h:2163
Stamp annotation.
Definition poppler-annotation.h:725
SubType subType() const override
The type of the annotation.
void setStampCustomImage(const QImage &image)
Set a custom icon for this stamp annotation.
void setStampIconName(const QString &name)
Set the icon type for this stamp annotation.
QString stampIconName() const
The name of the icon for this stamp annotation.
Annotation containing text.
Definition poppler-annotation.h:466
QString textIcon() const
The name of the icon for this text annotation.
TextType textType() const
The type of text annotation represented by this object.
void setTextIcon(const QString &icon)
Set the name of the icon to use for this text annotation.
SubType subType() const override
The type of the annotation.
QColor textColor() const
Default text color is black.
The Poppler Qt6 binding.
Definition poppler-annotation.h:49
Structure corresponding to a QuadPoints array.
Definition poppler-annotation.h:684