Bookmark.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_CPPPDFBookmark
#define PDFTRON_H_CPPPDFBookmark
 
#include <PDF/Action.h>
#include <C/PDF/TRN_Bookmark.h>
 
namespace pdftron { 
    namespace PDF {
 
class PDFDoc;

class Bookmark
{
public:

     static Bookmark Create(class PDFDoc& in_doc, const UString& in_title);

     Bookmark();

     Bookmark(SDF::Obj in_bookmark_dict);

     Bookmark(const Bookmark& in_bookmark);

     Bookmark& operator=(const Bookmark& in_bookmark);

     bool operator==(const Bookmark& in_bookmark);
     
     bool IsValid() const;

     bool HasChildren(); 

     Bookmark GetNext();

     Bookmark GetPrev();

     Bookmark GetFirstChild();

     Bookmark GetLastChild();

     Bookmark GetParent();

     Bookmark Find(const UString& in_title);
 
     Bookmark AddChild(const UString& in_title);

     Bookmark AddChild(Bookmark in_bookmark);
 
     Bookmark AddNext(const UString& in_title);
 
     void AddNext(Bookmark in_bookmark);
 
     Bookmark AddPrev(const UString& in_title);
 
     void AddPrev(Bookmark in_bookmark);
 
     void Delete();
 
     void Unlink();

     int GetIndent();

     bool IsOpen();

     void SetOpen(bool in_open);

     int GetOpenCount();

     UString GetTitle();

     SDF::Obj GetTitleObj();
 
     void SetTitle(const UString& title);

     Action GetAction();

     void SetAction(Action in_action);

     void RemoveAction();   
 
     int GetFlags();

     void SetFlags(int in_flags);
 
     std::vector<double> GetColor();
 
#ifndef SWIG
     void GetColor(double& out_r, double& out_g, double& out_b);
#endif

     void SetColor(double in_r = 0.0, double in_g = 0.0, double in_b = 0.0);

     SDF::Obj GetSDFObj() const;
 
   //for xamarin use only
    static Bookmark* CreateInternal(ptrdiff_t impl);
    ptrdiff_t GetHandleInternal();
 
 
// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    Bookmark(TRN_Bookmark impl);
    TRN_Bookmark mp_obj;
#endif
// @endcond
};
 
    };  // namespace PDF
};  // namespace pdftron
 
#include <Impl/PDFDoc.inl>
 
#endif // PDFTRON_H_CPPPDFBookmark