PDFView.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2026 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFPDFView
#define PDFTRON_H_CPPPDFPDFView

#include <Common/BasicTypes.h>
#include <PDF/PDFDoc.h>
#include <PDF/ExternalAnnotManager.h>
#include <PDF/PDFRasterizer.h>
#include <PDF/Highlights.h>
#include <PDF/LinkInfo.h>
#include <PDF/OCG/Context.h>
#include <C/PDF/TRN_PDFView.h>
#include <PDF/Selection.h>
#include <PDF/DocumentConversion.h>
#include <SDF/ObjSet.h>
#include <PDF/ViewChangeCollection.h>
#include <PDF/ActionParameter.h>
#ifdef SWIG
#include <PDF/Callback.h>
#endif

namespace pdftron {
    namespace PDF {

class PDFView
{
public:

     PDFView();
     ~PDFView();

     void SetDoc(PDFDoc& doc);

     void OpenUniversalDoc(DocumentConversion& conversion);

     void CloseDoc();

     PDFDoc* GetDoc();

     void DocLock(bool cancel_threads);

     void DocUnlock();

     bool DocTryLock( int milliseconds = 0 );

     void DocLockRead();

     void DocUnlockRead();

     bool DocTryLockRead( int milliseconds = 0 );
      
    enum PagePresentationMode
    {
        e_single_page = 1,         //<<< Display one page at a time.
        e_single_continuous,       //<<< Display the pages in one column.
        e_facing,                  //<<< Display the pages two at a time, with odd-numbered pages on the left.
        e_facing_continuous,       //<<< Display the pages in two columns, with odd-numbered pages on the left.
        e_facing_cover,            //<<< Display the pages two at a time, with odd-numbered pages on the right.
        e_facing_continuous_cover  //<<< Display the pages in two columns, with odd-numbered pages on the right.
    };
    
     void SetPagePresentationMode(PagePresentationMode mode);

    PagePresentationMode GetPagePresentationMode() const;
    
    void SetColorPostProcessMode(PDFRasterizer::ColorPostProcessMode mode);
    
    
    void SetColorPostProcessMapFile(Filters::Filter image_file_contents);
    
    ColorPt GetPostProcessedColor(const ColorPt& color) const;

    void SetColorPostProcessColors(unsigned int white_color, unsigned int black_color);

     PDFRasterizer::ColorPostProcessMode GetColorPostProcessMode() const;

    int GetCurrentPage() const;

    int GetPageCount() const;

     bool GotoFirstPage();

     bool GotoLastPage();

     bool GotoNextPage();

     bool GotoPreviousPage();

     bool SetCurrentPage(int page_num);

    bool ShowRect( int page_num, const Rect& rect );
    
    std::vector<int> GetVisiblePages() const ;

    double GetZoom() const;

     bool SetZoom(double zoom);

     bool SetZoom(int x, int y, double zoom);

     bool SmartZoom(int x, int y);
     void RotateClockwise();

     void RotateCounterClockwise();

    Page::Rotate GetRotation() const;

    int GetPageNumberFromScreenPt(double x, double y) const;

    Point ConvScreenPtToCanvasPt(const Point& pt) const;

#ifndef SWIG
    void ConvScreenPtToCanvasPt(double& x, double& y) const;
#endif

    Point ConvCanvasPtToScreenPt(const Point& pt) const;

#ifndef SWIG
    void ConvCanvasPtToScreenPt(double& x, double& y) const;
#endif

    Point ConvCanvasPtToPagePt(const Point& pt, int page_num = -1) const;

#ifndef SWIG
    void ConvCanvasPtToPagePt(double& x, double& y, int page_num = -1) const;
#endif

    Point ConvPagePtToCanvasPt(const Point& pt, int page_num = -1) const;

#ifndef SWIG
    void ConvPagePtToCanvasPt(double& x, double& y, int page_num = -1) const;
#endif

    Point ConvScreenPtToPagePt(const Point& pt, int page_num = -1) const;

#ifndef SWIG
    void ConvScreenPtToPagePt(double& x, double& y, int page_num = -1) const;
#endif

    Point ConvPagePtToScreenPt(const Point& pt, int page_num = -1) const;

#ifndef SWIG
    void ConvPagePtToScreenPt(double& x, double& y, int page_num = -1) const;
#endif

    Point SnapToNearestInDoc(const Point& screen_pt);

    Point SnapToNearestInDocFromPageSpace(double page_x, double page_y, int page_num);

    void SetSnappingMode(UInt32 mode_flags);

    Common::Matrix2D GetDeviceTransform(int page_num = -1) const;

#ifdef SWIG
    void SetErrorReportProc(Callback* instance);
#else
    void SetErrorReportProc(PDFRasterizer::ErrorReportProc error_proc, void* data);
#endif

    typedef void (*CurrentPageProc) (int current_page, int num_pages, void* data);

#ifdef SWIG
     void SetCurrentPageProc(Callback* instance);
#else
     void SetCurrentPageProc(CurrentPageProc curr_pagenum_proc, void* data);
#endif

     typedef void(*JavaScriptEventProc) (const char* event_type, const char* json, void* data);

#ifdef SWIG
     void SetJavaScriptEventCallBack(Callback* instance);
#else
     void SetJavaScriptEventCallBack(JavaScriptEventProc js_proc, void* data);
#endif

     typedef void (*CurrentZoomProc) (double curr_zoom_proc, void* data);

#ifdef SWIG
     void SetCurrentZoomProc(Callback* instance);
#else
     void SetCurrentZoomProc(CurrentZoomProc curr_zoom_proc, void* data);
#endif

     void ExecuteAction(Action& action);

     void ExecuteAction(ActionParameter& action_param);

     double GetCanvasWidth() const;

     double GetCanvasHeight() const;

     double GetHScrollPos() const;

     double GetVScrollPos() const;

     void OnScroll(int pix_dx, int pix_dy);

     void SetHScrollPos(double pos);

     void SetVScrollPos(double pos);

     void OnSize(int width, int height);

     bool IsFinishedRendering(bool visible_region_only) const;

     void CancelRendering();
    
     void Update(bool all = false);

    void Update(const Rect& update);

    void Update(const Annot& annot, int page_num);

    void Update(const Field& field);

    void UpdatePageLayout();

#ifdef SWIG
    std::vector<unsigned char> GetBuffer() const;
#else
    const char* GetBuffer() const;
#endif

    void UpdateBuffer();

     int GetBufferWidth() const;

     int GetBufferHeight() const;

     int GetBufferStride() const;
    
    void HideAnnotation(Annot annot);
    
    void ShowAnnotation(Annot annot);

     void SetDrawAnnotations(bool render_annots);

    void SetUrlExtraction(bool enabled);

    LinkInfo GetLinkAt(int x, int y);

    void SetFieldHighlightColor(const ColorPt& new_field_highlight_color);

    void SetHighlightFields(bool highlight_fields);
    
    void SetRequiredFieldBorderColor(const ColorPt& new_border_color);

    void SetSignatureHighlightColor(const ColorPt& new_signature_highlight_color);
    
     void SetAntiAliasing(bool enable_aa);

     void SetPathHinting(bool enable_hinting);

    void SetThinLineAdjustment(bool pixel_grid_fit, bool stroke_adjust);

     void SetImageSmoothing(bool smoothing_enabled = true);

     void SetCaching(bool enabled);

     void SetRasterizerType (PDFRasterizer::Type type);

    void SetGamma(double exp);

    void SetOverprint(PDFRasterizer::OverprintPreviewMode op);

    void SetOCGContext(const OCG::Context& ctx);

    OCG::Context GetOCGContext();
    
    void UpdateOCGContext();

    
    typedef void (*RenderBeginEventProc) (void* data);

    typedef void (*RenderFinishEventProc) (void* data, bool canceled);

#ifdef SWIG
     void SetRenderBeginProc(class Callback* instance);
#else
     void SetRenderBeginProc(RenderBeginEventProc proc, void* data);
#endif

#ifdef SWIG
     void SetRenderFinishProc(class Callback* instance);
#else
     void SetRenderFinishProc(RenderFinishEventProc proc, void* data);
#endif
    

    enum TextSelectionMode {
        e_structural,
        e_rectangular,
        e_structural_algorithm_2
    };

     void SetTextSelectionMode(TextSelectionMode tm);

    TextSelectionMode GetTextSelectionMode() const;

    void SetRightToLeftLanguage(bool flag);

    bool GetRightToLeftLanguage() const;

    bool Select(double x1, double y1, double x2, double y2);

    bool SelectWithSnapping(double x1, double y1, double x2, double y2, bool snap_to_start, bool snap_to_end);

    bool SelectWithSmartSnapping(double x1, double y1, double x2, double y2);

    bool Select(double x1, double y1, int page1, double x2, double y2, int page2);

    bool SelectWithSnapping(double x1, double y1, int page1, double x2, double y2, int page2,
        bool snap_to_start, bool snap_to_end);

    bool SelectWithSmartSnapping(double x1, double y1, int page1, double x2, double y2, int page2);

    bool Select(const Highlights& highlights);

    bool Select(const Selection& select);
    
    void CancelFindText();
    
     void SelectAll();

     bool HasSelection() const;

     void ClearSelection();

    Selection GetSelection( int pagenum = -1 ) const;

    int GetSelectionBeginPage() const ;

    int GetSelectionEndPage() const;

    bool HasSelectionOnPage( int ipage ) const;

    void PrepareWords(int page_num);

    bool WereWordsPrepared(int page_num) const;

    bool IsThereTextInRect(double x1, double y1, double x2, double y2) const;

    void PrepareAnnotsForMouse(int page_num, double distance_threshold, double minimum_line_weight);

    bool WereAnnotsForMousePrepared(int page_num) const;

    Annot::Type GetAnnotTypeUnder(double x, double y);

    void SetPageBorderVisibility(bool border_visible);

    void SetPageTransparencyGrid(bool trans_grid_visible);

    void SetDefaultPageColor(UInt8 r, UInt8 g, UInt8 b);

    void SetBackgroundColor(UInt8 r, UInt8 g, UInt8 b, UInt8 a = 255);

    void SetHorizontalAlign(int align);

     void SetVerticalAlign(int align);

    void SetPageSpacing(int horiz_col_space, int vert_col_space, int horiz_pad, int vert_pad);

    static void SetViewerCache(SDF::SDFDoc& document, size_t max_cache_size, bool on_disk);

     void Destroy();

     void SetDevicePixelDensity(double dpi, double scale_factor);

     Rect GetScreenRectForAnnot(Annot annot, int page_num = -1);
    
     Annot GetAnnotationAt(int x, int y, double distanceThreshold, double minimumLineWeight);
    
    enum PageViewMode
    {
        e_fit_page = 0,
        e_fit_width,
        e_fit_height,
        e_zoom,
        PVM_SIZE    //must stay as the last element
    };
    
    void SetPageViewMode(PageViewMode mode);
    
    PageViewMode GetPageViewMode() const;
    
    void RefreshAndUpdate(const ViewChangeCollection& view_change);

     void SetPageRefViewMode(PageViewMode mode);
    
    PageViewMode GetPageRefViewMode() const;

    void SetupThumbnails(bool use_embedded, bool generate_at_runtime, bool use_disk_cache, int thumb_max_side_length, size_t max_abs_cache_size, double max_perc_cache_size);

    void ClearThumbCache();

     typedef void (*ThumbAsyncHandler) (int page_num, bool was_thumb_found, const char* thumb_buf, int thumb_width, int thumb_height, void* custom_data);

#ifdef SWIG
     void GetThumbAsync(int page_num, Callback* instance);
#else
     void GetThumbAsync(int page_num, ThumbAsyncHandler proc, void* custom_data);
#endif

    size_t GetThumbInCacheSize(int page_num);

     bool GetThumbInCache(int page_num, UChar* buf, UInt32& out_width, UInt32& out_height);

     /*
      * Cancel all pending GetThumbAsync requests. Your callback function will still be called
      * for each canceled request, but 'was_thumb_found' will be set to 'false'.
      */
     void CancelAllThumbRequests();

     typedef void (*RequestRenderInWorkerThreadProc) (void* custom_data);

#ifdef SWIG
     void SetRequestRenderInWorkerThreadProc(Callback* instance);
#else
     void SetRequestRenderInWorkerThreadProc(RequestRenderInWorkerThreadProc proc, void* custom_data);
#endif

    typedef void (*FindTextHandler)(bool success, PDF::Selection selection, void* custom_data);

    
#ifdef SWIG

    void SetFindTextHandler(Callback* instance);
#else // SWIG

    void SetFindTextHandler(PDFView::FindTextHandler proc, void* custom_data);
#endif // SWIG

     void FindTextAsync(const UString& search_str, bool match_case, bool match_whole_word, bool search_up, bool reg_exp);
    
    std::vector<Annot> GetAnnotationsOnPage(int page_num);

    std::vector<Annot> GetAnnotationListAt(int x1, int y1, int x2, int y2);
    
    void EnableUndoRedo();
    
    UString Undo();
    
    UString Redo();
    
    bool HasChangesSinceSnapshot();
    
    void TakeSnapshot(const UString& meta_info);
    
    UString GetNextUndoInfo();
    
    UString GetNextRedoInfo();
    
    bool CanUndo();
    
    bool CanRedo();
    
    void RevertChangesSinceSnapshot();
    
    void RevertAllChanges();
    
    ExternalAnnotManager GetExternalAnnotManager(const UString& author, ExternalAnnotManager::Mode mode = ExternalAnnotManager::e_admin_undo_own);
    
    
    // @cond PRIVATE_DOC
private:
    TRN_PDFView mp_view;
    TRN_PDFDoc temp_doc;

    // PDFView should not be copied
    PDFView(const PDFView&);
    PDFView& operator= (const PDFView&);

    FindTextHandler mp_findtexthandler;
    void* mp_findtextdata;

    static void StaticTRNPDFViewFindTextHandler(TRN_Bool success, TRN_PDFViewSelection selection, void* custom_data);

    //for internal use only
#if defined(__iOS__)
public:
    #include <Impl/PDFView.internal>
#endif // defined(__iOS__)
    // @endcond
};

#include <Impl/PDFView.inl>

    };  // namespace PDF
};  // namespace pdftron

#endif // PDFTRON_H_CPPPDFPDFView