XpdfWidget.h

Go to the documentation of this file.

//========================================================================
//
// XpdfWidget.h
//
// Copyright 2009-2021 Glyph & Cog, LLC
//
//========================================================================
 
 
 
#ifndef XPDFWIDGET_H
#define XPDFWIDGET_H
 
#include <aconf.h>
 
#ifdef USE_GCC_PRAGMAS
#pragma interface
#endif
 
#include <QAbstractScrollArea>
 
class QMutex;
class QTimer;
#if XPDFWIDGET_PRINTING
class QPrinter;
class QPrintDialog;
#endif
 
class GString;
class PDFDoc;
class QtPDFCore;
 
//------------------------------------------------------------------------
 
#ifdef HIGHLIGHTED_REGIONS
typedef void *XpdfRegionHandle;
#endif
 
typedef void *XpdfOutlineHandle;
 
typedef void *XpdfLayerHandle;
 
typedef void *XpdfLayerOrderHandle;
 
typedef void *XpdfAnnotHandle;
 
typedef void *XpdfFormFieldHandle;
 
typedef void *XpdfDocHandle;
 
//------------------------------------------------------------------------
 
struct XpdfFindResult {
 
  XpdfFindResult(int pageA, double xMinA, double yMinA,
                 double xMaxA, double yMaxA)
    : page(pageA), xMin(xMinA), yMin(yMinA), xMax(xMaxA), yMax(yMaxA) {}
  XpdfFindResult(): page(0), xMin(0), yMin(0), xMax(0), yMax(0) {}
 
  int page;
 
  double xMin,  
         yMin,  
         xMax,  
         yMax;  
};
 
//------------------------------------------------------------------------
 
class XpdfWidget: public QAbstractScrollArea {
  Q_OBJECT
 
public:
 
  enum ErrorCode {
    pdfOk               =    0, 
    pdfErrOpenFile      =    1, 
    pdfErrBadCatalog    =    2, 
    pdfErrDamaged       =    3, 
    pdfErrEncrypted     =    4, 
    pdfErrHighlightFile =    5, 
    pdfErrBadPrinter    =    6, 
    pdfErrPrinting      =    7, 
    pdfErrPermission    =    8, 
    pdfErrBadPageNum    =    9, 
    pdfErrFileIO        =   10, 
    pdfErrNoHandle      = 1001, 
    pdfErrOutOfMemory   = 1002, 
    pdfErrBusy          = 1003, 
    pdfErrBadArg        = 1004  
  };
 
  enum DisplayMode {
    pdfDisplaySingle,                   
    pdfDisplayContinuous,               
    pdfDisplaySideBySideSingle,         
    pdfDisplaySideBySideContinuous,     
    pdfDisplayHorizontalContinuous      
  };
 
 
  static const int zoomToPage  = -1;    
  static const int zoomToWidth = -2;    
  static const int zoomToHeight = -3;   
 
 
 
  static const int findBackward      = 0x00000001;
  static const int findCaseSensitive = 0x00000002;
  static const int findNext          = 0x00000004;
  static const int findOnePageOnly   = 0x00000008;
  static const int findWholeWord     = 0x00000010;
 
  static void init(const QString &configFileName = QString());
 
  static void setConfig(const QString &command);
 
  XpdfWidget(const QColor &paperColor = QColor(0xff, 0xff, 0xff),
             const QColor &matteColor = QColor(0x80, 0x80, 0x80),
             bool reverseVideo = false, QWidget *parentA = 0);
 
  XpdfWidget(QWidget *parentA,
             const QColor &paperColor = QColor(0xff, 0xff, 0xff),
             const QColor &matteColor = QColor(0x80, 0x80, 0x80),
             bool reverseVideo = false);
 
  virtual ~XpdfWidget();
 
  void enableHyperlinks(bool on);
 
  void enableExternalHyperlinks(bool on);
 
  void enableSelect(bool on);
 
  void enablePan(bool on);
 
  void enableTouchPan(bool on);
 
  void enableTouchZoom(bool on);
 
  void setKeyPassthrough(bool on) { keyPassthrough = on; }
 
  void setMousePassthrough(bool on) { mousePassthrough = on; }
 
  void showPasswordDialog(bool showDlg);
 
  void setMatteColor(const QColor &matteColor);
 
  void setReverseVideo(bool reverse);
 
  void setCursor(const QCursor &cursor);
 
  void unsetCursor();
 
  ErrorCode loadFile(const QString &fileName,
                     const QString &password = "");
 
  ErrorCode loadMem(const char *buffer, unsigned int bufferLength,
                    const QString &password = "");
 
 
  ErrorCode readDoc(XpdfDocHandle *docPtr,
                    const QString &fileName,
                    const QString &password = "");
 
  ErrorCode loadDoc(XpdfDocHandle doc);
 
  void freeDoc(XpdfDocHandle doc);
 
  ErrorCode reload();
 
  void closeFile();
 
  ErrorCode saveAs(const QString &fileName);
 
  QString getFileName() const;
 
  bool hasOpenDocument() const;
 
  int getNumPages() const;
 
  int getCurrentPage() const;
 
  int getMidPage() const;
 
  void gotoPage(int pageNum);
 
  void gotoFirstPage();
 
  void gotoLastPage();
 
  void gotoNextPage(bool scrollToTop = true);
 
  void gotoPreviousPage(bool scrollToTop = true);
 
  bool gotoNamedDestination(const QString &dest);
 
  void goForward();
 
  void goBackward();
 
  void scrollPageUp();
 
  void scrollPageDown();
 
  void scrollTo(int xx, int yy);
 
  void scrollBy(int dx, int dy);
 
  int getScrollX() const;
 
  int getScrollY() const;
 
  void setZoom(double zoom);
 
  double getZoom() const;
 
  double getZoomPercent(int page = 1) const;
 
  void zoomToRect(int page, double xMin, double yMin,
                  double xMax, double yMax);
 
  void zoomCentered(double zoom);
 
  void zoomToCurrentWidth();
 
  void setRotate(int rotate);
 
  int getRotate() const;
 
  void setContinuousMode(bool continuous);
 
  bool getContinuousMode() const;
 
  void setDisplayMode(DisplayMode mode);
 
  DisplayMode getDisplayMode();
 
  bool mouseOverLink();
 
  bool onLink(int page, double xx, double yy);
 
  QString getLinkInfo(int page, double xx, double yy);
 
  QString getMouseLinkInfo();
 
  bool gotoLinkAt(int page, double xx, double yy);
 
  XpdfAnnotHandle onAnnot(int page, double xx, double yy);
 
  QString getAnnotType(XpdfAnnotHandle annot);
 
  QString getAnnotContent(XpdfAnnotHandle annot);
 
  XpdfFormFieldHandle onFormField(int page, double xx, double yy);
 
  QString getFormFieldType(XpdfFormFieldHandle field);
 
  QString getFormFieldName(XpdfFormFieldHandle field);
 
  QString getFormFieldValue(XpdfFormFieldHandle field);
 
  void getFormFieldBBox(XpdfFormFieldHandle field, int *pageNum,
                        double *xMin, double *yMin,
                        double *xMax, double *yMax);
 
  bool convertWindowToPDFCoords(int winX, int winY,
                                int *page, double *pdfX, double *pdfY);
 
  void convertPDFToWindowCoords(int page, double pdfX, double pdfY,
                                int *winX, int *winY);
 
  void enableRedraw(bool enable);
 
  void getPageBox(int page, const QString &box,
                  double *xMin, double *yMin, double *xMax, double *yMax) const;
 
  double getPageWidth(int page) const;
 
  double getPageHeight(int page) const;
 
  int getPageRotation(int page) const;
 
  bool hasSelection();
 
  bool getCurrentSelection(int *page, double *x0, double *y0,
                           double *x1, double *y1) const;
 
  void setCurrentSelection(int page, double x0, double y0,
                           double x1, double y1);
 
  void clearSelection();
 
  bool isBlockSelectMode();
 
  bool isLinearSelectMode();
 
  void setBlockSelectMode();
 
  void setLinearSelectMode();
 
  void setSelectionColor(const QColor &selectionColor);
 
#ifdef HIGHLIGHTED_REGIONS
  XpdfRegionHandle addRegion(int page,
                             double x0, double y0,
                             double x1, double y1,
                             const QColor &color, const QColor &selectColor,
                             bool selectable, const QString &label);
 
  void setRegionLabel(XpdfRegionHandle region, const QString &label);
 
  void setRegionResizable(XpdfRegionHandle region, bool resizable);
 
  void deleteRegion(XpdfRegionHandle region);
 
  void deleteAllRegions();
 
  int getNumRegions() const;
 
  XpdfRegionHandle getRegion(int idx) const;
 
  XpdfRegionHandle getSelectedRegion() const;
 
  void setSelectedRegion(XpdfRegionHandle region);
 
  void makeRegionVisible(XpdfRegionHandle region);
 
  void getRegionInfo(XpdfRegionHandle region,
                     int *page, double *x0, double *y0,
                     double *x1, double *y1,
                     QColor *color, QColor *selectColor,
                     QString *label) const;
#endif
 
  void forceRedraw();
 
#if XPDFWIDGET_PRINTING
  bool okToPrint() const;
 
  ErrorCode print(bool showDialog);
 
  ErrorCode print(QPrinter *prt);
 
  void cancelPrint() { printCanceled = true; }
 
  void updatePrintStatus(int nextPage, int firstPage, int lastPage);
  bool isPrintCanceled() { return printCanceled; }
 
  void setPrintDPI(int hDPI, int vDPI);
#endif // XPDFWIDGET_PRINTING
 
  QImage convertPageToImage(int page, double dpi, bool transparent = false);
 
  QImage convertRegionToImage(int page, double x0, double y0,
                              double x1, double y1, double dpi,
                              bool transparent = false);
 
  QImage getThumbnail(int page);
 
  bool okToExtractText() const;
 
  void setTextEncoding(const QString &encodingName);
 
  QString extractText(int page, double x0, double y0,
                      double x1, double y1);
 
  QString getSelectedText();
 
  void copySelection();
 
  bool find(const QString &text, int flags = 0);
 
  QVector<XpdfFindResult> findAll(const QString &text, int firstPage,
                                  int lastPage, int flags = 0);
 
  bool hasPageLabels();
 
  QString getPageLabelFromPageNum(int pageNum);
 
  int getPageNumFromPageLabel(QString pageLabel);
 
  int getOutlineNumChildren(XpdfOutlineHandle outline);
 
  XpdfOutlineHandle getOutlineChild(XpdfOutlineHandle outline, int idx);
 
  XpdfOutlineHandle getOutlineParent(XpdfOutlineHandle outline);
 
  QString getOutlineTitle(XpdfOutlineHandle outline);
 
  bool getOutlineStartsOpen(XpdfOutlineHandle outline);
 
  int getOutlineTargetPage(XpdfOutlineHandle outline);
 
  void gotoOutlineTarget(XpdfOutlineHandle outline);
 
  int getNumLayers() const;
 
  XpdfLayerHandle getLayer(int idx) const;
 
  QString getLayerName(XpdfLayerHandle layer) const;
 
  bool getLayerVisibility(XpdfLayerHandle layer) const;
 
  void setLayerVisibility(XpdfLayerHandle layer, bool visibility);
 
  int getLayerViewState(XpdfLayerHandle layer) const;
 
  int getLayerPrintState(XpdfLayerHandle layer) const;
 
  XpdfLayerOrderHandle getLayerOrderRoot() const;
 
  bool getLayerOrderIsName(XpdfLayerOrderHandle order) const;
 
  QString getLayerOrderName(XpdfLayerOrderHandle order) const;
 
  XpdfLayerHandle getLayerOrderLayer(XpdfLayerOrderHandle order);
 
  int getLayerOrderNumChildren(XpdfLayerOrderHandle order);
 
  XpdfLayerOrderHandle getLayerOrderChild(XpdfLayerOrderHandle order, int idx);
 
  XpdfLayerOrderHandle getLayerOrderParent(XpdfLayerOrderHandle order);
 
  int getNumEmbeddedFiles();
 
  QString getEmbeddedFileName(int idx);
 
  bool saveEmbeddedFile(int idx, QString fileName);
 
  //--- for internal use
 
 
  virtual QSize sizeHint() const;
  QtPDFCore *getCore() { return core; }
 
 
signals:
 
  void pageChange(int pageNum);
 
  void midPageChange(int pageNum);
 
  void preLoad();
 
  void postLoad();
 
  void keyPress(QKeyEvent *e);
 
  void mousePress(QMouseEvent *e);
 
  void mouseRelease(QMouseEvent *e);
 
  void mouseClick(QMouseEvent *e);
 
  void mouseDoubleClick(QMouseEvent *e);
 
  void mouseTripleClick(QMouseEvent *e);
 
  void mouseMove(QMouseEvent *e);
 
  void mouseWheel(QWheelEvent *e);
 
  void linkClick(const QString &linkType, const QString &dest, int page);
 
  void selectDone();
 
  void paintDone(bool finished);
 
  void resized();
 
#ifdef HIGHLIGHTED_REGIONS
  void regionSelected(XpdfRegionHandle region);
 
  void regionChanged(XpdfRegionHandle region);
#endif
 
#if XPDFWIDGET_PRINTING
  void printStatus(int nextPage, int firstPage, int lastPage);
#endif
 
 
  void tileDone();
 
 
protected:
 
 
  virtual void paintEvent(QPaintEvent *eventA);
  virtual void resizeEvent(QResizeEvent *eventA);
  virtual void scrollContentsBy(int dx, int dy);
  virtual void keyPressEvent(QKeyEvent *e);
  virtual void mousePressEvent(QMouseEvent *e);
  virtual void mouseReleaseEvent(QMouseEvent *e);
  virtual void mouseMoveEvent(QMouseEvent *e);
  virtual void wheelEvent(QWheelEvent *e);
  virtual bool eventFilter(QObject *obj, QEvent *event);
 
 
private slots:
 
  void tick();
 
private:
 
  void setup(const QColor &paperColor, const QColor &matteColor,
             bool reverseVideo);
  static void updateCbk(void *data, GString *fileName,
                        int pageNum, int numPages,
                        const char *linkLabel);
  static void midPageChangedCbk(void *data, int pageNum);
  static void preLoadCbk(void *data);
  static void postLoadCbk(void *data);
  static void linkCbk(void *data, const char *type,
                      const char *dest, int page);
  static void selectDoneCbk(void *data);
  static void paintDoneCbk(void *data, bool finished);
  static void tileDoneCbk(void *data);
#ifdef HIGHLIGHTED_REGIONS
  static void regionSelectedCbk(void *data);
  static void regionChangedCbk(void *data);
#endif
 
  friend class XpdfViewer;
  bool getLinkTarget(int page, double xx, double yy,
                     QString &targetFileName, int &targetPage,
                     QString &targetDest);
 
#if XPDFWIDGET_PRINTING
  QPrinter *printerForDialog;
  QPrintDialog *printDialog;
  int printHDPI, printVDPI;
  bool printCanceled;
#endif
 
  static QMutex initMutex;
 
  QtPDFCore *core;
  double scaleFactor;
 
  bool keyPassthrough;
  bool mousePassthrough;
  int lastMousePressX[3], lastMousePressY[3];
  ulong lastMousePressTime[3];
  bool lastMouseEventWasPress;
 
  bool touchPanEnabled;
  bool touchZoomEnabled;
  double pinchZoomStart;
 
  QTimer *tickTimer;
};
 
#endif