ARIAMixin.h 8.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194
  1. /*
  2. * Copyright (c) 2022, Jonah Shafran <jonahshafran@gmail.com>
  3. *
  4. * SPDX-License-Identifier: BSD-2-Clause
  5. */
  6. #pragma once
  7. #include <AK/String.h>
  8. #include <AK/Vector.h>
  9. #include <LibWeb/ARIA/AriaData.h>
  10. #include <LibWeb/ARIA/Roles.h>
  11. #include <LibWeb/WebIDL/ExceptionOr.h>
  12. namespace Web::ARIA {
  13. class ARIAMixin {
  14. public:
  15. virtual ~ARIAMixin() = default;
  16. virtual Optional<String> role() const = 0;
  17. virtual WebIDL::ExceptionOr<void> set_role(Optional<String> const&) = 0;
  18. virtual Optional<String> aria_active_descendant() const = 0;
  19. virtual WebIDL::ExceptionOr<void> set_aria_active_descendant(Optional<String> const&) = 0;
  20. virtual Optional<String> aria_atomic() const = 0;
  21. virtual WebIDL::ExceptionOr<void> set_aria_atomic(Optional<String> const&) = 0;
  22. virtual Optional<String> aria_auto_complete() const = 0;
  23. virtual WebIDL::ExceptionOr<void> set_aria_auto_complete(Optional<String> const&) = 0;
  24. virtual Optional<String> aria_busy() const = 0;
  25. virtual WebIDL::ExceptionOr<void> set_aria_busy(Optional<String> const&) = 0;
  26. virtual Optional<String> aria_checked() const = 0;
  27. virtual WebIDL::ExceptionOr<void> set_aria_checked(Optional<String> const&) = 0;
  28. virtual Optional<String> aria_col_count() const = 0;
  29. virtual WebIDL::ExceptionOr<void> set_aria_col_count(Optional<String> const&) = 0;
  30. virtual Optional<String> aria_col_index() const = 0;
  31. virtual WebIDL::ExceptionOr<void> set_aria_col_index(Optional<String> const&) = 0;
  32. virtual Optional<String> aria_col_span() const = 0;
  33. virtual WebIDL::ExceptionOr<void> set_aria_col_span(Optional<String> const&) = 0;
  34. virtual Optional<String> aria_controls() const = 0;
  35. virtual WebIDL::ExceptionOr<void> set_aria_controls(Optional<String> const&) = 0;
  36. virtual Optional<String> aria_current() const = 0;
  37. virtual WebIDL::ExceptionOr<void> set_aria_current(Optional<String> const&) = 0;
  38. virtual Optional<String> aria_described_by() const = 0;
  39. virtual WebIDL::ExceptionOr<void> set_aria_described_by(Optional<String> const&) = 0;
  40. virtual Optional<String> aria_details() const = 0;
  41. virtual WebIDL::ExceptionOr<void> set_aria_details(Optional<String> const&) = 0;
  42. virtual Optional<String> aria_disabled() const = 0;
  43. virtual WebIDL::ExceptionOr<void> set_aria_disabled(Optional<String> const&) = 0;
  44. virtual Optional<String> aria_drop_effect() const = 0;
  45. virtual WebIDL::ExceptionOr<void> set_aria_drop_effect(Optional<String> const&) = 0;
  46. virtual Optional<String> aria_error_message() const = 0;
  47. virtual WebIDL::ExceptionOr<void> set_aria_error_message(Optional<String> const&) = 0;
  48. virtual Optional<String> aria_expanded() const = 0;
  49. virtual WebIDL::ExceptionOr<void> set_aria_expanded(Optional<String> const&) = 0;
  50. virtual Optional<String> aria_flow_to() const = 0;
  51. virtual WebIDL::ExceptionOr<void> set_aria_flow_to(Optional<String> const&) = 0;
  52. virtual Optional<String> aria_grabbed() const = 0;
  53. virtual WebIDL::ExceptionOr<void> set_aria_grabbed(Optional<String> const&) = 0;
  54. virtual Optional<String> aria_has_popup() const = 0;
  55. virtual WebIDL::ExceptionOr<void> set_aria_has_popup(Optional<String> const&) = 0;
  56. virtual Optional<String> aria_hidden() const = 0;
  57. virtual WebIDL::ExceptionOr<void> set_aria_hidden(Optional<String> const&) = 0;
  58. virtual Optional<String> aria_invalid() const = 0;
  59. virtual WebIDL::ExceptionOr<void> set_aria_invalid(Optional<String> const&) = 0;
  60. virtual Optional<String> aria_key_shortcuts() const = 0;
  61. virtual WebIDL::ExceptionOr<void> set_aria_key_shortcuts(Optional<String> const&) = 0;
  62. virtual Optional<String> aria_label() const = 0;
  63. virtual WebIDL::ExceptionOr<void> set_aria_label(Optional<String> const&) = 0;
  64. virtual Optional<String> aria_labelled_by() const = 0;
  65. virtual WebIDL::ExceptionOr<void> set_aria_labelled_by(Optional<String> const&) = 0;
  66. virtual Optional<String> aria_level() const = 0;
  67. virtual WebIDL::ExceptionOr<void> set_aria_level(Optional<String> const&) = 0;
  68. virtual Optional<String> aria_live() const = 0;
  69. virtual WebIDL::ExceptionOr<void> set_aria_live(Optional<String> const&) = 0;
  70. virtual Optional<String> aria_modal() const = 0;
  71. virtual WebIDL::ExceptionOr<void> set_aria_modal(Optional<String> const&) = 0;
  72. virtual Optional<String> aria_multi_line() const = 0;
  73. virtual WebIDL::ExceptionOr<void> set_aria_multi_line(Optional<String> const&) = 0;
  74. virtual Optional<String> aria_multi_selectable() const = 0;
  75. virtual WebIDL::ExceptionOr<void> set_aria_multi_selectable(Optional<String> const&) = 0;
  76. virtual Optional<String> aria_orientation() const = 0;
  77. virtual WebIDL::ExceptionOr<void> set_aria_orientation(Optional<String> const&) = 0;
  78. virtual Optional<String> aria_owns() const = 0;
  79. virtual WebIDL::ExceptionOr<void> set_aria_owns(Optional<String> const&) = 0;
  80. virtual Optional<String> aria_placeholder() const = 0;
  81. virtual WebIDL::ExceptionOr<void> set_aria_placeholder(Optional<String> const&) = 0;
  82. virtual Optional<String> aria_pos_in_set() const = 0;
  83. virtual WebIDL::ExceptionOr<void> set_aria_pos_in_set(Optional<String> const&) = 0;
  84. virtual Optional<String> aria_pressed() const = 0;
  85. virtual WebIDL::ExceptionOr<void> set_aria_pressed(Optional<String> const&) = 0;
  86. virtual Optional<String> aria_read_only() const = 0;
  87. virtual WebIDL::ExceptionOr<void> set_aria_read_only(Optional<String> const&) = 0;
  88. virtual Optional<String> aria_relevant() const = 0;
  89. virtual WebIDL::ExceptionOr<void> set_aria_relevant(Optional<String> const&) = 0;
  90. virtual Optional<String> aria_required() const = 0;
  91. virtual WebIDL::ExceptionOr<void> set_aria_required(Optional<String> const&) = 0;
  92. virtual Optional<String> aria_role_description() const = 0;
  93. virtual WebIDL::ExceptionOr<void> set_aria_role_description(Optional<String> const&) = 0;
  94. virtual Optional<String> aria_row_count() const = 0;
  95. virtual WebIDL::ExceptionOr<void> set_aria_row_count(Optional<String> const&) = 0;
  96. virtual Optional<String> aria_row_index() const = 0;
  97. virtual WebIDL::ExceptionOr<void> set_aria_row_index(Optional<String> const&) = 0;
  98. virtual Optional<String> aria_row_span() const = 0;
  99. virtual WebIDL::ExceptionOr<void> set_aria_row_span(Optional<String> const&) = 0;
  100. virtual Optional<String> aria_selected() const = 0;
  101. virtual WebIDL::ExceptionOr<void> set_aria_selected(Optional<String> const&) = 0;
  102. virtual Optional<String> aria_set_size() const = 0;
  103. virtual WebIDL::ExceptionOr<void> set_aria_set_size(Optional<String> const&) = 0;
  104. virtual Optional<String> aria_sort() const = 0;
  105. virtual WebIDL::ExceptionOr<void> set_aria_sort(Optional<String> const&) = 0;
  106. virtual Optional<String> aria_value_max() const = 0;
  107. virtual WebIDL::ExceptionOr<void> set_aria_value_max(Optional<String> const&) = 0;
  108. virtual Optional<String> aria_value_min() const = 0;
  109. virtual WebIDL::ExceptionOr<void> set_aria_value_min(Optional<String> const&) = 0;
  110. virtual Optional<String> aria_value_now() const = 0;
  111. virtual WebIDL::ExceptionOr<void> set_aria_value_now(Optional<String> const&) = 0;
  112. virtual Optional<String> aria_value_text() const = 0;
  113. virtual WebIDL::ExceptionOr<void> set_aria_value_text(Optional<String> const&) = 0;
  114. // https://www.w3.org/TR/html-aria/#docconformance
  115. virtual Optional<Role> default_role() const { return {}; }
  116. Optional<Role> role_or_default() const;
  117. // https://www.w3.org/TR/wai-aria-1.2/#tree_exclusion
  118. virtual bool exclude_from_accessibility_tree() const = 0;
  119. // https://www.w3.org/TR/wai-aria-1.2/#tree_inclusion
  120. virtual bool include_in_accessibility_tree() const = 0;
  121. bool has_global_aria_attribute() const;
  122. // https://www.w3.org/TR/wai-aria-1.2/#valuetype_idref
  123. Optional<String> parse_id_reference(Optional<String> const&) const;
  124. // https://www.w3.org/TR/wai-aria-1.2/#valuetype_idref_list
  125. Vector<String> parse_id_reference_list(Optional<String> const&) const;
  126. protected:
  127. ARIAMixin() = default;
  128. virtual bool id_reference_exists(String const&) const = 0;
  129. };
  130. }