blob: 35e26769c6aab6c7ffb9ebceaf63f6e0bf14e96c [file] [log] [blame]
/* poppler-annotation-private.h: qt interface to poppler
* Copyright (C) 2007, Pino Toscano <>
* Copyright (C) 2012, Tobias Koenig <>
* Copyright (C) 2012, 2013 Fabio D'Urso <>
* Copyright (C) 2012, 2014, 2018-2020, Albert Astals Cid <>
* Copyright (C) 2020, Klarälvdalens Datakonsult AB, a KDAB Group company, <>. Work sponsored by Technische Universität Dresden
* Copyright (C) 2021, Oliver Sander <>
* Copyright (C) 2021, Mahmoud Ahmed Khalil <>
* This program is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2, or (at your option)
* any later version.
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* GNU General Public License for more details.
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street - Fifth Floor, Boston, MA 02110-1301, USA.
#include <memory>
#include <QtCore/QPointF>
#include <QtCore/QSharedDataPointer>
#include "poppler-annotation.h"
#include <Object.h>
#include <AnnotStampImageHelper.h>
class Annot;
class AnnotPath;
class Page;
class PDFRectangle;
namespace Poppler {
class DocumentData;
PDFRectangle boundaryToPdfRectangle(::Page *pdfPage, const QRectF &r, int flags);
void getRawDataFromQImage(const QImage &qimg, int bitsPerPixel, QByteArray *data, QByteArray *sMaskData);
class AnnotationPrivate : public QSharedData
virtual ~AnnotationPrivate();
AnnotationPrivate(const AnnotationPrivate &) = delete;
AnnotationPrivate &operator=(const AnnotationPrivate &) = delete;
void addRevision(Annotation *ann, Annotation::RevScope scope, Annotation::RevType type);
/* Returns an Annotation of the right subclass whose d_ptr points to
* this AnnotationPrivate */
virtual Annotation *makeAlias() = 0;
/* properties: contents related */
QString author;
QString contents;
QString uniqueName;
QDateTime modDate; // before or equal to currentDateTime()
QDateTime creationDate; // before or equal to modifyDate
/* properties: look/interaction related */
Annotation::Flags flags;
QRectF boundary;
/* style and popup */
Annotation::Style style;
Annotation::Popup popup;
/* revisions */
Annotation::RevScope revisionScope;
Annotation::RevType revisionType;
QList<Annotation *> revisions;
/* After this call, the Annotation object will behave like a wrapper for
* the specified Annot object. All cached values are discarded */
void tieToNativeAnnot(Annot *ann, ::Page *page, DocumentData *doc);
/* Creates a new Annot object on the specified page, flushes current
* values to that object and ties this Annotation to that object */
virtual Annot *createNativeAnnot(::Page *destPage, DocumentData *doc) = 0;
/* Inited to 0 (i.e. untied annotation) */
Annot *pdfAnnot;
::Page *pdfPage;
DocumentData *parentDoc;
/* The following helpers only work if pdfPage is set */
void flushBaseAnnotationProperties();
void fillTransformationMTX(double MTX[6]) const;
QRectF fromPdfRectangle(const PDFRectangle &r) const;
PDFRectangle boundaryToPdfRectangle(const QRectF &r, int flags) const;
AnnotPath *toAnnotPath(const QVector<QPointF> &l) const;
/* Scan page for annotations, parentId=0 searches for root annotations, subtypes empty means all subtypes */
static std::vector<std::unique_ptr<Annotation>> findAnnotations(::Page *pdfPage, DocumentData *doc, const QSet<Annotation::SubType> &subtypes, int parentId = -1);
/* Add given annotation to given page */
static void addAnnotationToPage(::Page *pdfPage, DocumentData *doc, const Annotation *ann);
/* Remove annotation from page and destroy ann */
static void removeAnnotationFromPage(::Page *pdfPage, const Annotation *ann);
Ref pdfObjectReference() const;
std::unique_ptr<Link> additionalAction(Annotation::AdditionalActionType type) const;
Object annotationAppearance;
class AnnotationAppearancePrivate
explicit AnnotationAppearancePrivate(Annot *annot);
Object appearance;