From e5f56c004944944e7ac95d02e2f7e78ad2d6176e Mon Sep 17 00:00:00 2001 From: Padraig O'Briain Date: Wed, 10 Sep 2003 10:19:52 +0000 Subject: Remove comments about signals. The description should be in files in 2003-09-10 Padraig O'Briain * 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. --- ChangeLog | 19 +++++++++++++++++++ atk/atkobject.c | 9 --------- docs/tmpl/atkhypertext.sgml | 5 +++-- docs/tmpl/atkobject.sgml | 26 ++++++++++++++++---------- docs/tmpl/atkselection.sgml | 3 ++- docs/tmpl/atktable.sgml | 21 +++++++++++++++------ docs/tmpl/atktext.sgml | 14 ++++++++++---- 7 files changed, 65 insertions(+), 32 deletions(-) diff --git a/ChangeLog b/ChangeLog index 9dd9cf2..829d74b 100644 --- a/ChangeLog +++ b/ChangeLog @@ -1,3 +1,22 @@ +2003-09-10 Padraig O'Briain + + * 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 * ===== Released 1.4.0===== diff --git a/atk/atkobject.c b/atk/atkobject.c index 5f25af5..343c0d5 100755 --- a/atk/atkobject.c +++ b/atk/atkobject.c @@ -307,10 +307,6 @@ atk_object_class_init (AtkObjectClass *klass) "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), @@ -338,11 +334,6 @@ atk_object_class_init (AtkObjectClass *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), diff --git a/docs/tmpl/atkhypertext.sgml b/docs/tmpl/atkhypertext.sgml index 0f59ad5..e8ba992 100644 --- a/docs/tmpl/atkhypertext.sgml +++ b/docs/tmpl/atkhypertext.sgml @@ -51,9 +51,10 @@ The AtkHypertext structure does not contain any fields. - +The "link-selected" signal is emitted by an AtkHyperText object when one of +the hyperlinks associated with the object is selected. @atkhypertext: the object which received the signal. -@arg1: +@arg1: the index of the hyperlink which is selected diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml index 19b3cca..0231c37 100644 --- a/docs/tmpl/atkobject.sgml +++ b/docs/tmpl/atkobject.sgml @@ -420,16 +420,19 @@ atk_object_connect_property_change_handler(). - +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. @atkobject: the object which received the signal. -@arg1: +@arg1: the newly focused object. -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" @atkobject: the object which received the signal. @@ -438,16 +441,17 @@ indicate whether a child was added or removed - +The signal "focus-event" is emitted when an object gains or loses focus. @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. -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. @atkobject: the object which received the signal. @@ -455,7 +459,8 @@ changed. -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. @atkobject: the object which received the signal. @@ -464,7 +469,8 @@ This signal support, which may be any of the accessible state types. - +The "visible-data-changed" signal is emitted when the visual appearance of +the object changed. @atkobject: the object which received the signal. diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml index 1f6fa6f..b3a6148 100644 --- a/docs/tmpl/atkselection.sgml +++ b/docs/tmpl/atkselection.sgml @@ -101,7 +101,8 @@ The AtkAction structure does not contain any fields. - +The "selection-changed" signal is emitted by an object which implements +AtkSelection interface when the selection changes. @atkselection: the object which received the signal. diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml index d710d68..96d6dc7 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -331,7 +331,8 @@ The AtkTable structure does not contain any fields. - +The "column-deleted" signal is emitted by an object which implements the +AtkTable interface when a column is deleted. @atktable: the object which received the signal. @@ -340,29 +341,35 @@ The AtkTable structure does not contain any fields. +The "column-inserted" signal is emitted by an object which implements the +AtkTable interface when a column is inserted. @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. - +The "column-reordered" signal is emitted by an object which implements the +AtkTable interface when the columns are reordered. @atktable: the object which received the signal. - +The "model-changed" signal is emitted by an object which implements the +AtkTable interface when the model displayed by the table changes. @atktable: the object which received the signal. +The "row-deleted" signal is emitted by an object which implements the +AtkTable interface when a column is inserted. @@ -372,7 +379,8 @@ The AtkTable structure does not contain any fields. - +The "row-inserted" signal is emitted by an object which implements the +AtkTable interface when a column is inserted. @atktable: the object which received the signal. @@ -381,7 +389,8 @@ The AtkTable structure does not contain any fields. - +The "row-reordered" signal is emitted by an object which implements the +AtkTable interface when the columns are reordered. @atktable: the object which received the signal. diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml index 4910972..38e3945 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -399,14 +399,16 @@ The AtkText structure does not contain any fields. - +The "text-attributes-changed" signal is emitted when the text attributes of +the text of an object which implements AtkText changes. @atktext: the object which received the signal. - +The "text-caret-moved" signal is emitted when the caret position of +the text of an object which implements AtkText changes. @atktext: the object which received the signal. @@ -414,8 +416,10 @@ The AtkText structure does not contain any fields. -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 @atktext: the object which received the signal. @@ -424,6 +428,8 @@ which identifies whether the text change was an insertion or a deletion +The "text-selection-changed" signal is emitted when the selected text of +an object which implements AtkText changes. -- cgit v1.2.1