Foxit PDF SDK
fs_accessibility.h
浏览该文件的文档.
1 
15 #ifndef FS_ACCESSIBILITY_H_
16 #define FS_ACCESSIBILITY_H_
17 
18 #include "common/fs_common.h"
19 #include "pdf/fs_pdfdoc.h"
20 #include "pdf/fs_pdfpage.h"
21 #include "pdf/annots/fs_annot.h"
22 
28 namespace foxit {
32 namespace addon {
36 namespace accessibility {
42 typedef enum _RuleType {
107 } RuleType;
108 
114 typedef enum _CheckState {
131 } CheckState;
132 
133 
137 class AccessibilityRectInfo FS_FINAL : public Object {
138  public:
141  : data_index(-1) {}
142 
149  rect = other.rect;
150  data_index = other.data_index;
151  }
152 
161  rect = other.rect;
162  data_index = other.data_index;
163  return *this;
164  }
165 
175  void Set(const RectF& rect, int data_index) {
176  this->rect = rect;
177  this->data_index = data_index;
178  }
179 
182 
187 };
188 
191 
192 
195 class AccessibilityLineInfo FS_FINAL : public Object {
196  public:
199 
206  AccessibilityLineInfo(const PointF& start_point, const PointF& end_point) {
207  this->start_point = start_point;
208  this->end_point = end_point;
209  }
210 
217  start_point = other.start_point;
218  end_point = other.end_point;
219  }
220 
229  start_point = other.start_point;
230  end_point = other.end_point;
231  return *this;
232  }
233 
242  void Set(const PointF& start_point, const PointF& end_point) {
243  this->start_point = start_point;
244  this->end_point = end_point;
245  }
246 
249 
252 };
253 
256 
257 
260 class AccessibilityTextInfo FS_FINAL : public Object {
261  public:
264  : data_index(-1) {}
265 
273  text = other.text;
274  rect = other.rect;
275  data_index = other.data_index;
276  text_color = other.text_color;
277  background_color = other.background_color;
278  border_color = other.border_color;
279  }
280 
290  text = other.text;
291  rect = other.rect;
292  data_index = other.data_index;
293  text_color = other.text_color;
294  background_color = other.background_color;
295  border_color = other.border_color;
296  return *this;
297  }
298 
312  void Set(WString text, const RectF& rect, int data_index,
313  foxit::RGB text_color, foxit::RGB background_color, foxit::RGB border_color) {
314  this->text = text;
315  this->rect = rect;
316  this->data_index = data_index;
317  this->text_color = text_color;
318  this->background_color = background_color;
319  this->border_color = border_color;
320  }
321 
336 };
337 
340 
341 
344 class AccessibilityCheckOptions FS_FINAL : public Object {
345  public:
351  typedef enum _CheckValidateRuleType {
353  e_CheckValidateRuleTypeDocPermission = 0x0101,
355  e_CheckValidateRuleTypeDocPureImage = 0x0102,
357  e_CheckValidateRuleTypeDocTagged = 0x0103,
359  e_CheckValidateRuleTypeDocStructTreeOrder = 0x0104,
361  e_CheckValidateRuleTypeDocLanguageSpecified = 0x0105,
363  e_CheckValidateRuleTypeDocTitle = 0x0106,
365  e_CheckValidateRuleTypeDocOutlineForLarge = 0x0107,
367  e_CheckValidateRuleTypeDocColorContrast = 0x0108,
369  e_CheckValidateRuleTypePageContentTagged = 0x0109,
371  e_CheckValidateRuleTypePageAnnotTagged = 0x010A,
373  e_CheckValidateRuleTypePageTabOrder = 0x010B,
375  e_CheckValidateRuleTypePageFontEncoding = 0x010C,
377  e_CheckValidateRuleTypePageMultimediaObjectTagged = 0x010D,
379  e_CheckValidateRuleTypePageNoFlickering = 0x010E,
381  e_CheckValidateRuleTypePageNoInaccessibleScript = 0x010F,
383  e_CheckValidateRuleTypePageNoTimedResponse = 0x0110,
385  e_CheckValidateRuleTypePageNavigationLinkRepeat = 0x0111,
387  e_CheckValidateRuleTypeFormFieldTagged = 0x0112,
389  e_CheckValidateRuleTypeFormFieldAltText = 0x0113,
391  e_CheckValidateRuleTypeTableRowsUsed = 0x0114,
393  e_CheckValidateRuleTypeTableThTdUsed = 0x0115,
395  e_CheckValidateRuleTypeTableHeadersExist = 0x0116,
397  e_CheckValidateRuleTypeTableSpanCorrect = 0x0117,
399  e_CheckValidateRuleTypeTableSummary = 0x0118,
401  e_CheckValidateRuleTypeListItemsUsed = 0x0119,
403  e_CheckValidateRuleTypeListLblLbodyUsed = 0x011A,
405  e_CheckValidateRuleTypeFigureAltText = 0x011B,
407  e_CheckValidateRuleTypeNoNestedAltText = 0x011C,
409  e_CheckValidateRuleTypeAltTextHasContent = 0x011D,
411  e_CheckValidateRuleTypeAltTextHideAnnot = 0x011E,
413  e_CheckValidateRuleTypeElementAltText = 0x011F,
415  e_CheckValidateRuleTypeHeadingProperNest = 0x0120
416  } CheckValidateRuleType;
417 
418 
421 
428  check_rule_array = other.check_rule_array;
429  page_range = other.page_range;
430  }
431 
440  check_rule_array = other.check_rule_array;
441  page_range = other.page_range;
442  return *this;
443  }
444 
456  void Set(UInt32Array check_rule_array, foxit::common::Range page_range) {
457  this->check_rule_array = check_rule_array;
458  this->page_range = page_range;
459  }
460 
469 };
470 
475  public:
478  : page_index(-1)
479  , can_show_in_tags(false) {}
480 
491  AccessibilityCheckResultDetailData(const wchar_t* item_name, const char* item_id, const wchar_t* explain_url,
492  int page_index, const RectF& item_rect, bool can_show_in_tags)
494  , item_id(item_id)
499 
507  this->item_name = other.item_name;
508  this->item_id = other.item_id;
509  this->explain_url = other.explain_url;
510  this->page_index = other.page_index;
511  this->item_rect = other.item_rect;
512  this->can_show_in_tags = other.can_show_in_tags;
513  }
514 
524  this->item_name = other.item_name;
525  this->item_id = other.item_id;
526  this->explain_url = other.explain_url;
527  this->page_index = other.page_index;
528  this->item_rect = other.item_rect;
529  this->can_show_in_tags = other.can_show_in_tags;
530  return *this;
531  }
532 
545  void Set(const wchar_t* item_name, const char* item_id, const wchar_t* explain_url,
546  int page_index, const RectF& item_rect, bool can_show_in_tags) {
547  this->item_name = item_name;
548  this->item_id = item_id;
549  this->explain_url = explain_url;
550  this->page_index = page_index;
551  this->item_rect = item_rect;
552  this->can_show_in_tags = can_show_in_tags;
553  }
554 
567 };
568 
571 
572 
576  public:
579  : item_rule(e_RuleTypeDocPermission)
580  , item_state(e_CheckStateNone) {}
581 
592  AccessibilityCheckResultSubItemData(const wchar_t* item_name, const wchar_t* item_full_name, const wchar_t* explain_url,
593  RuleType item_rule, CheckState item_state,
594  AccessibilityCheckResultDetailDataArray detail_data_array)
595  : item_name(item_name)
596  , item_full_name(item_full_name)
597  , explain_url(explain_url)
598  , item_rule(item_rule)
599  , item_state(item_state)
600  , detail_data_array(detail_data_array) {}
601 
609  this->item_name = other.item_name;
610  this->item_full_name = other.item_full_name;
611  this->explain_url = other.explain_url;
612  this->item_rule = other.item_rule;
613  this->item_state = other.item_state;
614  this->detail_data_array = other.detail_data_array;
615  }
616 
626  this->item_name = other.item_name;
627  this->item_full_name = other.item_full_name;
628  this->explain_url = other.explain_url;
629  this->item_rule = other.item_rule;
630  this->item_state = other.item_state;
631  this->detail_data_array = other.detail_data_array;
632  return *this;
633  }
634 
647  void Set(const wchar_t* item_name, const wchar_t* item_full_name, const wchar_t* explain_url,
648  RuleType item_rule, CheckState item_state,
649  AccessibilityCheckResultDetailDataArray detail_data_array) {
650  this->item_name = item_name;
651  this->item_full_name = item_full_name;
652  this->explain_url = explain_url;
653  this->item_rule = item_rule;
654  this->item_state = item_state;
655  this->detail_data_array = detail_data_array;
656  }
657 
676 };
677 
680 
681 
684 class AccessibilityCheckResultItemData FS_FINAL : public Object {
685  public:
688  : issues_num(0) {}
689 
699  AccessibilityCheckResultItemData(const wchar_t* item_name, const wchar_t* item_full_name, const wchar_t* explain_url,
700  int issues_num, AccessibilityCheckResultSubItemDataArray subitem_array)
701  : item_name(item_name)
702  , item_full_name(item_full_name)
703  , explain_url(explain_url)
704  , issues_num(issues_num)
705  , subitem_array(subitem_array) {}
706 
714  this->issues_num = other.issues_num;
715  this->item_name = other.item_name;
716  this->item_full_name = other.item_full_name;
717  this->explain_url = other.explain_url;
718  this->subitem_array = other.subitem_array;
719  }
720 
730  this->issues_num = other.issues_num;
731  this->item_name = other.item_name;
732  this->item_full_name = other.item_full_name;
733  this->explain_url = other.explain_url;
734  this->subitem_array = other.subitem_array;
735  return *this;
736  }
737 
749  void Set(const wchar_t* item_name, const wchar_t* item_full_name, const wchar_t* explain_url,
750  int issues_num, AccessibilityCheckResultSubItemDataArray subitem_array) {
751  this->issues_num = issues_num;
752  this->item_full_name = item_full_name;
753  this->item_name = item_name;
754  this->explain_url = explain_url;
755  this->subitem_array = subitem_array;
756  }
757 
768 };
769 
772 
773 
776 class AccessibilityFindResult FS_FINAL : public Object {
777  public:
780  : page_index(-1) {}
781 
789  AccessibilityFindResult(const foxit::RectFArray& rects, const wchar_t* result_type, int page_index)
790  : rects(rects)
791  , result_type(result_type)
792  , page_index(page_index) {}
793 
800  rects = other.rects;
801  result_type = other.result_type;
802  page_index = other.page_index;
803  }
804 
813  rects = other.rects;
814  result_type = other.result_type;
815  page_index = other.page_index;
816  return *this;
817  }
818 
828  void Set(const foxit::RectFArray& rects, const wchar_t* result_type, int page_index) {
829  this->rects = rects;
830  this->result_type = result_type;
831  this->page_index = page_index;
832  }
833 
840 };
841 
846  public:
852  typedef enum _DictionaryValueType {
878 
884  typedef enum _TreeItemStatus {
893  } TreeItemStatus;
894 
895 
900 
911  AccessibilityDictionaryTreeItemData(const wchar_t* item_name, const char* item_id, const wchar_t* key,
914  , item_id(item_id)
915  , key(key)
916  , value(value)
918  , status(status) {}
919 
926  this->item_name = other.item_name;
927  this->item_id = other.item_id;
928  this->key = other.key;
929  this->value = other.value;
930  this->value_type = other.value_type;
931  this->status = other.status;
932  }
933 
942  this->item_name = other.item_name;
943  this->item_id = other.item_id;
944  this->key = other.key;
945  this->value = other.value;
946  this->value_type = other.value_type;
947  this->status = other.status;
948  return *this;
949  }
950 
963  void Set(const wchar_t* item_name, const char* item_id, const wchar_t* key,
965  this->item_name = item_name;
966  this->item_id = item_id;
967  this->key = key;
968  this->value = value;
969  this->value_type = value_type;
970  this->status = status;
971  }
972 
987 };
988 
991 
992 
995 class AccessibilityDictionaryTreeItem FS_FINAL : public Object {
996  public:
999 
1008  const AccessibilityDictionaryTreeItemDataArray& children_items_data,
1009  const char* parent_item_id)
1010  : item_data(item_data)
1011  , children_items_data(children_items_data)
1012  , parent_item_id(parent_item_id) {}
1013 
1020  this->item_data = other.item_data;
1021  this->children_items_data = other.children_items_data;
1022  this->parent_item_id = other.parent_item_id;
1023  }
1024 
1033  this->item_data = other.item_data;
1034  this->children_items_data = other.children_items_data;
1035  this->parent_item_id = other.parent_item_id;
1036  return (*this);
1037  }
1038 
1049  const AccessibilityDictionaryTreeItemDataArray& children_items_data,
1050  const char* parent_item_id) {
1051  this->item_data = item_data;
1052  this->children_items_data = children_items_data;
1053  this->parent_item_id = parent_item_id;
1054  }
1055 
1062 };
1063 
1064 FSDK_DEFINE_ARRAY(AccessibilityDictionaryTreeItemArray, AccessibilityDictionaryTreeItem)
1065 
1066 
1073  public:
1079  virtual void Release() = 0;
1080 
1087  typedef enum _DrawRectType {
1089  e_DrawRectTypeContent = 0,
1091  e_DrawRectTypeTableCell = 1,
1093  e_DrawRectTypeTableFigure = 2,
1095  e_DrawRectTypeOrderRect = 3,
1097  e_DrawRectTypeText = 4,
1099  e_DrawRectTypeTableLabel = 5,
1101  e_DrawRectTypeLine = 6,
1103  e_DrawRectTypeLabel = 7,
1105  e_DrawRectTypeTableCellsType = 8,
1107  e_DrawRectTypeTableCellsBorder = 9,
1109  e_DrawRectTypeTableCellsSelectedBorder = 10,
1111  e_DrawRectTypeTableCellsHeaderBackground = 11,
1113  e_DrawRectTypeTableCellsDataBackground = 12,
1115  e_DrawRectTypeTableCellsHeaderBackgroundMultispan = 13,
1117  e_DrawRectTypeTableCellsDataBackgroundMultispan = 14,
1119  e_DrawRectTypeTableCellsHeaderBackgroundMissingHeader = 15,
1121  e_DrawRectTypeTableCellsDataBackgroundMissingHeader = 16
1122  } DrawRectType;
1123 
1124 
1133  virtual bool GenerateContent(const foxit::pdf::PDFDoc& pdf_doc, int page_index) = 0;
1134 
1144  virtual void OnContentChanged(const foxit::pdf::PDFDoc& pdf_doc, int page_index, bool is_notify_self) = 0;
1145 
1153  virtual WString GetDocumentFileName(const foxit::pdf::PDFDoc& pdf_doc) = 0;
1154 
1162  virtual WString GetTextStringByStringID(const WString& string_id) = 0;
1163 
1176  virtual void DrawRect(const foxit::pdf::PDFDoc& pdf_doc, int page_index, DrawRectType type, const AccessibilityRectInfoArray& rect_info_array) = 0;
1177 
1190  virtual void DrawLine(const foxit::pdf::PDFDoc& pdf_doc, int page_index, DrawRectType type, const AccessibilityLineInfoArray& line_info_array) = 0;
1191 
1204  virtual void DrawText(const foxit::pdf::PDFDoc& pdf_doc, int page_index, DrawRectType type, const AccessibilityTextInfoArray& text_info_array) = 0;
1205 
1206  protected:
1208 };
1209 
1216  public:
1222  virtual WString GetIdentityName() = 0;
1223 
1229  virtual WString GetIdentityOrganization() = 0;
1230 
1238  virtual WString GetURL(const WString& linkInfo) = 0;
1239 
1247  virtual WString GetTextName(const WString& stringID) = 0;
1248 
1254  virtual void ReportCheckResult(const AccessibilityCheckResultItemDataArray& item_array) = 0;
1255 
1256  protected:
1258 };
1259 
1268 class AccessibilityNavigator FS_FINAL : public Base {
1269  public:
1275  typedef enum _FinderType {
1290  } FinderType;
1291 
1292 
1298  explicit AccessibilityNavigator(const foxit::pdf::PDFDoc& pdf_doc);
1299 
1300  explicit AccessibilityNavigator(FS_HANDLE handle);
1301 
1304 
1311 
1320 
1328  bool operator==(const AccessibilityNavigator& other) const;
1329 
1337  bool operator!=(const AccessibilityNavigator& other) const;
1338 
1346  bool IsEmpty() const;
1347 
1353  void StartFindNextElement();
1354 
1364  AccessibilityFindResult FindNextElement(int page_index, FinderType find_type, bool is_search_page);
1365 
1371  void StopFindNextElement();
1372 };
1373 
1383 class AccessibilityChecker FS_FINAL : public Base {
1384  public:
1390  explicit AccessibilityChecker(const foxit::pdf::PDFDoc& pdf_doc);
1391 
1392  explicit AccessibilityChecker(FS_HANDLE handle);
1393 
1396 
1403 
1412 
1420  bool operator==(const AccessibilityChecker& other) const;
1421 
1429  bool operator!=(const AccessibilityChecker& other) const;
1430 
1438  bool IsEmpty() const;
1439 
1445  bool CanCheck();
1446 
1458  foxit::common::file::StreamCallback* report_callback,
1460  common::PauseCallback* pause);
1461 
1471  const AccessibilityCheckResultItemData& root_data);
1472 
1483  const AccessibilityCheckResultItemData& root_data,
1484  const AccessibilityCheckResultSubItemData& sub_item_data);
1485 
1496  const AccessibilityCheckResultSubItemData& sub_item_data,
1497  const CheckState& new_check_state);
1498 
1509  const AccessibilityCheckResultItemData& root_data,
1510  const AccessibilityCheckResultSubItemData& sub_item_data);
1511 
1520  String GetTagTreeNodeIDByCheckResultItemID(int page_index, const char* item_id);
1521 
1527  bool UpdateCheckResultReport();
1528 
1537  bool UpdateCheckState(const RuleType& rule_type, const CheckState& check_state);
1538 };
1539 
1549 class AccessibilityFixer FS_FINAL : public Base {
1550  public:
1556  explicit AccessibilityFixer(const foxit::pdf::PDFDoc& pdf_doc);
1557 
1558  explicit AccessibilityFixer(FS_HANDLE handle);
1559 
1562 
1568  AccessibilityFixer(const AccessibilityFixer& other);
1569 
1578 
1586  bool operator==(const AccessibilityFixer& other) const;
1587 
1595  bool operator!=(const AccessibilityFixer& other) const;
1596 
1604  bool IsEmpty() const;
1605 
1614  bool CanFixRules(const RuleType& check_rule, const CheckState& check_state);
1615 
1624  bool CanFixPermissionRules(const RuleType& check_rule, bool is_ocr_enabled);
1625 
1633  bool FixDocumentLanguage(const wchar_t* lang);
1634 
1641 
1652  bool FixDocumentTitle(const wchar_t* title, const wchar_t* subject, const wchar_t* author, const wchar_t* keywords);
1653 
1661  bool FixDocumentBookmark(const WStringArray& roles_array);
1662 
1668  bool FixDocumentPermission();
1669 
1675  bool FixDocumentTag();
1676 
1682  bool FixPageTabOrder();
1683 
1691  bool FixFigureAltText(const AccessibilityCheckResultDetailDataArray& detail_data_array);
1692 
1698  bool FixFormFieldTagged();
1699 
1705  bool FixFormFieldDescriptions();
1706 };
1707 
1708 } // namespace accessibility
1709 } // namespace addon
1710 } // namespace foxit
1711 #endif // FS_ACCESSIBILITY_H_
字典值类型:整数。
Definition: fs_accessibility.h:862
void Set(const wchar_t *item_name, const char *item_id, const wchar_t *key, const wchar_t *value, DictionaryValueType value_type, TreeItemStatus status)
设置值。
Definition: fs_accessibility.h:963
AccessibilityRectInfo & operator=(const AccessibilityRectInfo &other)
赋值操作符。
Definition: fs_accessibility.h:160
规则:页面链接。
Definition: fs_accessibility.h:76
WString explain_url
与此项相关的说明或指导链接 URL。
Definition: fs_accessibility.h:560
编辑状态:删除,节点已被标记为删除。
Definition: fs_accessibility.h:890
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)
构造函数,使用参数构造。
Definition: fs_accessibility.h:592
Definition: fs_accessibility.h:260
int page_index
此项所在的页面索引。
Definition: fs_accessibility.h:562
AccessibilityChecker & operator=(const AccessibilityChecker &other)
赋值操作符。
DictionaryValueType value_type
字典值类型。请参考从 foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::e_DictionaryValueTypeArr...
Definition: fs_accessibility.h:983
void StartFindNextElement()
开始查找下一个元素。
AccessibilityNavigator(const foxit::pdf::PDFDoc &pdf_doc)
构造函数。
规则:页面内容是否已标记。
Definition: fs_accessibility.h:60
AccessibilityTextInfo(const AccessibilityTextInfo &other)
构造函数,使用另一个可访问性文本信息对象构造。
Definition: fs_accessibility.h:272
字典值类型:文档类根节点。
Definition: fs_accessibility.h:874
WString item_full_name
此检查项的完整描述名称。
Definition: fs_accessibility.h:761
Definition: fs_common.h:1368
AccessibilityTextInfo()
构造函数。
Definition: fs_accessibility.h:263
AccessibilityCheckResultDetailDataArray detail_data_array
属于此子项的详情项。
Definition: fs_accessibility.h:675
AccessibilityCheckResultSubItemData & operator=(const AccessibilityCheckResultSubItemData &other)
赋值操作符。
Definition: fs_accessibility.h:625
AccessibilityCheckResultDetailData & operator=(const AccessibilityCheckResultDetailData &other)
赋值操作符。
Definition: fs_accessibility.h:523
WString item_name
此检查项的显示名称。
Definition: fs_accessibility.h:759
WString item_full_name
此检查子项的完整描述名称。
Definition: fs_accessibility.h:661
CFX_Object Object
对象类型。
Definition: fs_basictypes.h:220
Definition: fs_accessibility.h:195
检查状态:无。
Definition: fs_accessibility.h:116
virtual void ReportCheckResult(const AccessibilityCheckResultItemDataArray &item_array)=0
报告完整检查的结果。
检查状态:已跳过。
Definition: fs_accessibility.h:124
WString item_name
此检查子项的显示名称。
Definition: fs_accessibility.h:659
规则:替代文本不应隐藏注释。
Definition: fs_accessibility.h:102
AccessibilityDictionaryTreeItem(const AccessibilityDictionaryTreeItemData &item_data, const AccessibilityDictionaryTreeItemDataArray &children_items_data, const char *parent_item_id)
构造函数,使用参数构造。
Definition: fs_accessibility.h:1007
AccessibilityCheckOptions & operator=(const AccessibilityCheckOptions &other)
赋值操作符。
Definition: fs_accessibility.h:439
foxit::RectF rect
文本内容的边界矩形。
Definition: fs_accessibility.h:325
规则:页面闪烁。
Definition: fs_accessibility.h:70
PDF文档相关定义和类的头文件。
规则:文档权限。
Definition: fs_accessibility.h:44
字典值类型:文档类。
Definition: fs_accessibility.h:868
WString value
字典值。
Definition: fs_accessibility.h:980
AccessibilityDictionaryTreeItemData item_data
项的信息。
Definition: fs_accessibility.h:1057
规则:页面注释是否已标记。
Definition: fs_accessibility.h:62
AccessibilityCheckOptions()
构造函数。
Definition: fs_accessibility.h:420
Definition: fs_basictypes.h:227
bool operator==(const AccessibilityChecker &other) const
等于操作符。
FinderType
查找器类型枚举。
Definition: fs_accessibility.h:1275
bool IsEmpty() const
检查当前对象是否为空。
uint32 RGB
RGB 颜色类型,24 位,((b) | ((g) << 8) | ((r) << 16)))
Definition: fs_basictypes.h:211
检查状态:未通过。
Definition: fs_accessibility.h:120
Definition: fx_coordinates.h:30
AccessibilityCheckResultItemData RemoveSkippedStateInResultTree(AccessibilityCheckOptions check_options, const AccessibilityCheckResultItemData &root_data, const AccessibilityCheckResultSubItemData &sub_item_data)
移除结果树中的"已跳过"状态。
WString result_type
结果类型。
Definition: fs_accessibility.h:837
CheckState
检查状态枚举。
Definition: fs_accessibility.h:114
查找器类型:未标记的注释。
Definition: fs_accessibility.h:1285
规则:替代文本应有内容。
Definition: fs_accessibility.h:100
编辑状态:修改,节点的值已发生变更。
Definition: fs_accessibility.h:892
AccessibilityDictionaryTreeItem()
构造函数。
Definition: fs_accessibility.h:998
WString FixDocumentTitleWithExistingTitle()
使用已有标题修复文档标题。
查找器类型:未标记的批注。
Definition: fs_accessibility.h:1281
宽字符串类
Definition: fx_string.h:1457
规则:页面多媒体对象是否已标记。
Definition: fs_accessibility.h:68
AccessibilityFindResult()
构造函数。
Definition: fs_accessibility.h:779
规则:表单字段替代文本。
Definition: fs_accessibility.h:80
规则:文档标题。
Definition: fs_accessibility.h:54
bool UpdateCheckState(const RuleType &rule_type, const CheckState &check_state)
更新指定规则的检查状态。
String item_id
检查结果项的唯一标识符。
Definition: fs_accessibility.h:558
int data_index
将该矩形映射回本页阅读顺序(reading-order)数据中对应条目的索引。非负值为有效的顺序数据 索引;-1 表示该矩形不与任何顺序数据关联(默认值)。
Definition: fs_accessibility.h:186
bool CanFixRules(const RuleType &check_rule, const CheckState &check_state)
检查指定规则是否可被修复。
AccessibilityDictionaryTreeItemData(const AccessibilityDictionaryTreeItemData &other)
构造函数,使用另一个可访问性字典树项数据对象构造。
Definition: fs_accessibility.h:925
规则:文档是否为纯图像文档。
Definition: fs_accessibility.h:46
Definition: fs_pdfdoc.h:768
foxit::RectF item_rect
此项在页面上的边界矩形。
Definition: fs_accessibility.h:564
AccessibilityDictionaryTreeItem & operator=(const AccessibilityDictionaryTreeItem &other)
赋值操作符。
Definition: fs_accessibility.h:1032
bool operator!=(const AccessibilityChecker &other) const
不等于操作符。
foxit::RGB border_color
文本区域边框所使用的颜色。
Definition: fs_accessibility.h:335
bool UpdateCheckResultReport()
更新检查结果报告。
编辑状态:新增,节点为新添加。
Definition: fs_accessibility.h:888
AccessibilityCheckResultDetailData(const wchar_t *item_name, const char *item_id, const wchar_t *explain_url, int page_index, const RectF &item_rect, bool can_show_in_tags)
构造函数,使用参数构造。
Definition: fs_accessibility.h:491
规则:文档结构树顺序。
Definition: fs_accessibility.h:50
AccessibilityCheckResultItemData(const AccessibilityCheckResultItemData &other)
构造函数,使用另一个可访问性检查结果项数据对象构造。
Definition: fs_accessibility.h:713
AccessibilityFixer & operator=(const AccessibilityFixer &other)
赋值操作符。
Definition: fs_accessibility.h:1549
AccessibilityCheckResultItemData()
构造函数。
Definition: fs_accessibility.h:687
virtual WString GetTextName(const WString &stringID)=0
根据字符串 ID 获取文本内容字符串。
检查状态:最后一项。
Definition: fs_accessibility.h:130
规则:表单字段是否已标记。
Definition: fs_accessibility.h:78
bool FixDocumentTag()
修复文档标签。
规则:列表项是否正确使用。
Definition: fs_accessibility.h:92
字典值类型:名称对象。
Definition: fs_accessibility.h:864
void StopFindNextElement()
停止查找下一个元素。
bool operator==(const AccessibilityNavigator &other) const
等于操作符。
bool operator!=(const AccessibilityNavigator &other) const
不等于操作符。
bool CanCheck()
检查当前 PDF 文档是否可以进行完整检查。
AccessibilityFindResult & operator=(const AccessibilityFindResult &other)
赋值操作符。
Definition: fs_accessibility.h:812
规则:文档颜色对比度。
Definition: fs_accessibility.h:58
AccessibilityChecker(const foxit::pdf::PDFDoc &pdf_doc)
构造函数。
AccessibilityRectInfo()
构造函数。
Definition: fs_accessibility.h:140
查找器类型:未标记的链接。
Definition: fs_accessibility.h:1283
字典值类型:字符串对象。
Definition: fs_accessibility.h:866
PointF start_point
线条的起点。
Definition: fs_accessibility.h:248
AccessibilityCheckResultDetailData()
构造函数。
Definition: fs_accessibility.h:477
AccessibilityDictionaryTreeItem(const AccessibilityDictionaryTreeItem &other)
构造函数,使用另一个可访问性字典树项对象构造。
Definition: fs_accessibility.h:1019
foxit::RGB text_color
文本所使用的颜色。
Definition: fs_accessibility.h:331
规则:表格规整性(合并单元格是否正确)。
Definition: fs_accessibility.h:88
TreeItemStatus
字典树节点的编辑状态枚举。
Definition: fs_accessibility.h:884
bool FixDocumentLanguage(const wchar_t *lang)
修复文档语言。
bool FixDocumentTitle(const wchar_t *title, const wchar_t *subject, const wchar_t *author, const wchar_t *keywords)
修复文档标题。
规则:标题的正确嵌套。
Definition: fs_accessibility.h:106
foxit::common::Range page_range
要调整的页面范围,若为空表示所有页面。
Definition: fs_accessibility.h:468
检查状态:需人工检查。
Definition: fs_accessibility.h:122
文件流接口,用于读取和写入。
Definition: fx_stream.h:692
规则:页面 Tab 顺序。
Definition: fs_accessibility.h:64
AccessibilityDictionaryTreeItemData & operator=(const AccessibilityDictionaryTreeItemData &other)
赋值操作符。
Definition: fs_accessibility.h:941
规则:替代文本不允许嵌套。
Definition: fs_accessibility.h:98
WString text
用于可访问性可视化展示的文本内容。
Definition: fs_accessibility.h:323
注释相关定义和类的头文件。
bool IsEmpty() const
检查当前对象是否为空。
AccessibilityDictionaryTreeItemData()
构造函数。
Definition: fs_accessibility.h:897
AccessibilityTextInfo & operator=(const AccessibilityTextInfo &other)
赋值操作符。
Definition: fs_accessibility.h:289
bool FixFormFieldTagged()
修复表单字段标记。
Definition: fx_basic.h:3737
AccessibilityCheckResultItemData RecheckResult(AccessibilityCheckOptions check_options, const AccessibilityCheckResultItemData &root_data)
按结果根节点重新检查。
void Set(const RectF &rect, int data_index)
设置值。
Definition: fs_accessibility.h:175
bool IsEmpty() const
检查当前对象是否为空。
foxit::RectFArray rects
查找结果的矩形集合。
Definition: fs_accessibility.h:835
AccessibilityFindResult(const AccessibilityFindResult &other)
构造函数,使用另一个可访问性查找结果对象构造。
Definition: fs_accessibility.h:799
规则:文档是否已标记。
Definition: fs_accessibility.h:48
WString key
字典键。
Definition: fs_accessibility.h:978
String parent_item_id
父项 ID。
Definition: fs_accessibility.h:1061
common::Progressive StartCheck(AccessibilityCheckOptions check_options, foxit::common::file::StreamCallback *report_callback, AccessibilityCheckResultsCallback *provider, common::PauseCallback *pause)
开始进行可访问性检查。
Definition: fs_common.h:377
规则:页面脚本。
Definition: fs_accessibility.h:72
规则:表格 TH 与 TD 是否正确使用。
Definition: fs_accessibility.h:84
AccessibilityCheckResultItemData ChangeCheckStateInResultTree(const AccessibilityCheckResultItemData &root_data, const AccessibilityCheckResultSubItemData &sub_item_data, const CheckState &new_check_state)
更改结果树中的检查状态。
Definition: fs_accessibility.h:137
WString item_name
检查结果项的显示名称。
Definition: fs_accessibility.h:556
void Set(WString text, const RectF &rect, int data_index, foxit::RGB text_color, foxit::RGB background_color, foxit::RGB border_color)
设置值。
Definition: fs_accessibility.h:312
AccessibilityRectInfo(const AccessibilityRectInfo &other)
构造函数,使用另一个可访问性矩形信息对象构造。
Definition: fs_accessibility.h:148
Definition: fs_accessibility.h:1383
WString explain_url
与此子项相关的说明或指导链接 URL。
Definition: fs_accessibility.h:663
void Set(const AccessibilityDictionaryTreeItemData &item_data, const AccessibilityDictionaryTreeItemDataArray &children_items_data, const char *parent_item_id)
设置值。
Definition: fs_accessibility.h:1048
void * FS_HANDLE
句柄类型。
Definition: fs_basictypes.h:213
Definition: fs_accessibility.h:1268
WString explain_url
与此检查项相关的说明或指导链接 URL。
Definition: fs_accessibility.h:763
查找器类型:OCR 检测到的疑似项。
Definition: fs_accessibility.h:1289
规则:文档书签。
Definition: fs_accessibility.h:56
通用定义和类的头文件。
字典值类型:布尔值。
Definition: fs_accessibility.h:856
检查状态:人工确认未通过。
Definition: fs_accessibility.h:128
查找器类型:无效。
Definition: fs_accessibility.h:1277
AccessibilityCheckResultItemData(const wchar_t *item_name, const wchar_t *item_full_name, const wchar_t *explain_url, int issues_num, AccessibilityCheckResultSubItemDataArray subitem_array)
构造函数,使用参数构造。
Definition: fs_accessibility.h:699
virtual WString GetIdentityOrganization()=0
获取身份所属组织。
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)
设置值。
Definition: fs_accessibility.h:647
AccessibilityCheckOptions(const AccessibilityCheckOptions &other)
构造函数,使用另一个可访问性检查选项对象构造。
Definition: fs_accessibility.h:427
void Set(const wchar_t *item_name, const char *item_id, const wchar_t *explain_url, int page_index, const RectF &item_rect, bool can_show_in_tags)
设置值。
Definition: fs_accessibility.h:545
void Set(const PointF &start_point, const PointF &end_point)
设置值。
Definition: fs_accessibility.h:242
WString item_name
项名称。
Definition: fs_accessibility.h:974
PointF end_point
线条的终点。
Definition: fs_accessibility.h:251
Definition: fs_basictypes.h:471
bool can_show_in_tags
此项是否可以在标签树视图中显示。
Definition: fs_accessibility.h:566
AccessibilityNavigator & operator=(const AccessibilityNavigator &other)
赋值操作符。
RuleType
规则类型枚举。
Definition: fs_accessibility.h:42
AccessibilityDictionaryTreeItemData(const wchar_t *item_name, const char *item_id, const wchar_t *key, const wchar_t *value, DictionaryValueType value_type, TreeItemStatus status)
构造函数,使用参数构造。
Definition: fs_accessibility.h:911
AccessibilityCheckResultSubItemData(const AccessibilityCheckResultSubItemData &other)
构造函数,使用另一个可访问性检查结果子项数据对象构造。
Definition: fs_accessibility.h:608
bool operator==(const AccessibilityFixer &other) const
等于操作符。
编辑状态:正常,节点未发生任何修改。
Definition: fs_accessibility.h:886
PDF页面相关定义和类的头文件。
字典值类型:字典/对象。
Definition: fs_accessibility.h:858
CheckState item_state
此子项在所关联规则下的检查状态。 请参考从 foxit::addon::accessibility::e_CheckStateNone 开始的值, 本参数应为其中之一。
Definition: fs_accessibility.h:673
int issues_num
此检查项发现的问题数量。
Definition: fs_accessibility.h:765
String item_id
项 ID。
Definition: fs_accessibility.h:976
int data_index
将该文本项映射回本页阅读顺序(reading-order)数据中对应条目的索引。非负值为有效的顺序数据 索引;-1 表示该文本项不与任何顺序数据关联(默认值)。
Definition: fs_accessibility.h:329
AccessibilityFindResult(const foxit::RectFArray &rects, const wchar_t *result_type, int page_index)
构造函数,使用参数构造。
Definition: fs_accessibility.h:789
foxit::RGB background_color
文本区域的背景填充色。
Definition: fs_accessibility.h:333
查找器类型:人工元素(页面人工元素)。
Definition: fs_accessibility.h:1279
规则:表格表头是否存在。
Definition: fs_accessibility.h:86
Foxit命名空间。
Definition: fs_pdf3d.h:26
规则:列表标签(Lbl)与列表正文(LBody)是否正确使用。
Definition: fs_accessibility.h:94
规则:页面响应。
Definition: fs_accessibility.h:74
规则:图形的替代文本。
Definition: fs_accessibility.h:96
AccessibilityCheckResultItemData & operator=(const AccessibilityCheckResultItemData &other)
赋值操作符。
Definition: fs_accessibility.h:729
字节字符串类
Definition: fx_string.h:317
规则:表格行是否正确使用。
Definition: fs_accessibility.h:82
int page_index
页面索引。
Definition: fs_accessibility.h:839
bool CanFixPermissionRules(const RuleType &check_rule, bool is_ocr_enabled)
检查权限相关规则是否可被修复。
bool FixDocumentBookmark(const WStringArray &roles_array)
修复文档书签。
规则:文档是否指定了语言。
Definition: fs_accessibility.h:52
bool FixFormFieldDescriptions()
修复表单字段描述。
virtual WString GetURL(const WString &linkInfo)=0
根据链接信息获取链接。
AccessibilityLineInfo()
构造函数。
Definition: fs_accessibility.h:198
bool FixDocumentPermission()
修复文档权限。
void Set(const wchar_t *item_name, const wchar_t *item_full_name, const wchar_t *explain_url, int issues_num, AccessibilityCheckResultSubItemDataArray subitem_array)
设置值。
Definition: fs_accessibility.h:749
bool operator!=(const AccessibilityFixer &other) const
不等于操作符。
AccessibilityCheckResultSubItemData()
构造函数。
Definition: fs_accessibility.h:578
TreeItemStatus status
树项的编辑状态。请参考从 foxit::addon::accessibility::AccessibilityDictionaryTreeItemData::e_TreeItemStatusNormal...
Definition: fs_accessibility.h:986
UInt32Array check_rule_array
待检查规则的数组。 请参考从 foxit::addon::accessibility::AccessibilityCheckOptions::e_CheckValidateRuleTypeDocPerm...
Definition: fs_accessibility.h:466
foxit::RectF rect
矩形。
Definition: fs_accessibility.h:181
AccessibilityCheckResultDetailData(const AccessibilityCheckResultDetailData &other)
构造函数,使用另一个可访问性检查结果详情数据对象构造。
Definition: fs_accessibility.h:506
查找器类型:未标记的页面内容。
Definition: fs_accessibility.h:1287
规则:表格摘要。
Definition: fs_accessibility.h:90
void Set(const foxit::RectFArray &rects, const wchar_t *result_type, int page_index)
设置值。
Definition: fs_accessibility.h:828
AccessibilityDictionaryTreeItemDataArray children_items_data
子项的信息。
Definition: fs_accessibility.h:1059
字典值类型:属性对象根节点。
Definition: fs_accessibility.h:876
AccessibilityFixer(const foxit::pdf::PDFDoc &pdf_doc)
构造函数。
检查状态:人工确认通过。
Definition: fs_accessibility.h:126
AccessibilityFindResult FindNextElement(int page_index, FinderType find_type, bool is_search_page)
查找下一个元素。
RuleType item_rule
与此子项关联的可访问性规则。 请参考从 foxit::addon::accessibility::e_RuleTypeDocPermission 开始的值, 本参数应为其中之一。
Definition: fs_accessibility.h:668
virtual WString GetIdentityName()=0
获取身份名称。
AccessibilityLineInfo(const AccessibilityLineInfo &other)
构造函数,使用另一个可访问性线条信息对象构造。
Definition: fs_accessibility.h:216
void Set(UInt32Array check_rule_array, foxit::common::Range page_range)
设置值。
Definition: fs_accessibility.h:456
检查状态:通过。
Definition: fs_accessibility.h:118
String GetTagTreeNodeIDByCheckResultItemID(int page_index, const char *item_id)
根据检查结果项 ID 获取标签树节点 ID。
DictionaryValueType
字典值类型枚举。
Definition: fs_accessibility.h:852
规则:其他元素的替代文本。
Definition: fs_accessibility.h:104
AccessibilityLineInfo(const PointF &start_point, const PointF &end_point)
构造函数,使用起点和终点构造。
Definition: fs_accessibility.h:206
bool FixFigureAltText(const AccessibilityCheckResultDetailDataArray &detail_data_array)
修复图形替代文本。
规则:页面字体编码。
Definition: fs_accessibility.h:66
AccessibilityLineInfo & operator=(const AccessibilityLineInfo &other)
赋值操作符。
Definition: fs_accessibility.h:228
bool FixPageTabOrder()
修复页面 Tab 顺序。
Definition: fx_coordinates.h:771
字典值类型:属性类根节点。
Definition: fs_accessibility.h:872
AccessibilityCheckResultSubItemDataArray subitem_array
此检查项下的子项。
Definition: fs_accessibility.h:767