SElement.h

Go to the documentation of this file.

//---------------------------------------------------------------------------------------
// Copyright (c) 2001-2023 by Apryse Software Inc. All Rights Reserved.
// Consult legal.txt regarding legal and license information.
//---------------------------------------------------------------------------------------
#ifndef PDFTRON_H_CPPPDFStructSElement
#define PDFTRON_H_CPPPDFStructSElement

namespace pdftron { 
    namespace PDF {
        class PDFDoc;
        namespace Struct {

class SElement
{
public: 

     SElement (SDF::Obj dict = SDF::Obj(0));
    
     SElement (const SElement&);
     SElement& operator= (const SElement&);
     
     static SElement Create(pdftron::PDF::PDFDoc& doc, const char* struct_type);    

    void Insert(SElement& kid, int insert_before);

    int CreateContentItem(PDFDoc& doc, Page& page, int insert_before = -1);

     bool IsValid() const;

     const char* GetType() const;

     int GetNumKids() const;

     bool IsContentItem(int index) const;

     class ContentItem GetAsContentItem(int index) const;

     SElement GetAsStructElem(int index) const;

     SElement GetParent() const;

     class STree GetStructTreeRoot() const;

     bool HasTitle() const;

     UString GetTitle() const;

     SDF::Obj GetID() const;

     bool HasActualText() const;

     UString GetActualText() const;

     bool HasAlt() const;

     UString GetAlt() const;

     SDF::Obj GetSDFObj() const;


// @cond PRIVATE_DOC
#ifndef SWIGHIDDEN
    SElement(TRN_SElement impl);
    TRN_SElement mp_elem;
#endif
// @endcond
};



        };  // namespace Struct
    };  // namespace PDF
};  // namespace pdftron

#include <Impl/PDFDoc.inl>

#endif // PDFTRON_H_CPPPDFStructSElement