form_field.h

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CXX_PDF_FORM_FIELD_H_INCLUDED_
#define PDFSDK_CXX_PDF_FORM_FIELD_H_INCLUDED_
 
#include <string>
#include <vector>
 
#include <pdfsdk/core/acroform.h>
 
#include "forward_declarations.h"
#include "wrapper_base.h"
 
namespace PDF {
 
class SignHandler
{
public:
    virtual ~SignHandler() = default;
 
    virtual std::string GetFilter() = 0;
 
    virtual std::string GetSubFilter() = 0;
 
    virtual void FillSigDict(Object dict) = 0;
 
    virtual size_t GetNumCerts() = 0;
 
    virtual std::vector<uint8_t> GetCertData(size_t index) = 0;
 
    virtual size_t EstimateMaxSize() = 0;
 
    virtual std::vector<uint8_t> Sign(const uint8_t* data, size_t size) = 0;
};
 
class FormField : public detail::RefCountedHandle<PDField> {
public:
    static FormField CreateFromPdfObject(const Object& object);
 
    Object GetPdfObject() const;
 
    PDAtom GetFieldType() const;
 
    bool IsTerminal() const;
 
    PDFieldFlags GetFlags() const;
 
    std::wstring GetFullName() const;
 
    size_t GetNumWidgets() const;
 
    Annot GetWidget(size_t index) const;
 
    size_t GetChoiceNumOptions() const;
 
    std::wstring GetChoiceOption(size_t index) const;
 
    bool IsSignBlank() const;
 
    void SetSignLock(PDAtom action, Object fields, PDSignLockPerms perms);
 
    PDAtom GetSignLockAction() const;
 
    Object GetSignLockFields() const;
 
    PDSignLockPerms GetSignLockPerms() const;
 
    void SignApprove(std::shared_ptr<SignHandler> signer, const std::wstring& reason);
 
    void SignCertify(std::shared_ptr<SignHandler> signer, const std::wstring& reason, PDSignLockPerms perms = kPDSignLockPermsAllowFormFill);
 
    void SignClear();
 
    bool SignVerify() const;
 
    bool SignDocModifiedAfterSign() const;
 
    std::wstring GetSignReason() const;
 
    PDDateTime GetSignDate() const;
 
    size_t GetNumSignCertificates() const;
 
    std::vector<uint8_t> GetSignCertificate(size_t index) const;
 
    int GetSignRevision() const;
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(FormField, PDField)
};
 
}  // namespace PDF
 
#include "form_field_impl.inl"
 
#endif  // PDFSDK_CXX_PDF_FORM_FIELD_H_INCLUDED_