annot.h

Go to the documentation of this file.

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CXX_PDF_ANNOT_H_INCLUDED_
#define PDFSDK_CXX_PDF_ANNOT_H_INCLUDED_
 
#include <pdfsdk/core/annots.h>
#include <pdfsdk/cxx/math.h>
 
#include "forward_declarations.h"
#include "wrapper_base.h"
 
namespace PDF {
 
class Annot : public detail::RefCountedHandle<PDAnnot> {
public:
    Object GetPdfObject() const;
 
    bool Equals(const Annot& that) const;
 
    PDAtom GetSubtype() const;
 
    void SetFlags(PDAnnotFlags flags);
 
    PDAnnotFlags GetFlags() const;
 
    void SetRect(const PDF::RectF& rect);
 
    PDF::RectF GetRect() const;
 
    void SetColor(PDColorValue color);
 
    PDColorValue GetColor() const;
 
    void SetContents(const std::wstring& contents);
 
    std::wstring GetContents() const;
 
    void SetModDate(const PDDateTime& date);
 
    PDDateTime GetModDate() const;
 
    void SetBorder(const PDAnnotBorder& border);
 
    PDAnnotBorder GetBorder() const;
 
    void SetOCMD(OCMembership ocmd);
 
    OCMembership GetOCMD() const;
 
    bool IsVisibleInConfig(OCConfig config) const;
 
    void SetAppearanceState(PDAtom appState);
 
    PDAtom GetAppearanceState() const;
 
    void SetFillOpacity(float opacity);
 
    float GetFillOpacity() const;
 
    void SetStrokeOpacity(float opacity);
 
    float GetStrokeOpacity() const;
 
    bool HasAppearance(PDAnnotState state, PDAtom appState) const;
 
    std::wstring GetName() const;
 
    void SetName(const std::wstring& name);
 
    bool IsVisible() const;
 
    void SetVisible(bool visible);
 
    PDEBlendMode GetBlendMode() const;
 
    void SetBlendMode(PDEBlendMode blendMode);
 
    void SetAppearance(PDAnnotState state, PDAtom appState, XObject app);
 
    XObject GetAppearance(PDAnnotState state, PDAtom appState) const;
 
    void SetLinkActions(const Action& actions);
 
    Action GetLinkActions() const;
 
    void RemoveLinkActions();
 
    void SetLinkQuadPoints(const QuadPoints& quadpoints);
 
    QuadPoints GetLinkQuadPoints() const;
 
    void SetLinkBorderStyle(const PDAnnotBorderStyle& borderStyle);
 
    PDAnnotBorderStyle GetLinkBorderStyle() const;
 
    void SetLinkDest(const Dest& dest);
 
    Dest GetLinkDest() const;
 
    bool IsMarkupAnnot() const;
 
    void SetMarkupTitle(const std::wstring& title);
 
    std::wstring GetMarkupTitle() const;
 
    Annot GetMarkupPopup() const;
 
    void SetMarkupRichContents(const std::wstring& contents);
 
    std::wstring GetMarkupRichContents() const;
 
    void SetMarkupCreationDate(const PDDateTime& date);
 
    PDDateTime GetMarkupCreationDate() const;
 
    void SetMarkupSubject(const std::wstring& subject);
 
    std::wstring GetMarkupSubject() const;
 
    void SetMarkupInReplyTo(const Annot& inReplyTo);
 
    Annot GetMarkupInReplyTo() const;
 
    void SetMarkupReplyType(PDMarkupAnnotReplyType replyType);
 
    PDMarkupAnnotReplyType GetMarkupReplyType() const;
 
    void SetMarkupIntent(PDAtom intent);
 
    PDAtom GetMarkupIntent() const;
 
    void SetTextOpen(bool open);
 
    bool IsTextOpen() const;
 
    void SetTextMarkupQuadPoints(const QuadPoints& quads);
 
    QuadPoints GetTextMarkupQuadPoints() const;
 
    std::vector<std::vector<PointF>> GetInkPointsList() const;
 
    void SetInkPointsList(const std::vector<std::vector<PointF>>& pointslist);
 
    PDRotate GetWidgetRotate() const;
 
    void SetWidgetRotate(PDRotate rotate);
 
    PDAnnotBorderStyle GetWidgetBorderStyle() const;
 
    void SetWidgetBorderStyle(PDAnnotBorderStyle borderStyle);
 
    PDColorValue GetWidgetBorderColor() const;
 
    void SetWidgetBorderColor(PDColorValue color);
 
    PDColorValue GetWidgetBackgroundColor() const;
 
    void SetWidgetBackgroundColor(PDColorValue color);
 
    PDFontInfo GetWidgetFontInfo() const;
 
    void SetWidgetFontInfo(const PDFontInfo& fontInfo);
 
    float GetWidgetFontSize() const;
 
    void SetWidgetFontSize(float fontSize);
 
    PDColorValue GetWidgetFontColor() const;
 
    void SetWidgetFontColor(PDColorValue color);
 
    FormField GetWidgetParent() const;
 
    PDRotate GetFreeTextRotate() const;
 
    void SetFreeTextRotate(PDRotate rotate);
 
    PDQuadding GetFreeTextQuadding() const;
 
    void SetFreeTextQuadding(PDQuadding quadding);
 
    PDAnnotBorderStyle GetFreeTextBorderStyle() const;
 
    void SetFreeTextBorderStyle(const PDAnnotBorderStyle& borderStyle);
 
    PDAnnotBorderEffect GetFreeTextBorderEffect() const;
 
    void SetFreeTextBorderEffect(const PDAnnotBorderEffect& borderEffect);
 
    PDFontInfo GetFreeTextFontInfo() const;
 
    void SetFreeTextFontInfo(const PDFontInfo& fontInfo);
 
    PDColorValue GetFreeTextFontColor() const;
 
    void SetFreeTextFontColor(PDColorValue fontColor);
 
    PDColorValue GetFreeTextBorderColor() const;
 
    void SetFreeTextBorderColor(PDColorValue borderColor);
 
    float GetFreeTextFontSize() const;
 
    void SetFreeTextFontSize(float fontSize);
 
    PDAtom GetFreeTextLineEnding() const;
 
    void SetFreeTextLineEnding(PDAtom endPointStyle);
 
    RectF GetFreeTextRectDifferences() const;
 
    void SetFreeTextRectDifferences(const RectF& differences);
 
    size_t HitTestFreeTextChar(const PointF& pagePt) const;
 
    Quad GetFreeTextCharQuad(size_t index) const;
 
    size_t GetFreeTextNumLines() const;
 
    float GetFreeTextLineSpacing() const;
 
    void SetFreeTextLineSpacing(float lineSpacing);
 
    float GetFreeTextCharSpacing() const;
 
    void SetFreeTextCharSpacing(float charSpacing);
 
    size_t GetFreeTextFirstCharOnLine(size_t lineIndex) const;
 
    size_t GetFreeTextLineWithChar(size_t charIndex) const;
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(Annot, PDAnnot)
};
 
}  // namespace PDF
 
#include "annot_impl.inl"
 
#endif  // PDFSDK_CXX_PDF_ANNOT_H_INCLUDED_