summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJoanmarie Diggs <jdiggs@igalia.com>2014-11-17 11:43:53 -0500
committerJoanmarie Diggs <jdiggs@igalia.com>2014-11-19 11:57:41 -0500
commite36374307644141cf16736a4fc53c09b1f06a1c5 (patch)
tree2c80f1ac67538ee7f4f4cdb3c3a13fa335bc315b
parentf532cdb855af7988f5a792bb80c4257083c2b2ba (diff)
downloadat-spi2-core-e36374307644141cf16736a4fc53c09b1f06a1c5.tar.gz
Make the documentation of ATSPI's STATE_ACTIVE consistent with that of ATK's.
https://bugzilla.gnome.org/show_bug.cgi?id=740274
-rw-r--r--atspi/atspi-constants.h8
1 files changed, 7 insertions, 1 deletions
diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h
index 3675bcca..3b7653d8 100644
--- a/atspi/atspi-constants.h
+++ b/atspi/atspi-constants.h
@@ -412,7 +412,13 @@ typedef enum {
* @ATSPI_STATE_INVALID: Indicates an invalid state - probably an error
* condition.
* @ATSPI_STATE_ACTIVE: Indicates a window is currently the active window, or
- * is an active subelement within a container or table.
+ * an object is the active subelement within a container or table.
+ * @ATSPI_STATE_ACTIVE should not be used for objects which have
+ * @ATSPI_STATE_FOCUSABLE or @ATSPI_STATE_SELECTABLE: Those objects should use
+ * @ATSPI_STATE_FOCUSED and @ATSPI_STATE_SELECTED respectively.
+ * @ATSPI_STATE_ACTIVE is a means to indicate that an object which is not
+ * focusable and not selectable is the currently-active item within its
+ * parent container.
* @ATSPI_STATE_ARMED: Indicates that the object is armed.
* @ATSPI_STATE_BUSY: Indicates the current object is busy, i.e. onscreen
* representation is in the process of changing, or the object is