PDFView.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2012 by PDFTron Systems Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------

#ifndef   H_CPPPDFView
#define   H_CPPPDFView

#include <PDF/PDFDoc.h>
#include <PDF/PDFRasterizer.h>
#include <PDF/Highlights.h>
#include <PDF/OCG/Context.h>
#include <C/PDF/TRN_PDFView.h>
#ifdef SWIG
#include <PDF/Callback.h>
#endif

namespace pdftron {
        namespace PDF {

class PDFView
{
public:

         PDFView();
         ~PDFView();

         void SetDoc(PDFDoc& doc);

         void CloseDoc();

         PDFDoc* GetDoc();

        enum PageViewMode
        {
                e_fit_page = 0,
                e_fit_width,
                e_fit_height,
                e_zoom
        };

         void SetPageViewMode(PageViewMode mode);

         PageViewMode GetPageViewMode() const;

        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;

        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 );

        double GetZoom() const;

         bool SetZoom(double zoom);

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

         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

        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 (*CurrentZoomProc) (double curr_zoom_proc, void* data);

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

         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() const;

         void CancelRendering();

         void Update();

        void Update(const Rect& update);

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

        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 SetDrawAnnotations(bool render_annots);

        void SetHighlightFields(bool highlight_fields);

         void SetAntiAliasing(bool enable_aa);

        void SetPathHinting(bool path_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();

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

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

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

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


        class Selection {
        public:
                 int GetPageNum() const;

                 std::vector<QuadPoint> GetQuads() const;

#ifndef SWIG
                 int GetQuads(const double* &quads) const;
#endif

                 UString GetAsUnicode() const;

#ifndef SWIG
                 void GetAsUnicode(UString& out_str) const;
#endif

                 const char* GetAsHtml() const;

                #ifndef SWIGHIDDEN
                 Selection();
                 Selection(const Selection&);
                 Selection& operator=(const Selection&);
                 Selection(TRN_PDFViewSelection impl);
        private:
                TRN_PDFViewSelection mp_selection;
                #endif
        };

         /*
          * TextSelectionMode lists different text selection modes that can be used to highlight text.
          * PDFView currently supports the following text selection modes: 
          *   - e_structural - Selects text based on the logical structure of the page. This type of selection is similar to HTML like selection in web-browsers.
          *   - e_rectangular - Selects all words that intersect the given selection rectangle.
          */
        enum TextSelectionMode {
                e_structural,
                e_rectangular  
        };

         void SetTextSelectionMode(TextSelectionMode tm);

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

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

        bool Select(const Highlights& highlights);

        bool FindText(const UString& search_str, bool match_case = false, bool match_whole_word = false, bool search_up = false, bool reg_exp = false);

         void SelectAll();

         bool HasSelection() const;

         void ClearSelection();

         PDFView::Selection GetSelection( int pagenum = -1 ) const;
        
        int GetSelectionBeginPage() const ;

        int GetSelectionEndPage() const;

        bool HasSelectionOnPage( int ipage ) const;

        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);

        void SetHorizontalAlign(int align);

         void SetVerticalAlign(int align);

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

         void Destroy();
    
    Annot GetAnnotationAt(int x, int y);


#if defined(__iOS__) || defined(__ANDROID__)
    
    void PushViewingStates();
        void PopViewingStates(bool restore);
    
        void SetFreezeTile(bool freeze);

        void SetThumbRenderEnabled(bool enable);
    
    int GetCurCanvasId() const;

         void GetPageRects(const Rect& rect, std::vector<double>& page_rects_info) const;

         void DoProgressiveRender();

         int GetCellSideLength() const;

         double GetPageVGap() const;
         double GetPageHGap() const;

         void RequestRender();

         bool IsValidTile(int canvasNumber, int cellNumber);

         void PurgeMemory();
         void SetMemInfo(double total_mem, double mem_cap);
    
     void ExecuteAction(Action& action);

         typedef void (*CreateTileProc)(void* pdfview, char* buffer, int originX, int originY, int width, int height, 
                 int page_num, int cellNumber, bool finalRender, bool predictionRender, int tiles_remaining,
                 bool first_tile, int canvas_width, int canvas_height, int cell_side_length, int cell_per_row, int cell_per_col,
                 int thumb_nail_id);

         typedef void (*RemoveTileProc)(void* callingObject, int canvasNumber, int cellNumber, int thumb_nail_id);

#ifdef SWIG
         void SetWrapperCreateTileProc(Callback* instance);
         void SetWrapperRemoveTileProc(Callback* instance);
#else
         void SetWrapperCreateTileProc(CreateTileProc wrapperCreateTileProc, void* callingObject);
         void SetWrapperRemoveTileProc(RemoveTileProc wrapperRemoveTileProc, void* callingObject);
#endif
         
#endif

private:
        TRN_PDFView mp_view;
        TRN_PDFDoc temp_doc;
};



#include <Impl/PDFView.inl>

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

#endif

---

© 2002-2012 PDFTron Systems Inc.