diff options
author | Federico Mena Quintero <federico@gnome.org> | 2022-12-12 12:29:15 -0600 |
---|---|---|
committer | Federico Mena Quintero <federico@gnome.org> | 2022-12-12 16:47:54 -0600 |
commit | 84bfa92ef32d5fbc1ade858d32b3bd242e0e4263 (patch) | |
tree | 24496a4e4834d4804b12206de26235c2e5ddec96 | |
parent | b8c7f7f01c7718e2e055eb61e0372c09fd92730f (diff) | |
download | at-spi2-core-84bfa92ef32d5fbc1ade858d32b3bd242e0e4263.tar.gz |
Finish the list of changes to the XML interfaces
-rw-r--r-- | devel-docs/xml-changes.rst | 52 |
1 files changed, 43 insertions, 9 deletions
diff --git a/devel-docs/xml-changes.rst b/devel-docs/xml-changes.rst index bfb6bc31..cf49b4ba 100644 --- a/devel-docs/xml-changes.rst +++ b/devel-docs/xml-changes.rst @@ -9,21 +9,55 @@ past. During the process of `auditing the XML and C code they match each other, changes have been needed in the XML definitions. -The idea is that the C code nominally *works*, and we hope to make the -XML descriptions of the DBus interfaces actually match reality. This -is so that other projects that consume those interfaces can assume -that the XML is correct and documented, instead of having to dig into -the accessibility code. +**Assumptions for toolkits:** Regretfully, both the in-tree XML files +and the introspected XML you get from DBus have been out of sync with +the C code. We are fixing this so that they always stay in sync: + +* Make the XML files the single source of truth... + +* By making sure the XML matches the C code, which is the ground truth + before this auditing project began... + +* And by making sure that the introspected XML matches the XML files + in-tree. + +* Along the way, document all the XML interfaces properly. This document is a list of changes that we've made to the XML -interfaces since FIXME: date/version. If you generate code based on -the XML, keep an eye on this document. +interfaces since 2022/Jun (starting with version 2.45.90). If you +generate code based on the XML, keep an eye on this document. The changes here are about **method signatures**. Changes to the documentation are not listed, since they do not affect generated code. +The changes are listed in reverse chronological order (newest first). + +* add8abce - 2022/12/09 - ``DeviceEventListener.xml`` - Remove unused signals + ``DeviceListenerRegistered`` and ``DeviceListenerDeregistered``. -* 9096b760 - 2022/12/09 - DeviceEventController.xml: fix the signature +* 9096b760 - 2022/12/09 - ``DeviceEventController.xml`` - fix the signature of the ``types`` argument in the ``RegisterKeystrokeListener`` method; it's ``u`` now as it is a bitmask, not an array. -* +* 55934a59 - 2022/12/05 - ``DeviceEventController.xml`` - remove unused method + ``DeregisterDeviceEventListener``. + +* 9b96a257 - 2022/12/05 - ``DeviceEventController.xml`` - remove unused method + ``RegisterDeviceEventListener``. + +* cb10a4c9 - 2022/12/05 - ``DeviceEventController.xml`` - remove unused method + ``GetDeviceEventListeners``. + +* f0781465 - 2022/08/26 - ``Event.xml`` - Fix the signature of all + signals. See https://gitlab.gnome.org/GNOME/at-spi2-core/-/issues/74 + +* 01d624b1 - 2022/08/11 - ``Application.xml`` - document the ``GetLocale`` method as not + used. + +* 26835da29 - 2022/08/04 - ``Event.xml`` - Add an ``Announcement`` signal to the + ``org.a11y.atspi.Event.Object`` interface. + +* 0412902f - 2022/07/01 - ``DeviceEventListener.xml``: add missing signals + ``KeystrokeListenerRegistered``, ``KeystrokeListenerDeregistered`` + +* ae6eb3bd - 2022/07/01 - ``DeviceEventController.xml``: add missing + methods ``GetKeystrokeListeners``. |