Element.h

#pragma once
// Copyright (c) 2001-2024 Aspose Pty Ltd. All Rights Reserved.

#include <system/string.h>
#include <system/collections/list.h>
#include <system/collections/ienumerable.h>
#include <cstdint>

#include "Aspose.PDF.Cpp/aspose_pdf_api_defs.h"

namespace Aspose
{
namespace Pdf
{
namespace Collections
{
template <typename, typename> class AsposeHashDictionary;
} // namespace Collections
namespace Engine
{
namespace Data
{
class IPdfDictionary;
class IPdfObject;
class IPdfPrimitive;
class ITrailerable;
} // namespace Data
} // namespace Engine
namespace Structure
{
class Element;
class ElementFactory;
class FigureElement;
class RootElement;
class StructElement;
class TextElement;
} // namespace Structure
namespace Tests
{
class RegressionTests_v23_10;
class RegressionTests_v24_02;
} // namespace Tests
class XmlConverter;
} // namespace Pdf
} // namespace Aspose
namespace System
{
namespace Collections
{
namespace Generic
{
template <typename> class IEnumerator;
} // namespace Generic
} // namespace Collections
} // namespace System

namespace Aspose {

namespace Pdf {

namespace Structure {

class ASPOSE_PDF_SHARED_CLASS ElementCollection : public System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Pdf::Structure::Element>>
{
    typedef ElementCollection ThisType;
    typedef System::Collections::Generic::IEnumerable<System::SharedPtr<Aspose::Pdf::Structure::Element>> BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Pdf::Structure::Element;
    
public:
    using iterator_holder_type = System::Collections::Generic::List<System::SharedPtr<Element>>;
    using iterator = typename iterator_holder_type::iterator;
    using const_iterator = typename iterator_holder_type::const_iterator;
    using virtualized_iterator_element = typename iterator_holder_type::virtualized_iterator_element;
    using virtualized_iterator = typename iterator_holder_type::virtualized_iterator;
    
public:

    ASPOSE_PDF_SHARED_API int32_t get_Count();
    
    ASPOSE_PDF_SHARED_API bool Remove(System::SharedPtr<Element> item);
    ASPOSE_PDF_SHARED_API System::SharedPtr<System::Collections::Generic::IEnumerator<System::SharedPtr<Element>>> GetEnumerator() override;
    
    ASPOSE_PDF_SHARED_API System::SharedPtr<Element> idx_get(int32_t index);
    
    ASPOSE_PDF_SHARED_API iterator begin() noexcept;
    ASPOSE_PDF_SHARED_API iterator end() noexcept;
    ASPOSE_PDF_SHARED_API const_iterator begin() const noexcept;
    ASPOSE_PDF_SHARED_API const_iterator end() const noexcept;
    ASPOSE_PDF_SHARED_API const_iterator cbegin() const noexcept;
    ASPOSE_PDF_SHARED_API const_iterator cend() const noexcept;
    ASPOSE_PDF_SHARED_API virtualized_iterator* virtualizeBeginIterator() override;
    ASPOSE_PDF_SHARED_API virtualized_iterator* virtualizeEndIterator() override;
    ASPOSE_PDF_SHARED_API virtualized_iterator* virtualizeBeginConstIterator() const override;
    ASPOSE_PDF_SHARED_API virtualized_iterator* virtualizeEndConstIterator() const override;
    
protected:

    ElementCollection(System::SharedPtr<Element> parent);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(ElementCollection, CODEPORTING_ARGS(System::SharedPtr<Element> parent));
    
    virtual ASPOSE_PDF_SHARED_API ~ElementCollection();
    
private:

    System::SharedPtr<Element> _parent;
    System::SharedPtr<System::Collections::Generic::List<System::SharedPtr<Element>>> _elements;
    
    static void RemoveFromParent(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> parent, System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfPrimitive> primitive);
    static void UnregisterSubTree(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfPrimitive> primitive);
    void Init();
    
};

class ASPOSE_PDF_SHARED_CLASS Element : public System::Object
{
    typedef Element ThisType;
    typedef System::Object BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Pdf::Structure::ElementCollection;
    friend class Aspose::Pdf::Structure::StructElement;
    friend class Aspose::Pdf::Structure::RootElement;
    friend class Aspose::Pdf::Structure::FigureElement;
    friend class Aspose::Pdf::Structure::TextElement;
    friend class Aspose::Pdf::XmlConverter;
    friend class Aspose::Pdf::Tests::RegressionTests_v23_10;
    friend class Aspose::Pdf::Tests::RegressionTests_v24_02;
    
public:

    ASPOSE_PDF_SHARED_API System::SharedPtr<ElementCollection> get_Children();
    virtual ASPOSE_PDF_SHARED_API System::String get_Lang();
    virtual ASPOSE_PDF_SHARED_API void set_Lang(System::String value);
    virtual ASPOSE_PDF_SHARED_API System::String get_ActualText();
    virtual ASPOSE_PDF_SHARED_API void set_ActualText(System::String value);
    virtual ASPOSE_PDF_SHARED_API System::String get_Alt();
    virtual ASPOSE_PDF_SHARED_API void set_Alt(System::String value);
    virtual ASPOSE_PDF_SHARED_API System::String get_E();
    virtual ASPOSE_PDF_SHARED_API void set_E(System::String value);
    
    ASPOSE_PDF_SHARED_API void Remove();
    
protected:

    System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> EngineDict;
    System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> PdfObject;
    
    System::String get_Type();
    void set_Type(System::String value);
    System::String get_StructureType();
    System::SharedPtr<Element> get_Parent() const;
    System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> get_Attributes();
    
    Element(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> engineDict, System::SharedPtr<Element> parent);
    Element(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> obj, System::SharedPtr<Element> parent);
    
    virtual ASPOSE_PDF_SHARED_API ~Element();
    
private:

    System::SharedPtr<Element> _parent;
    System::SharedPtr<ElementCollection> _elements;
    System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> _attrib;
    
    System::String GetAttributeValueString(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfPrimitive> primitive);
    
};

//TODO: remove next classes to separate files.
class ASPOSE_PDF_SHARED_CLASS StructElement : public Aspose::Pdf::Structure::Element
{
    typedef StructElement ThisType;
    typedef Aspose::Pdf::Structure::Element BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Pdf::Structure::ElementFactory;
    
protected:

    StructElement(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> engineDict, System::SharedPtr<Element> parent);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(StructElement, CODEPORTING_ARGS(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> engineDict, System::SharedPtr<Element> parent));
    
    StructElement(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> obj, System::SharedPtr<Element> parent);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(StructElement, CODEPORTING_ARGS(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> obj, System::SharedPtr<Element> parent));
    
};

class ASPOSE_PDF_SHARED_CLASS RootElement : public Aspose::Pdf::Structure::Element
{
    typedef RootElement ThisType;
    typedef Aspose::Pdf::Structure::Element BaseType;
    
    typedef ::System::BaseTypesInfo<BaseType> ThisTypeBaseTypesInfo;
    ASPOSE_PDF_SHARED_RTTI_INFO_DECL();
    
    friend class Aspose::Pdf::Structure::ElementFactory;
    friend class Aspose::Pdf::XmlConverter;
    
protected:

    System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> get_RoleMap();
    
    RootElement(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> engineDict, System::SharedPtr<Element> parent);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(RootElement, CODEPORTING_ARGS(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfDictionary> engineDict, System::SharedPtr<Element> parent));
    
    RootElement(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> obj, System::SharedPtr<Element> parent);
    
    MEMBER_FUNCTION_MAKE_OBJECT_DECLARATION(RootElement, CODEPORTING_ARGS(System::SharedPtr<Aspose::Pdf::Engine::Data::IPdfObject> obj, System::SharedPtr<Element> parent));
    
private:

    System::SharedPtr<Aspose::Pdf::Engine::Data::ITrailerable> tr;
    System::SharedPtr<Aspose::Pdf::Collections::AsposeHashDictionary<System::String, System::String>> _roleMap;
    
};

} // namespace Structure
} // namespace Pdf
} // namespace Aspose