summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTait Hoyem <tait@tait.tech>2023-01-10 19:28:01 -0700
committerTait Hoyem <tait@tait.tech>2023-01-10 19:28:01 -0700
commit69bd64dd2c7c953cae65deb17e0db760bd995da3 (patch)
tree10686bead17dbabda9b6b9599f4764118b1f3d92
parenta6d486411942c4ebea59eb9bedf7c1bbf6d81f23 (diff)
downloadat-spi2-core-69bd64dd2c7c953cae65deb17e0db760bd995da3.tar.gz
Add an example for DBus events that could be reworked
-rw-r--r--devel-docs/at-spi3.rst13
1 files changed, 12 insertions, 1 deletions
diff --git a/devel-docs/at-spi3.rst b/devel-docs/at-spi3.rst
index c1cf0e97..3e504cf4 100644
--- a/devel-docs/at-spi3.rst
+++ b/devel-docs/at-spi3.rst
@@ -17,6 +17,17 @@ future version of the API.
applications could then respond to, and applications could similarly
query consumers for a list of events that they care about.
-- The DBus API for sending events should be reviewed. TODO: flesh this out.
+- The DBus API for sending events should be reviewed. All events in the
+ `xml/Event.xml` file return items with the same "siiva{sv}" signature
+ when it is not necessary. Take for example "StateChanged", which only
+ uses the first two variables: a string of the state which has been
+ changed, and a signed integer that may be either 1 or 0 depending on
+ if the state has been added or removed. For one thing, it is clear that
+ the second argument for "StateChanged" should be "b" for bool, and
+ secondly the arguments "iva{sv}" do not seem to be used at all for this
+ event, and subsequently could be dropped. This is only the example of
+ one event with issues like this. Nearly every event has a similar case
+ of some unused fields, or fields that don't *exactly* match the
+ smenatics of their type sent over DBus.
- The AtspiEventListener API is hard to use and also needs to be reworked.