structure.h

Go to the documentation of this file.

/*
 * Copyright (C) 2018-2025 Global Graphics Software Ltd. All rights reserved.
 */
 
#ifndef JAWSMAKO_STRUCTURE_H
#define JAWSMAKO_STRUCTURE_H

 
#include <jawsmako/types.h>
#include <jawsmako/hashable.h>
 
namespace JawsMako
{
    using namespace EDL;
 
    class IStructureElementChild;
    DECL_SMART_PTR(IStructureElementChild);
    typedef CEDLVector<IStructureElementChildPtr> CStructureElementChildVect;
    class IStructureElementReferenceChild;
    DECL_SMART_PTR(IStructureElementReferenceChild);
    class IStructureMarkedContentReferenceChild;
    DECL_SMART_PTR(IStructureMarkedContentReferenceChild);
    class IStructureObjectReferenceChild;
    DECL_SMART_PTR(IStructureObjectReferenceChild);
    class IMarkedContentArtifactDetails;
    DECL_SMART_PTR(IMarkedContentArtifactDetails);

    class IMarkedContentDetails : public IRCObject, public IHashable
    {
      public:
        virtual ~IMarkedContentDetails() {}

        static JAWSMAKO_API IMarkedContentDetailsPtr create(const IJawsMakoPtr &jawsMako,
                                                            const U8String &tag, const IRCObjectPtr &properties,
                                                            bool isPoint);

        virtual U8String getTag() const = 0;

        virtual IPDFObjectPtr getProperties() const = 0;

        virtual bool getIsPoint() const = 0;
    };

    class IMarkedContentStructureDetails : public IMarkedContentDetails
    {
      public:
        virtual ~IMarkedContentStructureDetails() {}

        static JAWSMAKO_API IMarkedContentStructureDetailsPtr create(const IJawsMakoPtr &jawsMako,
                                                        const U8String &tag, const IRCObjectPtr &properties,
                                                        bool isPoint, const IStructureElementReferencePtr &elementReference);

        virtual IStructureElementReferencePtr getStructureElementReference() const = 0;
    };
    #define obj2IMarkedContentStructureDetails(obj)IMarkedContentStructureDetailsPtr(dynamic_cast<IMarkedContentStructureDetails *>((IRCObject *) (obj)), true)

    class IMarkedContentArtifactDetails : public IMarkedContentDetails
    {
      public:
        virtual ~IMarkedContentArtifactDetails() {}

        static JAWSMAKO_API IMarkedContentArtifactDetailsPtr create(const IJawsMakoPtr &jawsMako,
                                                                    const U8String &tag, const IRCObjectPtr &properties,
                                                                    bool isPoint);
        static JAWSMAKO_API IMarkedContentArtifactDetailsPtr create(const IJawsMakoPtr &jawsMako,
                                                                    const U8String &type,
                                                                    const U8String &subType);

        virtual U8String getType() const = 0;

        virtual U8String getSubtype() const = 0;
    };
    #define obj2IMarkedContentArtifactDetails(obj) IMarkedContentArtifactDetailsPtr(dynamic_cast<IMarkedContentArtifactDetails *>((IRCObject *) (obj)), true)

    class IStructureElementReference : public IRCObject, public IHashable
    {
      public:
        virtual ~IStructureElementReference() {}

        virtual bool equals(const IStructureElementReferencePtr &other) const = 0;
    };
 
 

    class IStructure : public IRCObject
    {
      public:
        virtual ~IStructure() {}

        static JAWSMAKO_API IStructurePtr create(const IJawsMakoPtr &jawsMako);

        virtual IStructurePtr clone() const = 0;

        virtual IDOMNodePtr tagNode(const IStructureElementPtr &element, const IPagePtr &page, const IDOMNodePtr &nodeToTag) = 0;

        virtual void appendElement(const IStructureElementPtr &element) = 0;

        virtual void insertElement(const IStructureElementPtr &element, uint32 index) = 0;

        virtual void removeElement(uint32 index) = 0;

        virtual const CStructureElementVect &getChildElements() const = 0;

        virtual IStructureElementPtr findStructureElementWithReference(const IStructureElementReferencePtr &reference) const = 0;
 
    };
 

    class IStructureElement : public IRCObject
    {
      public:
        virtual ~IStructureElement() {}

        static JAWSMAKO_API IStructureElementPtr create(const IJawsMakoPtr &jawsMako, const U8String &structureType);

        virtual IStructureElementPtr clone() const = 0;

        virtual U8String getStructureType() const = 0;

        virtual void setStructureType(const U8String &structureType) = 0;
 
        /*
         * @brief Get the "Title" of the structure element, or an empty string if none is present.
         * @return @b U8String The title of the structure element, or an empty string if none is set.
         */
        virtual U8String getTitle() const = 0;

        virtual void setTitle(const U8String &title) = 0;

        virtual U8String getLanguage() const = 0;

        virtual void setLanguage(const U8String &language) = 0;

        virtual U8String getAlternate() const = 0;

        virtual void setAlternate(const U8String &alternateDescription) = 0;

        virtual U8String getActualText() const = 0;

        virtual void setActualText(const U8String &actualText) = 0;

        virtual void setAttributes(const IPDFObjectPtr &attributes) = 0;

        virtual IPDFObjectPtr getAttributes() const = 0;

        virtual void appendElement(const IStructurePtr &structure, const IStructureElementPtr &element) = 0;

        virtual void insertElement(const IStructurePtr &structure,
                                   const IStructureElementPtr &element,
                                   uint32 index) = 0;

        virtual void appendMarkedContentReferenceChild(const IStructureMarkedContentReferenceChildPtr &child) = 0;

        virtual void insertMarkedContentReferenceChild(const IStructureMarkedContentReferenceChildPtr &child,
                                                       uint32 index) = 0;

        virtual void appendObjectReferenceChild(const IPagePtr &page, const IDOMFormPtr &targetForm) = 0;

        virtual void insertObjectReferenceChild(const IPagePtr &page,
                                                const IDOMFormPtr &targetForm,
                                                uint32 index) = 0;

        virtual void removeChild(const IStructurePtr &structure, uint32 index) = 0;

        virtual void createMarkedContentReferencePair(const IStructurePtr &structure,
                                                      const IPagePtr &page, const IDOMNodePtr &node,
                                                      IStructureMarkedContentReferenceChildPtr &resultReference,
                                                      IMarkedContentStructureDetailsPtr &resultDetails) = 0;

        virtual const CStructureElementChildVect &getChildren() const = 0;

        virtual IStructureElementReferencePtr getStructureElementReference() const = 0;

        virtual IStructureElementPtr findStructureElementWithReference(const IStructureElementReferencePtr &reference) const = 0;

        virtual IPDFObjectStorePtr getObjectStore() = 0;
    };

    class IStructureElementChild : public IRCObject
    {
      public:
        virtual ~IStructureElementChild() {}

        typedef enum eStructureChildType
 
        {
            eSCTStructureElement,           
            eSCTMarkedContentReference,     //<!A child that is a marked content reference
            eSCTObjectReference             //<!A child that is an object reference
        } eStructureChildType;

        virtual eStructureChildType getType() const = 0;

        virtual IStructureElementChildPtr clone() const = 0;
 
    };

    class IStructureElementReferenceChild : public IStructureElementChild
    {
      public:
        virtual ~IStructureElementReferenceChild() {}

        virtual IStructureElementPtr getElement() const = 0;
 
    };
    #define obj2IStructureElementReferenceChild(obj) IStructureElementReferenceChildPtr(dynamic_cast<IStructureElementReferenceChild *>((IRCObject *) (obj)), true)
 

    class IStructureMarkedContentReferenceChild : public IStructureElementChild
    {
      public:
        virtual ~IStructureMarkedContentReferenceChild() {}

        virtual bool matches(const IStructureElementPtr &parentElement, const IMarkedContentStructureDetailsPtr &details) const = 0;
    };
    #define obj2IStructureMarkedContentReference(obj) IStructureMarkedContentReferenceChildPtr(dynamic_cast<IStructureMarkedContentReferenceChild *>((IRCObject *) (obj)), true)

    class IStructureObjectReferenceChild : public IStructureElementChild
    {
      public:
        virtual ~IStructureObjectReferenceChild() {}

        virtual bool matches(const IDOMFormPtr &form) const = 0;
    };
    #define obj2IStructureObjectReferenceChild(obj) IStructureObjectReferenceChildPtr(dynamic_cast<IStructureObjectReferenceChild *>((IRCObject *) (obj)), true)
}
 
#endif /* JAWSMAKO_STRUCTURE_H */