accesskit.h 82 KB

12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078207920802081208220832084208520862087208820892090209120922093209420952096209720982099210021012102210321042105210621072108210921102111211221132114211521162117211821192120212121222123212421252126212721282129213021312132213321342135213621372138213921402141214221432144214521462147214821492150215121522153215421552156215721582159216021612162216321642165216621672168216921702171217221732174217521762177217821792180218121822183218421852186218721882189219021912192219321942195219621972198219922002201220222032204220522062207220822092210221122122213221422152216221722182219222022212222222322242225222622272228222922302231223222332234223522362237223822392240224122422243224422452246224722482249225022512252225322542255225622572258225922602261226222632264226522662267226822692270227122722273227422752276227722782279228022812282228322842285228622872288228922902291229222932294229522962297229822992300230123022303230423052306230723082309231023112312231323142315231623172318231923202321232223232324232523262327232823292330233123322333233423352336233723382339234023412342234323442345234623472348234923502351235223532354235523562357235823592360236123622363236423652366236723682369237023712372237323742375237623772378237923802381238223832384238523862387238823892390239123922393239423952396239723982399240024012402240324042405240624072408240924102411241224132414241524162417241824192420242124222423242424252426242724282429243024312432243324342435243624372438243924402441244224432444244524462447244824492450245124522453245424552456245724582459246024612462246324642465246624672468246924702471247224732474247524762477247824792480248124822483248424852486248724882489249024912492249324942495249624972498249925002501250225032504250525062507250825092510251125122513251425152516251725182519252025212522252325242525252625272528252925302531253225332534253525362537253825392540254125422543254425452546254725482549255025512552255325542555255625572558255925602561256225632564256525662567256825692570257125722573257425752576257725782579258025812582258325842585258625872588258925902591259225932594259525962597259825992600260126022603260426052606260726082609261026112612261326142615261626172618261926202621262226232624262526262627262826292630263126322633263426352636263726382639264026412642264326442645264626472648264926502651265226532654265526562657265826592660266126622663266426652666266726682669267026712672267326742675267626772678267926802681268226832684268526862687268826892690269126922693269426952696269726982699270027012702
  1. /**
  2. * Copyright 2023 The AccessKit Authors. All rights reserved.
  3. * Licensed under the Apache License, Version 2.0 (found in
  4. * the LICENSE-APACHE file) or the MIT license (found in
  5. * the LICENSE-MIT file), at your option.
  6. */
  7. #ifndef ACCESSKIT_H
  8. #define ACCESSKIT_H
  9. #include <stdarg.h>
  10. #include <stdbool.h>
  11. #include <stddef.h>
  12. #include <stdint.h>
  13. #include <stdlib.h>
  14. #ifdef _WIN32
  15. #include <windows.h>
  16. #endif
  17. /**
  18. * An action to be taken on an accessibility node.
  19. */
  20. enum accesskit_action
  21. #ifdef __cplusplus
  22. : uint8_t
  23. #endif // __cplusplus
  24. {
  25. /**
  26. * Do the equivalent of a single click or tap.
  27. */
  28. ACCESSKIT_ACTION_CLICK,
  29. ACCESSKIT_ACTION_FOCUS,
  30. ACCESSKIT_ACTION_BLUR,
  31. ACCESSKIT_ACTION_COLLAPSE,
  32. ACCESSKIT_ACTION_EXPAND,
  33. /**
  34. * Requires [`ActionRequest::data`] to be set to [`ActionData::CustomAction`].
  35. */
  36. ACCESSKIT_ACTION_CUSTOM_ACTION,
  37. /**
  38. * Decrement a numeric value by one step.
  39. */
  40. ACCESSKIT_ACTION_DECREMENT,
  41. /**
  42. * Increment a numeric value by one step.
  43. */
  44. ACCESSKIT_ACTION_INCREMENT,
  45. ACCESSKIT_ACTION_HIDE_TOOLTIP,
  46. ACCESSKIT_ACTION_SHOW_TOOLTIP,
  47. /**
  48. * Delete any selected text in the control's text value and
  49. * insert the specified value in its place, like when typing or pasting.
  50. * Requires [`ActionRequest::data`] to be set to [`ActionData::Value`].
  51. */
  52. ACCESSKIT_ACTION_REPLACE_SELECTED_TEXT,
  53. /**
  54. * Scroll down by the specified unit.
  55. */
  56. ACCESSKIT_ACTION_SCROLL_DOWN,
  57. /**
  58. * Scroll left by the specified unit.
  59. */
  60. ACCESSKIT_ACTION_SCROLL_LEFT,
  61. /**
  62. * Scroll right by the specified unit.
  63. */
  64. ACCESSKIT_ACTION_SCROLL_RIGHT,
  65. /**
  66. * Scroll up by the specified unit.
  67. */
  68. ACCESSKIT_ACTION_SCROLL_UP,
  69. /**
  70. * Scroll any scrollable containers to make the target node visible.
  71. * Optionally set [`ActionRequest::data`] to [`ActionData::ScrollHint`].
  72. */
  73. ACCESSKIT_ACTION_SCROLL_INTO_VIEW,
  74. /**
  75. * Scroll the given object to a specified point in the tree's container
  76. * (e.g. window). Requires [`ActionRequest::data`] to be set to
  77. * [`ActionData::ScrollToPoint`].
  78. */
  79. ACCESSKIT_ACTION_SCROLL_TO_POINT,
  80. /**
  81. * Requires [`ActionRequest::data`] to be set to
  82. * [`ActionData::SetScrollOffset`].
  83. */
  84. ACCESSKIT_ACTION_SET_SCROLL_OFFSET,
  85. /**
  86. * Requires [`ActionRequest::data`] to be set to
  87. * [`ActionData::SetTextSelection`].
  88. */
  89. ACCESSKIT_ACTION_SET_TEXT_SELECTION,
  90. /**
  91. * Don't focus this node, but set it as the sequential focus navigation
  92. * starting point, so that pressing Tab moves to the next element
  93. * following this one, for example.
  94. */
  95. ACCESSKIT_ACTION_SET_SEQUENTIAL_FOCUS_NAVIGATION_STARTING_POINT,
  96. /**
  97. * Replace the value of the control with the specified value and
  98. * reset the selection, if applicable. Requires [`ActionRequest::data`]
  99. * to be set to [`ActionData::Value`] or [`ActionData::NumericValue`].
  100. */
  101. ACCESSKIT_ACTION_SET_VALUE,
  102. ACCESSKIT_ACTION_SHOW_CONTEXT_MENU,
  103. };
  104. #ifndef __cplusplus
  105. typedef uint8_t accesskit_action;
  106. #endif // __cplusplus
  107. enum accesskit_aria_current
  108. #ifdef __cplusplus
  109. : uint8_t
  110. #endif // __cplusplus
  111. {
  112. ACCESSKIT_ARIA_CURRENT_FALSE,
  113. ACCESSKIT_ARIA_CURRENT_TRUE,
  114. ACCESSKIT_ARIA_CURRENT_PAGE,
  115. ACCESSKIT_ARIA_CURRENT_STEP,
  116. ACCESSKIT_ARIA_CURRENT_LOCATION,
  117. ACCESSKIT_ARIA_CURRENT_DATE,
  118. ACCESSKIT_ARIA_CURRENT_TIME,
  119. };
  120. #ifndef __cplusplus
  121. typedef uint8_t accesskit_aria_current;
  122. #endif // __cplusplus
  123. enum accesskit_auto_complete
  124. #ifdef __cplusplus
  125. : uint8_t
  126. #endif // __cplusplus
  127. {
  128. ACCESSKIT_AUTO_COMPLETE_INLINE,
  129. ACCESSKIT_AUTO_COMPLETE_LIST,
  130. ACCESSKIT_AUTO_COMPLETE_BOTH,
  131. };
  132. #ifndef __cplusplus
  133. typedef uint8_t accesskit_auto_complete;
  134. #endif // __cplusplus
  135. enum accesskit_has_popup
  136. #ifdef __cplusplus
  137. : uint8_t
  138. #endif // __cplusplus
  139. {
  140. ACCESSKIT_HAS_POPUP_MENU,
  141. ACCESSKIT_HAS_POPUP_LISTBOX,
  142. ACCESSKIT_HAS_POPUP_TREE,
  143. ACCESSKIT_HAS_POPUP_GRID,
  144. ACCESSKIT_HAS_POPUP_DIALOG,
  145. };
  146. #ifndef __cplusplus
  147. typedef uint8_t accesskit_has_popup;
  148. #endif // __cplusplus
  149. /**
  150. * Indicates if a form control has invalid input or if a web DOM element has an
  151. * [`aria-invalid`] attribute.
  152. *
  153. * [`aria-invalid`]: https://www.w3.org/TR/wai-aria-1.1/#aria-invalid
  154. */
  155. enum accesskit_invalid
  156. #ifdef __cplusplus
  157. : uint8_t
  158. #endif // __cplusplus
  159. {
  160. ACCESSKIT_INVALID_TRUE,
  161. ACCESSKIT_INVALID_GRAMMAR,
  162. ACCESSKIT_INVALID_SPELLING,
  163. };
  164. #ifndef __cplusplus
  165. typedef uint8_t accesskit_invalid;
  166. #endif // __cplusplus
  167. enum accesskit_list_style
  168. #ifdef __cplusplus
  169. : uint8_t
  170. #endif // __cplusplus
  171. {
  172. ACCESSKIT_LIST_STYLE_CIRCLE,
  173. ACCESSKIT_LIST_STYLE_DISC,
  174. ACCESSKIT_LIST_STYLE_IMAGE,
  175. ACCESSKIT_LIST_STYLE_NUMERIC,
  176. ACCESSKIT_LIST_STYLE_SQUARE,
  177. /**
  178. * Language specific ordering (alpha, roman, cjk-ideographic, etc...)
  179. */
  180. ACCESSKIT_LIST_STYLE_OTHER,
  181. };
  182. #ifndef __cplusplus
  183. typedef uint8_t accesskit_list_style;
  184. #endif // __cplusplus
  185. enum accesskit_live
  186. #ifdef __cplusplus
  187. : uint8_t
  188. #endif // __cplusplus
  189. {
  190. ACCESSKIT_LIVE_OFF,
  191. ACCESSKIT_LIVE_POLITE,
  192. ACCESSKIT_LIVE_ASSERTIVE,
  193. };
  194. #ifndef __cplusplus
  195. typedef uint8_t accesskit_live;
  196. #endif // __cplusplus
  197. enum accesskit_orientation
  198. #ifdef __cplusplus
  199. : uint8_t
  200. #endif // __cplusplus
  201. {
  202. /**
  203. * E.g. most toolbars and separators.
  204. */
  205. ACCESSKIT_ORIENTATION_HORIZONTAL,
  206. /**
  207. * E.g. menu or combo box.
  208. */
  209. ACCESSKIT_ORIENTATION_VERTICAL,
  210. };
  211. #ifndef __cplusplus
  212. typedef uint8_t accesskit_orientation;
  213. #endif // __cplusplus
  214. /**
  215. * The type of an accessibility node.
  216. *
  217. * The majority of these roles come from the ARIA specification. Reference
  218. * the latest draft for proper usage.
  219. *
  220. * Like the AccessKit schema as a whole, this list is largely taken
  221. * from Chromium. However, unlike Chromium's alphabetized list, this list
  222. * is ordered roughly by expected usage frequency (with the notable exception
  223. * of [`Role::Unknown`]). This is more efficient in serialization formats
  224. * where integers use a variable-length encoding.
  225. */
  226. enum accesskit_role
  227. #ifdef __cplusplus
  228. : uint8_t
  229. #endif // __cplusplus
  230. {
  231. ACCESSKIT_ROLE_UNKNOWN,
  232. ACCESSKIT_ROLE_TEXT_RUN,
  233. ACCESSKIT_ROLE_CELL,
  234. ACCESSKIT_ROLE_LABEL,
  235. ACCESSKIT_ROLE_IMAGE,
  236. ACCESSKIT_ROLE_LINK,
  237. ACCESSKIT_ROLE_ROW,
  238. ACCESSKIT_ROLE_LIST_ITEM,
  239. /**
  240. * Contains the bullet, number, or other marker for a list item.
  241. */
  242. ACCESSKIT_ROLE_LIST_MARKER,
  243. ACCESSKIT_ROLE_TREE_ITEM,
  244. ACCESSKIT_ROLE_LIST_BOX_OPTION,
  245. ACCESSKIT_ROLE_MENU_ITEM,
  246. ACCESSKIT_ROLE_MENU_LIST_OPTION,
  247. ACCESSKIT_ROLE_PARAGRAPH,
  248. /**
  249. * A generic container that should be ignored by assistive technologies
  250. * and filtered out of platform accessibility trees. Equivalent to the ARIA
  251. * `none` or `presentation` role, or to an HTML `div` with no role.
  252. */
  253. ACCESSKIT_ROLE_GENERIC_CONTAINER,
  254. ACCESSKIT_ROLE_CHECK_BOX,
  255. ACCESSKIT_ROLE_RADIO_BUTTON,
  256. ACCESSKIT_ROLE_TEXT_INPUT,
  257. ACCESSKIT_ROLE_BUTTON,
  258. ACCESSKIT_ROLE_DEFAULT_BUTTON,
  259. ACCESSKIT_ROLE_PANE,
  260. ACCESSKIT_ROLE_ROW_HEADER,
  261. ACCESSKIT_ROLE_COLUMN_HEADER,
  262. ACCESSKIT_ROLE_ROW_GROUP,
  263. ACCESSKIT_ROLE_LIST,
  264. ACCESSKIT_ROLE_TABLE,
  265. ACCESSKIT_ROLE_LAYOUT_TABLE_CELL,
  266. ACCESSKIT_ROLE_LAYOUT_TABLE_ROW,
  267. ACCESSKIT_ROLE_LAYOUT_TABLE,
  268. ACCESSKIT_ROLE_SWITCH,
  269. ACCESSKIT_ROLE_MENU,
  270. ACCESSKIT_ROLE_MULTILINE_TEXT_INPUT,
  271. ACCESSKIT_ROLE_SEARCH_INPUT,
  272. ACCESSKIT_ROLE_DATE_INPUT,
  273. ACCESSKIT_ROLE_DATE_TIME_INPUT,
  274. ACCESSKIT_ROLE_WEEK_INPUT,
  275. ACCESSKIT_ROLE_MONTH_INPUT,
  276. ACCESSKIT_ROLE_TIME_INPUT,
  277. ACCESSKIT_ROLE_EMAIL_INPUT,
  278. ACCESSKIT_ROLE_NUMBER_INPUT,
  279. ACCESSKIT_ROLE_PASSWORD_INPUT,
  280. ACCESSKIT_ROLE_PHONE_NUMBER_INPUT,
  281. ACCESSKIT_ROLE_URL_INPUT,
  282. ACCESSKIT_ROLE_ABBR,
  283. ACCESSKIT_ROLE_ALERT,
  284. ACCESSKIT_ROLE_ALERT_DIALOG,
  285. ACCESSKIT_ROLE_APPLICATION,
  286. ACCESSKIT_ROLE_ARTICLE,
  287. ACCESSKIT_ROLE_AUDIO,
  288. ACCESSKIT_ROLE_BANNER,
  289. ACCESSKIT_ROLE_BLOCKQUOTE,
  290. ACCESSKIT_ROLE_CANVAS,
  291. ACCESSKIT_ROLE_CAPTION,
  292. ACCESSKIT_ROLE_CARET,
  293. ACCESSKIT_ROLE_CODE,
  294. ACCESSKIT_ROLE_COLOR_WELL,
  295. ACCESSKIT_ROLE_COMBO_BOX,
  296. ACCESSKIT_ROLE_EDITABLE_COMBO_BOX,
  297. ACCESSKIT_ROLE_COMPLEMENTARY,
  298. ACCESSKIT_ROLE_COMMENT,
  299. ACCESSKIT_ROLE_CONTENT_DELETION,
  300. ACCESSKIT_ROLE_CONTENT_INSERTION,
  301. ACCESSKIT_ROLE_CONTENT_INFO,
  302. ACCESSKIT_ROLE_DEFINITION,
  303. ACCESSKIT_ROLE_DESCRIPTION_LIST,
  304. ACCESSKIT_ROLE_DESCRIPTION_LIST_DETAIL,
  305. ACCESSKIT_ROLE_DESCRIPTION_LIST_TERM,
  306. ACCESSKIT_ROLE_DETAILS,
  307. ACCESSKIT_ROLE_DIALOG,
  308. ACCESSKIT_ROLE_DIRECTORY,
  309. ACCESSKIT_ROLE_DISCLOSURE_TRIANGLE,
  310. ACCESSKIT_ROLE_DOCUMENT,
  311. ACCESSKIT_ROLE_EMBEDDED_OBJECT,
  312. ACCESSKIT_ROLE_EMPHASIS,
  313. ACCESSKIT_ROLE_FEED,
  314. ACCESSKIT_ROLE_FIGURE_CAPTION,
  315. ACCESSKIT_ROLE_FIGURE,
  316. ACCESSKIT_ROLE_FOOTER,
  317. ACCESSKIT_ROLE_FOOTER_AS_NON_LANDMARK,
  318. ACCESSKIT_ROLE_FORM,
  319. ACCESSKIT_ROLE_GRID,
  320. ACCESSKIT_ROLE_GROUP,
  321. ACCESSKIT_ROLE_HEADER,
  322. ACCESSKIT_ROLE_HEADER_AS_NON_LANDMARK,
  323. ACCESSKIT_ROLE_HEADING,
  324. ACCESSKIT_ROLE_IFRAME,
  325. ACCESSKIT_ROLE_IFRAME_PRESENTATIONAL,
  326. ACCESSKIT_ROLE_IME_CANDIDATE,
  327. ACCESSKIT_ROLE_KEYBOARD,
  328. ACCESSKIT_ROLE_LEGEND,
  329. ACCESSKIT_ROLE_LINE_BREAK,
  330. ACCESSKIT_ROLE_LIST_BOX,
  331. ACCESSKIT_ROLE_LOG,
  332. ACCESSKIT_ROLE_MAIN,
  333. ACCESSKIT_ROLE_MARK,
  334. ACCESSKIT_ROLE_MARQUEE,
  335. ACCESSKIT_ROLE_MATH,
  336. ACCESSKIT_ROLE_MENU_BAR,
  337. ACCESSKIT_ROLE_MENU_ITEM_CHECK_BOX,
  338. ACCESSKIT_ROLE_MENU_ITEM_RADIO,
  339. ACCESSKIT_ROLE_MENU_LIST_POPUP,
  340. ACCESSKIT_ROLE_METER,
  341. ACCESSKIT_ROLE_NAVIGATION,
  342. ACCESSKIT_ROLE_NOTE,
  343. ACCESSKIT_ROLE_PLUGIN_OBJECT,
  344. ACCESSKIT_ROLE_PORTAL,
  345. ACCESSKIT_ROLE_PRE,
  346. ACCESSKIT_ROLE_PROGRESS_INDICATOR,
  347. ACCESSKIT_ROLE_RADIO_GROUP,
  348. ACCESSKIT_ROLE_REGION,
  349. ACCESSKIT_ROLE_ROOT_WEB_AREA,
  350. ACCESSKIT_ROLE_RUBY,
  351. ACCESSKIT_ROLE_RUBY_ANNOTATION,
  352. ACCESSKIT_ROLE_SCROLL_BAR,
  353. ACCESSKIT_ROLE_SCROLL_VIEW,
  354. ACCESSKIT_ROLE_SEARCH,
  355. ACCESSKIT_ROLE_SECTION,
  356. ACCESSKIT_ROLE_SLIDER,
  357. ACCESSKIT_ROLE_SPIN_BUTTON,
  358. ACCESSKIT_ROLE_SPLITTER,
  359. ACCESSKIT_ROLE_STATUS,
  360. ACCESSKIT_ROLE_STRONG,
  361. ACCESSKIT_ROLE_SUGGESTION,
  362. ACCESSKIT_ROLE_SVG_ROOT,
  363. ACCESSKIT_ROLE_TAB,
  364. ACCESSKIT_ROLE_TAB_LIST,
  365. ACCESSKIT_ROLE_TAB_PANEL,
  366. ACCESSKIT_ROLE_TERM,
  367. ACCESSKIT_ROLE_TIME,
  368. ACCESSKIT_ROLE_TIMER,
  369. ACCESSKIT_ROLE_TITLE_BAR,
  370. ACCESSKIT_ROLE_TOOLBAR,
  371. ACCESSKIT_ROLE_TOOLTIP,
  372. ACCESSKIT_ROLE_TREE,
  373. ACCESSKIT_ROLE_TREE_GRID,
  374. ACCESSKIT_ROLE_VIDEO,
  375. ACCESSKIT_ROLE_WEB_VIEW,
  376. ACCESSKIT_ROLE_WINDOW,
  377. ACCESSKIT_ROLE_PDF_ACTIONABLE_HIGHLIGHT,
  378. ACCESSKIT_ROLE_PDF_ROOT,
  379. ACCESSKIT_ROLE_GRAPHICS_DOCUMENT,
  380. ACCESSKIT_ROLE_GRAPHICS_OBJECT,
  381. ACCESSKIT_ROLE_GRAPHICS_SYMBOL,
  382. ACCESSKIT_ROLE_DOC_ABSTRACT,
  383. ACCESSKIT_ROLE_DOC_ACKNOWLEDGEMENTS,
  384. ACCESSKIT_ROLE_DOC_AFTERWORD,
  385. ACCESSKIT_ROLE_DOC_APPENDIX,
  386. ACCESSKIT_ROLE_DOC_BACK_LINK,
  387. ACCESSKIT_ROLE_DOC_BIBLIO_ENTRY,
  388. ACCESSKIT_ROLE_DOC_BIBLIOGRAPHY,
  389. ACCESSKIT_ROLE_DOC_BIBLIO_REF,
  390. ACCESSKIT_ROLE_DOC_CHAPTER,
  391. ACCESSKIT_ROLE_DOC_COLOPHON,
  392. ACCESSKIT_ROLE_DOC_CONCLUSION,
  393. ACCESSKIT_ROLE_DOC_COVER,
  394. ACCESSKIT_ROLE_DOC_CREDIT,
  395. ACCESSKIT_ROLE_DOC_CREDITS,
  396. ACCESSKIT_ROLE_DOC_DEDICATION,
  397. ACCESSKIT_ROLE_DOC_ENDNOTE,
  398. ACCESSKIT_ROLE_DOC_ENDNOTES,
  399. ACCESSKIT_ROLE_DOC_EPIGRAPH,
  400. ACCESSKIT_ROLE_DOC_EPILOGUE,
  401. ACCESSKIT_ROLE_DOC_ERRATA,
  402. ACCESSKIT_ROLE_DOC_EXAMPLE,
  403. ACCESSKIT_ROLE_DOC_FOOTNOTE,
  404. ACCESSKIT_ROLE_DOC_FOREWORD,
  405. ACCESSKIT_ROLE_DOC_GLOSSARY,
  406. ACCESSKIT_ROLE_DOC_GLOSS_REF,
  407. ACCESSKIT_ROLE_DOC_INDEX,
  408. ACCESSKIT_ROLE_DOC_INTRODUCTION,
  409. ACCESSKIT_ROLE_DOC_NOTE_REF,
  410. ACCESSKIT_ROLE_DOC_NOTICE,
  411. ACCESSKIT_ROLE_DOC_PAGE_BREAK,
  412. ACCESSKIT_ROLE_DOC_PAGE_FOOTER,
  413. ACCESSKIT_ROLE_DOC_PAGE_HEADER,
  414. ACCESSKIT_ROLE_DOC_PAGE_LIST,
  415. ACCESSKIT_ROLE_DOC_PART,
  416. ACCESSKIT_ROLE_DOC_PREFACE,
  417. ACCESSKIT_ROLE_DOC_PROLOGUE,
  418. ACCESSKIT_ROLE_DOC_PULLQUOTE,
  419. ACCESSKIT_ROLE_DOC_QNA,
  420. ACCESSKIT_ROLE_DOC_SUBTITLE,
  421. ACCESSKIT_ROLE_DOC_TIP,
  422. ACCESSKIT_ROLE_DOC_TOC,
  423. /**
  424. * Behaves similar to an ARIA grid but is primarily used by Chromium's
  425. * `TableView` and its subclasses, so they can be exposed correctly
  426. * on certain platforms.
  427. */
  428. ACCESSKIT_ROLE_LIST_GRID,
  429. /**
  430. * This is just like a multi-line document, but signals that assistive
  431. * technologies should implement behavior specific to a VT-100-style
  432. * terminal.
  433. */
  434. ACCESSKIT_ROLE_TERMINAL,
  435. };
  436. #ifndef __cplusplus
  437. typedef uint8_t accesskit_role;
  438. #endif // __cplusplus
  439. /**
  440. * A suggestion about where the node being scrolled into view should be
  441. * positioned relative to the edges of the scrollable container.
  442. */
  443. enum accesskit_scroll_hint
  444. #ifdef __cplusplus
  445. : uint8_t
  446. #endif // __cplusplus
  447. {
  448. ACCESSKIT_SCROLL_HINT_TOP_LEFT,
  449. ACCESSKIT_SCROLL_HINT_BOTTOM_RIGHT,
  450. ACCESSKIT_SCROLL_HINT_TOP_EDGE,
  451. ACCESSKIT_SCROLL_HINT_BOTTOM_EDGE,
  452. ACCESSKIT_SCROLL_HINT_LEFT_EDGE,
  453. ACCESSKIT_SCROLL_HINT_RIGHT_EDGE,
  454. };
  455. #ifndef __cplusplus
  456. typedef uint8_t accesskit_scroll_hint;
  457. #endif // __cplusplus
  458. /**
  459. * The amount by which to scroll in the direction specified by one of the
  460. * `Scroll` actions.
  461. */
  462. enum accesskit_scroll_unit
  463. #ifdef __cplusplus
  464. : uint8_t
  465. #endif // __cplusplus
  466. {
  467. /**
  468. * A single item of a list, line of text (for vertical scrolling),
  469. * character (for horizontal scrolling), or an approximation of
  470. * one of these.
  471. */
  472. ACCESSKIT_SCROLL_UNIT_ITEM,
  473. /**
  474. * The amount of content that fits in the viewport.
  475. */
  476. ACCESSKIT_SCROLL_UNIT_PAGE,
  477. };
  478. #ifndef __cplusplus
  479. typedef uint8_t accesskit_scroll_unit;
  480. #endif // __cplusplus
  481. enum accesskit_sort_direction
  482. #ifdef __cplusplus
  483. : uint8_t
  484. #endif // __cplusplus
  485. {
  486. ACCESSKIT_SORT_DIRECTION_ASCENDING,
  487. ACCESSKIT_SORT_DIRECTION_DESCENDING,
  488. ACCESSKIT_SORT_DIRECTION_OTHER,
  489. };
  490. #ifndef __cplusplus
  491. typedef uint8_t accesskit_sort_direction;
  492. #endif // __cplusplus
  493. enum accesskit_text_align
  494. #ifdef __cplusplus
  495. : uint8_t
  496. #endif // __cplusplus
  497. {
  498. ACCESSKIT_TEXT_ALIGN_LEFT,
  499. ACCESSKIT_TEXT_ALIGN_RIGHT,
  500. ACCESSKIT_TEXT_ALIGN_CENTER,
  501. ACCESSKIT_TEXT_ALIGN_JUSTIFY,
  502. };
  503. #ifndef __cplusplus
  504. typedef uint8_t accesskit_text_align;
  505. #endif // __cplusplus
  506. enum accesskit_text_decoration
  507. #ifdef __cplusplus
  508. : uint8_t
  509. #endif // __cplusplus
  510. {
  511. ACCESSKIT_TEXT_DECORATION_SOLID,
  512. ACCESSKIT_TEXT_DECORATION_DOTTED,
  513. ACCESSKIT_TEXT_DECORATION_DASHED,
  514. ACCESSKIT_TEXT_DECORATION_DOUBLE,
  515. ACCESSKIT_TEXT_DECORATION_WAVY,
  516. };
  517. #ifndef __cplusplus
  518. typedef uint8_t accesskit_text_decoration;
  519. #endif // __cplusplus
  520. enum accesskit_text_direction
  521. #ifdef __cplusplus
  522. : uint8_t
  523. #endif // __cplusplus
  524. {
  525. ACCESSKIT_TEXT_DIRECTION_LEFT_TO_RIGHT,
  526. ACCESSKIT_TEXT_DIRECTION_RIGHT_TO_LEFT,
  527. ACCESSKIT_TEXT_DIRECTION_TOP_TO_BOTTOM,
  528. ACCESSKIT_TEXT_DIRECTION_BOTTOM_TO_TOP,
  529. };
  530. #ifndef __cplusplus
  531. typedef uint8_t accesskit_text_direction;
  532. #endif // __cplusplus
  533. enum accesskit_toggled
  534. #ifdef __cplusplus
  535. : uint8_t
  536. #endif // __cplusplus
  537. {
  538. ACCESSKIT_TOGGLED_FALSE,
  539. ACCESSKIT_TOGGLED_TRUE,
  540. ACCESSKIT_TOGGLED_MIXED,
  541. };
  542. #ifndef __cplusplus
  543. typedef uint8_t accesskit_toggled;
  544. #endif // __cplusplus
  545. enum accesskit_vertical_offset
  546. #ifdef __cplusplus
  547. : uint8_t
  548. #endif // __cplusplus
  549. {
  550. ACCESSKIT_VERTICAL_OFFSET_SUBSCRIPT,
  551. ACCESSKIT_VERTICAL_OFFSET_SUPERSCRIPT,
  552. };
  553. #ifndef __cplusplus
  554. typedef uint8_t accesskit_vertical_offset;
  555. #endif // __cplusplus
  556. typedef struct accesskit_custom_action accesskit_custom_action;
  557. #if defined(__APPLE__)
  558. typedef struct accesskit_macos_adapter accesskit_macos_adapter;
  559. #endif
  560. #if defined(__APPLE__)
  561. typedef struct accesskit_macos_queued_events accesskit_macos_queued_events;
  562. #endif
  563. #if defined(__APPLE__)
  564. typedef struct accesskit_macos_subclassing_adapter
  565. accesskit_macos_subclassing_adapter;
  566. #endif
  567. typedef struct accesskit_node accesskit_node;
  568. typedef struct accesskit_tree accesskit_tree;
  569. typedef struct accesskit_tree_update accesskit_tree_update;
  570. #if (defined(__linux__) || defined(__DragonFly__) || defined(__FreeBSD__) || \
  571. defined(__NetBSD__) || defined(__OpenBSD__))
  572. typedef struct accesskit_unix_adapter accesskit_unix_adapter;
  573. #endif
  574. #if defined(_WIN32)
  575. typedef struct accesskit_windows_adapter accesskit_windows_adapter;
  576. #endif
  577. #if defined(_WIN32)
  578. typedef struct accesskit_windows_queued_events accesskit_windows_queued_events;
  579. #endif
  580. #if defined(_WIN32)
  581. typedef struct accesskit_windows_subclassing_adapter
  582. accesskit_windows_subclassing_adapter;
  583. #endif
  584. typedef uint64_t accesskit_node_id;
  585. typedef struct accesskit_node_ids {
  586. size_t length;
  587. const accesskit_node_id *values;
  588. } accesskit_node_ids;
  589. /**
  590. * Represents an optional value.
  591. *
  592. * If `has_value` is false, do not read the `value` field.
  593. */
  594. typedef struct accesskit_opt_node_id {
  595. bool has_value;
  596. accesskit_node_id value;
  597. } accesskit_opt_node_id;
  598. /**
  599. * Represents an optional value.
  600. *
  601. * If `has_value` is false, do not read the `value` field.
  602. */
  603. typedef struct accesskit_opt_double {
  604. bool has_value;
  605. double value;
  606. } accesskit_opt_double;
  607. /**
  608. * Represents an optional value.
  609. *
  610. * If `has_value` is false, do not read the `value` field.
  611. */
  612. typedef struct accesskit_opt_index {
  613. bool has_value;
  614. size_t value;
  615. } accesskit_opt_index;
  616. /**
  617. * Represents an optional value.
  618. *
  619. * If `has_value` is false, do not read the `value` field.
  620. */
  621. typedef struct accesskit_opt_color {
  622. bool has_value;
  623. uint32_t value;
  624. } accesskit_opt_color;
  625. /**
  626. * Represents an optional value.
  627. *
  628. * If `has_value` is false, do not read the `value` field.
  629. */
  630. typedef struct accesskit_opt_text_decoration {
  631. bool has_value;
  632. accesskit_text_decoration value;
  633. } accesskit_opt_text_decoration;
  634. typedef struct accesskit_lengths {
  635. size_t length;
  636. const uint8_t *values;
  637. } accesskit_lengths;
  638. typedef struct accesskit_opt_coords {
  639. bool has_value;
  640. size_t length;
  641. const float *values;
  642. } accesskit_opt_coords;
  643. /**
  644. * Represents an optional value.
  645. *
  646. * If `has_value` is false, do not read the `value` field.
  647. */
  648. typedef struct accesskit_opt_bool {
  649. bool has_value;
  650. bool value;
  651. } accesskit_opt_bool;
  652. /**
  653. * Represents an optional value.
  654. *
  655. * If `has_value` is false, do not read the `value` field.
  656. */
  657. typedef struct accesskit_opt_invalid {
  658. bool has_value;
  659. accesskit_invalid value;
  660. } accesskit_opt_invalid;
  661. /**
  662. * Represents an optional value.
  663. *
  664. * If `has_value` is false, do not read the `value` field.
  665. */
  666. typedef struct accesskit_opt_toggled {
  667. bool has_value;
  668. accesskit_toggled value;
  669. } accesskit_opt_toggled;
  670. /**
  671. * Represents an optional value.
  672. *
  673. * If `has_value` is false, do not read the `value` field.
  674. */
  675. typedef struct accesskit_opt_live {
  676. bool has_value;
  677. accesskit_live value;
  678. } accesskit_opt_live;
  679. /**
  680. * Represents an optional value.
  681. *
  682. * If `has_value` is false, do not read the `value` field.
  683. */
  684. typedef struct accesskit_opt_text_direction {
  685. bool has_value;
  686. accesskit_text_direction value;
  687. } accesskit_opt_text_direction;
  688. /**
  689. * Represents an optional value.
  690. *
  691. * If `has_value` is false, do not read the `value` field.
  692. */
  693. typedef struct accesskit_opt_orientation {
  694. bool has_value;
  695. accesskit_orientation value;
  696. } accesskit_opt_orientation;
  697. /**
  698. * Represents an optional value.
  699. *
  700. * If `has_value` is false, do not read the `value` field.
  701. */
  702. typedef struct accesskit_opt_sort_direction {
  703. bool has_value;
  704. accesskit_sort_direction value;
  705. } accesskit_opt_sort_direction;
  706. /**
  707. * Represents an optional value.
  708. *
  709. * If `has_value` is false, do not read the `value` field.
  710. */
  711. typedef struct accesskit_opt_aria_current {
  712. bool has_value;
  713. accesskit_aria_current value;
  714. } accesskit_opt_aria_current;
  715. /**
  716. * Represents an optional value.
  717. *
  718. * If `has_value` is false, do not read the `value` field.
  719. */
  720. typedef struct accesskit_opt_auto_complete {
  721. bool has_value;
  722. accesskit_auto_complete value;
  723. } accesskit_opt_auto_complete;
  724. /**
  725. * Represents an optional value.
  726. *
  727. * If `has_value` is false, do not read the `value` field.
  728. */
  729. typedef struct accesskit_opt_has_popup {
  730. bool has_value;
  731. accesskit_has_popup value;
  732. } accesskit_opt_has_popup;
  733. /**
  734. * Represents an optional value.
  735. *
  736. * If `has_value` is false, do not read the `value` field.
  737. */
  738. typedef struct accesskit_opt_list_style {
  739. bool has_value;
  740. accesskit_list_style value;
  741. } accesskit_opt_list_style;
  742. /**
  743. * Represents an optional value.
  744. *
  745. * If `has_value` is false, do not read the `value` field.
  746. */
  747. typedef struct accesskit_opt_text_align {
  748. bool has_value;
  749. accesskit_text_align value;
  750. } accesskit_opt_text_align;
  751. /**
  752. * Represents an optional value.
  753. *
  754. * If `has_value` is false, do not read the `value` field.
  755. */
  756. typedef struct accesskit_opt_vertical_offset {
  757. bool has_value;
  758. accesskit_vertical_offset value;
  759. } accesskit_opt_vertical_offset;
  760. /**
  761. * A 2D affine transform. Derived from
  762. * [kurbo](https://github.com/linebender/kurbo).
  763. */
  764. typedef struct accesskit_affine {
  765. double _0[6];
  766. } accesskit_affine;
  767. /**
  768. * A rectangle. Derived from [kurbo](https://github.com/linebender/kurbo).
  769. */
  770. typedef struct accesskit_rect {
  771. /**
  772. * The minimum x coordinate (left edge).
  773. */
  774. double x0;
  775. /**
  776. * The minimum y coordinate (top edge in y-down spaces).
  777. */
  778. double y0;
  779. /**
  780. * The maximum x coordinate (right edge).
  781. */
  782. double x1;
  783. /**
  784. * The maximum y coordinate (bottom edge in y-down spaces).
  785. */
  786. double y1;
  787. } accesskit_rect;
  788. /**
  789. * Represents an optional value.
  790. *
  791. * If `has_value` is false, do not read the `value` field.
  792. */
  793. typedef struct accesskit_opt_rect {
  794. bool has_value;
  795. struct accesskit_rect value;
  796. } accesskit_opt_rect;
  797. typedef struct accesskit_text_position {
  798. accesskit_node_id node;
  799. size_t character_index;
  800. } accesskit_text_position;
  801. typedef struct accesskit_text_selection {
  802. struct accesskit_text_position anchor;
  803. struct accesskit_text_position focus;
  804. } accesskit_text_selection;
  805. /**
  806. * Represents an optional value.
  807. *
  808. * If `has_value` is false, do not read the `value` field.
  809. */
  810. typedef struct accesskit_opt_text_selection {
  811. bool has_value;
  812. struct accesskit_text_selection value;
  813. } accesskit_opt_text_selection;
  814. typedef struct accesskit_custom_actions {
  815. size_t length;
  816. struct accesskit_custom_action **values;
  817. } accesskit_custom_actions;
  818. /**
  819. * A 2D point. Derived from [kurbo](https://github.com/linebender/kurbo).
  820. */
  821. typedef struct accesskit_point {
  822. /**
  823. * The x coordinate.
  824. */
  825. double x;
  826. /**
  827. * The y coordinate.
  828. */
  829. double y;
  830. } accesskit_point;
  831. typedef enum accesskit_action_data_Tag {
  832. ACCESSKIT_ACTION_DATA_CUSTOM_ACTION,
  833. ACCESSKIT_ACTION_DATA_VALUE,
  834. ACCESSKIT_ACTION_DATA_NUMERIC_VALUE,
  835. ACCESSKIT_ACTION_DATA_SCROLL_UNIT,
  836. /**
  837. * Optional suggestion for `ACCESSKIT_ACTION_SCROLL_INTO_VIEW`, specifying
  838. * the preferred position of the target node relative to the scrollable
  839. * container's viewport.
  840. */
  841. ACCESSKIT_ACTION_DATA_SCROLL_HINT,
  842. ACCESSKIT_ACTION_DATA_SCROLL_TO_POINT,
  843. ACCESSKIT_ACTION_DATA_SET_SCROLL_OFFSET,
  844. ACCESSKIT_ACTION_DATA_SET_TEXT_SELECTION,
  845. } accesskit_action_data_Tag;
  846. typedef struct accesskit_action_data {
  847. accesskit_action_data_Tag tag;
  848. union {
  849. struct {
  850. int32_t custom_action;
  851. };
  852. struct {
  853. char *value;
  854. };
  855. struct {
  856. double numeric_value;
  857. };
  858. struct {
  859. accesskit_scroll_unit scroll_unit;
  860. };
  861. struct {
  862. accesskit_scroll_hint scroll_hint;
  863. };
  864. struct {
  865. struct accesskit_point scroll_to_point;
  866. };
  867. struct {
  868. struct accesskit_point set_scroll_offset;
  869. };
  870. struct {
  871. struct accesskit_text_selection set_text_selection;
  872. };
  873. };
  874. } accesskit_action_data;
  875. /**
  876. * Represents an optional value.
  877. *
  878. * If `has_value` is false, do not read the `value` field.
  879. */
  880. typedef struct accesskit_opt_action_data {
  881. bool has_value;
  882. struct accesskit_action_data value;
  883. } accesskit_opt_action_data;
  884. typedef struct accesskit_action_request {
  885. accesskit_action action;
  886. accesskit_node_id target;
  887. struct accesskit_opt_action_data data;
  888. } accesskit_action_request;
  889. /**
  890. * A 2D vector. Derived from [kurbo](https://github.com/linebender/kurbo).
  891. *
  892. * This is intended primarily for a vector in the mathematical sense,
  893. * but it can be interpreted as a translation, and converted to and
  894. * from a point (vector relative to the origin) and size.
  895. */
  896. typedef struct accesskit_vec2 {
  897. /**
  898. * The x-coordinate.
  899. */
  900. double x;
  901. /**
  902. * The y-coordinate.
  903. */
  904. double y;
  905. } accesskit_vec2;
  906. /**
  907. * A 2D size. Derived from [kurbo](https://github.com/linebender/kurbo).
  908. */
  909. typedef struct accesskit_size {
  910. /**
  911. * The width.
  912. */
  913. double width;
  914. /**
  915. * The height.
  916. */
  917. double height;
  918. } accesskit_size;
  919. /**
  920. * Ownership of `request` is transferred to the callback. `request` must
  921. * be freed using `accesskit_action_request_free`.
  922. */
  923. typedef void (*accesskit_action_handler_callback)(
  924. struct accesskit_action_request *request, void *userdata);
  925. typedef void *accesskit_tree_update_factory_userdata;
  926. /**
  927. * This function can't return a null pointer. Ownership of the returned value
  928. * will be transferred to the caller.
  929. */
  930. typedef struct accesskit_tree_update *(*accesskit_tree_update_factory)(
  931. accesskit_tree_update_factory_userdata);
  932. typedef struct accesskit_tree_update *(*accesskit_activation_handler_callback)(
  933. void *userdata);
  934. typedef void (*accesskit_deactivation_handler_callback)(void *userdata);
  935. #if defined(_WIN32)
  936. /**
  937. * Represents an optional value.
  938. *
  939. * If `has_value` is false, do not read the `value` field.
  940. */
  941. typedef struct accesskit_opt_lresult {
  942. bool has_value;
  943. LRESULT value;
  944. } accesskit_opt_lresult;
  945. #endif
  946. #ifdef __cplusplus
  947. extern "C" {
  948. #endif // __cplusplus
  949. accesskit_role accesskit_node_role(const struct accesskit_node *node);
  950. void accesskit_node_set_role(struct accesskit_node *node, accesskit_role value);
  951. bool accesskit_node_supports_action(const struct accesskit_node *node,
  952. accesskit_action action);
  953. void accesskit_node_add_action(struct accesskit_node *node,
  954. accesskit_action action);
  955. void accesskit_node_remove_action(struct accesskit_node *node,
  956. accesskit_action action);
  957. void accesskit_node_clear_actions(struct accesskit_node *node);
  958. /**
  959. * Return whether the specified action is in the set supported on this node's
  960. * direct children in the filtered tree.
  961. */
  962. bool accesskit_node_child_supports_action(const struct accesskit_node *node,
  963. accesskit_action action);
  964. /**
  965. * Add the specified action to the set supported on this node's direct
  966. * children in the filtered tree.
  967. */
  968. void accesskit_node_add_child_action(struct accesskit_node *node,
  969. accesskit_action action);
  970. /**
  971. * Remove the specified action from the set supported on this node's direct
  972. * children in the filtered tree.
  973. */
  974. void accesskit_node_remove_child_action(struct accesskit_node *node,
  975. accesskit_action action);
  976. /**
  977. * Clear the set of actions supported on this node's direct children in the
  978. * filtered tree.
  979. */
  980. void accesskit_node_clear_child_actions(struct accesskit_node *node);
  981. bool accesskit_node_is_hidden(const struct accesskit_node *node);
  982. void accesskit_node_set_hidden(struct accesskit_node *node);
  983. void accesskit_node_clear_hidden(struct accesskit_node *node);
  984. bool accesskit_node_is_multiselectable(const struct accesskit_node *node);
  985. void accesskit_node_set_multiselectable(struct accesskit_node *node);
  986. void accesskit_node_clear_multiselectable(struct accesskit_node *node);
  987. bool accesskit_node_is_required(const struct accesskit_node *node);
  988. void accesskit_node_set_required(struct accesskit_node *node);
  989. void accesskit_node_clear_required(struct accesskit_node *node);
  990. bool accesskit_node_is_visited(const struct accesskit_node *node);
  991. void accesskit_node_set_visited(struct accesskit_node *node);
  992. void accesskit_node_clear_visited(struct accesskit_node *node);
  993. bool accesskit_node_is_busy(const struct accesskit_node *node);
  994. void accesskit_node_set_busy(struct accesskit_node *node);
  995. void accesskit_node_clear_busy(struct accesskit_node *node);
  996. bool accesskit_node_is_live_atomic(const struct accesskit_node *node);
  997. void accesskit_node_set_live_atomic(struct accesskit_node *node);
  998. void accesskit_node_clear_live_atomic(struct accesskit_node *node);
  999. bool accesskit_node_is_modal(const struct accesskit_node *node);
  1000. void accesskit_node_set_modal(struct accesskit_node *node);
  1001. void accesskit_node_clear_modal(struct accesskit_node *node);
  1002. bool accesskit_node_is_touch_transparent(const struct accesskit_node *node);
  1003. void accesskit_node_set_touch_transparent(struct accesskit_node *node);
  1004. void accesskit_node_clear_touch_transparent(struct accesskit_node *node);
  1005. bool accesskit_node_is_read_only(const struct accesskit_node *node);
  1006. void accesskit_node_set_read_only(struct accesskit_node *node);
  1007. void accesskit_node_clear_read_only(struct accesskit_node *node);
  1008. bool accesskit_node_is_disabled(const struct accesskit_node *node);
  1009. void accesskit_node_set_disabled(struct accesskit_node *node);
  1010. void accesskit_node_clear_disabled(struct accesskit_node *node);
  1011. bool accesskit_node_is_bold(const struct accesskit_node *node);
  1012. void accesskit_node_set_bold(struct accesskit_node *node);
  1013. void accesskit_node_clear_bold(struct accesskit_node *node);
  1014. bool accesskit_node_is_italic(const struct accesskit_node *node);
  1015. void accesskit_node_set_italic(struct accesskit_node *node);
  1016. void accesskit_node_clear_italic(struct accesskit_node *node);
  1017. bool accesskit_node_clips_children(const struct accesskit_node *node);
  1018. void accesskit_node_set_clips_children(struct accesskit_node *node);
  1019. void accesskit_node_clear_clips_children(struct accesskit_node *node);
  1020. bool accesskit_node_is_line_breaking_object(const struct accesskit_node *node);
  1021. void accesskit_node_set_is_line_breaking_object(struct accesskit_node *node);
  1022. void accesskit_node_clear_is_line_breaking_object(struct accesskit_node *node);
  1023. bool accesskit_node_is_page_breaking_object(const struct accesskit_node *node);
  1024. void accesskit_node_set_is_page_breaking_object(struct accesskit_node *node);
  1025. void accesskit_node_clear_is_page_breaking_object(struct accesskit_node *node);
  1026. bool accesskit_node_is_spelling_error(const struct accesskit_node *node);
  1027. void accesskit_node_set_is_spelling_error(struct accesskit_node *node);
  1028. void accesskit_node_clear_is_spelling_error(struct accesskit_node *node);
  1029. bool accesskit_node_is_grammar_error(const struct accesskit_node *node);
  1030. void accesskit_node_set_is_grammar_error(struct accesskit_node *node);
  1031. void accesskit_node_clear_is_grammar_error(struct accesskit_node *node);
  1032. bool accesskit_node_is_search_match(const struct accesskit_node *node);
  1033. void accesskit_node_set_is_search_match(struct accesskit_node *node);
  1034. void accesskit_node_clear_is_search_match(struct accesskit_node *node);
  1035. bool accesskit_node_is_suggestion(const struct accesskit_node *node);
  1036. void accesskit_node_set_is_suggestion(struct accesskit_node *node);
  1037. void accesskit_node_clear_is_suggestion(struct accesskit_node *node);
  1038. struct accesskit_node_ids accesskit_node_children(
  1039. const struct accesskit_node *node);
  1040. /**
  1041. * Caller is responsible for freeing `values`.
  1042. */
  1043. void accesskit_node_set_children(struct accesskit_node *node, size_t length,
  1044. const accesskit_node_id *values);
  1045. void accesskit_node_push_child(struct accesskit_node *node,
  1046. accesskit_node_id item);
  1047. void accesskit_node_clear_children(struct accesskit_node *node);
  1048. struct accesskit_node_ids accesskit_node_controls(
  1049. const struct accesskit_node *node);
  1050. /**
  1051. * Caller is responsible for freeing `values`.
  1052. */
  1053. void accesskit_node_set_controls(struct accesskit_node *node, size_t length,
  1054. const accesskit_node_id *values);
  1055. void accesskit_node_push_controlled(struct accesskit_node *node,
  1056. accesskit_node_id item);
  1057. void accesskit_node_clear_controls(struct accesskit_node *node);
  1058. struct accesskit_node_ids accesskit_node_details(
  1059. const struct accesskit_node *node);
  1060. /**
  1061. * Caller is responsible for freeing `values`.
  1062. */
  1063. void accesskit_node_set_details(struct accesskit_node *node, size_t length,
  1064. const accesskit_node_id *values);
  1065. void accesskit_node_push_detail(struct accesskit_node *node,
  1066. accesskit_node_id item);
  1067. void accesskit_node_clear_details(struct accesskit_node *node);
  1068. struct accesskit_node_ids accesskit_node_described_by(
  1069. const struct accesskit_node *node);
  1070. /**
  1071. * Caller is responsible for freeing `values`.
  1072. */
  1073. void accesskit_node_set_described_by(struct accesskit_node *node, size_t length,
  1074. const accesskit_node_id *values);
  1075. void accesskit_node_push_described_by(struct accesskit_node *node,
  1076. accesskit_node_id item);
  1077. void accesskit_node_clear_described_by(struct accesskit_node *node);
  1078. struct accesskit_node_ids accesskit_node_flow_to(
  1079. const struct accesskit_node *node);
  1080. /**
  1081. * Caller is responsible for freeing `values`.
  1082. */
  1083. void accesskit_node_set_flow_to(struct accesskit_node *node, size_t length,
  1084. const accesskit_node_id *values);
  1085. void accesskit_node_push_flow_to(struct accesskit_node *node,
  1086. accesskit_node_id item);
  1087. void accesskit_node_clear_flow_to(struct accesskit_node *node);
  1088. struct accesskit_node_ids accesskit_node_labelled_by(
  1089. const struct accesskit_node *node);
  1090. /**
  1091. * Caller is responsible for freeing `values`.
  1092. */
  1093. void accesskit_node_set_labelled_by(struct accesskit_node *node, size_t length,
  1094. const accesskit_node_id *values);
  1095. void accesskit_node_push_labelled_by(struct accesskit_node *node,
  1096. accesskit_node_id item);
  1097. void accesskit_node_clear_labelled_by(struct accesskit_node *node);
  1098. struct accesskit_node_ids accesskit_node_owns(
  1099. const struct accesskit_node *node);
  1100. /**
  1101. * Caller is responsible for freeing `values`.
  1102. */
  1103. void accesskit_node_set_owns(struct accesskit_node *node, size_t length,
  1104. const accesskit_node_id *values);
  1105. void accesskit_node_push_owned(struct accesskit_node *node,
  1106. accesskit_node_id item);
  1107. void accesskit_node_clear_owns(struct accesskit_node *node);
  1108. struct accesskit_node_ids accesskit_node_radio_group(
  1109. const struct accesskit_node *node);
  1110. /**
  1111. * Caller is responsible for freeing `values`.
  1112. */
  1113. void accesskit_node_set_radio_group(struct accesskit_node *node, size_t length,
  1114. const accesskit_node_id *values);
  1115. void accesskit_node_push_to_radio_group(struct accesskit_node *node,
  1116. accesskit_node_id item);
  1117. void accesskit_node_clear_radio_group(struct accesskit_node *node);
  1118. struct accesskit_opt_node_id accesskit_node_active_descendant(
  1119. const struct accesskit_node *node);
  1120. void accesskit_node_set_active_descendant(struct accesskit_node *node,
  1121. accesskit_node_id value);
  1122. void accesskit_node_clear_active_descendant(struct accesskit_node *node);
  1123. struct accesskit_opt_node_id accesskit_node_error_message(
  1124. const struct accesskit_node *node);
  1125. void accesskit_node_set_error_message(struct accesskit_node *node,
  1126. accesskit_node_id value);
  1127. void accesskit_node_clear_error_message(struct accesskit_node *node);
  1128. struct accesskit_opt_node_id accesskit_node_in_page_link_target(
  1129. const struct accesskit_node *node);
  1130. void accesskit_node_set_in_page_link_target(struct accesskit_node *node,
  1131. accesskit_node_id value);
  1132. void accesskit_node_clear_in_page_link_target(struct accesskit_node *node);
  1133. struct accesskit_opt_node_id accesskit_node_member_of(
  1134. const struct accesskit_node *node);
  1135. void accesskit_node_set_member_of(struct accesskit_node *node,
  1136. accesskit_node_id value);
  1137. void accesskit_node_clear_member_of(struct accesskit_node *node);
  1138. struct accesskit_opt_node_id accesskit_node_next_on_line(
  1139. const struct accesskit_node *node);
  1140. void accesskit_node_set_next_on_line(struct accesskit_node *node,
  1141. accesskit_node_id value);
  1142. void accesskit_node_clear_next_on_line(struct accesskit_node *node);
  1143. struct accesskit_opt_node_id accesskit_node_previous_on_line(
  1144. const struct accesskit_node *node);
  1145. void accesskit_node_set_previous_on_line(struct accesskit_node *node,
  1146. accesskit_node_id value);
  1147. void accesskit_node_clear_previous_on_line(struct accesskit_node *node);
  1148. struct accesskit_opt_node_id accesskit_node_popup_for(
  1149. const struct accesskit_node *node);
  1150. void accesskit_node_set_popup_for(struct accesskit_node *node,
  1151. accesskit_node_id value);
  1152. void accesskit_node_clear_popup_for(struct accesskit_node *node);
  1153. /**
  1154. * Only call this function with a string that originated from AccessKit.
  1155. */
  1156. void accesskit_string_free(char *string);
  1157. /**
  1158. * Caller must call `accesskit_string_free` with the return value.
  1159. */
  1160. char *accesskit_node_label(const struct accesskit_node *node);
  1161. /**
  1162. * Caller is responsible for freeing the memory pointed by `value`.
  1163. */
  1164. void accesskit_node_set_label(struct accesskit_node *node, const char *value);
  1165. /**
  1166. * Caller is responsible for freeing the memory pointed by `value`.
  1167. */
  1168. void accesskit_node_set_label_with_length(struct accesskit_node *node,
  1169. const char *value, size_t length);
  1170. void accesskit_node_clear_label(struct accesskit_node *node);
  1171. /**
  1172. * Caller must call `accesskit_string_free` with the return value.
  1173. */
  1174. char *accesskit_node_description(const struct accesskit_node *node);
  1175. /**
  1176. * Caller is responsible for freeing the memory pointed by `value`.
  1177. */
  1178. void accesskit_node_set_description(struct accesskit_node *node,
  1179. const char *value);
  1180. /**
  1181. * Caller is responsible for freeing the memory pointed by `value`.
  1182. */
  1183. void accesskit_node_set_description_with_length(struct accesskit_node *node,
  1184. const char *value,
  1185. size_t length);
  1186. void accesskit_node_clear_description(struct accesskit_node *node);
  1187. /**
  1188. * Caller must call `accesskit_string_free` with the return value.
  1189. */
  1190. char *accesskit_node_value(const struct accesskit_node *node);
  1191. /**
  1192. * Caller is responsible for freeing the memory pointed by `value`.
  1193. */
  1194. void accesskit_node_set_value(struct accesskit_node *node, const char *value);
  1195. /**
  1196. * Caller is responsible for freeing the memory pointed by `value`.
  1197. */
  1198. void accesskit_node_set_value_with_length(struct accesskit_node *node,
  1199. const char *value, size_t length);
  1200. void accesskit_node_clear_value(struct accesskit_node *node);
  1201. /**
  1202. * Caller must call `accesskit_string_free` with the return value.
  1203. */
  1204. char *accesskit_node_access_key(const struct accesskit_node *node);
  1205. /**
  1206. * Caller is responsible for freeing the memory pointed by `value`.
  1207. */
  1208. void accesskit_node_set_access_key(struct accesskit_node *node,
  1209. const char *value);
  1210. /**
  1211. * Caller is responsible for freeing the memory pointed by `value`.
  1212. */
  1213. void accesskit_node_set_access_key_with_length(struct accesskit_node *node,
  1214. const char *value,
  1215. size_t length);
  1216. void accesskit_node_clear_access_key(struct accesskit_node *node);
  1217. /**
  1218. * Caller must call `accesskit_string_free` with the return value.
  1219. */
  1220. char *accesskit_node_author_id(const struct accesskit_node *node);
  1221. /**
  1222. * Caller is responsible for freeing the memory pointed by `value`.
  1223. */
  1224. void accesskit_node_set_author_id(struct accesskit_node *node,
  1225. const char *value);
  1226. /**
  1227. * Caller is responsible for freeing the memory pointed by `value`.
  1228. */
  1229. void accesskit_node_set_author_id_with_length(struct accesskit_node *node,
  1230. const char *value, size_t length);
  1231. void accesskit_node_clear_author_id(struct accesskit_node *node);
  1232. /**
  1233. * Caller must call `accesskit_string_free` with the return value.
  1234. */
  1235. char *accesskit_node_class_name(const struct accesskit_node *node);
  1236. /**
  1237. * Caller is responsible for freeing the memory pointed by `value`.
  1238. */
  1239. void accesskit_node_set_class_name(struct accesskit_node *node,
  1240. const char *value);
  1241. /**
  1242. * Caller is responsible for freeing the memory pointed by `value`.
  1243. */
  1244. void accesskit_node_set_class_name_with_length(struct accesskit_node *node,
  1245. const char *value,
  1246. size_t length);
  1247. void accesskit_node_clear_class_name(struct accesskit_node *node);
  1248. /**
  1249. * Caller must call `accesskit_string_free` with the return value.
  1250. */
  1251. char *accesskit_node_font_family(const struct accesskit_node *node);
  1252. /**
  1253. * Caller is responsible for freeing the memory pointed by `value`.
  1254. */
  1255. void accesskit_node_set_font_family(struct accesskit_node *node,
  1256. const char *value);
  1257. /**
  1258. * Caller is responsible for freeing the memory pointed by `value`.
  1259. */
  1260. void accesskit_node_set_font_family_with_length(struct accesskit_node *node,
  1261. const char *value,
  1262. size_t length);
  1263. void accesskit_node_clear_font_family(struct accesskit_node *node);
  1264. /**
  1265. * Caller must call `accesskit_string_free` with the return value.
  1266. */
  1267. char *accesskit_node_html_tag(const struct accesskit_node *node);
  1268. /**
  1269. * Caller is responsible for freeing the memory pointed by `value`.
  1270. */
  1271. void accesskit_node_set_html_tag(struct accesskit_node *node,
  1272. const char *value);
  1273. /**
  1274. * Caller is responsible for freeing the memory pointed by `value`.
  1275. */
  1276. void accesskit_node_set_html_tag_with_length(struct accesskit_node *node,
  1277. const char *value, size_t length);
  1278. void accesskit_node_clear_html_tag(struct accesskit_node *node);
  1279. /**
  1280. * Caller must call `accesskit_string_free` with the return value.
  1281. */
  1282. char *accesskit_node_inner_html(const struct accesskit_node *node);
  1283. /**
  1284. * Caller is responsible for freeing the memory pointed by `value`.
  1285. */
  1286. void accesskit_node_set_inner_html(struct accesskit_node *node,
  1287. const char *value);
  1288. /**
  1289. * Caller is responsible for freeing the memory pointed by `value`.
  1290. */
  1291. void accesskit_node_set_inner_html_with_length(struct accesskit_node *node,
  1292. const char *value,
  1293. size_t length);
  1294. void accesskit_node_clear_inner_html(struct accesskit_node *node);
  1295. /**
  1296. * Caller must call `accesskit_string_free` with the return value.
  1297. */
  1298. char *accesskit_node_keyboard_shortcut(const struct accesskit_node *node);
  1299. /**
  1300. * Caller is responsible for freeing the memory pointed by `value`.
  1301. */
  1302. void accesskit_node_set_keyboard_shortcut(struct accesskit_node *node,
  1303. const char *value);
  1304. /**
  1305. * Caller is responsible for freeing the memory pointed by `value`.
  1306. */
  1307. void accesskit_node_set_keyboard_shortcut_with_length(
  1308. struct accesskit_node *node, const char *value, size_t length);
  1309. void accesskit_node_clear_keyboard_shortcut(struct accesskit_node *node);
  1310. /**
  1311. * Caller must call `accesskit_string_free` with the return value.
  1312. */
  1313. char *accesskit_node_language(const struct accesskit_node *node);
  1314. /**
  1315. * Caller is responsible for freeing the memory pointed by `value`.
  1316. */
  1317. void accesskit_node_set_language(struct accesskit_node *node,
  1318. const char *value);
  1319. /**
  1320. * Caller is responsible for freeing the memory pointed by `value`.
  1321. */
  1322. void accesskit_node_set_language_with_length(struct accesskit_node *node,
  1323. const char *value, size_t length);
  1324. void accesskit_node_clear_language(struct accesskit_node *node);
  1325. /**
  1326. * Caller must call `accesskit_string_free` with the return value.
  1327. */
  1328. char *accesskit_node_placeholder(const struct accesskit_node *node);
  1329. /**
  1330. * Caller is responsible for freeing the memory pointed by `value`.
  1331. */
  1332. void accesskit_node_set_placeholder(struct accesskit_node *node,
  1333. const char *value);
  1334. /**
  1335. * Caller is responsible for freeing the memory pointed by `value`.
  1336. */
  1337. void accesskit_node_set_placeholder_with_length(struct accesskit_node *node,
  1338. const char *value,
  1339. size_t length);
  1340. void accesskit_node_clear_placeholder(struct accesskit_node *node);
  1341. /**
  1342. * Caller must call `accesskit_string_free` with the return value.
  1343. */
  1344. char *accesskit_node_role_description(const struct accesskit_node *node);
  1345. /**
  1346. * Caller is responsible for freeing the memory pointed by `value`.
  1347. */
  1348. void accesskit_node_set_role_description(struct accesskit_node *node,
  1349. const char *value);
  1350. /**
  1351. * Caller is responsible for freeing the memory pointed by `value`.
  1352. */
  1353. void accesskit_node_set_role_description_with_length(
  1354. struct accesskit_node *node, const char *value, size_t length);
  1355. void accesskit_node_clear_role_description(struct accesskit_node *node);
  1356. /**
  1357. * Caller must call `accesskit_string_free` with the return value.
  1358. */
  1359. char *accesskit_node_state_description(const struct accesskit_node *node);
  1360. /**
  1361. * Caller is responsible for freeing the memory pointed by `value`.
  1362. */
  1363. void accesskit_node_set_state_description(struct accesskit_node *node,
  1364. const char *value);
  1365. /**
  1366. * Caller is responsible for freeing the memory pointed by `value`.
  1367. */
  1368. void accesskit_node_set_state_description_with_length(
  1369. struct accesskit_node *node, const char *value, size_t length);
  1370. void accesskit_node_clear_state_description(struct accesskit_node *node);
  1371. /**
  1372. * Caller must call `accesskit_string_free` with the return value.
  1373. */
  1374. char *accesskit_node_tooltip(const struct accesskit_node *node);
  1375. /**
  1376. * Caller is responsible for freeing the memory pointed by `value`.
  1377. */
  1378. void accesskit_node_set_tooltip(struct accesskit_node *node, const char *value);
  1379. /**
  1380. * Caller is responsible for freeing the memory pointed by `value`.
  1381. */
  1382. void accesskit_node_set_tooltip_with_length(struct accesskit_node *node,
  1383. const char *value, size_t length);
  1384. void accesskit_node_clear_tooltip(struct accesskit_node *node);
  1385. /**
  1386. * Caller must call `accesskit_string_free` with the return value.
  1387. */
  1388. char *accesskit_node_url(const struct accesskit_node *node);
  1389. /**
  1390. * Caller is responsible for freeing the memory pointed by `value`.
  1391. */
  1392. void accesskit_node_set_url(struct accesskit_node *node, const char *value);
  1393. /**
  1394. * Caller is responsible for freeing the memory pointed by `value`.
  1395. */
  1396. void accesskit_node_set_url_with_length(struct accesskit_node *node,
  1397. const char *value, size_t length);
  1398. void accesskit_node_clear_url(struct accesskit_node *node);
  1399. /**
  1400. * Caller must call `accesskit_string_free` with the return value.
  1401. */
  1402. char *accesskit_node_row_index_text(const struct accesskit_node *node);
  1403. /**
  1404. * Caller is responsible for freeing the memory pointed by `value`.
  1405. */
  1406. void accesskit_node_set_row_index_text(struct accesskit_node *node,
  1407. const char *value);
  1408. /**
  1409. * Caller is responsible for freeing the memory pointed by `value`.
  1410. */
  1411. void accesskit_node_set_row_index_text_with_length(struct accesskit_node *node,
  1412. const char *value,
  1413. size_t length);
  1414. void accesskit_node_clear_row_index_text(struct accesskit_node *node);
  1415. /**
  1416. * Caller must call `accesskit_string_free` with the return value.
  1417. */
  1418. char *accesskit_node_column_index_text(const struct accesskit_node *node);
  1419. /**
  1420. * Caller is responsible for freeing the memory pointed by `value`.
  1421. */
  1422. void accesskit_node_set_column_index_text(struct accesskit_node *node,
  1423. const char *value);
  1424. /**
  1425. * Caller is responsible for freeing the memory pointed by `value`.
  1426. */
  1427. void accesskit_node_set_column_index_text_with_length(
  1428. struct accesskit_node *node, const char *value, size_t length);
  1429. void accesskit_node_clear_column_index_text(struct accesskit_node *node);
  1430. struct accesskit_opt_double accesskit_node_scroll_x(
  1431. const struct accesskit_node *node);
  1432. void accesskit_node_set_scroll_x(struct accesskit_node *node, double value);
  1433. void accesskit_node_clear_scroll_x(struct accesskit_node *node);
  1434. struct accesskit_opt_double accesskit_node_scroll_x_min(
  1435. const struct accesskit_node *node);
  1436. void accesskit_node_set_scroll_x_min(struct accesskit_node *node, double value);
  1437. void accesskit_node_clear_scroll_x_min(struct accesskit_node *node);
  1438. struct accesskit_opt_double accesskit_node_scroll_x_max(
  1439. const struct accesskit_node *node);
  1440. void accesskit_node_set_scroll_x_max(struct accesskit_node *node, double value);
  1441. void accesskit_node_clear_scroll_x_max(struct accesskit_node *node);
  1442. struct accesskit_opt_double accesskit_node_scroll_y(
  1443. const struct accesskit_node *node);
  1444. void accesskit_node_set_scroll_y(struct accesskit_node *node, double value);
  1445. void accesskit_node_clear_scroll_y(struct accesskit_node *node);
  1446. struct accesskit_opt_double accesskit_node_scroll_y_min(
  1447. const struct accesskit_node *node);
  1448. void accesskit_node_set_scroll_y_min(struct accesskit_node *node, double value);
  1449. void accesskit_node_clear_scroll_y_min(struct accesskit_node *node);
  1450. struct accesskit_opt_double accesskit_node_scroll_y_max(
  1451. const struct accesskit_node *node);
  1452. void accesskit_node_set_scroll_y_max(struct accesskit_node *node, double value);
  1453. void accesskit_node_clear_scroll_y_max(struct accesskit_node *node);
  1454. struct accesskit_opt_double accesskit_node_numeric_value(
  1455. const struct accesskit_node *node);
  1456. void accesskit_node_set_numeric_value(struct accesskit_node *node,
  1457. double value);
  1458. void accesskit_node_clear_numeric_value(struct accesskit_node *node);
  1459. struct accesskit_opt_double accesskit_node_min_numeric_value(
  1460. const struct accesskit_node *node);
  1461. void accesskit_node_set_min_numeric_value(struct accesskit_node *node,
  1462. double value);
  1463. void accesskit_node_clear_min_numeric_value(struct accesskit_node *node);
  1464. struct accesskit_opt_double accesskit_node_max_numeric_value(
  1465. const struct accesskit_node *node);
  1466. void accesskit_node_set_max_numeric_value(struct accesskit_node *node,
  1467. double value);
  1468. void accesskit_node_clear_max_numeric_value(struct accesskit_node *node);
  1469. struct accesskit_opt_double accesskit_node_numeric_value_step(
  1470. const struct accesskit_node *node);
  1471. void accesskit_node_set_numeric_value_step(struct accesskit_node *node,
  1472. double value);
  1473. void accesskit_node_clear_numeric_value_step(struct accesskit_node *node);
  1474. struct accesskit_opt_double accesskit_node_numeric_value_jump(
  1475. const struct accesskit_node *node);
  1476. void accesskit_node_set_numeric_value_jump(struct accesskit_node *node,
  1477. double value);
  1478. void accesskit_node_clear_numeric_value_jump(struct accesskit_node *node);
  1479. struct accesskit_opt_double accesskit_node_font_size(
  1480. const struct accesskit_node *node);
  1481. void accesskit_node_set_font_size(struct accesskit_node *node, double value);
  1482. void accesskit_node_clear_font_size(struct accesskit_node *node);
  1483. struct accesskit_opt_double accesskit_node_font_weight(
  1484. const struct accesskit_node *node);
  1485. void accesskit_node_set_font_weight(struct accesskit_node *node, double value);
  1486. void accesskit_node_clear_font_weight(struct accesskit_node *node);
  1487. struct accesskit_opt_index accesskit_node_row_count(
  1488. const struct accesskit_node *node);
  1489. void accesskit_node_set_row_count(struct accesskit_node *node, size_t value);
  1490. void accesskit_node_clear_row_count(struct accesskit_node *node);
  1491. struct accesskit_opt_index accesskit_node_column_count(
  1492. const struct accesskit_node *node);
  1493. void accesskit_node_set_column_count(struct accesskit_node *node, size_t value);
  1494. void accesskit_node_clear_column_count(struct accesskit_node *node);
  1495. struct accesskit_opt_index accesskit_node_row_index(
  1496. const struct accesskit_node *node);
  1497. void accesskit_node_set_row_index(struct accesskit_node *node, size_t value);
  1498. void accesskit_node_clear_row_index(struct accesskit_node *node);
  1499. struct accesskit_opt_index accesskit_node_column_index(
  1500. const struct accesskit_node *node);
  1501. void accesskit_node_set_column_index(struct accesskit_node *node, size_t value);
  1502. void accesskit_node_clear_column_index(struct accesskit_node *node);
  1503. struct accesskit_opt_index accesskit_node_row_span(
  1504. const struct accesskit_node *node);
  1505. void accesskit_node_set_row_span(struct accesskit_node *node, size_t value);
  1506. void accesskit_node_clear_row_span(struct accesskit_node *node);
  1507. struct accesskit_opt_index accesskit_node_column_span(
  1508. const struct accesskit_node *node);
  1509. void accesskit_node_set_column_span(struct accesskit_node *node, size_t value);
  1510. void accesskit_node_clear_column_span(struct accesskit_node *node);
  1511. struct accesskit_opt_index accesskit_node_level(
  1512. const struct accesskit_node *node);
  1513. void accesskit_node_set_level(struct accesskit_node *node, size_t value);
  1514. void accesskit_node_clear_level(struct accesskit_node *node);
  1515. struct accesskit_opt_index accesskit_node_size_of_set(
  1516. const struct accesskit_node *node);
  1517. void accesskit_node_set_size_of_set(struct accesskit_node *node, size_t value);
  1518. void accesskit_node_clear_size_of_set(struct accesskit_node *node);
  1519. struct accesskit_opt_index accesskit_node_position_in_set(
  1520. const struct accesskit_node *node);
  1521. void accesskit_node_set_position_in_set(struct accesskit_node *node,
  1522. size_t value);
  1523. void accesskit_node_clear_position_in_set(struct accesskit_node *node);
  1524. struct accesskit_opt_color accesskit_node_color_value(
  1525. const struct accesskit_node *node);
  1526. void accesskit_node_set_color_value(struct accesskit_node *node,
  1527. uint32_t value);
  1528. void accesskit_node_clear_color_value(struct accesskit_node *node);
  1529. struct accesskit_opt_color accesskit_node_background_color(
  1530. const struct accesskit_node *node);
  1531. void accesskit_node_set_background_color(struct accesskit_node *node,
  1532. uint32_t value);
  1533. void accesskit_node_clear_background_color(struct accesskit_node *node);
  1534. struct accesskit_opt_color accesskit_node_foreground_color(
  1535. const struct accesskit_node *node);
  1536. void accesskit_node_set_foreground_color(struct accesskit_node *node,
  1537. uint32_t value);
  1538. void accesskit_node_clear_foreground_color(struct accesskit_node *node);
  1539. struct accesskit_opt_text_decoration accesskit_node_overline(
  1540. const struct accesskit_node *node);
  1541. void accesskit_node_set_overline(struct accesskit_node *node,
  1542. accesskit_text_decoration value);
  1543. void accesskit_node_clear_overline(struct accesskit_node *node);
  1544. struct accesskit_opt_text_decoration accesskit_node_strikethrough(
  1545. const struct accesskit_node *node);
  1546. void accesskit_node_set_strikethrough(struct accesskit_node *node,
  1547. accesskit_text_decoration value);
  1548. void accesskit_node_clear_strikethrough(struct accesskit_node *node);
  1549. struct accesskit_opt_text_decoration accesskit_node_underline(
  1550. const struct accesskit_node *node);
  1551. void accesskit_node_set_underline(struct accesskit_node *node,
  1552. accesskit_text_decoration value);
  1553. void accesskit_node_clear_underline(struct accesskit_node *node);
  1554. struct accesskit_lengths accesskit_node_character_lengths(
  1555. const struct accesskit_node *node);
  1556. /**
  1557. * Caller is responsible for freeing `values`.
  1558. */
  1559. void accesskit_node_set_character_lengths(struct accesskit_node *node,
  1560. size_t length, const uint8_t *values);
  1561. void accesskit_node_clear_character_lengths(struct accesskit_node *node);
  1562. struct accesskit_lengths accesskit_node_word_lengths(
  1563. const struct accesskit_node *node);
  1564. /**
  1565. * Caller is responsible for freeing `values`.
  1566. */
  1567. void accesskit_node_set_word_lengths(struct accesskit_node *node, size_t length,
  1568. const uint8_t *values);
  1569. void accesskit_node_clear_word_lengths(struct accesskit_node *node);
  1570. struct accesskit_opt_coords accesskit_node_character_positions(
  1571. const struct accesskit_node *node);
  1572. /**
  1573. * Caller is responsible for freeing `values`.
  1574. */
  1575. void accesskit_node_set_character_positions(struct accesskit_node *node,
  1576. size_t length, const float *values);
  1577. void accesskit_node_clear_character_positions(struct accesskit_node *node);
  1578. struct accesskit_opt_coords accesskit_node_character_widths(
  1579. const struct accesskit_node *node);
  1580. /**
  1581. * Caller is responsible for freeing `values`.
  1582. */
  1583. void accesskit_node_set_character_widths(struct accesskit_node *node,
  1584. size_t length, const float *values);
  1585. void accesskit_node_clear_character_widths(struct accesskit_node *node);
  1586. struct accesskit_opt_bool accesskit_node_is_expanded(
  1587. const struct accesskit_node *node);
  1588. void accesskit_node_set_expanded(struct accesskit_node *node, bool value);
  1589. void accesskit_node_clear_expanded(struct accesskit_node *node);
  1590. struct accesskit_opt_bool accesskit_node_is_selected(
  1591. const struct accesskit_node *node);
  1592. void accesskit_node_set_selected(struct accesskit_node *node, bool value);
  1593. void accesskit_node_clear_selected(struct accesskit_node *node);
  1594. struct accesskit_opt_invalid accesskit_node_invalid(
  1595. const struct accesskit_node *node);
  1596. void accesskit_node_set_invalid(struct accesskit_node *node,
  1597. accesskit_invalid value);
  1598. void accesskit_node_clear_invalid(struct accesskit_node *node);
  1599. struct accesskit_opt_toggled accesskit_node_toggled(
  1600. const struct accesskit_node *node);
  1601. void accesskit_node_set_toggled(struct accesskit_node *node,
  1602. accesskit_toggled value);
  1603. void accesskit_node_clear_toggled(struct accesskit_node *node);
  1604. struct accesskit_opt_live accesskit_node_live(
  1605. const struct accesskit_node *node);
  1606. void accesskit_node_set_live(struct accesskit_node *node, accesskit_live value);
  1607. void accesskit_node_clear_live(struct accesskit_node *node);
  1608. struct accesskit_opt_text_direction accesskit_node_text_direction(
  1609. const struct accesskit_node *node);
  1610. void accesskit_node_set_text_direction(struct accesskit_node *node,
  1611. accesskit_text_direction value);
  1612. void accesskit_node_clear_text_direction(struct accesskit_node *node);
  1613. struct accesskit_opt_orientation accesskit_node_orientation(
  1614. const struct accesskit_node *node);
  1615. void accesskit_node_set_orientation(struct accesskit_node *node,
  1616. accesskit_orientation value);
  1617. void accesskit_node_clear_orientation(struct accesskit_node *node);
  1618. struct accesskit_opt_sort_direction accesskit_node_sort_direction(
  1619. const struct accesskit_node *node);
  1620. void accesskit_node_set_sort_direction(struct accesskit_node *node,
  1621. accesskit_sort_direction value);
  1622. void accesskit_node_clear_sort_direction(struct accesskit_node *node);
  1623. struct accesskit_opt_aria_current accesskit_node_aria_current(
  1624. const struct accesskit_node *node);
  1625. void accesskit_node_set_aria_current(struct accesskit_node *node,
  1626. accesskit_aria_current value);
  1627. void accesskit_node_clear_aria_current(struct accesskit_node *node);
  1628. struct accesskit_opt_auto_complete accesskit_node_auto_complete(
  1629. const struct accesskit_node *node);
  1630. void accesskit_node_set_auto_complete(struct accesskit_node *node,
  1631. accesskit_auto_complete value);
  1632. void accesskit_node_clear_auto_complete(struct accesskit_node *node);
  1633. struct accesskit_opt_has_popup accesskit_node_has_popup(
  1634. const struct accesskit_node *node);
  1635. void accesskit_node_set_has_popup(struct accesskit_node *node,
  1636. accesskit_has_popup value);
  1637. void accesskit_node_clear_has_popup(struct accesskit_node *node);
  1638. struct accesskit_opt_list_style accesskit_node_list_style(
  1639. const struct accesskit_node *node);
  1640. void accesskit_node_set_list_style(struct accesskit_node *node,
  1641. accesskit_list_style value);
  1642. void accesskit_node_clear_list_style(struct accesskit_node *node);
  1643. struct accesskit_opt_text_align accesskit_node_text_align(
  1644. const struct accesskit_node *node);
  1645. void accesskit_node_set_text_align(struct accesskit_node *node,
  1646. accesskit_text_align value);
  1647. void accesskit_node_clear_text_align(struct accesskit_node *node);
  1648. struct accesskit_opt_vertical_offset accesskit_node_vertical_offset(
  1649. const struct accesskit_node *node);
  1650. void accesskit_node_set_vertical_offset(struct accesskit_node *node,
  1651. accesskit_vertical_offset value);
  1652. void accesskit_node_clear_vertical_offset(struct accesskit_node *node);
  1653. const struct accesskit_affine *accesskit_node_transform(
  1654. const struct accesskit_node *node);
  1655. void accesskit_node_set_transform(struct accesskit_node *node,
  1656. struct accesskit_affine value);
  1657. void accesskit_node_clear_transform(struct accesskit_node *node);
  1658. struct accesskit_opt_rect accesskit_node_bounds(
  1659. const struct accesskit_node *node);
  1660. void accesskit_node_set_bounds(struct accesskit_node *node,
  1661. struct accesskit_rect value);
  1662. void accesskit_node_clear_bounds(struct accesskit_node *node);
  1663. struct accesskit_opt_text_selection accesskit_node_text_selection(
  1664. const struct accesskit_node *node);
  1665. void accesskit_node_set_text_selection(struct accesskit_node *node,
  1666. struct accesskit_text_selection value);
  1667. void accesskit_node_clear_text_selection(struct accesskit_node *node);
  1668. struct accesskit_custom_action *accesskit_custom_action_new(int32_t id);
  1669. void accesskit_custom_action_free(struct accesskit_custom_action *action);
  1670. int32_t accesskit_custom_action_id(
  1671. const struct accesskit_custom_action *action);
  1672. void accesskit_custom_action_set_id(struct accesskit_custom_action *action,
  1673. int32_t id);
  1674. /**
  1675. * Caller must call `accesskit_string_free` with the return value.
  1676. */
  1677. char *accesskit_custom_action_description(
  1678. const struct accesskit_custom_action *action);
  1679. /**
  1680. * Caller is responsible for freeing the memory pointed by `description`.
  1681. */
  1682. void accesskit_custom_action_set_description(
  1683. struct accesskit_custom_action *action, const char *description);
  1684. /**
  1685. * Caller is responsible for freeing the memory pointed by `description`.
  1686. */
  1687. void accesskit_custom_action_set_description_with_length(
  1688. struct accesskit_custom_action *action, const char *description,
  1689. size_t length);
  1690. void accesskit_custom_actions_free(struct accesskit_custom_actions *value);
  1691. /**
  1692. * Caller must call `accesskit_custom_actions_free` with the return value.
  1693. */
  1694. struct accesskit_custom_actions *accesskit_node_custom_actions(
  1695. const struct accesskit_node *node);
  1696. /**
  1697. * Caller is responsible for freeing each `custom_action` in the array.
  1698. */
  1699. void accesskit_node_set_custom_actions(
  1700. struct accesskit_node *node, size_t length,
  1701. struct accesskit_custom_action *const *values);
  1702. /**
  1703. * Takes ownership of `action`.
  1704. */
  1705. void accesskit_node_push_custom_action(struct accesskit_node *node,
  1706. struct accesskit_custom_action *action);
  1707. void accesskit_node_clear_custom_actions(struct accesskit_node *node);
  1708. struct accesskit_node *accesskit_node_new(accesskit_role role);
  1709. void accesskit_node_free(struct accesskit_node *node);
  1710. /**
  1711. * Caller must call `accesskit_string_free` with the return value.
  1712. */
  1713. char *accesskit_node_debug(const struct accesskit_node *node);
  1714. struct accesskit_tree *accesskit_tree_new(accesskit_node_id root);
  1715. void accesskit_tree_free(struct accesskit_tree *tree);
  1716. /**
  1717. * Caller must call `accesskit_string_free` with the return value.
  1718. */
  1719. char *accesskit_tree_get_toolkit_name(const struct accesskit_tree *tree);
  1720. /**
  1721. * Caller is responsible for freeing the memory pointed by `toolkit_name`
  1722. */
  1723. void accesskit_tree_set_toolkit_name(struct accesskit_tree *tree,
  1724. const char *toolkit_name);
  1725. /**
  1726. * Caller is responsible for freeing the memory pointed by `toolkit_name`
  1727. */
  1728. void accesskit_tree_set_toolkit_name_with_length(struct accesskit_tree *tree,
  1729. const char *toolkit_name,
  1730. size_t length);
  1731. void accesskit_tree_clear_toolkit_name(struct accesskit_tree *tree);
  1732. /**
  1733. * Caller must call `accesskit_string_free` with the return value.
  1734. */
  1735. char *accesskit_tree_get_toolkit_version(const struct accesskit_tree *tree);
  1736. /**
  1737. * Caller is responsible for freeing the memory pointed by `toolkit_version`
  1738. */
  1739. void accesskit_tree_set_toolkit_version(struct accesskit_tree *tree,
  1740. const char *toolkit_version);
  1741. /**
  1742. * Caller is responsible for freeing the memory pointed by `toolkit_version`
  1743. */
  1744. void accesskit_tree_set_toolkit_version_with_length(struct accesskit_tree *tree,
  1745. const char *toolkit_version,
  1746. size_t length);
  1747. void accesskit_tree_clear_toolkit_version(struct accesskit_tree *tree);
  1748. /**
  1749. * Caller must call `accesskit_string_free` with the return value.
  1750. */
  1751. char *accesskit_tree_debug(const struct accesskit_tree *tree);
  1752. struct accesskit_tree_update *accesskit_tree_update_with_focus(
  1753. accesskit_node_id focus);
  1754. struct accesskit_tree_update *accesskit_tree_update_with_capacity_and_focus(
  1755. size_t capacity, accesskit_node_id focus);
  1756. void accesskit_tree_update_free(struct accesskit_tree_update *update);
  1757. /**
  1758. * Appends the provided node to the tree update's list of nodes.
  1759. * Takes ownership of `node`.
  1760. */
  1761. void accesskit_tree_update_push_node(struct accesskit_tree_update *update,
  1762. accesskit_node_id id,
  1763. struct accesskit_node *node);
  1764. void accesskit_tree_update_set_tree(struct accesskit_tree_update *update,
  1765. struct accesskit_tree *tree);
  1766. void accesskit_tree_update_clear_tree(struct accesskit_tree_update *update);
  1767. void accesskit_tree_update_set_focus(struct accesskit_tree_update *update,
  1768. accesskit_node_id focus);
  1769. /**
  1770. * Caller must call `accesskit_string_free` with the return value.
  1771. */
  1772. char *accesskit_tree_update_debug(
  1773. const struct accesskit_tree_update *tree_update);
  1774. void accesskit_action_request_free(struct accesskit_action_request *request);
  1775. struct accesskit_affine accesskit_affine_identity(void);
  1776. struct accesskit_affine accesskit_affine_flip_y(void);
  1777. struct accesskit_affine accesskit_affine_flip_x(void);
  1778. struct accesskit_affine accesskit_affine_scale(double s);
  1779. struct accesskit_affine accesskit_affine_scale_non_uniform(double s_x,
  1780. double s_y);
  1781. struct accesskit_affine accesskit_affine_translate(struct accesskit_vec2 p);
  1782. struct accesskit_affine accesskit_affine_map_unit_square(
  1783. struct accesskit_rect rect);
  1784. double accesskit_affine_determinant(struct accesskit_affine affine);
  1785. struct accesskit_affine accesskit_affine_inverse(
  1786. struct accesskit_affine affine);
  1787. struct accesskit_rect accesskit_affine_transform_rect_bbox(
  1788. struct accesskit_affine affine, struct accesskit_rect rect);
  1789. bool accesskit_affine_is_finite(const struct accesskit_affine *affine);
  1790. bool accesskit_affine_is_nan(const struct accesskit_affine *affine);
  1791. struct accesskit_affine accesskit_affine_mul(struct accesskit_affine a,
  1792. struct accesskit_affine b);
  1793. struct accesskit_point accesskit_affine_transform_point(
  1794. struct accesskit_affine affine, struct accesskit_point point);
  1795. struct accesskit_vec2 accesskit_point_to_vec2(struct accesskit_point point);
  1796. struct accesskit_point accesskit_point_add_vec2(struct accesskit_point point,
  1797. struct accesskit_vec2 vec);
  1798. struct accesskit_point accesskit_point_sub_vec2(struct accesskit_point point,
  1799. struct accesskit_vec2 vec);
  1800. struct accesskit_vec2 accesskit_point_sub_point(struct accesskit_point a,
  1801. struct accesskit_point b);
  1802. struct accesskit_rect accesskit_rect_new(double x0, double y0, double x1,
  1803. double y1);
  1804. struct accesskit_rect accesskit_rect_from_points(struct accesskit_point p0,
  1805. struct accesskit_point p1);
  1806. struct accesskit_rect accesskit_rect_from_origin_size(
  1807. struct accesskit_point origin, struct accesskit_size size);
  1808. struct accesskit_rect accesskit_rect_with_origin(struct accesskit_rect rect,
  1809. struct accesskit_point origin);
  1810. struct accesskit_rect accesskit_rect_with_size(struct accesskit_rect rect,
  1811. struct accesskit_size size);
  1812. double accesskit_rect_width(const struct accesskit_rect *rect);
  1813. double accesskit_rect_height(const struct accesskit_rect *rect);
  1814. double accesskit_rect_min_x(const struct accesskit_rect *rect);
  1815. double accesskit_rect_max_x(const struct accesskit_rect *rect);
  1816. double accesskit_rect_min_y(const struct accesskit_rect *rect);
  1817. double accesskit_rect_max_y(const struct accesskit_rect *rect);
  1818. struct accesskit_point accesskit_rect_origin(const struct accesskit_rect *rect);
  1819. struct accesskit_size accesskit_rect_size(const struct accesskit_rect *rect);
  1820. struct accesskit_rect accesskit_rect_abs(const struct accesskit_rect *rect);
  1821. double accesskit_rect_area(const struct accesskit_rect *rect);
  1822. bool accesskit_rect_is_empty(const struct accesskit_rect *rect);
  1823. bool accesskit_rect_contains(const struct accesskit_rect *rect,
  1824. struct accesskit_point point);
  1825. struct accesskit_rect accesskit_rect_union(const struct accesskit_rect *rect,
  1826. struct accesskit_rect other);
  1827. struct accesskit_rect accesskit_rect_union_pt(const struct accesskit_rect *rect,
  1828. struct accesskit_point pt);
  1829. struct accesskit_rect accesskit_rect_intersect(
  1830. const struct accesskit_rect *rect, struct accesskit_rect other);
  1831. struct accesskit_rect accesskit_rect_translate(
  1832. struct accesskit_rect rect, struct accesskit_vec2 translation);
  1833. struct accesskit_vec2 accesskit_size_to_vec2(struct accesskit_size size);
  1834. struct accesskit_size accesskit_size_scale(struct accesskit_size size,
  1835. double scalar);
  1836. struct accesskit_size accesskit_size_add(struct accesskit_size a,
  1837. struct accesskit_size b);
  1838. struct accesskit_size accesskit_size_sub(struct accesskit_size a,
  1839. struct accesskit_size b);
  1840. struct accesskit_point accesskit_vec2_to_point(struct accesskit_vec2 vec2);
  1841. struct accesskit_size accesskit_vec2_to_size(struct accesskit_vec2 vec2);
  1842. struct accesskit_vec2 accesskit_vec2_add(struct accesskit_vec2 a,
  1843. struct accesskit_vec2 b);
  1844. struct accesskit_vec2 accesskit_vec2_sub(struct accesskit_vec2 a,
  1845. struct accesskit_vec2 b);
  1846. struct accesskit_vec2 accesskit_vec2_scale(struct accesskit_vec2 vec,
  1847. double scalar);
  1848. struct accesskit_vec2 accesskit_vec2_neg(struct accesskit_vec2 vec);
  1849. #if defined(__APPLE__)
  1850. /**
  1851. * Memory is also freed when calling this function.
  1852. */
  1853. void accesskit_macos_queued_events_raise(
  1854. struct accesskit_macos_queued_events *events);
  1855. #endif
  1856. #if defined(__APPLE__)
  1857. /**
  1858. * # Safety
  1859. *
  1860. * `view` must be a valid, unreleased pointer to an `NSView`.
  1861. */
  1862. struct accesskit_macos_adapter *accesskit_macos_adapter_new(
  1863. void *view, bool is_view_focused,
  1864. accesskit_action_handler_callback action_handler,
  1865. void *action_handler_userdata);
  1866. #endif
  1867. #if defined(__APPLE__)
  1868. void accesskit_macos_adapter_free(struct accesskit_macos_adapter *adapter);
  1869. #endif
  1870. #if defined(__APPLE__)
  1871. /**
  1872. * You must call `accesskit_macos_queued_events_raise` on the returned pointer.
  1873. * It can be null if the adapter is not active.
  1874. */
  1875. struct accesskit_macos_queued_events *accesskit_macos_adapter_update_if_active(
  1876. struct accesskit_macos_adapter *adapter,
  1877. accesskit_tree_update_factory update_factory,
  1878. void *update_factory_userdata);
  1879. #endif
  1880. #if defined(__APPLE__)
  1881. /**
  1882. * Update the tree state based on whether the window is focused.
  1883. *
  1884. * You must call `accesskit_macos_queued_events_raise` on the returned pointer.
  1885. * It can be null if the adapter is not active.
  1886. */
  1887. struct accesskit_macos_queued_events *
  1888. accesskit_macos_adapter_update_view_focus_state(
  1889. struct accesskit_macos_adapter *adapter, bool is_focused);
  1890. #endif
  1891. #if defined(__APPLE__)
  1892. /**
  1893. * Returns a pointer to an `NSArray`. Ownership of the pointer is not
  1894. * transferred.
  1895. */
  1896. void *accesskit_macos_adapter_view_children(
  1897. struct accesskit_macos_adapter *adapter,
  1898. accesskit_activation_handler_callback activation_handler,
  1899. void *activation_handler_userdata);
  1900. #endif
  1901. #if defined(__APPLE__)
  1902. /**
  1903. * Returns a pointer to an `NSObject`. Ownership of the pointer is not
  1904. * transferred.
  1905. */
  1906. void *accesskit_macos_adapter_focus(
  1907. struct accesskit_macos_adapter *adapter,
  1908. accesskit_activation_handler_callback activation_handler,
  1909. void *activation_handler_userdata);
  1910. #endif
  1911. #if defined(__APPLE__)
  1912. /**
  1913. * Returns a pointer to an `NSObject`. Ownership of the pointer is not
  1914. * transferred.
  1915. */
  1916. void *accesskit_macos_adapter_hit_test(
  1917. struct accesskit_macos_adapter *adapter, double x, double y,
  1918. accesskit_activation_handler_callback activation_handler,
  1919. void *activation_handler_userdata);
  1920. #endif
  1921. #if defined(__APPLE__)
  1922. /**
  1923. * Caller must call `accesskit_string_free` with the return value.
  1924. */
  1925. char *accesskit_macos_adapter_debug(
  1926. const struct accesskit_macos_adapter *adapter);
  1927. #endif
  1928. #if defined(__APPLE__)
  1929. /**
  1930. * # Safety
  1931. *
  1932. * `view` must be a valid, unreleased pointer to an `NSView`.
  1933. */
  1934. struct accesskit_macos_subclassing_adapter *
  1935. accesskit_macos_subclassing_adapter_new(
  1936. void *view, accesskit_activation_handler_callback activation_handler,
  1937. void *activation_handler_userdata,
  1938. accesskit_action_handler_callback action_handler,
  1939. void *action_handler_userdata);
  1940. #endif
  1941. #if defined(__APPLE__)
  1942. /**
  1943. * # Safety
  1944. *
  1945. * `window` must be a valid, unreleased pointer to an `NSWindow`.
  1946. *
  1947. * # Panics
  1948. *
  1949. * This function panics if the specified window doesn't currently have
  1950. * a content view.
  1951. */
  1952. struct accesskit_macos_subclassing_adapter *
  1953. accesskit_macos_subclassing_adapter_for_window(
  1954. void *window, accesskit_activation_handler_callback activation_handler,
  1955. void *activation_handler_userdata,
  1956. accesskit_action_handler_callback action_handler,
  1957. void *action_handler_userdata);
  1958. #endif
  1959. #if defined(__APPLE__)
  1960. void accesskit_macos_subclassing_adapter_free(
  1961. struct accesskit_macos_subclassing_adapter *adapter);
  1962. #endif
  1963. #if defined(__APPLE__)
  1964. /**
  1965. * You must call `accesskit_macos_queued_events_raise` on the returned pointer.
  1966. * It can be null if the adapter is not active.
  1967. */
  1968. struct accesskit_macos_queued_events *
  1969. accesskit_macos_subclassing_adapter_update_if_active(
  1970. struct accesskit_macos_subclassing_adapter *adapter,
  1971. accesskit_tree_update_factory update_factory,
  1972. void *update_factory_userdata);
  1973. #endif
  1974. #if defined(__APPLE__)
  1975. /**
  1976. * Update the tree state based on whether the window is focused.
  1977. *
  1978. * You must call `accesskit_macos_queued_events_raise` on the returned pointer.
  1979. * It can be null if the adapter is not active.
  1980. */
  1981. struct accesskit_macos_queued_events *
  1982. accesskit_macos_subclassing_adapter_update_view_focus_state(
  1983. struct accesskit_macos_subclassing_adapter *adapter, bool is_focused);
  1984. #endif
  1985. #if defined(__APPLE__)
  1986. /**
  1987. * Modifies the specified class, which must be a subclass of `NSWindow`,
  1988. * to include an `accessibilityFocusedUIElement` method that calls
  1989. * the corresponding method on the window's content view. This is needed
  1990. * for windowing libraries such as SDL that place the keyboard focus
  1991. * directly on the window rather than the content view.
  1992. *
  1993. * # Safety
  1994. *
  1995. * This function is declared unsafe because the caller must ensure that the
  1996. * code for this library is never unloaded from the application process,
  1997. * since it's not possible to reverse this operation. It's safest
  1998. * if this library is statically linked into the application's main executable.
  1999. * Also, this function assumes that the specified class is a subclass
  2000. * of `NSWindow`.
  2001. */
  2002. void accesskit_macos_add_focus_forwarder_to_window_class(
  2003. const char *class_name);
  2004. #endif
  2005. #if defined(__APPLE__)
  2006. /**
  2007. * Modifies the specified class, which must be a subclass of `NSWindow`,
  2008. * to include an `accessibilityFocusedUIElement` method that calls
  2009. * the corresponding method on the window's content view. This is needed
  2010. * for windowing libraries such as SDL that place the keyboard focus
  2011. * directly on the window rather than the content view.
  2012. * Caller is responsible for freeing `class_name`.
  2013. *
  2014. * # Safety
  2015. *
  2016. * This function is declared unsafe because the caller must ensure that the
  2017. * code for this library is never unloaded from the application process,
  2018. * since it's not possible to reverse this operation. It's safest
  2019. * if this library is statically linked into the application's main executable.
  2020. * Also, this function assumes that the specified class is a subclass
  2021. * of `NSWindow`.
  2022. */
  2023. void accesskit_macos_add_focus_forwarder_to_window_class_with_length(
  2024. const char *class_name, size_t length);
  2025. #endif
  2026. #if (defined(__linux__) || defined(__DragonFly__) || defined(__FreeBSD__) || \
  2027. defined(__NetBSD__) || defined(__OpenBSD__))
  2028. /**
  2029. * All of the handlers will always be called from another thread.
  2030. */
  2031. struct accesskit_unix_adapter *accesskit_unix_adapter_new(
  2032. accesskit_activation_handler_callback activation_handler,
  2033. void *activation_handler_userdata,
  2034. accesskit_action_handler_callback action_handler,
  2035. void *action_handler_userdata,
  2036. accesskit_deactivation_handler_callback deactivation_handler,
  2037. void *deactivation_handler_userdata);
  2038. #endif
  2039. #if (defined(__linux__) || defined(__DragonFly__) || defined(__FreeBSD__) || \
  2040. defined(__NetBSD__) || defined(__OpenBSD__))
  2041. void accesskit_unix_adapter_free(struct accesskit_unix_adapter *adapter);
  2042. #endif
  2043. #if (defined(__linux__) || defined(__DragonFly__) || defined(__FreeBSD__) || \
  2044. defined(__NetBSD__) || defined(__OpenBSD__))
  2045. /**
  2046. * Set the bounds of the top-level window. The outer bounds contain any
  2047. * window decoration and borders.
  2048. *
  2049. * # Caveats
  2050. *
  2051. * Since an application can not get the position of its window under
  2052. * Wayland, calling this method only makes sense under X11.
  2053. */
  2054. void accesskit_unix_adapter_set_root_window_bounds(
  2055. struct accesskit_unix_adapter *adapter, struct accesskit_rect outer,
  2056. struct accesskit_rect inner);
  2057. #endif
  2058. #if (defined(__linux__) || defined(__DragonFly__) || defined(__FreeBSD__) || \
  2059. defined(__NetBSD__) || defined(__OpenBSD__))
  2060. void accesskit_unix_adapter_update_if_active(
  2061. struct accesskit_unix_adapter *adapter,
  2062. accesskit_tree_update_factory update_factory,
  2063. void *update_factory_userdata);
  2064. #endif
  2065. #if (defined(__linux__) || defined(__DragonFly__) || defined(__FreeBSD__) || \
  2066. defined(__NetBSD__) || defined(__OpenBSD__))
  2067. /**
  2068. * Update the tree state based on whether the window is focused.
  2069. */
  2070. void accesskit_unix_adapter_update_window_focus_state(
  2071. struct accesskit_unix_adapter *adapter, bool is_focused);
  2072. #endif
  2073. #if (defined(__linux__) || defined(__DragonFly__) || defined(__FreeBSD__) || \
  2074. defined(__NetBSD__) || defined(__OpenBSD__))
  2075. /**
  2076. * Caller must call `accesskit_string_free` with the return value.
  2077. */
  2078. char *accesskit_unix_adapter_debug(
  2079. const struct accesskit_unix_adapter *adapter);
  2080. #endif
  2081. #if defined(_WIN32)
  2082. /**
  2083. * Memory is also freed when calling this function.
  2084. */
  2085. void accesskit_windows_queued_events_raise(
  2086. struct accesskit_windows_queued_events *events);
  2087. #endif
  2088. #if defined(_WIN32)
  2089. struct accesskit_windows_adapter *accesskit_windows_adapter_new(
  2090. HWND hwnd, bool is_window_focused,
  2091. accesskit_action_handler_callback action_handler,
  2092. void *action_handler_userdata);
  2093. #endif
  2094. #if defined(_WIN32)
  2095. void accesskit_windows_adapter_free(struct accesskit_windows_adapter *adapter);
  2096. #endif
  2097. #if defined(_WIN32)
  2098. /**
  2099. * You must call `accesskit_windows_queued_events_raise` on the returned
  2100. * pointer. It can be null if the adapter is not active.
  2101. */
  2102. struct accesskit_windows_queued_events *
  2103. accesskit_windows_adapter_update_if_active(
  2104. struct accesskit_windows_adapter *adapter,
  2105. accesskit_tree_update_factory update_factory,
  2106. void *update_factory_userdata);
  2107. #endif
  2108. #if defined(_WIN32)
  2109. /**
  2110. * Update the tree state based on whether the window is focused.
  2111. *
  2112. * You must call `accesskit_windows_queued_events_raise` on the returned
  2113. * pointer.
  2114. */
  2115. struct accesskit_windows_queued_events *
  2116. accesskit_windows_adapter_update_window_focus_state(
  2117. struct accesskit_windows_adapter *adapter, bool is_focused);
  2118. #endif
  2119. #if defined(_WIN32)
  2120. struct accesskit_opt_lresult accesskit_windows_adapter_handle_wm_getobject(
  2121. struct accesskit_windows_adapter *adapter, WPARAM wparam, LPARAM lparam,
  2122. accesskit_activation_handler_callback activation_handler,
  2123. void *activation_handler_userdata);
  2124. #endif
  2125. #if defined(_WIN32)
  2126. /**
  2127. * Caller must call `accesskit_string_free` with the return value.
  2128. */
  2129. char *accesskit_windows_adapter_debug(
  2130. const struct accesskit_windows_adapter *adapter);
  2131. #endif
  2132. #if defined(_WIN32)
  2133. /**
  2134. * Creates a new Windows platform adapter using window subclassing.
  2135. * This must be done before the window is shown or focused
  2136. * for the first time.
  2137. *
  2138. * This must be called on the thread that owns the window. The activation
  2139. * handler will always be called on that thread. The action handler
  2140. * may or may not be called on that thread.
  2141. *
  2142. * # Panics
  2143. *
  2144. * Panics if the window is already visible.
  2145. */
  2146. struct accesskit_windows_subclassing_adapter *
  2147. accesskit_windows_subclassing_adapter_new(
  2148. HWND hwnd, accesskit_activation_handler_callback activation_handler,
  2149. void *activation_handler_userdata,
  2150. accesskit_action_handler_callback action_handler,
  2151. void *action_handler_userdata);
  2152. #endif
  2153. #if defined(_WIN32)
  2154. void accesskit_windows_subclassing_adapter_free(
  2155. struct accesskit_windows_subclassing_adapter *adapter);
  2156. #endif
  2157. #if defined(_WIN32)
  2158. /**
  2159. * You must call `accesskit_windows_queued_events_raise` on the returned
  2160. * pointer. It can be null if the adapter is not active.
  2161. */
  2162. struct accesskit_windows_queued_events *
  2163. accesskit_windows_subclassing_adapter_update_if_active(
  2164. struct accesskit_windows_subclassing_adapter *adapter,
  2165. accesskit_tree_update_factory update_factory,
  2166. void *update_factory_userdata);
  2167. #endif
  2168. #ifdef __cplusplus
  2169. } // extern "C"
  2170. #endif // __cplusplus
  2171. #endif /* ACCESSKIT_H */