element.h

// Copyright (c) 2009-2025 Avanquest Software. All rights reserved.
 
#ifndef PDFSDK_CXX_PDF_ELEMENT_H_INCLUDED_
#define PDFSDK_CXX_PDF_ELEMENT_H_INCLUDED_
 
#include <pdfsdk/core/content.h>
#include <pdfsdk/cxx/math.h>
 
#include "forward_declarations.h"
#include "wrapper_base.h"
 
namespace PDF {

class Element : public detail::RefCountedHandle<PDEElement> {
public:
    static Element CreateContainer(PDAtom tag, const Object& dict);

    static Element CreatePath();

    static Element CreateText();

    static Element CreateXObject(const XObject& xobject);

    static Element CreateShading(const Shading& shading);

    static Element LayoutText(const Document& doc,
                              const std::wstring& text,
                              const RectF& box,
                              const PDFontInfo& fontInfo,
                              float fontSize,
                              PDColorValue fontColor,
                              PDETextAlign alignment);

    Element Copy() const;

    bool Equals(const Element& that) const;

    PDEElementType GetElementType() const;

    RectF GetBBox() const;

    Quad GetQuad() const;

    Clip GetClip() const;

    void SetClip(const Clip& clip);

    GState GetGState() const;

    void SetGState(const GState& gstate);

    Matrix GetMatrix() const;

    void SetMatrix(const Matrix& matrix);

    bool HitTest(const PointF& point) const;

    PDAtom GetContainerTag() const;

    void SetContainerTag(PDAtom tag);

    Object GetContainerDict() const;

    void SetContainerDict(const Object& dict);

    Content GetContainerContent() const;

    OCMembership GetContainerOCMembership() const;

    bool IsVisibleInContext(const OCContext& context) const;

    PDAtom GetPlaceTag() const;

    void SetPlaceTag(PDAtom tag);

    Object GetPlaceDict() const;

    void SetPlaceDict(const Object& dict);

    PDEPaintOp GetPathPaintOp() const;

    void SetPathPaintOp(PDEPaintOp paintOp);

    size_t GetPathNumSegments() const;

    PDEPathSegment GetPathSegment(size_t index) const;

    void PathAddSegment(const PDEPathSegment& segment);

    void PathMoveTo(const PointF& to);

    void PathLineTo(const PointF& to);

    void PathCurveTo(const PointF& c0, const PointF& c1, const PointF& to);

    void PathVCurveTo(const PointF& c0, const PointF& to);

    void PathYCurveTo(const PointF& c1, const PointF& to);

    void PathRect(const RectF& rect);

    void PathClose();

    void PathRemoveSegment(size_t index);

    size_t GetTextNumRuns() const;

    TextRun GetTextRun(size_t index) const;

    TextRun GetTextRunAtPoint(const PointF& pagePt) const;

    void TextInsertRun(size_t index, const TextRun& run);

    void TextRemoveRun(size_t index);

    void TextSplitRun(size_t itemIndex, size_t charIndex);

    bool GetTextKnockout() const;

    void SetTextKnockout(bool knockout);

    XObject GetXObject() const;

    void SetXObject(const XObject& xobject);

    Shading GetShading() const;

    void SetShading(const Shading& shading);

    bool IsImage() const;

    PDEImageAttrs GetImageAttrs() const;

    ColorSpace GetImageColorSpace() const;
 
    PDF_CXX_CORE_WRAPPER_DEFINE_MEMBERS_(Element, PDEElement)
};
 
}  // namespace PDF
 
#include "element_impl.inl"
 
#endif  // PDFSDK_CXX_PDF_ELEMENT_H_INCLUDED_