diff options
Diffstat (limited to 'docs/tmpl')
| -rw-r--r-- | docs/tmpl/atkhyperlink.sgml | 10 | ||||
| -rw-r--r-- | docs/tmpl/atkhypertext.sgml | 18 | ||||
| -rw-r--r-- | docs/tmpl/atkobject.sgml | 254 | ||||
| -rw-r--r-- | docs/tmpl/atkrelation.sgml | 20 | ||||
| -rw-r--r-- | docs/tmpl/atkselection.sgml | 16 | ||||
| -rw-r--r-- | docs/tmpl/atktable.sgml | 132 | ||||
| -rw-r--r-- | docs/tmpl/atktext.sgml | 76 |
7 files changed, 263 insertions, 263 deletions
diff --git a/docs/tmpl/atkhyperlink.sgml b/docs/tmpl/atkhyperlink.sgml index e90e544..fe9840e 100644 --- a/docs/tmpl/atkhyperlink.sgml +++ b/docs/tmpl/atkhyperlink.sgml @@ -22,6 +22,11 @@ The AtkHyperlink structure should not be accessed directly. </para> +<!-- ##### ARG AtkHyperlink:selected-link ##### --> +<para> + +</para> + <!-- ##### ENUM AtkHyperlinkStateFlags ##### --> <para> @@ -103,8 +108,3 @@ The AtkHyperlink structure should not be accessed directly. @Returns: -<!-- ##### ARG AtkHyperlink:selected-link ##### --> -<para> - -</para> - diff --git a/docs/tmpl/atkhypertext.sgml b/docs/tmpl/atkhypertext.sgml index e8ba992..3b91fdf 100644 --- a/docs/tmpl/atkhypertext.sgml +++ b/docs/tmpl/atkhypertext.sgml @@ -20,6 +20,15 @@ The AtkHypertext structure does not contain any fields. </para> +<!-- ##### 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: the index of the hyperlink which is selected + <!-- ##### FUNCTION atk_hypertext_get_link ##### --> <para> @@ -49,12 +58,3 @@ The AtkHypertext structure does not contain any fields. @Returns: -<!-- ##### 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: the index of the hyperlink which is selected - diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml index 0231c37..ff081a2 100644 --- a/docs/tmpl/atkobject.sgml +++ b/docs/tmpl/atkobject.sgml @@ -38,6 +38,133 @@ The AtkObject structure should not be accessed directly. </para> +<!-- ##### 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: the newly focused object. + +<!-- ##### SIGNAL AtkObject::children-changed ##### --> +<para> +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. +@arg1: The index of the added or removed child +@arg2: The child which was added or removed + +<!-- ##### 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 the object gained or lost focus. + +<!-- ##### SIGNAL AtkObject::property-change ##### --> +<para> +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. +@arg1: The new value of the property which changed. + +<!-- ##### SIGNAL AtkObject::state-change ##### --> +<para> +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. +@arg1: The name of the state which has changed +@arg2: A boolean which indicates whether the state has been set or unset. + +<!-- ##### 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. + +<!-- ##### ARG AtkObject:accessible-component-layer ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-description ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-name ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-parent ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-role ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-table-caption ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-table-caption-object ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-table-column-description ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-table-column-header ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-table-row-description ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-table-row-header ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-table-summary ##### --> +<para> + +</para> + +<!-- ##### ARG AtkObject:accessible-value ##### --> +<para> + +</para> + <!-- ##### ENUM AtkRole ##### --> <para> </para> @@ -418,130 +545,3 @@ atk_object_connect_property_change_handler(). @Returns: -<!-- ##### 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: the newly focused object. - -<!-- ##### SIGNAL AtkObject::children-changed ##### --> -<para> -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. -@arg1: The index of the added or removed child -@arg2: The child which was added or removed - -<!-- ##### 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 the object gained or lost focus. - -<!-- ##### SIGNAL AtkObject::property-change ##### --> -<para> -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. -@arg1: The new value of the property which changed. - -<!-- ##### SIGNAL AtkObject::state-change ##### --> -<para> -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. -@arg1: The name of the state which has changed -@arg2: A boolean which indicates whether the state has been set or unset. - -<!-- ##### 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. - -<!-- ##### ARG AtkObject:accessible-component-layer ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-description ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-name ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-parent ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-role ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-caption ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-caption-object ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-column-description ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-column-header ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-row-description ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-row-header ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-summary ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-value ##### --> -<para> - -</para> - diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml index 2652225..2a05316 100644 --- a/docs/tmpl/atkrelation.sgml +++ b/docs/tmpl/atkrelation.sgml @@ -26,6 +26,16 @@ The AtkRelation structure should not be accessed directly. </para> +<!-- ##### ARG AtkRelation:relation-type ##### --> +<para> + +</para> + +<!-- ##### ARG AtkRelation:target ##### --> +<para> + +</para> + <!-- ##### ENUM AtkRelationType ##### --> <para> @@ -102,13 +112,3 @@ The AtkRelation structure should not be accessed directly. @Returns: -<!-- ##### ARG AtkRelation:relation-type ##### --> -<para> - -</para> - -<!-- ##### ARG AtkRelation:target ##### --> -<para> - -</para> - diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml index b3a6148..009f466 100644 --- a/docs/tmpl/atkselection.sgml +++ b/docs/tmpl/atkselection.sgml @@ -32,6 +32,14 @@ The AtkAction structure does not contain any fields. </para> +<!-- ##### 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. + <!-- ##### FUNCTION atk_selection_add_selection ##### --> <para> @@ -99,11 +107,3 @@ The AtkAction structure does not contain any fields. @Returns: -<!-- ##### 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. - diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml index 96d6dc7..57ce664 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -40,6 +40,72 @@ The AtkTable structure does not contain any fields. </para> +<!-- ##### 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. +@arg1: The index of the first column deleted. +@arg2: The number of columns deleted. + +<!-- ##### 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 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> + +@atktable: the object which received the signal. +@arg1: The index of the first row deleted. +@arg2: The number of rows deleted. + +<!-- ##### 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. +@arg1: The index of the first row deleted. +@arg2: The number of rows deleted. + +<!-- ##### 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. + <!-- ##### FUNCTION atk_table_ref_at ##### --> <para> @@ -329,69 +395,3 @@ The AtkTable structure does not contain any fields. @Returns: -<!-- ##### 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. -@arg1: The index of the first column deleted. -@arg2: The number of columns deleted. - -<!-- ##### 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 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> - -@atktable: the object which received the signal. -@arg1: The index of the first row deleted. -@arg2: The number of rows deleted. - -<!-- ##### 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. -@arg1: The index of the first row deleted. -@arg2: The number of rows deleted. - -<!-- ##### 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. - diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml index 38e3945..760a063 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -38,6 +38,44 @@ The AtkText structure does not contain any fields. </para> +<!-- ##### 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. +@arg1: The new position of the text caret. + +<!-- ##### SIGNAL AtkText::text-changed ##### --> +<para> +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. +@arg1: The position of the insertion or deletion. +@arg2: The length of text inserted or deleted. + +<!-- ##### 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> + +@atktext: the object which received the signal. + <!-- ##### ENUM AtkTextBoundary ##### --> <para> @@ -397,41 +435,3 @@ The AtkText structure does not contain any fields. @Returns: -<!-- ##### 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. -@arg1: The new position of the text caret. - -<!-- ##### SIGNAL AtkText::text-changed ##### --> -<para> -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. -@arg1: The position of the insertion or deletion. -@arg2: The length of text inserted or deleted. - -<!-- ##### 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> - -@atktext: the object which received the signal. - |