Foxit PDF SDK
|
Instance Methods | |
(unsigned int) | - getAttributeValueARGB:index: |
Get an ARGB value (specified by index) for specified attribute type. More... | |
(int) | - getAttributeValueCount: |
Get value count of a specified attribute type. More... | |
(FSLRStructureElement *) | - getAttributeValueElement:index: |
Get an structure element object (specified by index) for specified attribute type. More... | |
(FSLRStructureElementAttributeValueEnum) | - getAttributeValueEnum:index: |
Get an enum value (specified by index) for specified attribute type. More... | |
(float) | - getAttributeValueFloat:index: |
Get a float value (specified by index) for specified attribute type. More... | |
(int) | - getAttributeValueInt32:index: |
Get an integer value (specified by index) for specified attribute type. More... | |
(NSString *) | - getAttributeValueString:index: |
Get a string value (specified by index) for specified attribute type. More... | |
(FSLRStructureElementAttributeValueType) | - getAttributeValueType: |
Get attribute value type for a specified attribute type. More... | |
(FSRectF *) | - getBBox |
Get bounding box. More... | |
(FSLRElement *) | - getChild: |
Get a child element by index. More... | |
(int) | - getChildCount |
Get the count of children elements. More... | |
(FSLRStructureElement *) | - getParentElement |
Get the parent element. More... | |
(FSLRStructureElementAttributeType) | - getSupportedAttribute: |
Get a supported attribute type by index. More... | |
(int) | - getSupportedAttributeCount |
Get supported attribute count. More... | |
(id) | - initWithElement: |
Constructor, with parent class object. More... | |
(id) | - initWithOther: |
Constructor, with another structure element object. More... | |
![]() | |
(FSLRElementElementType) | - getElementType |
Get element type. More... | |
(id) | - initWithOther: |
Constructor, with another base element object. More... | |
(BOOL) | - isContentElement |
Check whether current object is content element or not. More... | |
(BOOL) | - isEmpty |
Check whether current object is empty or not. More... | |
(BOOL) | - isGraphicsObjectElement |
Check whether current object is graphics object element or not. More... | |
(BOOL) | - isStructureElement |
Check whether current object is structure element or not. More... | |
(NSString *) | - stringifyType |
Convert type (enum value) of current element to a short and memorable string (text) representation. More... | |
Class Methods | |
(BOOL) | + isArrayAttributeValueType: |
Check whether input attribute value type represents an array. More... | |
(FSLRStructureElementAttributeType) | + parseAttributeType: |
Parse a string representation for attribute type and retrieve the enum value for this attribute type. More... | |
(NSString *) | + stringifyAttributeType: |
Convert the enum value of a specified attribute type to a short and memorable string (text) representation. More... | |
(NSString *) | + stringifyEnumVariant: |
Convert the enum value of a specified attribute value enum to a short and memorable string (text) representation. More... | |
![]() | |
(NSString *) | + stringifyElementType: |
Convert enum value of a specified element type to a short and memorable string (text) representation. More... | |
This class represents a structure element. A structure element can be used to construct a tree, like graphics structure element, paragraph structure element, span structure element and so on.
- (unsigned int) getAttributeValueARGB: | (FSLRStructureElementAttributeType) | type | |
index: | (int) | index | |
Get an ARGB value (specified by index) for specified attribute type.
This function is available for attributes whose value type is FSLRStructureElementAttributeValueTypeARGB or FSLRStructureElementAttributeValueTypeARGBArray. For other value type, this function will return 0.
[in] | type | Attribute type. Please refer to values starting from FSLRStructureElementAttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function FSLRStructureElement::getAttributeValueCount:. |
- (int) getAttributeValueCount: | (FSLRStructureElementAttributeType) | type |
Get value count of a specified attribute type.
[in] | type | Attribute type. Please refer to values starting from FSLRStructureElementAttributeTypeRole and this should be one of these values. |
- (FSLRStructureElement *) getAttributeValueElement: | (FSLRStructureElementAttributeType) | type | |
index: | (int) | index | |
Get an structure element object (specified by index) for specified attribute type.
This function is available for attributes whose value type is FSLRStructureElementAttributeValueTypeElement or FSLRStructureElementAttributeValueTypeElementArray. For other value type, this function will return a structure element whose function LRStructureElement::IsEmpty returns YES.
[in] | type | Attribute type. Please refer to values starting from FSLRStructureElementAttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function FSLRStructureElement::getAttributeValueCount:. |
- (FSLRStructureElementAttributeValueEnum) getAttributeValueEnum: | (FSLRStructureElementAttributeType) | type | |
index: | (int) | index | |
Get an enum value (specified by index) for specified attribute type.
This function is available for attributes whose value type is FSLRStructureElementAttributeValueTypeEnum or FSLRStructureElementAttributeValueTypeEnumArray. For other value type, this function will return FSLRStructureElementAttributeValueEnumInvalid.
[in] | type | Attribute type. Please refer to values starting from FSLRStructureElementAttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function FSLRStructureElement::getAttributeValueCount:. |
- (float) getAttributeValueFloat: | (FSLRStructureElementAttributeType) | type | |
index: | (int) | index | |
Get a float value (specified by index) for specified attribute type.
This function is available for attributes whose value type is FSLRStructureElementAttributeValueTypeFloat or FSLRStructureElementAttributeValueTypeFloatArray. For other value type, this function will return 0.0.
[in] | type | Attribute type. Please refer to values starting from FSLRStructureElementAttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function FSLRStructureElement::getAttributeValueCount:. |
- (int) getAttributeValueInt32: | (FSLRStructureElementAttributeType) | type | |
index: | (int) | index | |
Get an integer value (specified by index) for specified attribute type.
This function is available for attributes whose value type is FSLRStructureElementAttributeValueTypeInt32 or FSLRStructureElementAttributeValueTypeInt32Array. For other value type, this function will return 0.
[in] | type | Attribute type. Please refer to values starting from FSLRStructureElementAttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function FSLRStructureElement::getAttributeValueCount:. |
- (NSString *) getAttributeValueString: | (FSLRStructureElementAttributeType) | type | |
index: | (int) | index | |
Get a string value (specified by index) for specified attribute type.
This function is available for attributes whose value type is FSLRStructureElementAttributeValueTypeWStr or FSLRStructureElementAttributeValueTypeWStrArray. For other value type, this function will return an empty string.
[in] | type | Attribute type. Please refer to values starting from FSLRStructureElementAttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function FSLRStructureElement::getAttributeValueCount:. |
- (FSLRStructureElementAttributeValueType) getAttributeValueType: | (FSLRStructureElementAttributeType) | type |
Get attribute value type for a specified attribute type.
[in] | type | Attribute type. Please refer to values starting from FSLRStructureElementAttributeTypeRole and this should be one of these values. |
- (FSRectF *) getBBox |
Get bounding box.
- (FSLRElement *) getChild: | (int) | index |
Get a child element by index.
[in] | index | Index of a child element to be retrieved. Valid range: from 0 to (count-1). count is returned by function FSLRStructureElement::getChildCount. |
- (int) getChildCount |
Get the count of children elements.
- (FSLRStructureElement *) getParentElement |
Get the parent element.
- (FSLRStructureElementAttributeType) getSupportedAttribute: | (int) | index |
Get a supported attribute type by index.
[in] | index | Index for a supported attribute whose type is to be retrieved. Valid range: from 0 to (count-1). count is returned by function FSLRStructureElement::getSupportedAttributeCount. |
- (int) getSupportedAttributeCount |
Get supported attribute count.
- (id) initWithElement: | (FSLRElement*) | element |
Constructor, with parent class object.
[in] | element | Parent class object. |
- (id) initWithOther: | (FSLRStructureElement*) | other |
Constructor, with another structure element object.
[in] | other | Another structure element object. |
+ (BOOL) isArrayAttributeValueType: | (FSLRStructureElementAttributeValueType) | type |
Check whether input attribute value type represents an array.
[in] | type | Attribute value type. Please refer to values starting from FSLRStructureElementAttributeValueTypeEmpty and this should be one of these values. |
+ (FSLRStructureElementAttributeType) parseAttributeType: | (NSString *) | type_string |
Parse a string representation for attribute type and retrieve the enum value for this attribute type.
[in] | type_string | A string representation for a structure element attribute type. |
+ (NSString *) stringifyAttributeType: | (FSLRStructureElementAttributeType) | type |
Convert the enum value of a specified attribute type to a short and memorable string (text) representation.
[in] | type | Enum value of a specified attribute type. Please refer to values starting from FSLRStructureElementAttributeTypeInvalid and this should be one of these values. |
+ (NSString *) stringifyEnumVariant: | (FSLRStructureElementAttributeValueEnum) | type |
Convert the enum value of a specified attribute value enum to a short and memorable string (text) representation.
[in] | type | Enum value of a specified attribute value enum. Please refer to values starting from FSLRStructureElementAttributeValueEnumInvalid and this should be one of these values. |