51#ifndef __POPPLER_QT_H__
52#define __POPPLER_QT_H__
56#include "poppler-annotation.h"
57#include "poppler-link.h"
58#include "poppler-optcontent.h"
59#include "poppler-page-transition.h"
61#include <QtCore/QByteArray>
62#include <QtCore/QDateTime>
64#include <QtXml/QDomDocument>
65#include "poppler-export.h"
89struct OutlineItemData;
207 friend class Document;
238 explicit FontInfo(
const FontInfoData &fid);
308 FontInfoData *m_data;
311class FontIteratorData;
331class POPPLER_QT5_EXPORT FontIterator
333 friend class Document;
334 friend class DocumentData;
360 Q_DISABLE_COPY(FontIterator)
361 FontIterator(
int, DocumentData *dd);
366class EmbeddedFileData;
370class POPPLER_QT5_EXPORT EmbeddedFile
372 friend class DocumentData;
373 friend class AnnotationPrivate;
377 explicit EmbeddedFile(EmbFile *embfile);
446 Q_DISABLE_COPY(EmbeddedFile)
447 explicit EmbeddedFile(EmbeddedFileData &dd);
449 EmbeddedFileData *m_embeddedFile;
460class POPPLER_QT5_EXPORT Page
462 friend class Document;
516 Q_DECLARE_FLAGS(PainterFlags, PainterFlag)
629 const QVariant &payload) const;
769 QString
text(const QRectF &rect) const;
805 Q_DECLARE_FLAGS(SearchFlags, SearchFlag)
955 void defaultCTM(
double *CTM,
double dpiX,
double dpiY,
int rotate,
bool upsideDown);
984 QList<Annotation *>
annotations(
const QSet<Annotation::SubType> &subtypes)
const;
1035 Q_DISABLE_COPY(Page)
1037 Page(DocumentData *doc,
int index);
1050 friend class Document;
1117 OutlineItemData *m_data;
1170class POPPLER_QT5_EXPORT Document
1173 friend class DocumentData;
1232 Q_DECLARE_FLAGS(RenderHints, RenderHint)
1309 static Document *
load(
const QString &filePath,
const QByteArray &ownerPassword = QByteArray(),
const QByteArray &userPassword = QByteArray());
1335 static Document *
load(QIODevice *device,
const QByteArray &ownerPassword = QByteArray(),
const QByteArray &userPassword = QByteArray());
1358 static Document *
loadFromData(
const QByteArray &fileContents,
const QByteArray &ownerPassword = QByteArray(),
const QByteArray &userPassword = QByteArray());
1391 Page *
page(
const QString &label)
const;
1428 bool unlock(
const QByteArray &ownerPassword,
const QByteArray &userPassword);
1450 QDateTime
date(
const QString &type)
const;
1457 bool setDate(
const QString &key,
const QDateTime &val);
1499 QString
info(
const QString &type)
const;
1506 bool setInfo(
const QString &key,
const QString &val);
1775 Q_DECL_DEPRECATED QDomDocument *
toc()
const;
1952 bool getPdfId(QByteArray *permanentId, QByteArray *updateId)
const;
1999 Q_DISABLE_COPY(Document)
2001 DocumentData *m_doc;
2003 explicit Document(DocumentData *dataA);
2006class BaseConverterPrivate;
2007class PSConverterPrivate;
2008class PDFConverterPrivate;
2018 friend class Document;
2048 NotSupportedInputFileError
2061 BaseConverterPrivate *d_ptr;
2086 friend class Document;
2097 StrictMargins = 0x00000002,
2098 ForceRasterization = 0x00000004,
2103 Q_DECLARE_FLAGS(PSOptions, PSOption)
2213 Q_DECLARE_PRIVATE(PSConverter)
2214 Q_DISABLE_COPY(PSConverter)
2216 explicit PSConverter(DocumentData *document);
2226 friend class Document;
2236 Q_DECLARE_FLAGS(PDFOptions, PDFOption)
2264 class POPPLER_QT5_EXPORT NewSignatureData
2268 ~NewSignatureData();
2269 NewSignatureData(
const NewSignatureData &) =
delete;
2270 NewSignatureData &operator=(
const NewSignatureData &) =
delete;
2272 QString certNickname()
const;
2273 void setCertNickname(
const QString &certNickname);
2275 QString password()
const;
2276 void setPassword(
const QString &password);
2279 void setPage(
int page);
2281 QRectF boundingRectangle()
const;
2282 void setBoundingRectangle(
const QRectF &rect);
2284 QString signatureText()
const;
2285 void setSignatureText(
const QString &text);
2295 void setSignatureLeftText(
const QString &text);
2305 void setReason(
const QString &
reason);
2315 void setLocation(
const QString &
location);
2329 void setLeftFontSize(
double fontSize);
2335 void setFontColor(
const QColor &color);
2341 void setBorderColor(
const QColor &color);
2351 void setBorderWidth(
double width);
2357 void setBackgroundColor(
const QColor &color);
2363 void setFieldPartialName(
const QString &name);
2373 void setDocumentOwnerPassword(
const QByteArray &password);
2383 void setDocumentUserPassword(
const QByteArray &password);
2394 void setImagePath(
const QString &path);
2397 struct NewSignatureDataPrivate;
2398 NewSignatureDataPrivate *
const d;
2445 Q_DECLARE_PRIVATE(PDFConverter)
2446 Q_DISABLE_COPY(PDFConverter)
2448 explicit PDFConverter(DocumentData *document);
2454POPPLER_QT5_EXPORT Q_DECL_DEPRECATED QDateTime
convertDate(
char *dateString);
2554 SoundData *m_soundData;
2565 friend class AnnotationPrivate;
2627 MovieData *m_movieData;
2632Q_DECLARE_OPERATORS_FOR_FLAGS(Poppler::Page::PainterFlags)
2633Q_DECLARE_OPERATORS_FOR_FLAGS(Poppler::Page::SearchFlags)
2634Q_DECLARE_OPERATORS_FOR_FLAGS(Poppler::Document::RenderHints)
2635Q_DECLARE_OPERATORS_FOR_FLAGS(Poppler::PDFConverter::PDFOptions)
2636Q_DECLARE_OPERATORS_FOR_FLAGS(Poppler::PSConverter::PSOptions)
Annotation class holding properties shared by all annotations.
Definition poppler-annotation.h:203
Base converter.
Definition poppler-qt5.h:2017
virtual bool convert()=0
Does the conversion.
void setOutputDevice(QIODevice *device)
Sets the output device.
Error lastError() const
Returns the last error.
void setOutputFileName(const QString &outputFileName)
Sets the output file name.
virtual ~BaseConverter()
Destructor.
PDF document.
Definition poppler-qt5.h:1171
QString subject() const
The subject of the document.
RenderHints renderHints() const
The currently set render hints.
bool isLinearized() const
Test if the document is linearised.
bool setAuthor(const QString &val)
Set the author of the document to.
bool setTitle(const QString &val)
Set the title of the document to.
static Document * load(const QString &filePath, const QByteArray &ownerPassword=QByteArray(), const QByteArray &userPassword=QByteArray())
Load the document from a file on disk.
bool okToChange() const
Test if the permissions on the document allow it to be changed.
QString title() const
The title of the document.
bool okToCreateFormFields() const
Test if the permissions on the document allow interactive form fields (including signature fields) to...
PDFConverter * pdfConverter() const
Gets a new PDF converter for this document.
void getPdfVersion(int *major, int *minor) const
The version of the PDF specification that the document conforms to.
bool isLocked() const
Determine if the document is locked.
bool okToCopy() const
Test if the permissions on the document allow the contents to be copied / extracted.
QVector< OutlineItem > outline() const
Gets the outline of the document.
bool getPdfId(QByteArray *permanentId, QByteArray *updateId) const
The PDF identifiers.
int numPages() const
The number of pages in the document.
bool removeInfo()
Remove the document's Info dictionary.
PageLayout
The page layout.
Definition poppler-qt5.h:1193
@ TwoPageRight
Display the pages two at a time, with odd-numbered pages on the right.
Definition poppler-qt5.h:1200
@ TwoPageLeft
Display the pages two at a time, with odd-numbered pages on the left.
Definition poppler-qt5.h:1199
@ TwoColumnLeft
Display the pages in two columns, with odd-numbered pages on the left.
Definition poppler-qt5.h:1197
@ SinglePage
Display a single page.
Definition poppler-qt5.h:1195
@ NoLayout
Layout not specified.
Definition poppler-qt5.h:1194
@ TwoColumnRight
Display the pages in two columns, with odd-numbered pages on the right.
Definition poppler-qt5.h:1198
@ OneColumn
Display a single column of pages.
Definition poppler-qt5.h:1196
bool hasOptionalContent() const
Test whether this document has "optional content".
QDateTime date(const QString &type) const
The date associated with the document.
bool okToAddNotes() const
Test if the permissions on the document allow annotations to be added or modified,...
Page * page(const QString &label) const
This is an overloaded member function, provided for convenience. It differs from the above function o...
QDateTime creationDate() const
The date of the creation of the document.
bool setCreator(const QString &val)
Set the creator of the document to.
QDomDocument * toc() const
Gets the table of contents (TOC) of the Document.
void setRenderHint(RenderHint hint, bool on=true)
Sets the render hint .
bool setProducer(const QString &val)
Set the producer of the document to.
QStringList infoKeys() const
Obtain a list of the available string information keys.
void * colorDisplayProfile() const
Return the current display profile.
void setPaperColor(const QColor &color)
Sets the paper color.
RenderBackend
The render backends available.
Definition poppler-qt5.h:1209
@ ArthurBackend
Definition poppler-qt5.h:1211
@ SplashBackend
Splash backend.
Definition poppler-qt5.h:1210
@ QPainterBackend
Definition poppler-qt5.h:1212
static Document * loadFromData(const QByteArray &fileContents, const QByteArray &ownerPassword=QByteArray(), const QByteArray &userPassword=QByteArray())
Load the document from memory.
bool unlock(const QByteArray &ownerPassword, const QByteArray &userPassword)
Provide the passwords required to unlock the document.
QByteArray fontData(const FontInfo &fi) const
The font data if the font is an embedded one.
bool setDate(const QString &key, const QDateTime &val)
Set the Info dict date entry specified by.
PageMode
The page mode.
Definition poppler-qt5.h:1180
@ UseOutlines
Document outline visible.
Definition poppler-qt5.h:1182
@ UseAttach
Attachments panel visible.
Definition poppler-qt5.h:1186
@ UseNone
No mode - neither document outline nor thumbnail images are visible.
Definition poppler-qt5.h:1181
@ UseThumbs
Thumbnail images visible.
Definition poppler-qt5.h:1183
@ FullScreen
Fullscreen mode (no menubar, windows controls etc).
Definition poppler-qt5.h:1184
@ UseOC
Optional content group panel visible.
Definition poppler-qt5.h:1185
PdfVersion getPdfVersion() const
The version of the PDF specification that the document conforms to.
QDateTime modificationDate() const
The date of the last change in the document.
void setRenderBackend(RenderBackend backend)
Sets the backend used to render the pages.
RenderHint
The render hints available.
Definition poppler-qt5.h:1221
@ IgnorePaperColor
Do not compose with the paper color.
Definition poppler-qt5.h:1229
@ TextHinting
Hinting for text.
Definition poppler-qt5.h:1224
@ ThinLineShape
Enhance thin lines shape. Wins over ThinLineSolid.
Definition poppler-qt5.h:1228
@ HideAnnotations
Do not render annotations.
Definition poppler-qt5.h:1230
@ TextSlightHinting
Lighter hinting for text when combined with TextHinting.
Definition poppler-qt5.h:1225
@ OverprintPreview
Overprint preview.
Definition poppler-qt5.h:1226
@ TextAntialiasing
Antialiasing for text.
Definition poppler-qt5.h:1223
@ Antialiasing
Antialiasing for graphics.
Definition poppler-qt5.h:1222
@ ThinLineSolid
Enhance thin lines solid.
Definition poppler-qt5.h:1227
Qt::LayoutDirection textDirection() const
The predominant reading order for text as supplied by the document's viewer preferences.
QString metadata() const
Gets the metadata stream contents.
DocumentAdditionalActionsType
Describes the flags for additional document actions i.e.
Definition poppler-qt5.h:1924
@ CloseDocument
Performed before closing the document.
Definition poppler-qt5.h:1925
@ PrintDocumentStart
Performed before printing the document.
Definition poppler-qt5.h:1928
@ PrintDocumentFinish
Performed after printing the document.
Definition poppler-qt5.h:1929
@ SaveDocumentFinish
Performed after saving the document.
Definition poppler-qt5.h:1927
@ SaveDocumentStart
Performed before saving the document.
Definition poppler-qt5.h:1926
void setColorDisplayProfile(void *outputProfileA)
Set a color display profile for the current document.
bool okToPrintHighRes() const
Test if the permissions on the document allow it to be printed at high resolution.
QVector< FormFieldSignature * > signatures() const
Returns the signatures of this document.
Link * additionalAction(DocumentAdditionalActionsType type) const
Returns the additional action of the given type for the document or 0 if no action has been defined.
bool okToExtractForAccessibility() const
Test if the permissions on the document allow content extraction (text and perhaps other content) for...
bool setModificationDate(const QDateTime &val)
Set the modification date of the document to.
void * colorRgbProfile() const
Return the current RGB profile.
QString author() const
The author of the document.
bool isEncrypted() const
Test if the document is encrypted.
void setColorDisplayProfileName(const QString &name)
Set a color display profile for the current document.
static QSet< RenderBackend > availableRenderBackends()
The available rendering backends.
void applyResetFormsLink(const LinkResetForm &link)
Resets the form with the details contained in the link.
QList< EmbeddedFile * > embeddedFiles() const
The documents embedded within the PDF document.
bool okToAssemble() const
Test if the permissions on the document allow it to be "assembled" - insertion, rotation and deletion...
OptContentModel * optionalContentModel()
Itemviews model for optional content.
QString creator() const
The creator of the document.
bool hasEmbeddedFiles() const
Whether there are any documents embedded in this PDF document.
FontIterator * newFontIterator(int startPage=0) const
Creates a new FontIterator object for font scanning.
QString producer() const
The producer of the document.
PSConverter * psConverter() const
Gets a new PS converter for this document.
PageLayout pageLayout() const
The layout that pages should be shown in when the document is first opened.
void setXRefReconstructedCallback(const std::function< void()> &callback)
Sets the document's XRef reconstruction callback, so whenever a XRef table reconstruction happens the...
bool setSubject(const QString &val)
Set the subject of the document to.
PageMode pageMode() const
The type of mode that should be used by the application when the document is opened.
FormType
Form types.
Definition poppler-qt5.h:1240
@ AcroForm
AcroForm.
Definition poppler-qt5.h:1242
@ XfaForm
Adobe XML Forms Architecture (XFA), currently unsupported.
Definition poppler-qt5.h:1243
@ NoForm
Document doesn't contain forms.
Definition poppler-qt5.h:1241
bool setCreationDate(const QDateTime &val)
Set the creation date of the document to.
static Document * load(QIODevice *device, const QByteArray &ownerPassword=QByteArray(), const QByteArray &userPassword=QByteArray())
Load the document from a device.
FormType formType() const
Returns the type of forms contained in the document.
QList< FontInfo > fonts() const
The fonts within the PDF document.
bool xrefWasReconstructed() const
Returns whether the document's XRef table has been reconstructed or not.
QColor paperColor() const
The paper color.
QString keywords() const
The keywords of the document.
LinkDestination * linkDestination(const QString &name)
Tries to resolve the named destination name.
bool okToPrint() const
Test if the permissions on the document allow it to be printed.
Page * page(int index) const
Get a specified Page.
RenderBackend renderBackend() const
The currently set render backend.
QVector< int > formCalculateOrder() const
Returns the calculate order for forms (using their id).
bool setKeywords(const QString &val)
Set the keywords of the document to.
QStringList scripts() const
Document-level JavaScript scripts.
QString info(const QString &type) const
Get specified information associated with the document.
bool setInfo(const QString &key, const QString &val)
Set the value of the document's Info dictionary entry specified by.
bool okToFillForm() const
Test if the permissions on the document allow interactive form fields (including signature fields) to...
bool isValid() const
Is the embedded file valid?
QString description() const
The description associated with the file, if any.
~EmbeddedFile()
Destructor.
QByteArray checksum() const
The MD5 checksum of the file.
QString name() const
The name associated with the file.
QString mimeType() const
The MIME type of the file, if known.
QDateTime createDate() const
The creation date for the embedded file, if known.
QDateTime modDate() const
The modification date for the embedded file, if known.
int size() const
The size of the file.
QByteArray data()
The data as a byte array.
Container class for information about a font within a PDF document.
Definition poppler-qt5.h:206
Type type() const
The type of font encoding.
FontInfo & operator=(const FontInfo &fi)
Standard assignment operator.
QString name() const
The name of the font.
QString typeName() const
The name of the font encoding used.
QString file() const
The path of the font file used to represent this font on this system, or a null string is the font is...
FontInfo(const FontInfo &fi)
Copy constructor.
Type
The type of font.
Definition poppler-qt5.h:214
QString substituteName() const
The name of the substitute font.
bool isSubset() const
Whether the font provided is only a subset of the full font or not.
bool isEmbedded() const
Whether the font is embedded in the file, or not.
Iterator for reading the fonts in a document.
Definition poppler-qt5.h:332
int currentPage() const
Returns the current page where the iterator is.
~FontIterator()
Destructor.
bool hasNext() const
Checks whether there is at least one more page to iterate, ie returns false when the iterator is beyo...
QList< FontInfo > next()
Returns the fonts of the current page and then advances the iterator to the next page.
A destination.
Definition poppler-link.h:74
Encapsulates data that describes a link.
Definition poppler-link.h:185
Container class for a movie object in a PDF document.
Definition poppler-qt5.h:2564
QString url() const
The URL of the movie to be played.
bool showControls() const
Whether show a bar with movie controls.
int rotation() const
The rotation (either 0, 90, 180, or 270 degrees clockwise) for the movie,.
bool showPosterImage() const
Returns whether a poster image should be shown if the movie is not playing.
QSize size() const
The size of the movie.
QImage posterImage() const
Returns the poster image that should be shown if the movie is not playing.
PlayMode
The play mode for playing the movie.
Definition poppler-qt5.h:2572
@ PlayPalindrome
Play forward, then backward, then again foward and so on until stopped.
Definition poppler-qt5.h:2576
@ PlayRepeat
Play continuously until stopped.
Definition poppler-qt5.h:2575
@ PlayOnce
Play the movie once, closing the movie controls at the end.
Definition poppler-qt5.h:2573
@ PlayOpen
Like PlayOnce, but leaving the controls open.
Definition poppler-qt5.h:2574
PlayMode playMode() const
How to play the movie.
Model for optional content.
Definition poppler-optcontent.h:50
QString uri() const
The URI to which the item links.
QString name() const
The name of the item which should be displayed to the user.
QVector< OutlineItem > children() const
Gets the child items of this item.
QSharedPointer< const LinkDestination > destination() const
The destination referred to by this item.
bool isOpen() const
Indicates whether the item should initially be display in an expanded or collapsed state.
OutlineItem()
Constructs a null item, i.e.
bool isNull() const
Indicates whether an item is null, i.e.
QString externalFileName() const
The external file name of the document to which the.
bool hasChildren() const
Determines if this item has any child items.
Holds data for a new signature.
Definition poppler-qt5.h:2265
QColor backgroundColor() const
Default: QColor(240, 240, 240).
QColor fontColor() const
Default: red.
QColor borderColor() const
Default: red.
double fontSize() const
Default: 10.
double borderWidth() const
border width in points
QString location() const
Signature's property Location.
QString signatureLeftText() const
If this text is not empty, the signature representation will split in two, with this text on the left...
QString fieldPartialName() const
Default: QUuid::createUuid().toString().
double leftFontSize() const
Default: 20.
QByteArray documentOwnerPassword() const
Document owner password (needed if the document that is being signed is password protected).
QString reason() const
Signature's property Reason.
QByteArray documentUserPassword() const
Document user password (needed if the document that is being signed is password protected).
QString imagePath() const
Filesystem path to an image file to be used as background image for the signature annotation widget.
Converts a PDF to PDF (thus saves a copy of the document).
Definition poppler-qt5.h:2225
bool convert() override
Does the conversion.
ErrorString lastSigningErrorDetails() const
A string with a string that might offer more details of the signing result failure.
PDFOption
Options for the PDF export.
Definition poppler-qt5.h:2233
@ WithChanges
The changes done to the document are saved as well.
Definition poppler-qt5.h:2234
~PDFConverter() override
Destructor.
void setPDFOptions(PDFOptions options)
Sets the options for the PDF export.
PDFOptions pdfOptions() const
The currently set options for the PDF export.
bool sign(const NewSignatureData &data)
Sign PDF at given Annotation / signature form.
SigningResult
Definition poppler-qt5.h:2418
@ FieldAlreadySigned
Trying to sign a field that is already signed.
Definition poppler-qt5.h:2420
@ InternalError
Unexpected error, likely a bug in poppler.
Definition poppler-qt5.h:2422
@ KeyMissing
Key not found (Either the input key is not from the list or the available keys has changed underneath...
Definition poppler-qt5.h:2423
@ UserCancelled
User cancelled the process.
Definition poppler-qt5.h:2425
@ GenericSigningError
Unclassified error.
Definition poppler-qt5.h:2421
@ BadPassphrase
User entered bad passphrase.
Definition poppler-qt5.h:2426
@ WriteFailed
Write failed (permissions, faulty disk, ...).
Definition poppler-qt5.h:2424
@ SigningSuccess
No error.
Definition poppler-qt5.h:2419
SigningResult lastSigningResult() const
The last signing result, mostly relevant if sign returns false.
Converts a PDF to PS.
Definition poppler-qt5.h:2085
void setPSOptions(PSOptions options)
Sets the options for the PS export.
void setStrictMargins(bool strictMargins)
Defines if margins have to be strictly followed (even if that means changing aspect ratio),...
PSOption
Options for the PS export.
Definition poppler-qt5.h:2095
@ ForceOverprintPreview
Force rasterized overprint preview during conversion.
Definition poppler-qt5.h:2101
@ Printing
The PS is generated for printing purposes.
Definition poppler-qt5.h:2096
@ HideAnnotations
Don't print annotations.
Definition poppler-qt5.h:2100
@ PrintToEPS
Output EPS instead of PS.
Definition poppler-qt5.h:2099
void setPageConvertedCallback(void(*callback)(int page, void *payload), void *payload)
Sets a function that will be called each time a page is converted.
void setRightMargin(int marginRight)
Sets the output right margin.
void setBottomMargin(int marginBottom)
Sets the output bottom margin.
bool convert() override
Does the conversion.
void setTopMargin(int marginTop)
Sets the output top margin.
void setForceOverprintPreview(bool forceOverprintPreview)
Defines if the page will be rasterized to an image with overprint preview enabled before printing.
~PSConverter() override
Destructor.
void setVDPI(double vDPI)
Sets the vertical DPI.
void setLeftMargin(int marginLeft)
Sets the output left margin.
void setPaperHeight(int paperHeight)
Sets the output paper height.
void setTitle(const QString &title)
Sets the title of the PS Document.
void setPageList(const QList< int > &pageList)
Sets the list of pages to print.
void setForceRasterize(bool forceRasterize)
Defines if the page will be rasterized to an image before printing.
void setHDPI(double hDPI)
Sets the horizontal DPI.
void setPaperWidth(int paperWidth)
Sets the output paper width.
void setRotate(int rotate)
Sets the rotate.
PSOptions psOptions() const
The currently set options for the PS export.
Describes how a PDF file viewer shall perform the transition from one page to another.
Definition poppler-page-transition.h:48
void defaultCTM(double *CTM, double dpiX, double dpiY, int rotate, bool upsideDown)
The default CTM.
bool(*)(const QVariant &) ShouldRenderToImagePartialQueryFunc
Partial Update query renderToImage callback.
Definition poppler-qt5.h:577
QList< Link * > links() const
Gets the links of the page.
Orientation
Types of orientations that are possible.
Definition poppler-qt5.h:940
@ UpsideDown
Upside down orientation (portrait, with 180 degrees rotation).
Definition poppler-qt5.h:944
@ Seascape
Seascape orientation (portrait, with 270 degrees clockwise rotation).
Definition poppler-qt5.h:943
@ Landscape
Landscape orientation (portrait, with 90 degrees clockwise rotation ).
Definition poppler-qt5.h:941
@ Portrait
Normal portrait orientation.
Definition poppler-qt5.h:942
QList< TextBox * > textList(Rotation rotate=Rotate0) const
Returns a list of text of the page.
SearchFlag
Flags to modify the search behaviour.
Definition poppler-qt5.h:794
@ NoSearchFlags
since 0.63
Definition poppler-qt5.h:795
@ IgnoreCase
Case differences are ignored.
Definition poppler-qt5.h:796
@ WholeWords
Only whole words are matched.
Definition poppler-qt5.h:797
@ AcrossLines
Allows to match on text spanning from end of a line to the next line.
Definition poppler-qt5.h:801
@ IgnoreDiacritics
Diacritic differences (eg.
Definition poppler-qt5.h:798
bool search(const QString &text, double &rectLeft, double &rectTop, double &rectRight, double &rectBottom, SearchDirection direction, SearchMode caseSensitive, Rotation rotate=Rotate0) const
Returns true if the specified text was found.
void addAnnotation(const Annotation *ann)
Adds an annotation to the page.
QString text(const QRectF &rect, TextLayout textLayout) const
Returns the text that is inside a specified rectangle.
PageTransition * transition() const
Returns the transition of this page.
QList< Annotation * > annotations(const QSet< Annotation::SubType > &subtypes) const
Returns the annotations of the page.
int index() const
Returns the index of the page.
SearchDirection
The starting point for a search.
Definition poppler-qt5.h:775
@ PreviousResult
Find the previous result, moving "up the page".
Definition poppler-qt5.h:778
@ FromTop
Start sorting at the top of the document.
Definition poppler-qt5.h:776
@ NextResult
Find the next result, moving "down the page".
Definition poppler-qt5.h:777
PainterFlag
Additional flags for the renderToPainter method.
Definition poppler-qt5.h:505
@ NoPainterFlags
Definition poppler-qt5.h:506
@ DontSaveAndRestore
Do not save/restore the caller-owned painter.
Definition poppler-qt5.h:514
Link * action(PageAction act) const
Gets the page action specified, or NULL if there is no action.
QList< FormField * > formFields() const
Returns the form fields on the page The caller gets the ownership of the returned objects.
QImage thumbnail() const
Get the page thumbnail if it exists.
Rotation
The type of rotation to apply for an operation.
Definition poppler-qt5.h:474
@ Rotate270
Rotate 270 degrees clockwise (90 degrees counterclockwise).
Definition poppler-qt5.h:478
@ Rotate90
Rotate 90 degrees clockwise.
Definition poppler-qt5.h:476
@ Rotate0
Do not rotate.
Definition poppler-qt5.h:475
@ Rotate180
Rotate 180 degrees.
Definition poppler-qt5.h:477
Orientation orientation() const
The orientation of the page.
SearchMode
The type of search to perform.
Definition poppler-qt5.h:785
@ CaseSensitive
Case differences cause no match in searching.
Definition poppler-qt5.h:786
@ CaseInsensitive
Case differences are ignored in matching.
Definition poppler-qt5.h:787
TextLayout
How the text is going to be returned.
Definition poppler-qt5.h:495
@ RawOrderLayout
The text is returned without any type of processing.
Definition poppler-qt5.h:497
@ PhysicalLayout
The text is layouted to resemble the real page layout.
Definition poppler-qt5.h:496
PageAction
The kinds of page actions.
Definition poppler-qt5.h:485
@ Closing
The action when a page is "closed".
Definition poppler-qt5.h:487
@ Opening
The action when a page is "opened".
Definition poppler-qt5.h:486
double duration() const
Returns the page duration.
void(*)(const QImage &, const QVariant &) RenderToImagePartialUpdateFunc
Partial Update renderToImage callback.
Definition poppler-qt5.h:567
QString label() const
Returns the label of the page, or a null string is the page has no label.
QImage renderToImage(double xres=72.0, double yres=72.0, int x=-1, int y=-1, int w=-1, int h=-1, Rotation rotate=Rotate0) const
Render the page to a QImage using the current Document renderer.
QList< Annotation * > annotations() const
Returns the annotations of the page.
bool renderToPainter(QPainter *painter, double xres=72.0, double yres=72.0, int x=-1, int y=-1, int w=-1, int h=-1, Rotation rotate=Rotate0, PainterFlags flags=NoPainterFlags) const
Render the page to the specified QPainter using the current Document renderer.
void removeAnnotation(const Annotation *ann)
Removes an annotation from the page and destroys the annotation object.
bool(*)(const QVariant &) ShouldAbortQueryFunc
Abort query function callback.
Definition poppler-qt5.h:638
Container class for a sound file in a PDF document.
Definition poppler-qt5.h:2488
double samplingRate() const
The sampling rate of the sound.
SoundEncoding soundEncoding() const
The encoding used for the sound.
int channels() const
The number of sound channels to use to play the sound.
SoundType soundType() const
Is the sound embedded (SoundObject::Embedded) or external (SoundObject::External)?
QString url() const
The URL of the sound file to be played, in case of SoundObject::External.
SoundEncoding
The encoding format used for the sound.
Definition poppler-qt5.h:2503
@ ALaw
A-law-encoded samples.
Definition poppler-qt5.h:2507
@ muLaw
mu-law-encoded samples
Definition poppler-qt5.h:2506
@ Signed
Twos-complement values.
Definition poppler-qt5.h:2505
@ Raw
Raw encoding, with unspecified or unsigned values in the range [ 0, 2^B - 1 ].
Definition poppler-qt5.h:2504
SoundType
The type of sound.
Definition poppler-qt5.h:2494
@ External
The real sound file is external.
Definition poppler-qt5.h:2495
@ Embedded
The sound is contained in the data.
Definition poppler-qt5.h:2496
int bitsPerSample() const
The number of bits per sample value per channel.
QByteArray data() const
The data of the sound, in case of SoundObject::Embedded.
Describes the physical location of text on a document page.
Definition poppler-qt5.h:149
bool hasSpaceAfter() const
Returns whether there is a space character after this text box.
TextBox(const QString &text, const QRectF &bBox)
The default constructor sets the text and the rectangle that contains the text.
QString text() const
Returns the text of this text box.
QRectF charBoundingBox(int i) const
Returns the bounding box of the i -th characted of the word.
TextBox * nextWord() const
Returns the pointer to the next text box, if there is one.
QRectF boundingBox() const
Returns the position of the text, in point, i.e., 1/72 of an inch.
The Poppler Qt5 binding.
Definition poppler-annotation.h:50
QDateTime convertDate(char *dateString)
Conversion from PDF date string format to QDateTime.
void(*)(const QString &, const QVariant &) PopplerDebugFunc
Debug/error function.
Definition poppler-qt5.h:100
bool isOverprintPreviewAvailable()
Whether the overprint preview functionality is available.
ErrorStringType
The various types of error strings.
Definition poppler-qt5.h:121
@ ErrorCodeString
The string should be treated like a error code.
Definition poppler-qt5.h:123
@ UserString
The string should be treated as an advanced error message that can be shown to user.
Definition poppler-qt5.h:125
bool isCmsAvailable()
Whether the color management functions are available.
void setDebugErrorFunction(PopplerDebugFunc debugFunction, const QVariant &closure)
Set a new debug/error output function.
The version specification of a pdf file.
Definition poppler-qt5.h:1689
Combination of an error data and type of error string.
Definition poppler-qt5.h:134