Foxit PDF SDK
foxit::addon::accessibility::AccessibilityCheckResultSubItemData Class Reference

Inherits Object.

Public Member Functions

 AccessibilityCheckResultSubItemData ()
 Constructor.
 
 AccessibilityCheckResultSubItemData (const AccessibilityCheckResultSubItemData &other)
 Constructor, with another accessibility check result sub item data object. More...
 
 AccessibilityCheckResultSubItemData (const wchar_t *item_name, const wchar_t *item_full_name, const wchar_t *explain_url, RuleType item_rule, CheckState item_state, AccessibilityCheckResultDetailDataArray detail_data_array)
 Constructor, with parameters. More...
 
AccessibilityCheckResultSubItemData & operator= (const AccessibilityCheckResultSubItemData &other)
 Assign operator. More...
 
void Set (const wchar_t *item_name, const wchar_t *item_full_name, const wchar_t *explain_url, RuleType item_rule, CheckState item_state, AccessibilityCheckResultDetailDataArray detail_data_array)
 Set value. More...
 

Public Attributes

AccessibilityCheckResultDetailDataArray detail_data_array
 The detail items belonging to this sub-item.
 
WString explain_url
 The URL for explanation or guidance related to this sub-item.
 
WString item_full_name
 The full descriptive name of this check sub-item.
 
WString item_name
 The display name of this check sub-item.
 
RuleType item_rule
 The accessibility rule associated with this sub-item. Please refer to values starting from foxit::addon::accessibility::e_RuleTypeDocPermission and this should be one of these values.
 
CheckState item_state
 The check state of this sub-item under the associated rule. Please refer to values starting from foxit::addon::accessibility::e_CheckStateNone and this should be one of these values.
 

Detailed Description

This class represents accessibility check result sub item data.

Constructor & Destructor Documentation

◆ AccessibilityCheckResultSubItemData() [1/2]

foxit::addon::accessibility::AccessibilityCheckResultSubItemData::AccessibilityCheckResultSubItemData ( const wchar_t *  item_name,
const wchar_t *  item_full_name,
const wchar_t *  explain_url,
RuleType  item_rule,
CheckState  item_state,
AccessibilityCheckResultDetailDataArray  detail_data_array 
)
inline

Constructor, with parameters.

Parameters
[in]item_nameThe display name of this check sub-item.
[in]item_full_nameThe full descriptive name of this check sub-item.
[in]explain_urlThe URL for explanation or guidance related to this sub-item.
[in]item_ruleThe accessibility rule associated with this sub-item.
[in]item_stateThe check state of this sub-item under the associated rule.
[in]detail_data_arrayThe detail items belonging to this sub-item.

◆ AccessibilityCheckResultSubItemData() [2/2]

foxit::addon::accessibility::AccessibilityCheckResultSubItemData::AccessibilityCheckResultSubItemData ( const AccessibilityCheckResultSubItemData &  other)
inline

Constructor, with another accessibility check result sub item data object.

Parameters
[in]otherAnother accessibility check result sub item data object whose values are copied to initialize the current object.

Member Function Documentation

◆ operator=()

AccessibilityCheckResultSubItemData& foxit::addon::accessibility::AccessibilityCheckResultSubItemData::operator= ( const AccessibilityCheckResultSubItemData &  other)
inline

Assign operator.

Parameters
[in]otherAnother accessibility check result sub item data object whose values are assigned to the current object.
Returns
Reference to current object itself.

◆ Set()

void foxit::addon::accessibility::AccessibilityCheckResultSubItemData::Set ( const wchar_t *  item_name,
const wchar_t *  item_full_name,
const wchar_t *  explain_url,
RuleType  item_rule,
CheckState  item_state,
AccessibilityCheckResultDetailDataArray  detail_data_array 
)
inline

Set value.

Parameters
[in]item_nameThe display name of this check sub-item.
[in]item_full_nameThe full descriptive name of this check sub-item.
[in]explain_urlThe URL for explanation or guidance related to this sub-item.
[in]item_ruleThe accessibility rule associated with this sub-item.
[in]item_stateThe check state of this sub-item under the associated rule.
[in]detail_data_arrayThe detail items belonging to this sub-item.
Returns
None.