foxit::addon::accessibility::AccessibilityDictionaryTreeItemData Class Reference

Inherits Object.

Public Types
enum	DictionaryValueType {   e_DictionaryValueTypeArray = 0, e_DictionaryValueTypeBoolean = 1, e_DictionaryValueTypeDictionary = 2, e_DictionaryValueTypeFixedPoint = 3,   e_DictionaryValueTypeInt = 4, e_DictionaryValueTypeName = 5, e_DictionaryValueTypeString = 6, e_DictionaryValueTypeDocClass = 7,   e_DictionaryValueTypeAttributeObject = 8, e_DictionaryValueTypeAttributeClassesRoot = 9, e_DictionaryValueTypeDocumentClassesRoot = 10, e_DictionaryValueTypeAttributeObjectsRoot = 11 }
	Enumeration for dictionary value type. More...
enum	TreeItemStatus { e_TreeItemStatusNormal = 0, e_TreeItemStatusAdd = 1, e_TreeItemStatusDelete = 2, e_TreeItemStatusChange = 3 }
	Enumeration for the edit status of a dictionary tree item. More...

Public Member Functions
	AccessibilityDictionaryTreeItemData ()
	Constructor.
	AccessibilityDictionaryTreeItemData (const wchar_t *item_name, const char *item_id, const wchar_t *key, const wchar_t *value, DictionaryValueType value_type, TreeItemStatus status)
	Constructor, with parameters. More...
	AccessibilityDictionaryTreeItemData (const AccessibilityDictionaryTreeItemData &other)
	Constructor, with another accessibility dictionary tree item data object. More...
AccessibilityDictionaryTreeItemData &	operator= (const AccessibilityDictionaryTreeItemData &other)
	Assign operator. More...
void	Set (const wchar_t *item_name, const char *item_id, const wchar_t *key, const wchar_t *value, DictionaryValueType value_type, TreeItemStatus status)
	Set value. More...

Public Attributes
String	item_id
	The item ID.
WString	item_name
	The item name.
WString	key
	The dictionary key.
TreeItemStatus	status
	The edit status of the tree item. Please refer to values starting from foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::e_TreeItemStatusNormal and this should be one of these values.
WString	value
	The dictionary value.
DictionaryValueType	value_type
	The dictionary value type. Please refer to values starting from foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::e_DictionaryValueTypeArray and this should be one of these values.

Detailed Description

This class represents accessibility dictionary tree item data.

Member Enumeration Documentation

DictionaryValueType

enum foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::DictionaryValueType

Enumeration for dictionary value type.

Values of this enumeration should be used alone.

Enumerator
e_DictionaryValueTypeArray	Dictionary value type: array.
e_DictionaryValueTypeBoolean	Dictionary value type: boolean.
e_DictionaryValueTypeDictionary	Dictionary value type: dictionary/object.
e_DictionaryValueTypeFixedPoint	Dictionary value type: fixed point number.
e_DictionaryValueTypeInt	Dictionary value type: integer.
e_DictionaryValueTypeName	Dictionary value type: name object.
e_DictionaryValueTypeString	Dictionary value type: string object.
e_DictionaryValueTypeDocClass	Dictionary value type: document class.
e_DictionaryValueTypeAttributeObject	Dictionary value type: attribute object.
e_DictionaryValueTypeAttributeClassesRoot	Dictionary value type: attribute classes root.
e_DictionaryValueTypeDocumentClassesRoot	Dictionary value type: document classes root.
e_DictionaryValueTypeAttributeObjectsRoot	Dictionary value type: attribute objects root.

TreeItemStatus

enum foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::TreeItemStatus

Enumeration for the edit status of a dictionary tree item.

Values of this enumeration should be used alone.

Enumerator
e_TreeItemStatusNormal	Edit status: normal, the item is unchanged.
e_TreeItemStatusAdd	Edit status: added, the item is newly added.
e_TreeItemStatusDelete	Edit status: deleted, the item is marked as deleted.
e_TreeItemStatusChange	Edit status: changed, the item value has been modified.

Constructor & Destructor Documentation

AccessibilityDictionaryTreeItemData() [1/2]

foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::AccessibilityDictionaryTreeItemData ( const wchar_t *  item_name, const char *  item_id, const wchar_t *  key, const wchar_t *  value, DictionaryValueType  value_type, TreeItemStatus  status  )

inline

Constructor, with parameters.

Parameters

[in]	item_name	The item name.
[in]	item_id	The item ID.
[in]	key	The dictionary key.
[in]	value	The dictionary value.
[in]	value_type	The dictionary value type.
[in]	status	The status.

AccessibilityDictionaryTreeItemData() [2/2]

foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::AccessibilityDictionaryTreeItemData ( const AccessibilityDictionaryTreeItemData &  other )

inline

Constructor, with another accessibility dictionary tree item data object.

Parameters

[in]

other

Another accessibility dictionary tree item data object.

Member Function Documentation

operator=()

AccessibilityDictionaryTreeItemData& foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::operator= ( const AccessibilityDictionaryTreeItemData &  other )

inline

Assign operator.

Parameters

[in]

other

Another accessibility dictionary tree item data object, whose value would be assigned to current object.

Returns

Reference to current object itself.

Set()

void foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::Set ( const wchar_t *  item_name, const char *  item_id, const wchar_t *  key, const wchar_t *  value, DictionaryValueType  value_type, TreeItemStatus  status  )

inline

Set value.

Parameters

[in]	item_name	The item name.
[in]	item_id	The item ID.
[in]	key	The dictionary key.
[in]	value	The dictionary value.
[in]	value_type	The dictionary value type.
[in]	status	The status.

Returns

None.