+2003-09-10 Padraig O'Briain <padraig.obriain@sun.com>
+
+ * atk/atkobject.c: Remove comments about signals. The description
+ should be in files in docs/tmpl directory.
+
+ * docs/tmpl/atkhypertext.sgml: Add description for link-selected signal.
+ * docs/tmpl/atkobject.sgml: Add descriptions for
+ active-descendant-changed, children-changed, focus-event,
+ property-change, state-change and visible-data-changed signals.
+ * docs/tmpl/atkselection.sgml: Add description for selection-changed
+ signal.
+ * docs/tmpl/atktable.sgml: Add descriptions for column-deleted,
+ columnn-inserted, column-reordered, model-changed, row-deleted,
+ row-inserted and row-reordered signals.
+ * docs/tmpl/atktext.sgml: Add description for text-attributes-changed,
+ text-caret-moved, text-changed nd text-selection-changed signals.
+
+ This fixes bug #121163.
+
2003-09-02 Padraig O'Briain <padraig.obriain@sun.com>
* ===== Released 1.4.0=====
"Is used to notify that the table caption has changed ",
ATK_TYPE_OBJECT,
G_PARAM_READWRITE));
- /*
- * The signal "children_changed" supports two details:
- * "add" and "remove"
- */
atk_object_signals[CHILDREN_CHANGED] =
g_signal_new ("children_changed",
G_TYPE_FROM_CLASS (klass),
g_cclosure_marshal_VOID__POINTER,
G_TYPE_NONE, 1,
G_TYPE_POINTER);
- /*
- * The "state_change" signal supports details, one for each accessible
- * state type
- * (see atkstate.c).
- */
atk_object_signals[STATE_CHANGE] =
g_signal_new ("state_change",
G_TYPE_FROM_CLASS (klass),
<!-- ##### SIGNAL AtkHypertext::link-selected ##### -->
<para>
-
+The "link-selected" signal is emitted by an AtkHyperText object when one of
+the hyperlinks associated with the object is selected.
</para>
@atkhypertext: the object which received the signal.
-@arg1:
+@arg1: the index of the hyperlink which is selected
<!-- ##### SIGNAL AtkObject::active-descendant-changed ##### -->
<para>
-
+The "active-descendant-changed" signal is emitted by an object which has
+the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the
+object changes. For instance, a table will emit the signal when the cell
+in the table which has focus changes.
</para>
@atkobject: the object which received the signal.
-@arg1:
+@arg1: the newly focused object.
<!-- ##### SIGNAL AtkObject::children-changed ##### -->
<para>
-The children_changed signal supports two details, "add" and "remove" which
-indicate whether a child was added or removed
+The signal "children-changed" is emitted when a child is added or
+removed form an object. It supports two details: "add" and "remove"
</para>
@atkobject: the object which received the signal.
<!-- ##### SIGNAL AtkObject::focus-event ##### -->
<para>
-
+The signal "focus-event" is emitted when an object gains or loses focus.
</para>
@atkobject: the object which received the signal.
-@arg1: A boolean value which indicates whether or not the focus event is is or out.
+@arg1: A boolean value which indicates whether the object gained or lost focus.
<!-- ##### SIGNAL AtkObject::property-change ##### -->
<para>
-This signal support a detail which identifies the property which has
-changed.
+The signal "property-change" is emitted when an object's property
+value changes. The detail identifies the name of the property whose
+value has changed.
</para>
@atkobject: the object which received the signal.
<!-- ##### SIGNAL AtkObject::state-change ##### -->
<para>
-This signal support, which may be any of the accessible state types.
+The "state-change" signal is emitted when an object's state changes.
+The detail value identifies the state type which has changed.
</para>
@atkobject: the object which received the signal.
<!-- ##### SIGNAL AtkObject::visible-data-changed ##### -->
<para>
-
+The "visible-data-changed" signal is emitted when the visual appearance of
+the object changed.
</para>
@atkobject: the object which received the signal.
<!-- ##### SIGNAL AtkSelection::selection-changed ##### -->
<para>
-
+The "selection-changed" signal is emitted by an object which implements
+AtkSelection interface when the selection changes.
</para>
@atkselection: the object which received the signal.
<!-- ##### SIGNAL AtkTable::column-deleted ##### -->
<para>
-
+The "column-deleted" signal is emitted by an object which implements the
+AtkTable interface when a column is deleted.
</para>
@atktable: the object which received the signal.
<!-- ##### SIGNAL AtkTable::column-inserted ##### -->
<para>
+The "column-inserted" signal is emitted by an object which implements the
+AtkTable interface when a column is inserted.
</para>
@atktable: the object which received the signal.
@arg1: The index of the column inserted.
-@arg2: The number of colums inserteda.
+@arg2: The number of colums inserted.
<!-- ##### SIGNAL AtkTable::column-reordered ##### -->
<para>
-
+The "column-reordered" signal is emitted by an object which implements the
+AtkTable interface when the columns are reordered.
</para>
@atktable: the object which received the signal.
<!-- ##### SIGNAL AtkTable::model-changed ##### -->
<para>
-
+The "model-changed" signal is emitted by an object which implements the
+AtkTable interface when the model displayed by the table changes.
</para>
@atktable: the object which received the signal.
<!-- ##### SIGNAL AtkTable::row-deleted ##### -->
<para>
+The "row-deleted" signal is emitted by an object which implements the
+AtkTable interface when a column is inserted.
</para>
<!-- ##### SIGNAL AtkTable::row-inserted ##### -->
<para>
-
+The "row-inserted" signal is emitted by an object which implements the
+AtkTable interface when a column is inserted.
</para>
@atktable: the object which received the signal.
<!-- ##### SIGNAL AtkTable::row-reordered ##### -->
<para>
-
+The "row-reordered" signal is emitted by an object which implements the
+AtkTable interface when the columns are reordered.
</para>
@atktable: the object which received the signal.
<!-- ##### SIGNAL AtkText::text-attributes-changed ##### -->
<para>
-
+The "text-attributes-changed" signal is emitted when the text attributes of
+the text of an object which implements AtkText changes.
</para>
@atktext: the object which received the signal.
<!-- ##### SIGNAL AtkText::text-caret-moved ##### -->
<para>
-
+The "text-caret-moved" signal is emitted when the caret position of
+the text of an object which implements AtkText changes.
</para>
@atktext: the object which received the signal.
<!-- ##### SIGNAL AtkText::text-changed ##### -->
<para>
-This signal will have a detail which is either "insert" or "delete"
-which identifies whether the text change was an insertion or a deletion
+The "text-changed" signal is emitted when the text of the object which
+implements the AtkText interface changes, This signal will have a detail
+which is either "insert" or "delete" which identifies whether the text
+change was an insertion or a deletion
</para>
@atktext: the object which received the signal.
<!-- ##### SIGNAL AtkText::text-selection-changed ##### -->
<para>
+The "text-selection-changed" signal is emitted when the selected text of
+an object which implements AtkText changes.
</para>
projects / platform / upstream / atk.git / commitdiff