StructElement Class Documentation
class StructElementNamespace:datalogics_interface
Detailed Description
Internal wrapper for a single node in the PDF logical structure tree.
Owns a non-owning reference to its CDocument. Exposes type (/S) access, the backing dict (for arbitrary attribute reads/writes), child creation, and marked-content reference insertion.
Threading: single-thread use. A StructElement is bound to its owning Document's thread; do not share it across threads. See datalogics_interface.hpp for the full threading model.
Lifetime: a StructElement must not outlive the Document that produced it.
Referenced by
Constructor & Destructor Documentation
StructElement
StructElement(StructElement && )Parameters
~StructElement
~StructElement()Member Function Documentation
add_child
StructElement add_child(const std::string & struct_type)Parameters
struct_type: const std::string &
Returns:
StructElementCreate and append a child element with the given struct type (/S).
add_marked_content_ref
void add_marked_content_ref(Page & page, const Container & container)Parameters
page: Page &container: const Container &
Returns:
voidAppend a marked-content reference. /StructParents on the page and the parent tree are wired automatically.
as_pdf_object
PDFObject as_pdf_object()Returns:
PDFObjectNon-owning indirect handle for use in containers.
get_kid_as_element
StructElement get_kid_as_element(size_t index)Parameters
index: size_t
Returns:
StructElementKid at index interpreted as a child struct element.
Exceptions
- std::invalid_argument —
if the kid is not a struct element.
get_kid_as_marked_content_mcid
int get_kid_as_marked_content_mcid(size_t index)Parameters
index: size_t
Returns:
intMCID of the marked-content kid at index.
Exceptions
- std::invalid_argument —
if the kid is not a marked-content ref.
get_kid_as_marked_content_page
Page get_kid_as_marked_content_page(size_t index)Parameters
index: size_t
Returns:
PagePage containing the marked-content kid at index.
Exceptions
- std::invalid_argument —
if the kid is not a marked-content ref.
get_kid_count
size_t get_kid_count()Returns:
size_tNumber of kids in this element's /K array.
get_kid_type
StructKidType get_kid_type(size_t index)Parameters
index: size_t
Returns:
StructKidTypeClassify the kid at index. Caller should gate type-specific accessors on this result.
get_parent
std::optional< StructElement > get_parent()Returns:
std::optional< StructElement >Immediate parent element in the tree, or std::nullopt when the parent is the struct tree root (use parent_is_tree_root() to tell the two nullopt conditions apart explicitly).
get_pdf_dict
PDFDict get_pdf_dict()Returns:
PDFDictFull backing dict — escape hatch for all attributes (/Alt, /ActualText, /Lang, /E, /T, /ID, /A, etc.).
get_type
std::string get_type()Returns:
std::stringStruct type (/S) value as a string.
operator=
StructElement & operator=(StructElement && )Parameters
Returns:
StructElement &parent_is_tree_root
bool parent_is_tree_root()Returns:
boolTrue when this element's immediate parent is the struct tree root.