Make the documentation of ATSPI's STATE_ACTIVE consistent with that of ATK's.
authorJoanmarie Diggs <jdiggs@igalia.com>
Mon, 17 Nov 2014 16:43:53 +0000 (11:43 -0500)
committerJoanmarie Diggs <jdiggs@igalia.com>
Wed, 19 Nov 2014 16:57:41 +0000 (11:57 -0500)
https://bugzilla.gnome.org/show_bug.cgi?id=740274

atspi/atspi-constants.h

index 3675bcc..3b7653d 100644 (file)
@@ -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