Highlights.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2025 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPHighlights
#define PDFTRON_H_CPPHighlights
 
#include <PDF/PDFDoc.h>
#include <Common/UString.h>
#include <C/PDF/TRN_Highlights.h>
#include <PDF/TextRange.h>
 
namespace pdftron { 
    namespace PDF {
 
struct Highlight
{
    Highlight()
    {
        page_num = 0; //invalid
        position = 0;
        length = 0;
    }
 
    Highlight(int pg, int pos, int len) : page_num(pg), position(pos), length(len)
    {}
 
    Highlight(const Highlight& hlt) : page_num(hlt.page_num), position(hlt.position), length(hlt.length)
    {}
 
    int page_num;
    int position;
    int length;
};

class Highlights 
{
    friend class PDFView;
    friend class PDFViewCtrl;
    friend class TextSearch;
public:
 
    typedef pdftron::PDF::Highlight Highlight;
    Highlights();
    ~Highlights();
    Highlights(const Highlights& hlts);

    Highlights& operator = ( const Highlights& hlts );

    void Load( const UString& file_name );

    void Save( const UString& file_name );

    UString SaveToString();

    void Add( const Highlights& hlts );

    void Clear();

    void Begin(PDFDoc& doc);

    bool HasNext() const;

    void Next();

    int GetCurrentPageNumber() const;

    std::vector<QuadPoint> GetCurrentQuads() const;
 
#ifndef SWIG
    int GetCurrentQuads(const double* &quads) const;
#endif

    TextRange GetCurrentTextRange() const;

     void Destroy();
 
     
  //for xamarin use only
     static Highlights* CreateInternal(ptrdiff_t impl);
     ptrdiff_t GetHandleInternal();
 
#ifndef SWIGHIDDEN
    
//private:
     TRN_Highlights mp_highlights;
    //for xamarin use only
    Highlights(TRN_Highlights impl) : mp_highlights(impl) {}
#endif
};
 
 
#include <Impl/Highlights.inl>
 
    }   // namespace PDF
}   // namespace pdftron
 
#endif // PDFTRON_H_CPPHighlights