diff options
author | Bill Haneman <billh@src.gnome.org> | 2005-11-18 14:08:01 +0000 |
---|---|---|
committer | Bill Haneman <billh@src.gnome.org> | 2005-11-18 14:08:01 +0000 |
commit | 7a56a583b968de3db888135dec1d6c73e593ad6e (patch) | |
tree | dad26f1b3a2ecec0d27fdb2123ec20a0a74c49a8 /docs | |
parent | 43ccc848ace2a984274b6de0ae0ea2fa5dffc3fa (diff) | |
download | atk-7a56a583b968de3db888135dec1d6c73e593ad6e.tar.gz |
Added new API for ATK 1.11/1.12. Minor docs cleanup.
Added new API for ATK 1.11/1.12.
Minor docs cleanup.
Diffstat (limited to 'docs')
-rw-r--r-- | docs/tmpl/atkaction.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkcomponent.sgml | 21 | ||||
-rw-r--r-- | docs/tmpl/atkdocument.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkeditabletext.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkgobjectaccessible.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkhyperlink.sgml | 57 | ||||
-rw-r--r-- | docs/tmpl/atkhypertext.sgml | 21 | ||||
-rw-r--r-- | docs/tmpl/atkimage.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atknoopobject.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atknoopobjectfactory.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkobject.sgml | 279 | ||||
-rw-r--r-- | docs/tmpl/atkobjectfactory.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkregistry.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkrelation.sgml | 23 | ||||
-rw-r--r-- | docs/tmpl/atkrelationset.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkselection.sgml | 19 | ||||
-rw-r--r-- | docs/tmpl/atkstate.sgml | 7 | ||||
-rw-r--r-- | docs/tmpl/atkstateset.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atkstreamablecontent.sgml | 3 | ||||
-rw-r--r-- | docs/tmpl/atktable.sgml | 135 | ||||
-rw-r--r-- | docs/tmpl/atktext.sgml | 79 | ||||
-rw-r--r-- | docs/tmpl/atkvalue.sgml | 3 |
22 files changed, 379 insertions, 301 deletions
diff --git a/docs/tmpl/atkaction.sgml b/docs/tmpl/atkaction.sgml index 1dec4a9..565b7b2 100644 --- a/docs/tmpl/atkaction.sgml +++ b/docs/tmpl/atkaction.sgml @@ -41,6 +41,9 @@ terminology for #AtkAction names. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkAction ##### --> <para> The AtkAction structure does not contain any fields. diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml index 59c2b3e..2ea4585 100644 --- a/docs/tmpl/atkcomponent.sgml +++ b/docs/tmpl/atkcomponent.sgml @@ -25,6 +25,9 @@ provided by #AtkText. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkComponent ##### --> <para> The AtkComponent structure does not contain any fields. @@ -32,6 +35,15 @@ The AtkComponent structure does not contain any fields. </para> +<!-- ##### SIGNAL AtkComponent::bounds-changed ##### --> +<para> +The 'bounds-changed" signal is emitted when the bposition or size of the +a component changes. +</para> + +@atkcomponent: the object which received the signal. +@arg1: The AtkRectangle giving the new position and size. + <!-- ##### FUNCTION atk_component_add_focus_handler ##### --> <para> @@ -173,12 +185,3 @@ The AtkComponent structure does not contain any fields. @Returns: -<!-- ##### SIGNAL AtkComponent::bounds-changed ##### --> -<para> -The 'bounds-changed" signal is emitted when the bposition or size of the -a component changes. -</para> - -@atkcomponent: the object which received the signal. -@arg1: The AtkRectangle giving the new position and size. - diff --git a/docs/tmpl/atkdocument.sgml b/docs/tmpl/atkdocument.sgml index f93065d..70aead7 100644 --- a/docs/tmpl/atkdocument.sgml +++ b/docs/tmpl/atkdocument.sgml @@ -16,6 +16,9 @@ standard mechanism allowing an assistive technology access to the DOM. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkDocument ##### --> <para> The AtkDocument structure does not contain any fields. diff --git a/docs/tmpl/atkeditabletext.sgml b/docs/tmpl/atkeditabletext.sgml index 2a3d611..945b583 100644 --- a/docs/tmpl/atkeditabletext.sgml +++ b/docs/tmpl/atkeditabletext.sgml @@ -20,6 +20,9 @@ implements #AtkEditableText is by definition an #AtkText implementor as well. #AtkText </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkEditableText ##### --> <para> The AtkEditableText structure does not contain any fields. diff --git a/docs/tmpl/atkgobjectaccessible.sgml b/docs/tmpl/atkgobjectaccessible.sgml index 460512b..3e3e59b 100644 --- a/docs/tmpl/atkgobjectaccessible.sgml +++ b/docs/tmpl/atkgobjectaccessible.sgml @@ -19,6 +19,9 @@ for GnomeCanvasItem in the GAIL library. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkGObjectAccessible ##### --> <para> The AtkGObjectAccessible structure should not be accessed directly. diff --git a/docs/tmpl/atkhyperlink.sgml b/docs/tmpl/atkhyperlink.sgml index 3d6708c..b0bcc62 100644 --- a/docs/tmpl/atkhyperlink.sgml +++ b/docs/tmpl/atkhyperlink.sgml @@ -15,6 +15,9 @@ It implements the AtkAction interface. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkHyperlink ##### --> <para> The AtkHyperlink structure should not be accessed directly. @@ -22,6 +25,33 @@ The AtkHyperlink structure should not be accessed directly. </para> +<!-- ##### SIGNAL AtkHyperlink::link-activated ##### --> +<para> +The signal link-activated is emitted when a link is activated. +</para> + +@atkhyperlink: the object which received the signal. + +<!-- ##### ARG AtkHyperlink:end-index ##### --> +<para> + +</para> + +<!-- ##### ARG AtkHyperlink:number-of-anchors ##### --> +<para> + +</para> + +<!-- ##### ARG AtkHyperlink:selected-link ##### --> +<para> + +</para> + +<!-- ##### ARG AtkHyperlink:start-index ##### --> +<para> + +</para> + <!-- ##### ENUM AtkHyperlinkStateFlags ##### --> <para> @@ -103,30 +133,3 @@ The AtkHyperlink structure should not be accessed directly. @Returns: -<!-- ##### SIGNAL AtkHyperlink::link-activated ##### --> -<para> -The signal link-activated is emitted when a link is activated. -</para> - -@atkhyperlink: the object which received the signal. - -<!-- ##### ARG AtkHyperlink:end-index ##### --> -<para> - -</para> - -<!-- ##### ARG AtkHyperlink:number-of-anchors ##### --> -<para> - -</para> - -<!-- ##### ARG AtkHyperlink:selected-link ##### --> -<para> - -</para> - -<!-- ##### ARG AtkHyperlink:start-index ##### --> -<para> - -</para> - diff --git a/docs/tmpl/atkhypertext.sgml b/docs/tmpl/atkhypertext.sgml index e8ba992..20903a5 100644 --- a/docs/tmpl/atkhypertext.sgml +++ b/docs/tmpl/atkhypertext.sgml @@ -14,12 +14,24 @@ The ATK interface which provides standard mechanism for manipulating hyperlinks. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkHypertext ##### --> <para> 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 +61,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/atkimage.sgml b/docs/tmpl/atkimage.sgml index fbfb8f2..00757b0 100644 --- a/docs/tmpl/atkimage.sgml +++ b/docs/tmpl/atkimage.sgml @@ -26,6 +26,9 @@ most significant information present in the image. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkImage ##### --> <para> The AtkImage structure does not contain any fields. diff --git a/docs/tmpl/atknoopobject.sgml b/docs/tmpl/atknoopobject.sgml index f0fc084..1492b71 100644 --- a/docs/tmpl/atknoopobject.sgml +++ b/docs/tmpl/atknoopobject.sgml @@ -16,6 +16,9 @@ object is requested for an object type for which no factory type is specified. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkNoOpObject ##### --> <para> The AtkNoOpObject structure should not be accessed directly. diff --git a/docs/tmpl/atknoopobjectfactory.sgml b/docs/tmpl/atknoopobjectfactory.sgml index 6733264..ab304d2 100644 --- a/docs/tmpl/atknoopobjectfactory.sgml +++ b/docs/tmpl/atknoopobjectfactory.sgml @@ -16,6 +16,9 @@ create an accessible object of a particular type. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkNoOpObjectFactory ##### --> <para> The AtkNoOpObjectFactory structure should not be accessed directly. diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml index 448292d..dc03dd3 100644 --- a/docs/tmpl/atkobject.sgml +++ b/docs/tmpl/atkobject.sgml @@ -31,6 +31,9 @@ See also: #AtkObjectFactory, #AtkRegistry. ( GTK+ users see also #GtkAccessible). </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkObject ##### --> <para> The AtkObject structure should not be accessed directly. @@ -38,6 +41,138 @@ 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-hypertext-nlinks ##### --> +<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> @@ -119,6 +254,14 @@ The AtkObject structure should not be accessed directly. @ATK_ROLE_AUTOCOMPLETE: @ATK_ROLE_EDITBAR: @ATK_ROLE_EMBEDDED: +@ATK_ROLE_ENTRY: +@ATK_ROLE_CHART: +@ATK_ROLE_CAPTION: +@ATK_ROLE_DOCUMENT_FRAME: +@ATK_ROLE_HEADING: +@ATK_ROLE_PAGE: +@ATK_ROLE_SECTION: +@ATK_ROLE_REDUNDANT_OBJECT: @ATK_ROLE_LAST_DEFINED: <!-- ##### FUNCTION atk_role_register ##### --> @@ -184,8 +327,8 @@ An AtkPropertyChangeHandler is a function which is executed when an AtkObject's atk_object_connect_property_change_handler(). </para> -@Param1: -@Param2: +@Param1: an #AtkObject +@Param2: an #AtkPropertyValues <!-- ##### FUNCTION atk_implementor_ref_accessible ##### --> @@ -420,135 +563,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-hypertext-nlinks ##### --> -<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/atkobjectfactory.sgml b/docs/tmpl/atkobjectfactory.sgml index 63c56cf..bc82582 100644 --- a/docs/tmpl/atkobjectfactory.sgml +++ b/docs/tmpl/atkobjectfactory.sgml @@ -20,6 +20,9 @@ AtkRegistry </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkObjectFactory ##### --> <para> The AtkObjectFactory structure should not be accessed directly. diff --git a/docs/tmpl/atkregistry.sgml b/docs/tmpl/atkregistry.sgml index 45098af..a1de43c 100644 --- a/docs/tmpl/atkregistry.sgml +++ b/docs/tmpl/atkregistry.sgml @@ -15,6 +15,9 @@ object for an object of a particular GType. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkRegistry ##### --> <para> The AtkRegistry structure should not be accessed directly. diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml index 4d0f412..8b3faeb 100644 --- a/docs/tmpl/atkrelation.sgml +++ b/docs/tmpl/atkrelation.sgml @@ -19,6 +19,9 @@ are defined as an AtkRelationSet, which is a set of AtkRelations. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkRelation ##### --> <para> The AtkRelation structure should not be accessed directly. @@ -26,6 +29,16 @@ The AtkRelation structure should not be accessed directly. </para> +<!-- ##### ARG AtkRelation:relation-type ##### --> +<para> + +</para> + +<!-- ##### ARG AtkRelation:target ##### --> +<para> + +</para> + <!-- ##### ENUM AtkRelationType ##### --> <para> @@ -112,13 +125,3 @@ The AtkRelation structure should not be accessed directly. @target: -<!-- ##### ARG AtkRelation:relation-type ##### --> -<para> - -</para> - -<!-- ##### ARG AtkRelation:target ##### --> -<para> - -</para> - diff --git a/docs/tmpl/atkrelationset.sgml b/docs/tmpl/atkrelationset.sgml index ec8c673..4b61cc8 100644 --- a/docs/tmpl/atkrelationset.sgml +++ b/docs/tmpl/atkrelationset.sgml @@ -14,6 +14,9 @@ A set of AtkRelations, normally the set of AtkRelations which an AtkObject has. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkRelationSet ##### --> <para> The AtkRelationSet structure should not be accessed directly. diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml index b3a6148..2c651d4 100644 --- a/docs/tmpl/atkselection.sgml +++ b/docs/tmpl/atkselection.sgml @@ -25,6 +25,9 @@ selection/deselection of children. #AtkText </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkSelection ##### --> <para> The AtkAction structure does not contain any fields. @@ -32,6 +35,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 +110,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/atkstate.sgml b/docs/tmpl/atkstate.sgml index 9e4ba71..b48b2d2 100644 --- a/docs/tmpl/atkstate.sgml +++ b/docs/tmpl/atkstate.sgml @@ -15,6 +15,9 @@ an component is described by its AtkStateSet, which is a set of AtkStates. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### ENUM AtkStateType ##### --> <para> @@ -52,6 +55,10 @@ an component is described by its AtkStateSet, which is a set of AtkStates. @ATK_STATE_MANAGES_DESCENDANTS: @ATK_STATE_INDETERMINATE: @ATK_STATE_TRUNCATED: +@ATK_STATE_REQUIRED: +@ATK_STATE_INVALID_ENTRY: +@ATK_STATE_SUPPORTS_AUTOCOMPLETION: +@ATK_STATE_SELECTABLE_TEXT: @ATK_STATE_LAST_DEFINED: <!-- ##### TYPEDEF AtkState ##### --> diff --git a/docs/tmpl/atkstateset.sgml b/docs/tmpl/atkstateset.sgml index c06bd66..2f71a26 100644 --- a/docs/tmpl/atkstateset.sgml +++ b/docs/tmpl/atkstateset.sgml @@ -15,6 +15,9 @@ of AtkStates. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### FUNCTION atk_state_set_new ##### --> <para> diff --git a/docs/tmpl/atkstreamablecontent.sgml b/docs/tmpl/atkstreamablecontent.sgml index 9676179..5795f29 100644 --- a/docs/tmpl/atkstreamablecontent.sgml +++ b/docs/tmpl/atkstreamablecontent.sgml @@ -14,6 +14,9 @@ The ATK interface which provides access to streamable content. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkStreamableContent ##### --> <para> The AtkStreamableContent structure does not contain any fields. diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml index 96d6dc7..a166826 100644 --- a/docs/tmpl/atktable.sgml +++ b/docs/tmpl/atktable.sgml @@ -33,6 +33,9 @@ implement other interfaces (#AtkText, #AtkImage, etc.) as appropriate. #AtkObject, #ATK_STATE_TRANSIENT </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkTable ##### --> <para> The AtkTable structure does not contain any fields. @@ -40,6 +43,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 +398,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..e604ad6 100644 --- a/docs/tmpl/atktext.sgml +++ b/docs/tmpl/atktext.sgml @@ -31,6 +31,9 @@ glyph-to-offset mapping may be complex for languages which use ligatures. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkText ##### --> <para> The AtkText structure does not contain any fields. @@ -38,6 +41,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 +438,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. - diff --git a/docs/tmpl/atkvalue.sgml b/docs/tmpl/atkvalue.sgml index 3fd10a0..78090fe 100644 --- a/docs/tmpl/atkvalue.sgml +++ b/docs/tmpl/atkvalue.sgml @@ -21,6 +21,9 @@ indicate failure. </para> +<!-- ##### SECTION Stability_Level ##### --> + + <!-- ##### STRUCT AtkValue ##### --> <para> The AtkValue structure does not contain any fields. |