fpdf_structtree.h File Reference

(ada9ddbf8c604585ac344b72f7bb63ac27c84726)

#include "fpdfview.h"

Include dependency graph for fpdf_structtree.h:

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
FPDF_EXPORT FPDF_STRUCTTREE FPDF_CALLCONV	FPDF_StructTree_GetForPage (FPDF_PAGE page)
FPDF_EXPORT void FPDF_CALLCONV	FPDF_StructTree_Close (FPDF_STRUCTTREE struct_tree)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructTree_CountChildren (FPDF_STRUCTTREE struct_tree)
FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV	FPDF_StructTree_GetChildAtIndex (FPDF_STRUCTTREE struct_tree, int index)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetAltText (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetActualText (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetID (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetLang (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetStringAttribute (FPDF_STRUCTELEMENT struct_element, FPDF_BYTESTRING attr_name, void *buffer, unsigned long buflen)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_GetMarkedContentID (FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetType (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetObjType (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT unsigned long FPDF_CALLCONV	FPDF_StructElement_GetTitle (FPDF_STRUCTELEMENT struct_element, void *buffer, unsigned long buflen)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_CountChildren (FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV	FPDF_StructElement_GetChildAtIndex (FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_GetChildMarkedContentID (FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV	FPDF_StructElement_GetParent (FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_GetAttributeCount (FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT FPDF_STRUCTELEMENT_ATTR FPDF_CALLCONV	FPDF_StructElement_GetAttributeAtIndex (FPDF_STRUCTELEMENT struct_element, int index)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_Attr_GetCount (FPDF_STRUCTELEMENT_ATTR struct_attribute)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV	FPDF_StructElement_Attr_GetName (FPDF_STRUCTELEMENT_ATTR struct_attribute, int index, void *buffer, unsigned long buflen, unsigned long *out_buflen)
FPDF_EXPORT FPDF_OBJECT_TYPE FPDF_CALLCONV	FPDF_StructElement_Attr_GetType (FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV	FPDF_StructElement_Attr_GetBooleanValue (FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name, FPDF_BOOL *out_value)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV	FPDF_StructElement_Attr_GetNumberValue (FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name, float *out_value)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV	FPDF_StructElement_Attr_GetStringValue (FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name, void *buffer, unsigned long buflen, unsigned long *out_buflen)
FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV	FPDF_StructElement_Attr_GetBlobValue (FPDF_STRUCTELEMENT_ATTR struct_attribute, FPDF_BYTESTRING name, void *buffer, unsigned long buflen, unsigned long *out_buflen)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_GetMarkedContentIdCount (FPDF_STRUCTELEMENT struct_element)
FPDF_EXPORT int FPDF_CALLCONV	FPDF_StructElement_GetMarkedContentIdAtIndex (FPDF_STRUCTELEMENT struct_element, int index)

Function Documentation

FPDF_StructElement_Attr_GetBlobValue()

FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetBlobValue	(	FPDF_STRUCTELEMENT_ATTR	struct_attribute,
		FPDF_BYTESTRING	name,
		void *	buffer,
		unsigned long	buflen,
		unsigned long *	out_buflen )

Definition at line 403 of file fpdf_structtree.cpp.

References fxcrt::ByteString::c_str(), and CPDFDictionaryFromFPDFStructElementAttr().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetBooleanValue()

FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetBooleanValue	(	FPDF_STRUCTELEMENT_ATTR	struct_attribute,
		FPDF_BYTESTRING	name,
		FPDF_BOOL *	out_value )

Definition at line 339 of file fpdf_structtree.cpp.

References CPDFDictionaryFromFPDFStructElementAttr().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetCount()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_Attr_GetCount

(

FPDF_STRUCTELEMENT_ATTR

struct_attribute

)

Definition at line 292 of file fpdf_structtree.cpp.

References CPDFDictionaryFromFPDFStructElementAttr().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetName()

FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetName	(	FPDF_STRUCTELEMENT_ATTR	struct_attribute,
		int	index,
		void *	buffer,
		unsigned long	buflen,
		unsigned long *	out_buflen )

Definition at line 301 of file fpdf_structtree.cpp.

References CPDF_DictionaryLocker::CPDF_DictionaryLocker(), and CPDFDictionaryFromFPDFStructElementAttr().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetNumberValue()

FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetNumberValue	(	FPDF_STRUCTELEMENT_ATTR	struct_attribute,
		FPDF_BYTESTRING	name,
		float *	out_value )

Definition at line 360 of file fpdf_structtree.cpp.

References CPDFDictionaryFromFPDFStructElementAttr().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetStringValue()

FPDF_EXPORT FPDF_BOOL FPDF_CALLCONV FPDF_StructElement_Attr_GetStringValue	(	FPDF_STRUCTELEMENT_ATTR	struct_attribute,
		FPDF_BYTESTRING	name,
		void *	buffer,
		unsigned long	buflen,
		unsigned long *	out_buflen )

Definition at line 380 of file fpdf_structtree.cpp.

References CPDFDictionaryFromFPDFStructElementAttr(), and fxcrt::WideString::FromUTF8().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_Attr_GetType()

FPDF_EXPORT FPDF_OBJECT_TYPE FPDF_CALLCONV FPDF_StructElement_Attr_GetType	(	FPDF_STRUCTELEMENT_ATTR	struct_attribute,
		FPDF_BYTESTRING	name )

Definition at line 328 of file fpdf_structtree.cpp.

References CPDFDictionaryFromFPDFStructElementAttr().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_CountChildren()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_CountChildren

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 247 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetActualText()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetActualText	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 90 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), and CPDF_StructElement::GetActualText().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetAltText()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetAltText	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 81 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), and CPDF_StructElement::GetAltText().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetAttributeAtIndex()

FPDF_EXPORT FPDF_STRUCTELEMENT_ATTR FPDF_CALLCONV FPDF_StructElement_GetAttributeAtIndex	(	FPDF_STRUCTELEMENT	struct_element,
		int	index )

Definition at line 145 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetAttributeCount()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetAttributeCount

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 127 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetChildAtIndex()

FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV FPDF_StructElement_GetChildAtIndex	(	FPDF_STRUCTELEMENT	struct_element,
		int	index )

Definition at line 258 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetChildMarkedContentID()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetChildMarkedContentID	(	FPDF_STRUCTELEMENT	struct_element,
		int	index )

Definition at line 269 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetID()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetID	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 99 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetLang()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetLang	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 113 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetMarkedContentID()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetMarkedContentID

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 204 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetMarkedContentIdAtIndex()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetMarkedContentIdAtIndex	(	FPDF_STRUCTELEMENT	struct_element,
		int	index )

Definition at line 447 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetMarkedContentIdCount()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructElement_GetMarkedContentIdCount

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 431 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetObjType()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetObjType	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 226 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), fxcrt::WideString::FromUTF8(), and CPDF_StructElement::GetObjType().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetParent()

FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV FPDF_StructElement_GetParent

(

FPDF_STRUCTELEMENT

struct_element

)

Definition at line 281 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), FPDFStructElementFromCPDFStructElement(), and CPDF_StructElement::GetParent().

Referenced by CheckPDFiumCApi(), DumpChildStructure(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetStringAttribute()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetStringAttribute	(	FPDF_STRUCTELEMENT	struct_element,
		FPDF_BYTESTRING	attr_name,
		void *	buffer,
		unsigned long	buflen )

Definition at line 178 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement().

Referenced by CheckPDFiumCApi(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetTitle()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetTitle	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 238 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), and CPDF_StructElement::GetTitle().

Referenced by CheckPDFiumCApi(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructElement_GetType()

FPDF_EXPORT unsigned long FPDF_CALLCONV FPDF_StructElement_GetType	(	FPDF_STRUCTELEMENT	struct_element,
		void *	buffer,
		unsigned long	buflen )

Definition at line 214 of file fpdf_structtree.cpp.

References CPDFStructElementFromFPDFStructElement(), fxcrt::WideString::FromUTF8(), and CPDF_StructElement::GetType().

Referenced by CheckPDFiumCApi(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), TEST_F(), and TEST_F().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructTree_Close()

FPDF_EXPORT void FPDF_CALLCONV FPDF_StructTree_Close

(

FPDF_STRUCTTREE

struct_tree

)

Definition at line 54 of file fpdf_structtree.cpp.

Referenced by CheckPDFiumCApi(), and FPDFStructTreeDeleter::operator()().

Here is the caller graph for this function:

FPDF_StructTree_CountChildren()

FPDF_EXPORT int FPDF_CALLCONV FPDF_StructTree_CountChildren

(

FPDF_STRUCTTREE

struct_tree

)

Definition at line 60 of file fpdf_structtree.cpp.

References CPDFStructTreeFromFPDFStructTree().

Referenced by CheckPDFiumCApi().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructTree_GetChildAtIndex()

FPDF_EXPORT FPDF_STRUCTELEMENT FPDF_CALLCONV FPDF_StructTree_GetChildAtIndex	(	FPDF_STRUCTTREE	struct_tree,
		int	index )

Definition at line 70 of file fpdf_structtree.cpp.

References CPDFStructTreeFromFPDFStructTree().

Referenced by CheckPDFiumCApi().

Here is the call graph for this function:

Here is the caller graph for this function:

FPDF_StructTree_GetForPage()

FPDF_EXPORT FPDF_STRUCTTREE FPDF_CALLCONV FPDF_StructTree_GetForPage

(

FPDF_PAGE

page

)

Definition at line 42 of file fpdf_structtree.cpp.

References CPDFPageFromFPDFPage(), and CPDF_Page::GetDocument().

Referenced by CheckPDFiumCApi().

Here is the call graph for this function:

Here is the caller graph for this function: