document.h

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CXX_PDF_DOCUMENT_H_INCLUDED_
#define PDFSDK_CXX_PDF_DOCUMENT_H_INCLUDED_
 
#include <filesystem>
#include <string>
 
#include <pdfsdk/core/types.h>
#include <pdfsdk/cxx/math.h>
#include <pdfsdk/cxx/progress_monitor.h>
 
#include "forward_declarations.h"
#include "standard_security.h"
#include "wrapper_base.h"
 
namespace PDF {
 
class Document : public detail::RefCountedHandle<PDDoc> {
public:
    static Document NewDocument();
 
    static Document OpenDocument(const std::filesystem::path& path, const std::wstring& password = std::wstring());
 
    static Document OpenDocument(const void* data, size_t size, bool copy = false, const std::wstring& password = std::wstring());
 
    bool IsCompressed() const;
 
    bool IsModified() const;
 
    void SetModified(bool modified);
 
    std::filesystem::path GetFilePath() const;
 
    void Save(const std::filesystem::path& path,
              PDDocSaveFlags flags = kPDDocSaveFull | kPDDocSaveCompressed,
              ProgressMonitor* progmon = nullptr,
              const PDOptSaveSettings* optSettings = nullptr,
              const PDVersion* version = nullptr);
 
    size_t GetNumPages() const;
 
    Page GetPage(size_t index) const;
 
    Page CreatePage(size_t insertAt, const RectF& mediaBox);
 
    void CreatePages(size_t insertAt, size_t count, const RectF& mediaBox);
 
    void DeletePages(const PDPageRange& range, ProgressMonitor* mon = nullptr);
 
    void DeletePage(size_t index);
 
    void InsertPages(size_t insertAt, const Document& sourceDoc, const PDPageRange& sourceRange, ProgressMonitor* mon = nullptr);
 
    void InsertPage(const Page& page, size_t insertAt);
 
    void MovePages(size_t insertAt, const PDPageRange& range, ProgressMonitor* mon = nullptr);
 
    std::wstring GetInfoString(PDAtom infoStringAtom) const;
 
    void SetInfoString(PDAtom infoStringAtom, const std::wstring& string);
 
    PDDateTime GetCreationDate() const;
 
    void SetCreationDate(const PDDateTime& date);
 
    PDDateTime GetModDate() const;
 
    void SetModDate(const PDDateTime& date);
 
    void SetPageLayout(PDAtom layout);
 
    PDAtom GetPageLayout() const;
 
    void SetPageMode(PDAtom mode);
 
    PDAtom GetPageMode() const;
 
    void SetPageDirection(PDPageDirection direction);
 
    PDPageDirection GetPageDirection() const;
 
    XObject CreateFormXObject(const Content& content);
 
    Pattern CreatePatternTiling(PDETilingPatternPaintType paintType,
                                PDETilingPatternTilingType tilingType,
                                const RectF& bbox,
                                float xStep,
                                float yStep,
                                const Content& content);
 
    Pattern CreatePatternShading(const Shading& shading);
 
    Font CreateFontInDoc(const PDFontInfo& fontInfo, bool needSubset = true, bool forceSysFont = true);
 
    size_t GetNumFormFields() const;
 
    FormField GetField(size_t index) const;
 
    void AppendField(FormField field);
 
    void RemoveField(FormField field);
 
    FormField CreateField(const std::wstring& fullname, PDAtom type, PDFieldFlags flags);
 
    FormField FindField(const std::wstring& fullname) const;
 
    void RenameField(FormField field, const std::wstring& fullname);
 
    bool IsSigned() const;
 
    void SaveSignedVersion(FormField sigField, const std::filesystem::path& path) const;
 
    Action CreateActionURI(const std::string& uri);
 
    Action CreateActionGoTo(Dest dest);
 
    Action CreateActionJavaScript(const std::wstring& jscode);
 
    Action CreateActionSubmitForm(const std::string& serverUri);
 
    Action CreateActionResetForm();
 
    Action CreateActionHide();
 
    Action CreateActionNamed(PDAtom name);
 
    void SetOpenAction(Action action);
 
    Action GetOpenAction() const;
 
    Dest CreateDestXYZ(size_t pageIndex, const PointF& xy, float zoom, bool isRemote = false);
 
    Dest CreateDestFit(size_t pageIndex, bool isRemote = false);
 
    Dest CreateDestFitH(size_t pageIndex, float top, bool isRemote = false);
 
    Dest CreateDestFitV(size_t pageIndex, float left, bool isRemote = false);
 
    Dest CreateDestFitR(size_t pageIndex, const RectF& rect, bool isRemote = false);
 
    Dest CreateDestFitB(size_t pageIndex, bool isRemote = false);
 
    Dest CreateDestFitBH(size_t pageIndex, float top, bool isRemote = false);
 
    Dest CreateDestFitBV(size_t pageIndex, float left, bool isRemote = false);
 
    void SetOpenDestination(Dest dest);
 
    Dest GetOpenDestination() const;
 
    template<class EnumProc>
    void EnumDocLevelJSActions(EnumProc enumProc) const;
 
    Action GetDocLevelJSAction(const std::wstring& name) const;
 
    void RemoveDocLevelJS();
 
    FileSpec GetAttachment(const std::wstring& name) const;
 
    template<class EnumProc>
    void EnumAttachments(EnumProc enumProc) const;
 
    void AddAttachment(const std::wstring& name, FileSpec filespec);
 
    void RemoveAttachment(const std::wstring& name);
 
    size_t GetNumAttachments() const;
 
    std::wstring GetAttachmentNameByIndex(size_t index) const;
 
    FileSpec CreateFileSpec(PDAtom fileSys, const std::wstring& path);
 
    FileSpec CreateEmbeddedFile(const std::wstring& path);
 
    Bookmark GetRootBookmark() const;
 
    Bookmark CreateRootBookmark();
 
    OCConfig GetOCConfig() const;
 
    OCGroup CreateOCGroup(const std::wstring& name);
 
    size_t GetNumOCGroups() const;
 
    OCGroup GetOCGroup(size_t index) const;
 
    Annot CreateTextAnnot(const RectF& rect);
 
    Annot CreateTextMarkupAnnot(PDAtom type, PDColorValue color, const QuadPoints& quads);
 
    Annot CreateInkAnnot(PDColorValue color, float lineWidth, const std::vector<std::vector<PointF>>& points);
 
    Annot CreateFreeTextAnnot(const RectF& rect);
 
    Annot CreateStampAnnot(const RectF& rect, const XObject& appearance);
 
    Annot CreateButtonWidget(const FormField& field, const RectF& rect);
    Annot CreateTextWidget(const FormField& field, const RectF& rect);
    Annot CreateChoiceWidget(const FormField& field, const RectF& rect);
    Annot CreateSignWidget(const FormField& field, const RectF& rect);
 
    Object GetObjectByID(uint32_t id) const;
 
    Object GetRootObject() const;
 
    Object GetInfoObject() const;
 
    Object CreateBoolObject(bool value, bool indirect = false);
 
    Object CreateIntObject(int64_t value, bool indirect = false);
 
    Object CreateRealObject(float value, bool indirect = false);
 
    Object CreateStringObjectUnicode(const std::wstring& unicode, bool indirect = false);
 
    Object CreateStringObject(const std::string& bytes, bool hex = false, bool indirect = false);
 
    Object CreateNameObject(PDAtom value, bool indirect = false);
 
    Object CreateArrayObject(bool indirect);
 
    Object CreateDictObject(bool indirect);
 
    Object CreateStreamObject(const void* buffer, size_t bufSize, const Object& attributesDict, const Object& encodeParms, bool encodeSource);
 
    Object CopyObject(const Object& source);
 
    ReadStream OpenXfaStream() const;
 
    StdSecurityParams GetStandardSecurityParams() const;
 
    void SetStandardSecurityParams(const StdSecurityParams& requestedParams);
 
    bool RequestPermission(PDPermReqObj object, PDPermReqOp operation, const std::wstring& password = std::wstring()) const;
 
    XObject ImportIcon(const Document& source, size_t pageIndex = 0);
 
    void CreatePageFromIcon(size_t insertAt, const Document& iconDoc, const XObject& icon);
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(Document, PDDoc)
};
 
}  // namespace PDF
 
#include "document_impl.inl"
 
#endif  // PDFSDK_CXX_PDF_DOCUMENT_H_INCLUDED_