diff options
| author | Thomas Booker <tw.booker@outlook.com> | 2022-09-10 14:11:44 +1200 |
|---|---|---|
| committer | CoderThomasB <tw.booker@outlook.com> | 2022-09-28 09:37:27 +1300 |
| commit | 837c050e48ea73f6dcf5ef9ff7120bc7da8b38ad (patch) | |
| tree | 63f04cc81df87161f3d3c1ad5122b04a64741bc1 | |
| parent | 35bcba928650b415b4d8a572b4d9b19384234ee6 (diff) | |
| download | at-spi2-core-837c050e48ea73f6dcf5ef9ff7120bc7da8b38ad.tar.gz | |
Docs: Move to gi-docgen
98 files changed, 534 insertions, 5819 deletions
diff --git a/.gitlab-ci.yml b/.gitlab-ci.yml index 740bc14d..210928a2 100644 --- a/.gitlab-ci.yml +++ b/.gitlab-ci.yml @@ -187,10 +187,10 @@ reference: MESON_EXTRA_FLAGS: "--buildtype=release -Ddocs=true" script: - meson setup ${MESON_EXTRA_FLAGS} --prefix /usr _build . - - ninja -C _build libatspi-doc atk-doc # target names generated by meson's gnome.gtkdoc function + - ninja -C _build doc/atk doc/libatspi # target names generated by meson's gnome.gtkdoc function - mkdir _reference - - mv _build/doc/libatspi/html _reference/libatspi - - mv _build/doc/atk/html _reference/atk + - mv _build/doc/libatspi _reference/libatspi + - mv _build/doc/atk _reference/atk artifacts: paths: - _reference diff --git a/atk/atkaction.c b/atk/atkaction.c index bc12cb23..03407aae 100644 --- a/atk/atkaction.c +++ b/atk/atkaction.c @@ -22,10 +22,10 @@ #include "atkaction.h" /** - * SECTION:atkaction - * @Short_description: The ATK interface provided by UI components + * AtkAction: + * + * The ATK interface provided by UI components * which the user can activate/interact with. - * @Title:AtkAction * * #AtkAction should be implemented by instances of #AtkObject classes * with which the user can interact directly, i.e. buttons, diff --git a/atk/atkcomponent.c b/atk/atkcomponent.c index 3949116b..271f1fa3 100644 --- a/atk/atkcomponent.c +++ b/atk/atkcomponent.c @@ -22,11 +22,11 @@ #include "atkcomponent.h" /** - * SECTION:atkcomponent - * @Short_description: The ATK interface provided by UI components + * AtkComponent: + * + * The ATK interface provided by UI components * which occupy a physical area on the screen. * which the user can activate/interact with. - * @Title:AtkComponent * * #AtkComponent should be implemented by most if not all UI elements * with an actual on-screen presence, i.e. components which can be diff --git a/atk/atkdocument.c b/atk/atkdocument.c index b661c267..b4825ebd 100644 --- a/atk/atkdocument.c +++ b/atk/atkdocument.c @@ -22,10 +22,10 @@ #include "atkdocument.h" /** - * SECTION:atkdocument - * @Short_description: The ATK interface which represents the toplevel + * AtkDocument: + * + * The ATK interface which represents the toplevel * container for document content. - * @Title:AtkDocument * * The AtkDocument interface should be supported by any object whose * content is a representation or view of a document. The AtkDocument diff --git a/atk/atkeditabletext.c b/atk/atkeditabletext.c index d44f8bff..7085be36 100644 --- a/atk/atkeditabletext.c +++ b/atk/atkeditabletext.c @@ -22,10 +22,9 @@ #include "atkeditabletext.h" /** - * SECTION:atkeditabletext - * @Short_description: The ATK interface implemented by components - * containing user-editable text content. - * @Title:AtkEditableText + * AtkEditableText: + * + * The ATK interface implemented by components containing user-editable text content. * * #AtkEditableText should be implemented by UI components which * contain text which the user can edit, via the #AtkObject @@ -35,7 +34,7 @@ * which implements #AtkEditableText is by definition an #AtkText * implementor as well. * - * See also: #AtkText + * See [iface@AtkText] */ GType diff --git a/atk/atkgobjectaccessible.c b/atk/atkgobjectaccessible.c index d651c439..83967c46 100644 --- a/atk/atkgobjectaccessible.c +++ b/atk/atkgobjectaccessible.c @@ -24,10 +24,9 @@ #include <atk/atkutil.h> /** - * SECTION:atkgobjectaccessible - * @Short_description: This object class is derived from AtkObject and - * can be used as a basis implementing accessible objects. - * @Title:AtkGObjectAccessible + * AtkGObjectAccessible: + * + * This object class is derived from AtkObject and can be used as a basis implementing accessible objects. * * This object class is derived from AtkObject. It can be used as a * basis for implementing accessible objects for GObjects which are diff --git a/atk/atkhyperlink.c b/atk/atkhyperlink.c index ae2e2e76..4caa8d44 100644 --- a/atk/atkhyperlink.c +++ b/atk/atkhyperlink.c @@ -22,10 +22,9 @@ #include <glib/gi18n-lib.h> /** - * SECTION:atkhyperlink - * @Short_description: An ATK object which encapsulates a link or set - * of links in a hypertext document. - * @Title:AtkHyperlink + * AtkHyperlink: + * + * An ATK object which encapsulates a link or set of links in a hypertext document. * * An ATK object which encapsulates a link or set of links (for * instance in the case of client-side image maps) in a hypertext diff --git a/atk/atkhyperlinkimpl.c b/atk/atkhyperlinkimpl.c index 7021bcf6..0814fa61 100644 --- a/atk/atkhyperlinkimpl.c +++ b/atk/atkhyperlinkimpl.c @@ -23,10 +23,10 @@ #include "atkhyperlinkimpl.h" /** - * SECTION:atkhyperlinkimpl - * @Short_description: An interface from which the AtkHyperlink + * AtkHyperlinImpl: + * + * An interface from which the AtkHyperlink * associated with an AtkObject may be obtained. - * @Title:AtkHyperlinImpl * * AtkHyperlinkImpl allows AtkObjects to refer to their associated * AtkHyperlink instance, if one exists. AtkHyperlinkImpl differs diff --git a/atk/atkhypertext.c b/atk/atkhypertext.c index 984899a5..6a664db4 100644 --- a/atk/atkhypertext.c +++ b/atk/atkhypertext.c @@ -22,10 +22,9 @@ #include "atkhypertext.h" /** - * SECTION:atkhypertext - * @Short_description: The ATK interface which provides standard - * mechanism for manipulating hyperlinks. - * @Title:AtkHypertext + * AtkHypertext: + * + * The ATK interface which provides standard mechanism for manipulating hyperlinks. * * An interface used for objects which implement linking between * multiple resource or content locations, or multiple 'markers' diff --git a/atk/atkimage.c b/atk/atkimage.c index 3a7bdc78..7ea9d163 100644 --- a/atk/atkimage.c +++ b/atk/atkimage.c @@ -22,10 +22,10 @@ #include "atkimage.h" /** - * SECTION:atkimage - * @Short_description: The ATK Interface implemented by components + * AtkImage: + * + * The ATK Interface implemented by components * which expose image or pixmap content on-screen. - * @Title:AtkImage * * #AtkImage should be implemented by #AtkObject subtypes on behalf of * components which display image/pixmap information onscreen, and diff --git a/atk/atkmisc.c b/atk/atkmisc.c index cd59a079..beca3db2 100644 --- a/atk/atkmisc.c +++ b/atk/atkmisc.c @@ -22,9 +22,9 @@ #include "atkmisc.h" /** - * SECTION:atkmisc - * @Short_description: A set of ATK utility functions for thread locking - * @Title:AtkMisc + * AtkMisc: + * + * A set of ATK utility functions for thread locking * * A set of utility functions for thread locking. This interface and * all his related methods are deprecated since 2.12. diff --git a/atk/atknoopobject.c b/atk/atknoopobject.c index 41b6551d..939bee83 100644 --- a/atk/atknoopobject.c +++ b/atk/atknoopobject.c @@ -23,9 +23,9 @@ #include "atknoopobject.h" /** - * SECTION:atknoopobject - * @Short_description: An AtkObject which purports to implement all ATK interfaces. - * @Title:AtkNoOpObject + * AtkNoOpObject: + * + * An AtkObject which purports to implement all ATK interfaces. * * An AtkNoOpObject is an AtkObject which purports to implement all * ATK interfaces. It is the type of AtkObject which is created if an diff --git a/atk/atknoopobjectfactory.c b/atk/atknoopobjectfactory.c index 501476b7..3026cac4 100644 --- a/atk/atknoopobjectfactory.c +++ b/atk/atknoopobjectfactory.c @@ -24,9 +24,9 @@ #include "atknoopobjectfactory.h" /** - * SECTION:atknoopobjectfactory - * @Short_description: The AtkObjectFactory which creates an AtkNoOpObject. - * @Title:AtkNoOpObjectFactory + * AtkNoOpObjectFactory: + * + * The AtkObjectFactory which creates an AtkNoOpObject. * * The AtkObjectFactory which creates an AtkNoOpObject. An instance of * this is created by an AtkRegistry if no factory type has not been diff --git a/atk/atkobject.c b/atk/atkobject.c index 68827af3..fb96b730 100644 --- a/atk/atkobject.c +++ b/atk/atkobject.c @@ -30,9 +30,9 @@ #include "atkprivate.h" /** - * SECTION:atkobject - * @Short_description: The base object class for the Accessibility Toolkit API. - * @Title:AtkObject + * AtkObject: + * + * The base object class for the Accessibility Toolkit API. * * This class is the primary class for accessibility support via the * Accessibility ToolKit (ATK). Objects which are instances of @@ -52,7 +52,7 @@ * implementation is insufficient, via instances of a new #AtkObject * subclass. * - * See also: #AtkObjectFactory, #AtkRegistry. (GTK+ users see also + * See [class@AtkObjectFactory], [class@AtkRegistry]. (GTK+ users see also * #GtkAccessible). * */ diff --git a/atk/atkobjectfactory.c b/atk/atkobjectfactory.c index 298f3c24..a49464c6 100644 --- a/atk/atkobjectfactory.c +++ b/atk/atkobjectfactory.c @@ -23,10 +23,10 @@ #include "atknoopobjectfactory.h" /** - * SECTION:atkobjectfactory - * @Short_description: The base object class for a factory used to + * AtkObjectFactory: + * + * The base object class for a factory used to * create accessible objects for objects of a specific GType. - * @Title:AtkObjectFactory * * This class is the base object class for a factory used to create an * accessible object for a specific GType. The function diff --git a/atk/atkplug.c b/atk/atkplug.c index ddd86ed0..87a7aeee 100644 --- a/atk/atkplug.c +++ b/atk/atkplug.c @@ -23,13 +23,11 @@ #include "atkplug.h" /** - * SECTION:atkplug - * @Short_description: Toplevel for embedding into other processes - * @Title: AtkPlug - * @See_also: #AtkPlug + * AtkPlug: * - * See #AtkSocket + * Toplevel for embedding into other processes * + * See [class@AtkSocket] */ static void atk_component_interface_init (AtkComponentIface *iface); diff --git a/atk/atkrange.c b/atk/atkrange.c index bb69ca5c..b8ae3422 100644 --- a/atk/atkrange.c +++ b/atk/atkrange.c @@ -24,9 +24,9 @@ #include "atkvalue.h" /** - * SECTION:atkrange - * @Short_description: A given range or subrange, to be used with #AtkValue - * @Title:AtkRange + * AtkRange: + * + * A given range or subrange, to be used with #AtkValue * * #AtkRange are used on #AtkValue, in order to represent the full * range of a given component (for example an slider or a range diff --git a/atk/atkregistry.c b/atk/atkregistry.c index 45fabdeb..efa9cb49 100644 --- a/atk/atkregistry.c +++ b/atk/atkregistry.c @@ -23,11 +23,11 @@ #include "atknoopobjectfactory.h" /** - * SECTION:atkregistry - * @Short_description: An object used to store the GType of the + * AtkRegistry: + * + * An object used to store the GType of the * factories used to create an accessible object for an object of a * particular GType. - * @Title:AtkRegistry * * The AtkRegistry is normally used to create appropriate ATK "peers" * for user interface components. Application developers usually need diff --git a/atk/atkrelation.c b/atk/atkrelation.c index 6dcb1c47..4ea9de81 100644 --- a/atk/atkrelation.c +++ b/atk/atkrelation.c @@ -24,10 +24,10 @@ #include "atk.h" /** - * SECTION:atkrelation - * @Short_description: An object used to describe a relation between a + * AtkRelation: + * + * An object used to describe a relation between a * object and one or more other objects. - * @Title:AtkRelation * * An AtkRelation describes a relation between an object and one or * more other objects. The actual relations that an object has with diff --git a/atk/atkrelationset.c b/atk/atkrelationset.c index 95d50e66..476a8216 100644 --- a/atk/atkrelationset.c +++ b/atk/atkrelationset.c @@ -24,10 +24,10 @@ #include "atk.h" /** - * SECTION:atkrelationset - * @Short_description: A set of AtkRelations, normally the set of + * AtkRelationSet: + * + * A set of AtkRelations, normally the set of * AtkRelations which an AtkObject has. - * @Title:AtkRelationSet * * The AtkRelationSet held by an object establishes its relationships * with objects beyond the normal "parent/child" hierarchical diff --git a/atk/atkselection.c b/atk/atkselection.c index d4bd8363..34d6a5b7 100644 --- a/atk/atkselection.c +++ b/atk/atkselection.c @@ -22,10 +22,9 @@ #include "atkselection.h" /** - * SECTION:atkselection - * @Short_description: The ATK interface implemented by container - * objects whose #AtkObject children can be selected. - * @Title:AtkSelection + * AtkSelection: + * + * The ATK interface implemented by container objects whose #AtkObject children can be selected. * * #AtkSelection should be implemented by UI components with children * which are exposed by #atk_object_ref_child and diff --git a/atk/atksocket.c b/atk/atksocket.c index 887fb5c0..7cedba0c 100644 --- a/atk/atksocket.c +++ b/atk/atksocket.c @@ -23,10 +23,9 @@ #include "atksocket.h" /** - * SECTION:atksocket - * @Short_description: Container for AtkPlug objects from other processes - * @Title: AtkSocket - * @See_also: #AtkPlug + * AtkSocket: + * + * Container for AtkPlug objects from other processes * * Together with #AtkPlug, #AtkSocket provides the ability to embed * accessibles from one process into another in a fashion that is @@ -50,6 +49,8 @@ * atk_object_get_n_accessible_children() and * atk_object_ref_accessible_child(). All the logic related to those * functions will be implemented by the IPC layer. + * + * See [class@AtkPlug] */ static void atk_socket_finalize (GObject *obj); diff --git a/atk/atkstate.c b/atk/atkstate.c index 5d5bd175..369c6ab4 100644 --- a/atk/atkstate.c +++ b/atk/atkstate.c @@ -24,13 +24,14 @@ #include <string.h> /** - * SECTION:atkstate - * @Short_description: An AtkState describes a single state of an object. - * @Title:AtkState + * AtkState: + * + * An AtkState describes a single state of an object. * * An AtkState describes a single state of an object. The full set of states * that apply to an object at a given time are contained in its #AtkStateSet. - * See also #atk_object_ref_state_set and #atk_object_notify_state_change. + * + * See [id@atk_object_ref_state_set] and [id@atk_object_notify_state_change] */ static guint last_type = ATK_STATE_LAST_DEFINED; diff --git a/atk/atkstateset.c b/atk/atkstateset.c index d240ee6e..957786d6 100644 --- a/atk/atkstateset.c +++ b/atk/atkstateset.c @@ -25,9 +25,9 @@ #include "atkstateset.h" /** - * SECTION:atkstateset - * @Short_description: An AtkStateSet contains the states of an object. - * @Title:AtkStateSet + * AtkStateSet: + * + * An AtkStateSet contains the states of an object. * * An AtkStateSet is a read-only representation of the full set of #AtkStates * that apply to an object at a given time. This set is not meant to be diff --git a/atk/atkstreamablecontent.c b/atk/atkstreamablecontent.c index 571ca2b6..2ace98ed 100644 --- a/atk/atkstreamablecontent.c +++ b/atk/atkstreamablecontent.c @@ -22,10 +22,9 @@ #include "atkstreamablecontent.h" /** - * SECTION:atkstreamablecontent - * @Short_description: The ATK interface which provides access to - * streamable content. - * @Title:AtkStreamableContent + * AtkStreamableContent: + * + * The ATK interface which provides access to streamable content. * * An interface whereby an object allows its backing content to be * streamed to clients. Typical implementors would be images or diff --git a/atk/atktable.c b/atk/atktable.c index 082de56d..dbdfca39 100644 --- a/atk/atktable.c +++ b/atk/atktable.c @@ -23,10 +23,9 @@ #include "atkmarshal.h" /** - * SECTION:atktable - * @Short_description: The ATK interface implemented for UI components - * which contain tabular or row/column information. - * @Title:AtkTable + * AtkTable: + * + * The ATK interface implemented for UI components which contain tabular or row/column information. * * #AtkTable should be implemented by components which present * elements ordered via rows and columns. It may also be used to diff --git a/atk/atktablecell.c b/atk/atktablecell.c index 1cec6fa2..67bfdbfb 100644 --- a/atk/atktablecell.c +++ b/atk/atktablecell.c @@ -23,16 +23,15 @@ /** - * SECTION:atktablecell - * @Short_description: The ATK interface implemented for a cell inside - * a two-dimentional #AtkTable - * @Title:AtkTableCell + * AtkTableCell: + * + * The ATK interface implemented for a cell inside a two-dimentional #AtkTable * * Being #AtkTable a component which present elements ordered via rows * and columns, an #AtkTableCell is the interface which each of those * elements, so "cells" should implement. * - * See also #AtkTable. + * See [iface@AtkTable] */ typedef AtkTableCellIface AtkTableCellInterface; diff --git a/atk/atktext.c b/atk/atktext.c index 95b91f92..a2da5989 100644 --- a/atk/atktext.c +++ b/atk/atktext.c @@ -25,10 +25,9 @@ #include <string.h> /** - * SECTION:atktext - * @Short_description: The ATK interface implemented by components - * with text content. - * @Title:AtkText + * AtkText: + * + * The ATK interface implemented by components with text content. * * #AtkText should be implemented by #AtkObjects on behalf of widgets * that have text content which is either attributed or otherwise diff --git a/atk/atkutil.c b/atk/atkutil.c index ec61612d..7e1870b6 100644 --- a/atk/atkutil.c +++ b/atk/atkutil.c @@ -23,9 +23,9 @@ #include "atkmarshal.h" /** - * SECTION:atkutil - * @Short_description: A set of ATK utility functions for event and toolkit support. - * @Title:AtkUtil + * AtkUtil: + * + * A set of ATK utility functions for event and toolkit support. * * A set of ATK utility functions which are used to support event * registration of various types, and obtaining the 'root' accessible diff --git a/atk/atkutil.h b/atk/atkutil.h index 2bac9631..28371d85 100644 --- a/atk/atkutil.h +++ b/atk/atkutil.h @@ -54,7 +54,7 @@ typedef struct _AtkKeyEventStruct AtkKeyEventStruct; * supported are events of type "focus:". Most clients of ATK will prefer to * attach signal handlers for the various ATK signals instead. * - * see atk_add_focus_tracker. + * see [id@atk_add_focus_tracker] **/ typedef void (*AtkEventListener) (AtkObject* obj); /** @@ -64,7 +64,7 @@ typedef void (*AtkEventListener) (AtkObject* obj); * called in order to initialize the per-object event registration system * used by #AtkEventListener, if any preparation is required. * - * see atk_focus_tracker_init. + * see [id@atk_focus_tracker_init] **/ typedef void (*AtkEventListenerInit) (void); /** @@ -81,13 +81,16 @@ typedef void (*AtkEventListenerInit) (void); * discarded without being passed to the normal GUI recipient; FALSE (zero) if the * event dispatch to the client application should proceed as normal. * - * see atk_add_key_event_listener. + * see [id@atk_add_key_event_listener] **/ typedef gint (*AtkKeySnoopFunc) (AtkKeyEventStruct *event, gpointer user_data); /** * AtkKeyEventStruct: + * + * Encapsulates information about a key event. + * * @type: An AtkKeyEventType, generally one of ATK_KEY_EVENT_PRESS or ATK_KEY_EVENT_RELEASE * @state: A bitmask representing the state of the modifier keys immediately after the event takes place. * The meaning of the bits is currently defined to match the bitmask used by GDK in @@ -104,8 +107,6 @@ typedef gint (*AtkKeySnoopFunc) (AtkKeyEventStruct *event, * @timestamp: A timestamp in milliseconds indicating when the event occurred. * These timestamps are relative to a starting point which should be considered arbitrary, * and only used to compare the dispatch times of events to one another. - * - * Encapsulates information about a key event. **/ struct _AtkKeyEventStruct { gint type; diff --git a/atk/atkvalue.c b/atk/atkvalue.c index ae7242f7..2b352dd0 100644 --- a/atk/atkvalue.c +++ b/atk/atkvalue.c @@ -28,11 +28,9 @@ #include "atkprivate.h" /** - * SECTION:atkvalue - * @Short_description: The ATK interface implemented by valuators and - * components which display or select a value from a bounded range of - * values. - * @Title:AtkValue + * AtkValue: + * + * The ATK interface implemented by valuators and components which display or select a value from a bounded range of values. * * #AtkValue should be implemented for components which either display * a value from a bounded range, or which allow the user to specify a diff --git a/atk/atkversion.c b/atk/atkversion.c index eae1460b..388a801e 100644 --- a/atk/atkversion.c +++ b/atk/atkversion.c @@ -25,9 +25,11 @@ #include "atk.h" /** - * SECTION:atkversion - * @Short_description: Variables and functions to check the ATK version - * @Title: Versioning macros + * atkversion: + * + * TODO title Versioning macros + * + * Variables and functions to check the ATK version * * ATK provides a set of macros and methods for checking the version * of the library at compile and run time. diff --git a/atk/atkwindow.c b/atk/atkwindow.c index 8e7ad8ac..8f6d06a1 100644 --- a/atk/atkwindow.c +++ b/atk/atkwindow.c @@ -23,15 +23,15 @@ #include "atkmarshal.h" /** - * SECTION:atkwindow - * @Short_description: The ATK Interface provided by UI components that represent a top-level window. - * @Title: AtkWindow - * @See_also: #AtkObject + * AtkWindow: + * + * The ATK Interface provided by UI components that represent a top-level window. * * #AtkWindow should be implemented by the UI elements that represent * a top-level window, such as the main window of an application or * dialog. * + * See [class@AtkObject] */ enum { diff --git a/atk/meson.build b/atk/meson.build index e99160e3..d216b680 100644 --- a/atk/meson.build +++ b/atk/meson.build @@ -138,7 +138,7 @@ libatk = library(atk_api_name, atk_sources_dep = [ atk_enum_h ] if have_gir - atk_sources_dep += gnome.generate_gir(libatk, + atk_gir = gnome.generate_gir(libatk, sources: atk_sources + atk_headers + [ atk_enum_h ] + [ atk_version_h ], namespace: 'Atk', nsversion: atk_api_version, @@ -153,6 +153,8 @@ if have_gir '-DATK_COMPILATION', ], ) + + atk_sources_dep += atk_gir endif libatk_dep = declare_dependency(link_with: libatk, diff --git a/atspi/atspi-accessible.c b/atspi/atspi-accessible.c index 9c4725a4..d7d3f833 100644 --- a/atspi/atspi-accessible.c +++ b/atspi/atspi-accessible.c @@ -26,6 +26,16 @@ #include "atspi-accessible-private.h" #include <string.h> +/** + * AtspiAccessible: + * + * The base interface which is implemented by all accessible objects. + * + * All objects support interfaces for querying their contained 'children' + * and position in the accessible-object hierarchy, whether or not they + * actually have children. + */ + enum { REGION_CHANGED, MODE_CHANGED, diff --git a/atspi/atspi-application.c b/atspi/atspi-application.c index cccaf861..8045a819 100644 --- a/atspi/atspi-application.c +++ b/atspi/atspi-application.c @@ -23,6 +23,16 @@ #include "atspi-private.h" +/** + * AtspiApplication: + * + * An interface identifying the root object associated + * with a running application. + * + * An interface identifying an object which is the root of the + * hierarchy associated with a running application. + */ + G_DEFINE_TYPE (AtspiApplication, atspi_application, G_TYPE_OBJECT) static void diff --git a/atspi/atspi-collection.c b/atspi/atspi-collection.c index 34fbbabe..caf335be 100644 --- a/atspi/atspi-collection.c +++ b/atspi/atspi-collection.c @@ -26,6 +26,17 @@ /* TODO: Improve documentation and implement some missing functions */ /** + * AtspiCollection + * + * An interface designed to allow accessibles which satisfy a set of + * criteria to be returned. + * + * An interface designed to allow accessibles which satisfy a set of + * criteria to be returned. This interface can be used to avoid iteration + * or client-side search of the object tree. + */ + +/** * atspi_collection_is_ancestor_of: * * Not yet implemented. diff --git a/atspi/atspi-component.c b/atspi/atspi-component.c index 59879bb7..4a0238f2 100644 --- a/atspi/atspi-component.c +++ b/atspi/atspi-component.c @@ -30,6 +30,22 @@ #include "atspi-private.h" #include "atspi-accessible-private.h" +/** + * AtspiComponent + * + * An interface implemented by objects which have onscreen visual + * representations. + * + * The Component interface is implemented by objects which occupy on-screen + * space, e.g. objects which have onscreen visual representations. The methods + * in Component allow clients to identify where the objects lie in the onscreen + * coordinate system, their relative size, stacking order, and position. It + * also provides a mechanism whereby keyboard focus may be transferred to + * specific user interface elements programmatically. This is a 2D API. + * Coordinates of 3D objects are projected into the 2-dimensional screen view + * for purposes of this interface. + */ + void atspi_rect_free (AtspiRect *rect) { diff --git a/atspi/atspi-constants.h b/atspi/atspi-constants.h index af9c4c20..9c0eb34f 100644 --- a/atspi/atspi-constants.h +++ b/atspi/atspi-constants.h @@ -84,6 +84,12 @@ */ +/** + * AtspiConstants: + * + * Constant definitions needed by multiple interfaces. + */ + #ifndef _ATSPI_CONSTANTS_H_ #define _ATSPI_CONSTANTS_H_ #ifdef __cplusplus diff --git a/atspi/atspi-device-listener.c b/atspi/atspi-device-listener.c index e23b58d5..964d9160 100644 --- a/atspi/atspi-device-listener.c +++ b/atspi/atspi-device-listener.c @@ -25,6 +25,16 @@ #include "atspi-private.h" #include <stdio.h> +/** + * AtspiDevicelistener: + * + * An interface for creating and manipulating + * device listeners. + * + * An interface for creating and manipulating + * device listeners with callback functions. + */ + typedef struct { AtspiDeviceListenerCB callback; diff --git a/atspi/atspi-editabletext.c b/atspi/atspi-editabletext.c index 350617eb..75af1593 100644 --- a/atspi/atspi-editabletext.c +++ b/atspi/atspi-editabletext.c @@ -23,6 +23,18 @@ #include "atspi-private.h" +/** + * AtspiEditabletext: + * + * An interface that provides methods for modifying textual content + * of components which support editing. + * + * Derived from atspi-text, the atspi-editabletext interface + * provides methods for modifying textual content of components + * which support editing. EditableText also interacts with the + * system clipboard via copy, cut, and paste methods. + */ + #if 0 /* TODO: implement */ /** diff --git a/atspi/atspi-event-listener.c b/atspi/atspi-event-listener.c index 8b172434..4c268c41 100644 --- a/atspi/atspi-event-listener.c +++ b/atspi/atspi-event-listener.c @@ -28,6 +28,18 @@ #include <strings.h> #include <ctype.h> +/** + * AtspiEventListener: + * + * A generic interface implemented by objects for the receipt of event + * notifications. + * + * A generic interface implemented by objects for the receipt of event + * notifications. atspi-event-listener is the interface via which clients of + * the atspi-registry receive notification of changes to an application's user + * interface and content. + */ + typedef struct { AtspiEventListenerCB callback; diff --git a/atspi/atspi-hyperlink.c b/atspi/atspi-hyperlink.c index c01f547b..c815a31e 100644 --- a/atspi/atspi-hyperlink.c +++ b/atspi/atspi-hyperlink.c @@ -24,6 +24,21 @@ #include "atspi-private.h" +/** + * AtspiHyperlink: + * + * Instances of atspi-hyperlink are the means by which end users + * and clients interact with linked content. + * + * Instances of atspi-hyperlink are returned by + * atspi-hypertext objects, and are the means by + * which end users and clients interact with linked, + * and in some cases embedded, content. These instances + * may have multiple "anchors", where an anchor corresponds to a + * reference to a particular resource with a corresponding resource + * identified (URI). + */ + G_DEFINE_TYPE (AtspiHyperlink, atspi_hyperlink, ATSPI_TYPE_OBJECT) static void diff --git a/atspi/atspi-hypertext.c b/atspi/atspi-hypertext.c index 7ddaab6b..ffe20f21 100644 --- a/atspi/atspi-hypertext.c +++ b/atspi/atspi-hypertext.c @@ -25,6 +25,19 @@ #include "atspi-private.h" /** + * AtspiHypertext: + * + * An interface used for objects which implement linking between + * multiple resource locations. + * + * An interface used for objects which implement linking between + * multiple resource or content locations, or multiple 'markers' + * within a single document. A hypertext instance is associated + * with one or more hyperlinks which are associated with particular + * offests within the hypertext's content. + */ + +/** * atspi_hypertext_get_n_links: * @obj: a pointer to the #AtspiHypertext implementor on which to operate. * diff --git a/atspi/atspi-matchrule.c b/atspi/atspi-matchrule.c index 6fb42107..a75150ee 100644 --- a/atspi/atspi-matchrule.c +++ b/atspi/atspi-matchrule.c @@ -24,6 +24,13 @@ #include "atspi-private.h" +/** + * AtspiMatchRule: + * + * An interface that allows the definition of match rules + * for accessible objects. + */ + G_DEFINE_TYPE (AtspiMatchRule, atspi_match_rule, G_TYPE_OBJECT) static void diff --git a/atspi/atspi-misc.c b/atspi/atspi-misc.c index cc7e54dd..dc22a53b 100644 --- a/atspi/atspi-misc.c +++ b/atspi/atspi-misc.c @@ -37,6 +37,12 @@ #include <string.h> #include <ctype.h> +/** + * AtspiMisc: + * + * Miscellaneous methods for using AT-SPI services. + */ + static void handle_get_items (DBusPendingCall *pending, void *user_data); static DBusConnection *bus = NULL; diff --git a/atspi/atspi-registry.c b/atspi/atspi-registry.c index 382308fd..752ef8af 100644 --- a/atspi/atspi-registry.c +++ b/atspi/atspi-registry.c @@ -26,6 +26,18 @@ #include "atspi-private.h" +/** + * AtspiRegistry: + * + * A service through which applications providing accessibility services + * can rendezvous with consumers of those services. + * + * A service through which applications providing accessibility services (servers) + * can rendezvous with consumers of those services (Assistive Technologies). The + * atspi-registry is the first "port of call" for accessible applications and for + * assistive technologies wishing to query and interact with those applications. + */ + typedef struct { AtspiDeviceListener *listener; diff --git a/atspi/atspi-relation.c b/atspi/atspi-relation.c index 10063439..527826f6 100644 --- a/atspi/atspi-relation.c +++ b/atspi/atspi-relation.c @@ -25,6 +25,17 @@ #include "atspi-private.h" /** + * AtspiRelation: + * + * An interface via which non-hierarchical relationships + * are indicated. + * + * An interface via which non-hierarchical relationships + * are indicated. An instance of this interface represents + * a "one-to-many" correspondance. + */ + +/** * atspi_relation_get_relation_type: * @obj: a pointer to the #AtspiRelation object to query. * diff --git a/atspi/atspi-selection.c b/atspi/atspi-selection.c index 0e728450..ead851b5 100644 --- a/atspi/atspi-selection.c +++ b/atspi/atspi-selection.c @@ -25,6 +25,19 @@ #include "atspi-private.h" /** + * AtspiSelection: + * + * An interface which indicates that an object exposes a 'selection' model, + * allowing the selection of one or more of its children. + * + * An interface which indicates that an object exposes a 'selection' + * model, allowing the selection of one or more of its children. + * Read-only Selection instances are possible, in which case the + * interface is used to programmatically determine the selected-ness + * of its children. + */ + +/** * atspi_selection_get_n_selected_children: * @obj: a pointer to the #AtspiSelection implementor on which to operate. * diff --git a/atspi/atspi-stateset.c b/atspi/atspi-stateset.c index dd99d91b..2d5ca644 100644 --- a/atspi/atspi-stateset.c +++ b/atspi/atspi-stateset.c @@ -24,6 +24,13 @@ #include "atspi-private.h" +/** + * AtspiStateSet: + * + * The atspi-stateset objects implement wrappers around a + * bitmap of accessible states. + */ + static void atspi_state_set_class_init (AtspiStateSetClass *klass); G_DEFINE_TYPE (AtspiStateSet, atspi_state_set, G_TYPE_OBJECT) diff --git a/atspi/atspi-table.c b/atspi/atspi-table.c index 08718f4b..b2027e1e 100644 --- a/atspi/atspi-table.c +++ b/atspi/atspi-table.c @@ -26,6 +26,22 @@ #include "atspi-private.h" /** + * AtspiTable: + * + * An interface used by containers whose data is arranged in a tabular form. + * + * An interface used by containers whose contained data is arranged + * in a tabular (i.e. row-column) form. Tables may resemble + * a two-dimensional grid, as in a spreadsheet, or may feature objects + * which span multiple rows and/or columns, but whose bounds are + * aligned on a row/column matrix. Objects within tables are children + * of the table object, and they may be referenced either via a child + * index or via a row/column pair. Table 'cells' may implement other + * interfaces, such as Text, Action, Image, and Component, and should do + * so as appropriate to their onscreen rresentation and/or behavior. + */ + +/** * atspi_table_get_caption: * @obj: a pointer to the #AtspiTable implementor on which to operate. * diff --git a/atspi/atspi-text.c b/atspi/atspi-text.c index de99773e..f85d3f3e 100644 --- a/atspi/atspi-text.c +++ b/atspi/atspi-text.c @@ -23,6 +23,21 @@ */ #include "atspi-private.h" + +/** + * AtspiText: + * + * An interface implemented by objects which place textual + * information onscreen. + * + * The text interface should be implemented by objects which place textual + * information onscreen as character strings or glyphs. The text interface + * allows access to textual content including display attributes and + * semantic hints associated with runs of text, and to bounding boc + * information for glyphs and substrings. It also alows portions of text to + * be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT. + */ + /** * atspi_range_copy: * @src: a pointer to the source #AtspiRange object that will be copied. diff --git a/atspi/atspi-types.h b/atspi/atspi-types.h index ab43ca8c..8eca6dd5 100644 --- a/atspi/atspi-types.h +++ b/atspi/atspi-types.h @@ -29,6 +29,12 @@ #include "atspi-constants.h" +/** + * AtspiTypes: + * + * Type definitions needed by multiple interfaces. + */ + typedef struct _AtspiAccessible AtspiAccessible; typedef struct _AtspiAction AtspiAction; typedef struct _AtspiCollection AtspiCollection; @@ -133,8 +139,9 @@ typedef struct _AtspiKeySet } AtspiKeySet; /** - *AtspiKeyListenerSyncType: - * @ATSPI_KEYLISTENER_NOSYNC: Events may be delivered asynchronously, + * AtspiKeyListenerSyncType: + * + * @ATSPI_KEYLISTENER_NOSYNC: Events may be delivered asynchronously, * which means in some cases they may already have been delivered to the * application before the AT client receives the notification. * @ATSPI_KEYLISTENER_SYNCHRONOUS: Events are delivered synchronously, before the diff --git a/atspi/atspi-value.c b/atspi/atspi-value.c index 714fdb6e..54300319 100644 --- a/atspi/atspi-value.c +++ b/atspi/atspi-value.c @@ -25,6 +25,18 @@ #include "atspi-private.h" /** + * AtspiValue: + * + * An interface supporting a one-dimensional scalar + * to be modified, or which reflects its value. + * + * An interface supporting a one-dimensional scalar + * to be modified, or which reflects its value. If + * STATE_EDITABLE is not present, the value is + * treated as "read only". + */ + +/** * atspi_value_get_minimum_value: * @obj: a pointer to the #AtspiValue implementor on which to operate. * diff --git a/doc/atk.toml.in b/doc/atk.toml.in new file mode 100644 index 00000000..f45fcde5 --- /dev/null +++ b/doc/atk.toml.in @@ -0,0 +1,52 @@ +[library] +version = "@VERSION@" +browse_url = "https://gitlab.gnome.org/GNOME/at-spi2-core/" +repository_url = "https://gitlab.gnome.org/GNOME/at-spi2-core.git" +website_url = "https://wiki.gnome.org/Accessibility" +docs_url = "https://gnome.pages.gitlab.gnome.org/at-spi2-core/atk/" +authors = "ATK Development Team" +license = "LGPL-2.1-or-later" +description = """GNOME provides support for accessibility devices using the ATK +framework. This framework defines a set of interfaces to which +graphical interface components adhere. This allows, for instance, +screen readers to read the text of an interface and interact with its +controls. ATK support is built into GTK+ 3 and the rest of the GNOME +platform, so any application using GTK+ 3 will have reasonable +accessibility support for free. +GTK4 now includes accessibility support natively and does not need ATK.""" +devhelp = true +search_index = true +logo_url = "logo.png" + +dependencies = ["GObject-2.0",] + + [dependencies."GObject-2.0"] + name = "GObject" + description = "The base type system library" + docs_url = "https://docs.gtk.org/gobject/" + +related = ["Atspi-2.0"] + + [related."Atspi-2.0"] + name = "AT-SPI" + description = "The Assistive Technology Service Provider Interface" + docs_url = "https://gnome.pages.gitlab.gnome.org/at-spi2-core/libatspi/" + +[theme] +name = "basic" +show_index_summary = true +show_class_hierarchy = true + +[source-location] +# The base URL for the web UI +base_url = "https://gitlab.gnome.org/GNOME/at-spi2-core/-/blob/HEAD/" +# The format for links, using "filename" and "line" for the format +file_format = "{filename}#L{line}" + +[extra] +content_files = [ +] +content_images = [ + "logo.png", +] +urlmap_file = "urlmap.js" diff --git a/doc/atk/atk-docs.xml b/doc/atk/atk-docs.xml deleted file mode 100644 index f3dfccef..00000000 --- a/doc/atk/atk-docs.xml +++ /dev/null @@ -1,146 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> - <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent"> - %gtkdocentities; -]> - -<book> - <bookinfo> - <title>ATK - Accessibility Toolkit</title> - <releaseinfo>for ATK &package_version;</releaseinfo> - </bookinfo> - - <chapter id="overview"> - <title>Overview</title> - <para> - GNOME provides support for accessibility devices using the ATK - framework. This framework defines a set of interfaces to which - graphical interface components adhere. This allows, for instance, - screen readers to read the text of an interface and interact with its - controls. ATK support is built into GTK+ and the rest of the GNOME - platform, so any application using GTK+ will have reasonable - accessibility support for free. - </para> - - <para> - Nonetheless, you should be aware of accessibility issues when when - developing your applications. Although GTK+ interfaces provide - reasonable accessibility by default, you can often improve how well - your program behaves with accessibility tools by providing additional - information to ATK. If you develop custom widgets, you should ensure - that they expose their properties to ATK - </para> - - </chapter> - - <chapter id="base-object"> - <title>Base accessibility object</title> - <xi:include href="xml/atkobject.xml"/> - </chapter> - - <chapter id="toolkit"> - <title>Event and toolkit support</title> - <xi:include href="xml/atkutil.xml"/> - </chapter> - - <chapter id="interfaces"> - <title>ATK Interfaces</title> - <xi:include href="xml/atkaction.xml"/> - <xi:include href="xml/atkcomponent.xml"/> - <xi:include href="xml/atkdocument.xml"/> - <xi:include href="xml/atkeditabletext.xml"/> - <xi:include href="xml/atkhyperlinkimpl.xml"/> - <xi:include href="xml/atkhypertext.xml"/> - <xi:include href="xml/atkimage.xml"/> - <xi:include href="xml/atkselection.xml"/> - <xi:include href="xml/atkstreamablecontent.xml"/> - <xi:include href="xml/atktable.xml"/> - <xi:include href="xml/atktablecell.xml"/> - <xi:include href="xml/atktext.xml"/> - <xi:include href="xml/atkvalue.xml"/> - <xi:include href="xml/atkwindow.xml"/> - </chapter> - - <chapter id="data"> - <title>Basic accessible data types</title> - <xi:include href="xml/atkrange.xml"/> - <xi:include href="xml/atkrelation.xml"/> - <xi:include href="xml/atkrelationset.xml"/> - <xi:include href="xml/atkstate.xml"/> - <xi:include href="xml/atkstateset.xml"/> - </chapter> - - <chapter id="accessibles"> - <title>Custom accessible objects</title> - <xi:include href="xml/atkgobjectaccessible.xml"/> - <xi:include href="xml/atkhyperlink.xml"/> - <xi:include href="xml/atknoopobject.xml"/> - <xi:include href="xml/atkplug.xml"/> - <xi:include href="xml/atksocket.xml"/> - </chapter> - - <chapter id="utilities"> - <title>Utilities</title> - <xi:include href="xml/atknoopobjectfactory.xml"/> - <xi:include href="xml/atkobjectfactory.xml"/> - <xi:include href="xml/atkregistry.xml"/> - <xi:include href="xml/atkversion.xml"/> - </chapter> - - <chapter id="deprecated"> - <title>Deprecated Interfaces</title> - <xi:include href="xml/atkmisc.xml"/> - </chapter> - - <index id="api-index-full"> - <title>Index of all symbols</title> - </index> - <index id="api-index-deprecated" role="deprecated"> - <title>Index of deprecated symbols</title> - </index> - <index id="api-index-1-3" role="1.3"> - <title>Index of new symbols in 1.3</title> - </index> - <index id="api-index-1-4" role="1.4"> - <title>Index of new symbols in 1.4</title> - </index> - <index id="api-index-1-6" role="1.6"> - <title>Index of new symbols in 1.6</title> - </index> - <index id="api-index-1-9" role="1.9"> - <title>Index of new symbols in 1.9</title> - </index> - <index id="api-index-1-12" role="1.12"> - <title>Index of new symbols in 1.12</title> - </index> - <index id="api-index-1-13" role="1.13"> - <title>Index of new symbols in 1.13</title> - </index> - <index id="api-index-1-20" role="1.20"> - <title>Index of new symbols in 1.20</title> - </index> - <index id="api-index-1-22" role="1.22"> - <title>Index of new symbols in 1.22</title> - </index> - <index id="api-index-1-30" role="1.30"> - <title>Index of new symbols in 1.30</title> - </index> - <index id="api-index-2-2" role="2.2"> - <title>Index of new symbols in 2.2</title> - </index> - <index id="api-index-2-8" role="2.8"> - <title>Index of new symbols in 2.8</title> - </index> - <index id="api-index-2-10" role="2.10"> - <title>Index of new symbols in 2.10</title> - </index> - <index id="api-index-2-12" role="2.12"> - <title>Index of new symbols in 2.12</title> - </index> - - <xi:include href="xml/annotation-glossary.xml"><xi:fallback/></xi:include> -</book> - diff --git a/doc/atk/atk-sections.txt b/doc/atk/atk-sections.txt deleted file mode 100644 index 6bf2bfb3..00000000 --- a/doc/atk/atk-sections.txt +++ /dev/null @@ -1,785 +0,0 @@ -<INCLUDE>atk/atk.h</INCLUDE> - -<SECTION> -<FILE>atkaction</FILE> -<TITLE>AtkAction</TITLE> -AtkAction -AtkActionIface -atk_action_do_action -atk_action_get_n_actions -atk_action_get_description -atk_action_get_name -atk_action_get_localized_name -atk_action_get_keybinding -atk_action_set_description -<SUBSECTION Standard> -ATK_ACTION -ATK_IS_ACTION -ATK_TYPE_ACTION -ATK_ACTION_GET_IFACE -atk_action_get_type -</SECTION> - -<SECTION> -<FILE>atkcomponent</FILE> -<TITLE>AtkComponent</TITLE> -AtkComponent -AtkComponentIface -AtkFocusHandler -AtkRectangle -atk_component_add_focus_handler -atk_component_contains -atk_component_get_extents -atk_component_get_layer -atk_component_get_mdi_zorder -atk_component_get_position -atk_component_get_size -atk_component_grab_focus -atk_component_ref_accessible_at_point -atk_component_remove_focus_handler -atk_component_set_extents -atk_component_set_position -atk_component_set_size -atk_component_get_alpha -AtkScrollType -atk_component_scroll_to -atk_component_scroll_to_point -<SUBSECTION Standard> -ATK_COMPONENT -ATK_IS_COMPONENT -ATK_TYPE_COMPONENT -ATK_TYPE_RECTANGLE -ATK_TYPE_SCROLL_TYPE -ATK_COMPONENT_GET_IFACE -atk_component_get_type -atk_rectangle_get_type -atk_scroll_type_get_type -</SECTION> - -<SECTION> -<FILE>atkdocument</FILE> -<TITLE>AtkDocument</TITLE> -AtkDocument -AtkDocumentIface -atk_document_get_document_type -atk_document_get_document -atk_document_get_attribute_value -atk_document_set_attribute_value -atk_document_get_attributes -atk_document_get_locale -atk_document_get_current_page_number -atk_document_get_page_count -<SUBSECTION Standard> -ATK_DOCUMENT -ATK_IS_DOCUMENT -ATK_TYPE_DOCUMENT -ATK_DOCUMENT_GET_IFACE -atk_document_get_type -</SECTION> - -<SECTION> -<FILE>atkeditabletext</FILE> -<TITLE>AtkEditableText</TITLE> -AtkEditableText -atk_editable_text_set_run_attributes -atk_editable_text_set_text_contents -atk_editable_text_insert_text -atk_editable_text_copy_text -atk_editable_text_cut_text -atk_editable_text_delete_text -atk_editable_text_paste_text -<SUBSECTION Standard> -AtkEditableTextIface -ATK_EDITABLE_TEXT -ATK_IS_EDITABLE_TEXT -ATK_TYPE_EDITABLE_TEXT -ATK_EDITABLE_TEXT_GET_IFACE -atk_editable_text_get_type -</SECTION> - -<SECTION> -<FILE>atkhypertext</FILE> -<TITLE>AtkHypertext</TITLE> -AtkHypertext -atk_hypertext_get_link -atk_hypertext_get_n_links -atk_hypertext_get_link_index -<SUBSECTION Standard> -AtkHypertextIface -ATK_HYPERTEXT -ATK_IS_HYPERTEXT -ATK_TYPE_HYPERTEXT -ATK_HYPERTEXT_GET_IFACE -atk_hypertext_get_type -</SECTION> - -<SECTION> -<FILE>atkimage</FILE> -<TITLE>AtkImage</TITLE> -AtkImage -atk_image_get_image_position -atk_image_get_image_description -atk_image_set_image_description -atk_image_get_image_size -atk_image_get_image_locale -<SUBSECTION Standard> -AtkImageIface -ATK_IMAGE -ATK_IS_IMAGE -ATK_TYPE_IMAGE -ATK_IMAGE_GET_IFACE -atk_image_get_type -</SECTION> - -<SECTION> -<FILE>atknoopobject</FILE> -<TITLE>AtkNoOpObject</TITLE> -AtkNoOpObject -atk_no_op_object_new -<SUBSECTION Standard> -ATK_NO_OP_OBJECT -ATK_IS_NO_OP_OBJECT -ATK_TYPE_NO_OP_OBJECT -atk_no_op_object_get_type -ATK_NO_OP_OBJECT_CLASS -ATK_IS_NO_OP_OBJECT_CLASS -ATK_NO_OP_OBJECT_GET_CLASS -AtkNoOpObjectClass -</SECTION> - -<SECTION> -<FILE>atknoopobjectfactory</FILE> -<TITLE>AtkNoOpObjectFactory</TITLE> -AtkNoOpObjectFactory -atk_no_op_object_factory_new -<SUBSECTION Standard> -ATK_NO_OP_OBJECT_FACTORY -ATK_IS_NO_OP_OBJECT_FACTORY -ATK_TYPE_NO_OP_OBJECT_FACTORY -atk_no_op_object_factory_get_type -ATK_NO_OP_OBJECT_FACTORY_CLASS -ATK_IS_NO_OP_OBJECT_FACTORY_CLASS -ATK_NO_OP_OBJECT_FACTORY_GET_CLASS -AtkNoOpObjectFactoryClass -</SECTION> - -<SECTION> -<FILE>atkobject</FILE> -<TITLE>AtkObject</TITLE> -AtkObject -AtkRole -atk_role_register -AtkLayer -AtkImplementor -AtkAttribute -AtkAttributeSet -AtkPropertyValues -AtkFunction -AtkPropertyChangeHandler -atk_implementor_ref_accessible -atk_object_get_name -atk_object_get_description -atk_object_get_parent -atk_object_peek_parent -atk_object_get_n_accessible_children -atk_object_ref_accessible_child -atk_object_ref_relation_set -atk_object_get_layer -atk_object_get_mdi_zorder -atk_object_get_role -atk_object_ref_state_set -atk_object_get_index_in_parent -atk_object_set_name -atk_object_set_description -atk_object_set_parent -atk_object_set_role -atk_object_connect_property_change_handler -atk_object_remove_property_change_handler -atk_object_notify_state_change -atk_object_initialize -atk_object_add_relationship -atk_object_remove_relationship -atk_object_get_attributes -atk_object_get_object_locale -atk_object_get_accessible_id -atk_object_set_accessible_id -atk_role_get_name -atk_role_get_localized_name -atk_role_for_name -<SUBSECTION Standard> -AtkImplementorIface -ATK_OBJECT -ATK_IS_OBJECT -ATK_TYPE_OBJECT -ATK_IMPLEMENTOR_GET_IFACE -ATK_OBJECT_CLASS -ATK_IS_OBJECT_CLASS -ATK_OBJECT_GET_CLASS -ATK_TYPE_IMPLEMENTOR -ATK_IS_IMPLEMENTOR -ATK_IMPLEMENTOR -ATK_TYPE_ROLE -ATK_TYPE_LAYER -ATK_TYPE_SCROLL_TYPE -atk_implementor_get_type -atk_object_get_type -atk_role_get_type -atk_layer_get_type -AtkObjectClass -</SECTION> - -<SECTION> -<FILE>atkobjectfactory</FILE> -<TITLE>AtkObjectFactory</TITLE> -AtkObjectFactory -atk_object_factory_create_accessible -atk_object_factory_get_accessible_type -atk_object_factory_invalidate -<SUBSECTION Standard> -ATK_OBJECT_FACTORY -ATK_IS_OBJECT_FACTORY -ATK_TYPE_OBJECT_FACTORY -atk_object_factory_get_type -ATK_OBJECT_FACTORY_CLASS -ATK_IS_OBJECT_FACTORY_CLASS -ATK_OBJECT_FACTORY_GET_CLASS -AtkObjectFactoryClass -</SECTION> - -<SECTION> -<FILE>atkregistry</FILE> -<TITLE>AtkRegistry</TITLE> -AtkRegistry -atk_registry_set_factory_type -atk_registry_get_factory_type -atk_registry_get_factory -atk_get_default_registry -<SUBSECTION Standard> -ATK_REGISTRY -ATK_IS_REGISTRY -ATK_TYPE_REGISTRY -atk_registry_get_type -ATK_REGISTRY_CLASS -ATK_IS_REGISTRY_CLASS -ATK_REGISTRY_GET_CLASS -AtkRegistryClass -</SECTION> - -<SECTION> -<FILE>atkrelation</FILE> -<TITLE>AtkRelation</TITLE> -AtkRelation -AtkRelationType -atk_relation_type_register -atk_relation_type_get_name -atk_relation_type_for_name -atk_relation_new -atk_relation_get_relation_type -atk_relation_get_target -atk_relation_add_target -atk_relation_remove_target -<SUBSECTION Standard> -ATK_RELATION -ATK_IS_RELATION -ATK_TYPE_RELATION -ATK_TYPE_RELATION_TYPE -atk_relation_get_type -atk_relation_type_get_type -ATK_RELATION_CLASS -ATK_IS_RELATION_CLASS -ATK_RELATION_GET_CLASS -AtkRelationClass -</SECTION> - -<SECTION> -<FILE>atkrelationset</FILE> -<TITLE>AtkRelationSet</TITLE> -AtkRelationSet -atk_relation_set_new -atk_relation_set_contains -atk_relation_set_contains_target -atk_relation_set_remove -atk_relation_set_add -atk_relation_set_get_n_relations -atk_relation_set_get_relation -atk_relation_set_get_relation_by_type -atk_relation_set_add_relation_by_type -<SUBSECTION Standard> -ATK_RELATION_SET -ATK_IS_RELATION_SET -ATK_TYPE_RELATION_SET -atk_relation_set_get_type -ATK_RELATION_SET_CLASS -ATK_IS_RELATION_SET_CLASS -ATK_RELATION_SET_GET_CLASS -AtkRelationSetClass -</SECTION> - -<SECTION> -<FILE>atkselection</FILE> -<TITLE>AtkSelection</TITLE> -AtkSelection -atk_selection_add_selection -atk_selection_clear_selection -atk_selection_ref_selection -atk_selection_get_selection_count -atk_selection_is_child_selected -atk_selection_remove_selection -atk_selection_select_all_selection -<SUBSECTION Standard> -AtkSelectionIface -ATK_SELECTION -ATK_IS_SELECTION -ATK_TYPE_SELECTION -ATK_SELECTION_GET_IFACE -atk_selection_get_type -</SECTION> - -<SECTION> -<FILE>atkstateset</FILE> -<TITLE>AtkStateSet</TITLE> -AtkStateSet -atk_state_set_new -atk_state_set_is_empty -atk_state_set_add_state -atk_state_set_add_states -atk_state_set_clear_states -atk_state_set_contains_state -atk_state_set_contains_states -atk_state_set_remove_state -atk_state_set_and_sets -atk_state_set_or_sets -atk_state_set_xor_sets -<SUBSECTION Standard> -ATK_STATE_SET -ATK_IS_STATE_SET -ATK_TYPE_STATE_SET -atk_state_set_get_type -ATK_STATE_SET_CLASS -ATK_IS_STATE_SET_CLASS -ATK_STATE_SET_GET_CLASS -AtkStateSetClass -</SECTION> - -<SECTION> -<FILE>atktable</FILE> -<TITLE>AtkTable</TITLE> -AtkTable -atk_table_ref_at -atk_table_get_index_at -atk_table_get_column_at_index -atk_table_get_row_at_index -atk_table_get_n_columns -atk_table_get_n_rows -atk_table_get_column_extent_at -atk_table_get_row_extent_at -atk_table_get_caption -atk_table_get_column_description -atk_table_get_row_description -atk_table_get_column_header -atk_table_get_row_header -atk_table_get_summary -atk_table_set_caption -atk_table_set_row_description -atk_table_set_column_description -atk_table_set_row_header -atk_table_set_column_header -atk_table_set_summary -atk_table_get_selected_columns -atk_table_get_selected_rows -atk_table_is_column_selected -atk_table_is_row_selected -atk_table_is_selected -atk_table_add_column_selection -atk_table_add_row_selection -atk_table_remove_column_selection -atk_table_remove_row_selection -<SUBSECTION Standard> -AtkTableIface -ATK_TABLE -ATK_IS_TABLE -ATK_TYPE_TABLE -ATK_TABLE_GET_IFACE -atk_table_get_type -</SECTION> - -<SECTION> -<FILE>atktablecell</FILE> -<TITLE>AtkTableCell</TITLE> -AtkTableCell -AtkTableCellIface -atk_table_cell_get_column_span -atk_table_cell_get_column_header_cells -atk_table_cell_get_position -atk_table_cell_get_row_span -atk_table_cell_get_row_header_cells -atk_table_cell_get_row_column_span -atk_table_cell_get_table -<SUBSECTION Standard> -ATK_TABLE_CELL -ATK_IS_TABLE_CELL -ATK_TYPE_TABLE_CELL -ATK_TABLE_CELL_GET_IFACE -atk_table_cell_get_type -</SECTION> - -<SECTION> -<FILE>atktext</FILE> -<TITLE>AtkText</TITLE> -AtkText -AtkTextIface -AtkTextBoundary -AtkTextGranularity -AtkTextClipType -AtkTextRange -AtkTextRectangle -AtkTextAttribute -atk_text_get_text -atk_text_get_character_at_offset -atk_text_get_text_after_offset -atk_text_get_text_at_offset -atk_text_get_text_before_offset -atk_text_get_string_at_offset -atk_text_get_caret_offset -atk_text_get_character_extents -atk_text_get_run_attributes -atk_text_get_default_attributes -atk_text_get_character_count -atk_text_get_offset_at_point -atk_text_get_bounded_ranges -atk_text_get_range_extents -atk_text_free_ranges -atk_text_get_n_selections -atk_text_get_selection -atk_text_add_selection -atk_text_remove_selection -atk_text_set_selection -atk_text_set_caret_offset -atk_attribute_set_free -atk_text_attribute_register -atk_text_attribute_get_name -atk_text_attribute_for_name -atk_text_attribute_get_value -atk_text_scroll_substring_to -atk_text_scroll_substring_to_point -<SUBSECTION Standard> -ATK_TEXT -ATK_IS_TEXT -ATK_TYPE_TEXT -ATK_TEXT_GET_IFACE -ATK_TYPE_TEXT_ATTRIBUTE -ATK_TYPE_TEXT_BOUNDARY -ATK_TYPE_TEXT_GRANULARITY -ATK_TYPE_TEXT_CLIP_TYPE -atk_text_get_type -atk_text_attribute_get_type -atk_text_boundary_get_type -atk_text_granularity_get_type -atk_text_clip_type_get_type -atk_text_range_get_type -</SECTION> - -<SECTION> -<FILE>atkvalue</FILE> -<TITLE>AtkValue</TITLE> -AtkValue -AtkValueType -atk_value_get_current_value -atk_value_get_maximum_value -atk_value_get_minimum_value -atk_value_set_current_value -atk_value_get_minimum_increment -atk_value_get_value_and_text -atk_value_get_range -atk_value_get_increment -atk_value_get_sub_ranges -atk_value_set_value -atk_value_type_get_localized_name -atk_value_type_get_name -<SUBSECTION Standard> -AtkValueIface -ATK_VALUE -ATK_IS_VALUE -ATK_TYPE_VALUE -ATK_VALUE_GET_IFACE -atk_value_get_type -ATK_TYPE_VALUE_TYPE -atk_value_type_get_type -</SECTION> - -<SECTION> -<FILE>atkhyperlink</FILE> -<TITLE>AtkHyperlink</TITLE> -AtkHyperlink -AtkHyperlinkStateFlags -atk_hyperlink_get_uri -atk_hyperlink_get_object -atk_hyperlink_get_end_index -atk_hyperlink_get_start_index -atk_hyperlink_is_valid -atk_hyperlink_is_inline -atk_hyperlink_get_n_anchors -atk_hyperlink_is_selected_link -<SUBSECTION Standard> -ATK_HYPERLINK -ATK_IS_HYPERLINK -ATK_TYPE_HYPERLINK -atk_hyperlink_get_type -ATK_HYPERLINK_CLASS -ATK_IS_HYPERLINK_CLASS -ATK_HYPERLINK_GET_CLASS -atk_hyperlink_state_flags_get_type -ATK_TYPE_HYPERLINK_STATE_FLAGS -AtkHyperlinkClass -</SECTION> - -<SECTION> -<FILE>atkhyperlinkimpl</FILE> -<TITLE>AtkHyperlinkImpl</TITLE> -AtkHyperlinkImpl -atk_hyperlink_impl_get_hyperlink -<SUBSECTION Standard> -AtkHyperlinkImplIface -ATK_HYPERLINK_IMPL -ATK_IS_HYPERLINK_IMPL -ATK_TYPE_HYPERLINK_IMPL -atk_hyperlink_impl_get_type -ATK_HYPERLINK_IMPL_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atkstate</FILE> -<TITLE>AtkState</TITLE> -AtkStateType -AtkState -atk_state_type_register -atk_state_type_get_name -atk_state_type_for_name -<SUBSECTION Standard> -ATK_TYPE_STATE_TYPE -atk_state_type_get_type -</SECTION> - -<SECTION> -<FILE>atkstreamablecontent</FILE> -<TITLE>AtkStreamableContent</TITLE> -AtkStreamableContent -atk_streamable_content_get_n_mime_types -atk_streamable_content_get_mime_type -atk_streamable_content_get_stream -atk_streamable_content_get_uri -<SUBSECTION Standard> -AtkStreamableContentIface -ATK_STREAMABLE_CONTENT -ATK_IS_STREAMABLE_CONTENT -ATK_TYPE_STREAMABLE_CONTENT -atk_streamable_content_get_type -ATK_STREAMABLE_CONTENT_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atkutil</FILE> -<TITLE>AtkUtil</TITLE> -AtkUtil -AtkCoordType -atk_add_focus_tracker -atk_remove_focus_tracker -atk_focus_tracker_init -atk_focus_tracker_notify -AtkEventListener -AtkEventListenerInit -atk_add_global_event_listener -atk_remove_global_event_listener -AtkKeyEventStruct -AtkKeyEventType -AtkKeySnoopFunc -atk_add_key_event_listener -atk_remove_key_event_listener -atk_get_root -atk_get_focus_object -atk_get_toolkit_name -atk_get_toolkit_version -atk_get_version -ATK_DEFINE_TYPE -ATK_DEFINE_TYPE_EXTENDED -ATK_DEFINE_TYPE_WITH_CODE -ATK_DEFINE_ABSTRACT_TYPE -ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE -<SUBSECTION Standard> -ATK_UTIL -ATK_IS_UTIL -ATK_TYPE_UTIL -ATK_TYPE_KEY_EVENT_TYPE -ATK_TYPE_COORD_TYPE -atk_util_get_type -atk_key_event_type_get_type -atk_coord_type_get_type -ATK_UTIL_CLASS -ATK_IS_UTIL_CLASS -ATK_UTIL_GET_CLASS -AtkUtilClass -</SECTION> - -<SECTION> -<FILE>atkmisc</FILE> -<TITLE>AtkMisc</TITLE> -AtkMisc -atk_misc_threads_enter -atk_misc_threads_leave -atk_misc_get_instance -<SUBSECTION Standard> -ATK_MISC -ATK_IS_MISC -ATK_TYPE_MISC -ATK_MISC_CLASS -ATK_IS_MISC_CLASS -ATK_MISC_GET_CLASS -AtkMiscClass -atk_misc_get_type -atk_misc_instance -</SECTION> - -<SECTION> -<FILE>atkgobjectaccessible</FILE> -<TITLE>AtkGObjectAccessible</TITLE> -AtkGObjectAccessible -atk_gobject_accessible_for_object -atk_gobject_accessible_get_object -<SUBSECTION Standard> -ATK_GOBJECT_ACCESSIBLE -ATK_IS_GOBJECT_ACCESSIBLE -ATK_TYPE_GOBJECT_ACCESSIBLE -atk_gobject_accessible_get_type -ATK_GOBJECT_ACCESSIBLE_CLASS -ATK_IS_GOBJECT_ACCESSIBLE_CLASS -ATK_GOBJECT_ACCESSIBLE_GET_CLASS -AtkGObjectAccessibleClass -</SECTION> - -<SECTION> -<FILE>atkplug</FILE> -<TITLE>AtkPlug</TITLE> -AtkPlug -atk_plug_new -atk_plug_get_id -<SUBSECTION Standard> -ATK_IS_PLUG -ATK_IS_PLUG_CLASS -ATK_PLUG -ATK_PLUG_CLASS -ATK_PLUG_GET_CLASS -ATK_TYPE_PLUG -AtkPlugClass -atk_plug_get_type -</SECTION> - -<SECTION> -<FILE>atksocket</FILE> -<TITLE>AtkSocket</TITLE> -AtkSocket -atk_socket_new -atk_socket_embed -atk_socket_is_occupied -<SUBSECTION Standard> -ATK_IS_SOCKET -ATK_IS_SOCKET_CLASS -ATK_SOCKET -ATK_SOCKET_CLASS -ATK_SOCKET_GET_CLASS -ATK_TYPE_SOCKET -AtkSocketClass -atk_socket_get_type -</SECTION> - -<SECTION> -<FILE>atkwindow</FILE> -<TITLE>AtkWindow</TITLE> -AtkWindow -<SUBSECTION Standard> -ATK_IS_WINDOW -ATK_IS_WINDOW_CLASS -ATK_WINDOW -ATK_WINDOW_CLASS -ATK_WINDOW_GET_IFACE -ATK_TYPE_WINDOW -AtkWindowClass -atk_window_get_type -</SECTION> - -<SECTION> -<FILE>atkversion</FILE> -<TITLE>Versioning Utilities</TITLE> -ATK_BINARY_AGE -ATK_INTERFACE_AGE -atk_get_major_version -atk_get_minor_version -atk_get_micro_version -atk_get_binary_age -atk_get_interface_age -ATK_MAJOR_VERSION -ATK_MINOR_VERSION -ATK_MICRO_VERSION -ATK_CHECK_VERSION -<SUBSECTION> -ATK_VERSION_2_2 -ATK_VERSION_2_4 -ATK_VERSION_2_6 -ATK_VERSION_2_8 -ATK_VERSION_2_10 -ATK_VERSION_2_12 -ATK_VERSION_2_14 -ATK_VERSION_2_30 -ATK_VERSION_MAX_ALLOWED -ATK_VERSION_MIN_REQUIRED -<SUBSECTION Private> -atk_binary_age -atk_interface_age -atk_major_version -atk_micro_version -atk_minor_version -ATK_VERSION_PREV_STABLE -ATK_VERSION_CUR_STABLE -ATK_UNAVAILABLE -ATK_VAR -ATK_AVAILABLE_IN_ALL -ATK_AVAILABLE_IN_2_2 -ATK_AVAILABLE_IN_2_4 -ATK_AVAILABLE_IN_2_6 -ATK_AVAILABLE_IN_2_8 -ATK_AVAILABLE_IN_2_10 -ATK_AVAILABLE_IN_2_12 -ATK_AVAILABLE_IN_2_14 -ATK_AVAILABLE_IN_2_30 -ATK_DEPRECATED -ATK_DEPRECATED_FOR -ATK_DEPRECATED_IN_2_2 -ATK_DEPRECATED_IN_2_2_FOR -ATK_DEPRECATED_IN_2_30 -ATK_DEPRECATED_IN_2_30_FOR -ATK_DEPRECATED_IN_2_4 -ATK_DEPRECATED_IN_2_4_FOR -ATK_DEPRECATED_IN_2_6 -ATK_DEPRECATED_IN_2_6_FOR -ATK_DEPRECATED_IN_2_8 -ATK_DEPRECATED_IN_2_8_FOR -ATK_DEPRECATED_IN_2_10 -ATK_DEPRECATED_IN_2_10_FOR -ATK_DEPRECATED_IN_2_12 -ATK_DEPRECATED_IN_2_12_FOR -ATK_DEPRECATED_IN_2_14 -ATK_DEPRECATED_IN_2_14_FOR -</SECTION> - -<SECTION> -<FILE>atkrange</FILE> -<TITLE>AtkRange</TITLE> -atk_range_copy -atk_range_free -atk_range_get_lower_limit -atk_range_get_upper_limit -atk_range_get_description -atk_range_new -<SUBSECTION Standard> -ATK_TYPE_RANGE -atk_range_get_type -</SECTION> diff --git a/doc/atk/meson.build b/doc/atk/meson.build deleted file mode 100644 index d9d07ca9..00000000 --- a/doc/atk/meson.build +++ /dev/null @@ -1,32 +0,0 @@ -subdir('xml') - -private_headers = [ - 'atkmarshal.h', - 'atkintl.h', -] - -glib_prefix = dependency('glib-2.0').get_variable(pkgconfig: 'prefix') -glib_docpath = glib_prefix / 'share/gtk-doc/html' -docpath = atspi_datadir / 'gtk-doc/html' - -gnome.gtkdoc('atk', - main_xml: 'atk-docs.xml', - src_dir: atk_inc, - dependencies: libatk_dep, - gobject_typesfile: 'atk.types', - scan_args: [ - '--rebuild-types', - '--deprecated-guards=ATK_DISABLE_DEPRECATED', - '--ignore-decorators=_ATK_EXTERN', - '--ignore-headers=' + ' '.join(private_headers), - ], - mkdb_args: [ - '--output-format=xml', - ], - fixxref_args: [ - '--html-dir=@0@'.format(docpath), - '--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')), - '--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')), - ], - install: true, -) diff --git a/doc/atk/xml/gtkdocentities.ent.in b/doc/atk/xml/gtkdocentities.ent.in deleted file mode 100644 index f12c9ff7..00000000 --- a/doc/atk/xml/gtkdocentities.ent.in +++ /dev/null @@ -1,8 +0,0 @@ -<!ENTITY package "@PACKAGE@"> -<!ENTITY package_bugreport "@PACKAGE_BUGREPORT@"> -<!ENTITY package_name "@PACKAGE_NAME@"> -<!ENTITY package_string "@PACKAGE_STRING@"> -<!ENTITY package_tarname "@PACKAGE_TARNAME@"> -<!ENTITY package_url "@PACKAGE_URL@"> -<!ENTITY package_version "@PACKAGE_VERSION@"> -<!ENTITY package_api_version "@PACKAGE_API_VERSION@"> diff --git a/doc/atk/xml/meson.build b/doc/atk/xml/meson.build deleted file mode 100644 index 2a6a1f0a..00000000 --- a/doc/atk/xml/meson.build +++ /dev/null @@ -1,14 +0,0 @@ -ent_conf = configuration_data() -ent_conf.set('PACKAGE', meson.project_name()) -ent_conf.set('PACKAGE_BUGREPORT', 'https://gitlab.gnome.org/GNOME/atk') -ent_conf.set('PACKAGE_NAME', meson.project_name()) -ent_conf.set('PACKAGE_STRING', meson.project_name()) -ent_conf.set('PACKAGE_TARNAME', '@0@-@1@'.format(meson.project_name(), meson.project_version())) -ent_conf.set('PACKAGE_URL', 'https://developer.gnome.org/atk/stable') -ent_conf.set('PACKAGE_VERSION', meson.project_version()) -ent_conf.set('PACKAGE_API_VERSION', atk_api_version) -configure_file( - input: 'gtkdocentities.ent.in', - output: 'gtkdocentities.ent', - configuration: ent_conf, -) diff --git a/doc/libatspi.toml.in b/doc/libatspi.toml.in new file mode 100644 index 00000000..eb47cca6 --- /dev/null +++ b/doc/libatspi.toml.in @@ -0,0 +1,44 @@ +[library] +version = "@VERSION@" +browse_url = "https://gitlab.gnome.org/GNOME/at-spi2-core/" +repository_url = "https://gitlab.gnome.org/GNOME/at-spi2-core.git" +website_url = "https://wiki.gnome.org/Accessibility" +doc_url = "https://gnome.pages.gitlab.gnome.org/at-spi2-core/libatspi/" +authors = "The AT-SPI2 maintainers" +license = "LGPL-2.1-or-later" +description = "The Assistive Technology Service Provider Interface, version 2" +dependencies = ["GObject-2.0",] +devhelp = true +search_index = true +logo_url = "logo.png" + + [dependencies."GObject-2.0"] + name = "GObject" + description = "The base type system library" + docs_url = "https://docs.gtk.org/gobject/" + +related = ["Atk"] + + [related."Atk"] + name = "Atk" + description = "The Accessibility toolkite" + docs_url = "https://gnome.pages.gitlab.gnome.org/at-spi2-core/atk/" + +[theme] +name = "basic" +show_index_summary = true +show_class_hierarchy = true + +[source-location] +# The base URL for the web UI +base_url = "https://gitlab.gnome.org/GNOME/at-spi2-core/-/blob/HEAD/" +# The format for links, using "filename" and "line" for the format +file_format = "{filename}#L{line}" + +[extra] +content_files = [ +] +content_images = [ + "logo.png", +] +urlmap_file = "urlmap.js" diff --git a/doc/libatspi/libatspi-docs.sgml b/doc/libatspi/libatspi-docs.sgml deleted file mode 100644 index 935767c6..00000000 --- a/doc/libatspi/libatspi-docs.sgml +++ /dev/null @@ -1,57 +0,0 @@ -<?xml version="1.0"?> -<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" - "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" -[ - <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> - <!ENTITY version SYSTEM "version.xml"> -]> -<book id="index"> - <bookinfo> - <title>libatspi Reference Manual</title> - <releaseinfo> - for libatspi &version;. - The latest version of this documentation can be found on-line at - <ulink role="online-location" url="http://developer.gnome.org/libatspi/">http://developer.gnome.org/libatspi/</ulink>. - </releaseinfo> - </bookinfo> - - <chapter> - <title>API reference</title> - <xi:include href="xml/atspi-text.xml"/> - <xi:include href="xml/atspi-stateset.xml"/> - <xi:include href="xml/atspi-application.xml"/> - <xi:include href="xml/atspi-collection.xml"/> - <xi:include href="xml/atspi-action.xml"/> - <xi:include href="xml/atspi-relation.xml"/> - <xi:include href="xml/atspi-image.xml"/> - <xi:include href="xml/atspi-matchrule.xml"/> - <xi:include href="xml/atspi-document.xml"/> - <xi:include href="xml/atspi-object.xml"/> - <xi:include href="xml/atspi-accessible.xml"/> - <xi:include href="xml/atspi-device-listener.xml"/> - <xi:include href="xml/atspi-hyperlink.xml"/> - <xi:include href="xml/atspi-editabletext.xml"/> - <xi:include href="xml/atspi-value.xml"/> - <xi:include href="xml/atspi-table.xml"/> - <xi:include href="xml/atspi-table-cell.xml"/> - <xi:include href="xml/atspi-selection.xml"/> - <xi:include href="xml/atspi-event-listener.xml"/> - <xi:include href="xml/atspi-hypertext.xml"/> - <xi:include href="xml/atspi-component.xml"/> - <xi:include href="xml/atspi-registry.xml"/> - <xi:include href="xml/atspi-types.xml"/> - <xi:include href="xml/atspi-constants.xml"/> - <xi:include href="xml/atspi-misc.xml"/> - - </chapter> - <chapter id="object-tree"> - <title>Object Hierarchy</title> - <xi:include href="xml/tree_index.sgml"/> - </chapter> - <index id="api-index-full"> - <title>API Index</title> - <xi:include href="xml/api-index-full.xml"><xi:fallback /></xi:include> - </index> - - <xi:include href="xml/annotation-glossary.xml"><xi:fallback /></xi:include> -</book> diff --git a/doc/libatspi/libatspi-sections.txt b/doc/libatspi/libatspi-sections.txt deleted file mode 100644 index b99b9046..00000000 --- a/doc/libatspi/libatspi-sections.txt +++ /dev/null @@ -1,688 +0,0 @@ -<SECTION> -<FILE>atspi-text</FILE> -AtspiRange -atspi_range_copy -AtspiTextRange -atspi_text_get_type -AtspiText -atspi_text_range_get_type -atspi_text_get_character_count -atspi_text_get_text -atspi_text_get_caret_offset -atspi_text_get_attributes -atspi_text_get_attribute_run -atspi_text_get_attribute_value -atspi_text_get_default_attributes -atspi_text_set_caret_offset -atspi_text_get_text_before_offset -atspi_text_get_text_at_offset -atspi_text_get_text_after_offset -atspi_text_get_character_at_offset -atspi_text_get_character_extents -atspi_text_get_offset_at_point -atspi_text_get_range_extents -atspi_text_get_bounded_ranges -atspi_text_get_n_selections -atspi_text_get_selection -atspi_text_add_selection -atspi_text_remove_selection -atspi_text_set_selection -atspi_text_get_string_at_offset -atspi_text_get_text_attribute_value -atspi_text_get_text_attributes -atspi_text_scroll_substring_to -atspi_text_scroll_substring_to_point -<SUBSECTION Standard> -ATSPI_TEXT -ATSPI_IS_TEXT -ATSPI_TYPE_TEXT -atspi_range_get_type -ATSPI_TEXT_GET_IFACE -ATSPI_TYPE_RANGE -ATSPI_TYPE_TEXT_RANGE -</SECTION> - -<SECTION> -<FILE>atspi-stateset</FILE> -<TITLE>AtspiStateSet</TITLE> -AtspiStateSet -AtspiStateSetClass -atspi_state_set_new -atspi_state_set_set_by_name -atspi_state_set_add -atspi_state_set_compare -atspi_state_set_contains -atspi_state_set_equals -atspi_state_set_get_states -atspi_state_set_is_empty -atspi_state_set_remove -<SUBSECTION Standard> -ATSPI_STATE_SET -ATSPI_IS_STATE_SET -ATSPI_TYPE_STATE_SET -atspi_state_set_get_type -ATSPI_STATE_SET_CLASS -ATSPI_IS_STATE_SET_CLASS -ATSPI_STATE_SET_GET_CLASS -</SECTION> - -<SECTION> -<FILE>atspi-application</FILE> -<TITLE>AtspiApplication</TITLE> -AtspiApplication -AtspiApplicationClass -<SUBSECTION Standard> -ATSPI_APPLICATION -ATSPI_IS_APPLICATION -ATSPI_TYPE_APPLICATION -ATSPI_APPLICATION_CLASS -ATSPI_IS_APPLICATION_CLASS -ATSPI_APPLICATION_GET_CLASS -</SECTION> - -<SECTION> -<FILE>atspi-collection</FILE> -AtspiCollection -atspi_collection_is_ancestor_of -atspi_collection_get_matches -atspi_collection_get_matches_to -atspi_collection_get_matches_from -atspi_collection_get_active_descendant -<SUBSECTION Standard> -ATSPI_COLLECTION -ATSPI_IS_COLLECTION -ATSPI_TYPE_COLLECTION -atspi_collection_get_type -ATSPI_COLLECTION_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-action</FILE> -AtspiAction -atspi_action_get_n_actions -atspi_action_get_description -atspi_action_get_key_binding -atspi_action_get_action_description -atspi_action_get_action_name -atspi_action_get_localized_name -atspi_action_get_name -atspi_action_do_action -<SUBSECTION Standard> -ATSPI_ACTION -ATSPI_IS_ACTION -ATSPI_TYPE_ACTION -atspi_action_get_type -ATSPI_ACTION_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-relation</FILE> -<TITLE>AtspiRelation</TITLE> -AtspiRelation -AtspiRelationClass -atspi_relation_get_relation_type -atspi_relation_get_n_targets -atspi_relation_get_target -<SUBSECTION Standard> -ATSPI_RELATION -ATSPI_IS_RELATION -ATSPI_TYPE_RELATION -atspi_relation_get_type -ATSPI_RELATION_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-image</FILE> -AtspiImage -atspi_image_get_image_description -atspi_image_get_image_size -atspi_image_get_image_position -atspi_image_get_image_extents -atspi_image_get_image_locale -<SUBSECTION Standard> -ATSPI_IMAGE -ATSPI_IS_IMAGE -ATSPI_TYPE_IMAGE -atspi_image_get_type -ATSPI_IMAGE_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-matchrule</FILE> -<TITLE>AtspiMatchRule</TITLE> -AtspiMatchRule -AtspiMatchRuleClass -atspi_match_rule_new -<SUBSECTION Standard> -ATSPI_MATCH_RULE -ATSPI_IS_MATCH_RULE -ATSPI_TYPE_MATCH_RULE -atspi_match_rule_get_type -ATSPI_MATCH_RULE_CLASS -ATSPI_IS_MATCH_RULE_CLASS -ATSPI_MATCH_RULE_GET_CLASS -</SECTION> - -<SECTION> -<FILE>atspi-document</FILE> -AtspiDocument -atspi_document_get_locale -atspi_document_get_attribute_value -atspi_document_get_attributes -atspi_document_get_current_page_number -atspi_document_get_document_attribute_value -atspi_document_get_document_attributes -atspi_document_get_page_count -<SUBSECTION Standard> -ATSPI_DOCUMENT -ATSPI_IS_DOCUMENT -ATSPI_TYPE_DOCUMENT -atspi_document_get_type -ATSPI_DOCUMENT_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-object</FILE> -<TITLE>AtspiObject</TITLE> -AtspiObject -AtspiObjectClass -<SUBSECTION Standard> -ATSPI_OBJECT -ATSPI_IS_OBJECT -ATSPI_TYPE_OBJECT -atspi_object_get_type -ATSPI_OBJECT_CLASS -ATSPI_IS_OBJECT_CLASS -ATSPI_OBJECT_GET_CLASS -</SECTION> - -<SECTION> -<FILE>atspi-accessible</FILE> -<TITLE>AtspiAccessible</TITLE> -AtspiAccessible -AtspiAccessibleClass -atspi_accessible_new -atspi_role_get_name -atspi_accessible_get_name -atspi_accessible_get_description -atspi_accessible_get_parent -atspi_accessible_get_child_count -atspi_accessible_get_child_at_index -atspi_accessible_get_index_in_parent -atspi_accessible_get_relation_set -atspi_accessible_get_role -atspi_accessible_get_role_name -atspi_accessible_get_localized_role_name -atspi_accessible_get_state_set -atspi_accessible_get_attributes -atspi_accessible_get_attributes_as_array -atspi_accessible_get_locale -atspi_accessible_get_toolkit_name -atspi_accessible_get_toolkit_version -atspi_accessible_get_atspi_version -atspi_accessible_get_id -atspi_accessible_get_application -atspi_accessible_get_action -atspi_accessible_get_collection -atspi_accessible_get_component -atspi_accessible_get_document -atspi_accessible_get_editable_text -atspi_accessible_get_hyperlink -atspi_accessible_get_hypertext -atspi_accessible_get_image -atspi_accessible_get_selection -atspi_accessible_get_table -atspi_accessible_get_table_cell -atspi_accessible_get_text -atspi_accessible_get_value -atspi_accessible_get_object_locale -atspi_accessible_set_cache_mask -atspi_accessible_clear_cache -atspi_accessible_get_process_id -atspi_accessible_get_action_iface -atspi_accessible_get_collection_iface -atspi_accessible_get_component_iface -atspi_accessible_get_document_iface -atspi_accessible_get_editable_text_iface -atspi_accessible_get_hypertext_iface -atspi_accessible_get_image_iface -atspi_accessible_get_selection_iface -atspi_accessible_get_table_iface -atspi_accessible_get_text_iface -atspi_accessible_get_value_iface -atspi_accessible_get_interfaces -atspi_accessible_get_accessible_id -<SUBSECTION Standard> -ATSPI_ACCESSIBLE -ATSPI_IS_ACCESSIBLE -ATSPI_TYPE_ACCESSIBLE -atspi_accessible_get_type -ATSPI_ACCESSIBLE_CLASS -ATSPI_IS_ACCESSIBLE_CLASS -ATSPI_ACCESSIBLE_GET_CLASS - -<SUBSECTION Private> -AtspiAccessiblePrivate -</SECTION> - -<SECTION> -<FILE>atspi-device-listener</FILE> -<TITLE>AtspiDeviceListener</TITLE> -AtspiDeviceListenerCB -AtspiDeviceListenerSimpleCB -AtspiDeviceListener -AtspiDeviceListenerClass -atspi_device_listener_new -atspi_device_listener_new_simple -atspi_device_listener_add_callback -atspi_device_listener_remove_callback -<SUBSECTION Standard> -ATSPI_DEVICE_LISTENER -ATSPI_IS_DEVICE_LISTENER -ATSPI_TYPE_DEVICE_LISTENER -atspi_device_listener_get_type -ATSPI_DEVICE_LISTENER_CLASS -ATSPI_IS_DEVICE_LISTENER_CLASS -ATSPI_DEVICE_LISTENER_GET_CLASS -</SECTION> - -<SECTION> -<FILE>atspi-hypertext</FILE> -AtspiHypertext -atspi_hypertext_get_n_links -atspi_hypertext_get_link -atspi_hypertext_get_link_index -<SUBSECTION Standard> -ATSPI_HYPERTEXT -ATSPI_IS_HYPERTEXT -ATSPI_TYPE_HYPERTEXT -atspi_hypertext_get_type -ATSPI_HYPERTEXT_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-hyperlink</FILE> -<TITLE>AtspiHyperlink</TITLE> -AtspiHyperlink -AtspiHyperlinkClass -atspi_hyperlink_new -atspi_hyperlink_get_n_anchors -atspi_hyperlink_get_uri -atspi_hyperlink_get_object -atspi_hyperlink_get_index_range -atspi_hyperlink_get_start_index -atspi_hyperlink_get_end_index -atspi_hyperlink_is_valid -<SUBSECTION Standard> -ATSPI_HYPERLINK -ATSPI_IS_HYPERLINK -ATSPI_TYPE_HYPERLINK -atspi_hyperlink_get_type -ATSPI_HYPERLINK_CLASS -ATSPI_IS_HYPERLINK_CLASS -ATSPI_HYPERLINK_GET_CLASS -</SECTION> - -<SECTION> -<FILE>atspi-editabletext</FILE> -AtspiEditableText -atspi_editable_text_insert_text -atspi_editable_text_copy_text -atspi_editable_text_cut_text -atspi_editable_text_delete_text -atspi_editable_text_paste_text -<SUBSECTION Standard> -ATSPI_EDITABLE_TEXT -ATSPI_IS_EDITABLE_TEXT -ATSPI_TYPE_EDITABLE_TEXT -atspi_editable_text_get_type -ATSPI_EDITABLE_TEXT_GET_IFACE -<SUBSECTION Private> -atspi_editable_text_set_attributes -</SECTION> - -<SECTION> -<FILE>atspi-value</FILE> -AtspiValue -atspi_value_get_minimum_value -atspi_value_get_current_value -atspi_value_get_maximum_value -atspi_value_set_current_value -atspi_value_get_minimum_increment -atspi_value_get_text -<SUBSECTION Standard> -ATSPI_VALUE -ATSPI_IS_VALUE -ATSPI_TYPE_VALUE -atspi_value_get_type -ATSPI_VALUE_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-table</FILE> -AtspiTable -atspi_table_get_caption -atspi_table_get_summary -atspi_table_get_n_rows -atspi_table_get_n_columns -atspi_table_get_accessible_at -atspi_table_get_index_at -atspi_table_get_row_at_index -atspi_table_get_column_at_index -atspi_table_get_row_description -atspi_table_get_column_description -atspi_table_get_row_extent_at -atspi_table_get_column_extent_at -atspi_table_get_row_header -atspi_table_get_column_header -atspi_table_get_n_selected_rows -atspi_table_get_selected_rows -atspi_table_get_selected_columns -atspi_table_get_n_selected_columns -atspi_table_is_row_selected -atspi_table_is_column_selected -atspi_table_add_row_selection -atspi_table_add_column_selection -atspi_table_remove_row_selection -atspi_table_remove_column_selection -atspi_table_get_row_column_extents_at_index -atspi_table_is_selected -<SUBSECTION Standard> -ATSPI_TABLE -ATSPI_IS_TABLE -ATSPI_TYPE_TABLE -atspi_table_get_type -ATSPI_TABLE_GET_IFACE -</SECTION> - -<FILE>atspi-table-cell</FILE> -AtspiTableCell -atspi_table_cell_get_column_span -atspi_table_cell_get_column_header_cells -atspi_table_cell_get_column_index -atspi_table_cell_get_row_span -atspi_table_cell_get_row_header_cells -atspi_table_cell_get_position -atspi_table_cell_get_row_column_span -atspi_table_cell_get_table -<SUBSECTION Standard> -ATSPI_TABLE_CELL -ATSPI_IS_TABLE_CELL -ATSPI_TYPE_TABLE_CELL -atspi_table_cell_get_type -ATSPI_TABLE_CELL_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-selection</FILE> -AtspiSelection -atspi_selection_get_n_selected_children -atspi_selection_get_selected_child -atspi_selection_select_child -atspi_selection_deselect_selected_child -atspi_selection_deselect_child -atspi_selection_is_child_selected -atspi_selection_select_all -atspi_selection_clear_selection -<SUBSECTION Standard> -ATSPI_SELECTION -ATSPI_IS_SELECTION -ATSPI_TYPE_SELECTION -atspi_selection_get_type -ATSPI_SELECTION_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-event-listener</FILE> -<TITLE>AtspiEventListener</TITLE> -AtspiEventListenerCB -AtspiEventListenerSimpleCB -AtspiEventListener -AtspiEventListenerClass -atspi_event_listener_get_type -atspi_event_listener_new -atspi_event_listener_new_simple -atspi_event_listener_register -atspi_event_listener_register_from_callback -atspi_event_listener_register_from_callback_full -atspi_event_listener_register_no_data -atspi_event_listener_register_full -atspi_event_listener_register_with_app -atspi_event_listener_deregister -atspi_event_listener_deregister_from_callback -atspi_event_listener_deregister_no_data -<SUBSECTION Standard> -ATSPI_EVENT_LISTENER -ATSPI_IS_EVENT_LISTENER -ATSPI_TYPE_EVENT_LISTENER -atspi_event_get_type -ATSPI_EVENT_LISTENER_CLASS -ATSPI_IS_EVENT_LISTENER_CLASS -ATSPI_EVENT_LISTENER_GET_CLASS -</SECTION> - -<SECTION> -<FILE>atspi-component</FILE> -AtspiRect -ATSPI_TYPE_RECT -atspi_rect_copy -AtspiPoint -ATSPI_TYPE_POINT -atspi_point_get_type -atspi_point_copy -atspi_component_get_type -AtspiComponent -atspi_component_contains -atspi_component_get_accessible_at_point -atspi_component_get_extents -atspi_component_get_position -atspi_component_get_size -atspi_component_get_layer -atspi_component_get_mdi_z_order -atspi_component_grab_focus -atspi_component_get_alpha -atspi_component_scroll_to -atspi_component_scroll_to_point -atspi_component_set_extents -atspi_component_set_position -atspi_component_set_size -<SUBSECTION Standard> -ATSPI_COMPONENT -ATSPI_IS_COMPONENT -ATSPI_TYPE_COMPONENT -atspi_rect_get_type -ATSPI_COMPONENT_GET_IFACE -</SECTION> - -<SECTION> -<FILE>atspi-registry</FILE> -atspi_key_definition_get_type -atspi_get_desktop_count -atspi_get_desktop -atspi_get_desktop_list -atspi_register_keystroke_listener -atspi_deregister_keystroke_listener -atspi_register_device_event_listener -atspi_deregister_device_event_listener -atspi_generate_keyboard_event -atspi_generate_mouse_event -atspi_set_reference_window -</SECTION> - -<SECTION> -<FILE>atspi-types</FILE> -AtspiControllerEventMask -AtspiKeyMaskType -AtspiKeyEventMask -AtspiDeviceEventMask -AtspiDeviceEvent -AtspiEventListenerMode -AtspiKeyDefinition -AtspiEvent -AtspiKeystrokeListener -AtspiKeyListenerSyncType - -<SUBSECTION Standard> -ATSPI_TYPE_EVENT -atspi_device_event_get_type -atspi_key_listener_sync_type_get_type -</SECTION> - -<SECTION> -<FILE>atspi-constants</FILE> -AtspiLocaleType -ATSPI_LOCALE_TYPE -AtspiCoordType -ATSPI_COORD_TYPE_COUNT -AtspiCollectionSortOrder -ATSPI_SORTORDER_COUNT -AtspiCollectionMatchType -ATSPI_MATCHTYPES_COUNT -AtspiCollectionTreeTraversalType -ATSPI_TREETRAVERSALTYPE -AtspiComponentLayer -ATSPI_COMPONENTLAYER_COUNT -AtspiTextGranularity -AtspiTextBoundaryType -ATSPI_TEXT_BOUNDARY_TYPE_COUNT -AtspiTextClipType -ATSPI_TEXT_CLIP_TYPE_COUNT -AtspiStateType -ATSPI_STATETYPE_COUNT -AtspiKeyEventType -ATSPI_KEYEVENTTYPE_COUNT -AtspiEventType -ATSPI_EVENTTYPE_COUNT -AtspiKeySynthType -ATSPI_KEYSYNTHTYPE_COUNT -AtspiModifierType -ATSPI_MODIFIERTYPE_COUNT -AtspiRelationType -ATSPI_RELATIONTYPE_COUNT -AtspiRole -ATSPI_ROLE_COUNT -AtspiCache -AtspiScrollType -ATSPI_SCROLLTYPE_COUNT - -<SUBSECTION Standard> -atspi_cache_get_type -atspi_collection_match_type_get_type -atspi_collection_sort_order_get_type -atspi_collection_tree_traversal_type_get_type -atspi_component_layer_get_type -atspi_coord_type_get_type -atspi_event_type_get_type -atspi_key_event_type_get_type -atspi_key_synth_type_get_type -atspi_locale_type_get_type -atspi_modifier_type_get_type -atspi_modifier_type_get_type -atspi_relation_type_get_type -atspi_role_get_type -atspi_scroll_type_get_type -atspi_state_type_get_type -atspi_text_boundary_type_get_type -atspi_text_clip_type_get_type -atspi_text_granularity_get_type -ATSPI_TYPE_CACHE -ATSPI_TYPE_COLLECTION_MATCH_TYPE -ATSPI_TYPE_COLLECTION_SORT_ORDER -ATSPI_TYPE_COLLECTION_TREE_TRAVERSAL_TYPE -ATSPI_TYPE_COMPONENT_LAYER -ATSPI_TYPE_COORD_TYPE -ATSPI_TYPE_DEVICE_EVENT -ATSPI_TYPE_EVENT_TYPE -ATSPI_TYPE_KEY_EVENT_TYPE -ATSPI_TYPE_KEY_LISTENER_SYNC_TYPE -ATSPI_TYPE_KEY_SYNTH_TYPE -ATSPI_TYPE_LOCALE_TYPE -ATSPI_TYPE_MODIFIER_TYPE -ATSPI_TYPE_RELATION_TYPE -ATSPI_TYPE_ROLE -ATSPI_TYPE_SCROLL_TYPE -ATSPI_TYPE_STATE_TYPE -ATSPI_TYPE_TEXT_BOUNDARY_TYPE -ATSPI_TYPE_TEXT_CLIP_TYPE -ATSPI_TYPE_TEXT_GRANULARITY -</SECTION> - -<SECTION> -<FILE>atspi-misc</FILE> -atspi_init -atspi_is_initialized -atspi_set_timeout -atspi_set_main_context -atspi_event_main -atspi_event_quit -atspi_exit - -<SUBSECTION Private> -atspi_main_loop -atspi_get_a11y_bus -atspi_dbus_connection_setup_with_g_main -atspi_dbus_server_setup_with_g_main -atspi_bus_registry -ATSPI_CACHE_CHILDREN -ATSPI_CACHE_DESCRIPTION -ATSPI_CACHE_INTERFACES -ATSPI_CACHE_NAME -ATSPI_CACHE_PARENT -ATSPI_CACHE_ROLE -ATSPI_CACHE_STATES -ATSPI_DBUS_INTERFACE_ACCESSIBLE -ATSPI_DBUS_INTERFACE_ACTION -ATSPI_DBUS_INTERFACE_APPLICATION -ATSPI_DBUS_INTERFACE_CACHE -ATSPI_DBUS_INTERFACE_COLLECTION -ATSPI_DBUS_INTERFACE_COMPONENT -ATSPI_DBUS_INTERFACE_DEC -ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER -ATSPI_DBUS_INTERFACE_DOCUMENT -ATSPI_DBUS_INTERFACE_EDITABLE_TEXT -ATSPI_DBUS_INTERFACE_EVENT_KEYBOARD -ATSPI_DBUS_INTERFACE_EVENT_MOUSE -ATSPI_DBUS_INTERFACE_EVENT_OBJECT -ATSPI_DBUS_INTERFACE_HYPERLINK -ATSPI_DBUS_INTERFACE_HYPERTEXT -ATSPI_DBUS_INTERFACE_IMAGE -ATSPI_DBUS_INTERFACE_REGISTRY -ATSPI_DBUS_INTERFACE_SELECTION -ATSPI_DBUS_INTERFACE_SOCKET -ATSPI_DBUS_INTERFACE_TABLE -ATSPI_DBUS_INTERFACE_TABLE_CELL -ATSPI_DBUS_INTERFACE_TEXT -ATSPI_DBUS_INTERFACE_VALUE -ATSPI_DBUS_NAME_REGISTRY -ATSPI_DBUS_PATH_DEC -ATSPI_DBUS_PATH_NULL -ATSPI_DBUS_PATH_REGISTRY -ATSPI_DBUS_PATH_ROOT -atspi_interface_accessible -atspi_interface_action -atspi_interface_application -atspi_interface_cache -atspi_interface_collection -atspi_interface_component -atspi_interface_dec -atspi_interface_device_event_listener -atspi_interface_document -atspi_interface_editable_text -atspi_interface_hyperlink -atspi_interface_hypertext -atspi_interface_image -atspi_interface_registry -atspi_interface_selection -atspi_interface_table -atspi_interface_table_cell -atspi_interface_text -atspi_interface_value -atspi_no_cache -atspi_path_dec -atspi_path_registry -atspi_path_root -AtspiReference -AtspiError -ATSPI_ERROR - -</SECTION> diff --git a/doc/libatspi/libatspi.types b/doc/libatspi/libatspi.types deleted file mode 100644 index abeb3fed..00000000 --- a/doc/libatspi/libatspi.types +++ /dev/null @@ -1,25 +0,0 @@ -atspi_accessible_get_type -atspi_action_get_type -atspi_collection_get_type -atspi_component_get_type -atspi_device_listener_get_type -atspi_document_get_type -atspi_editable_text_get_type -atspi_event_get_type -atspi_event_listener_get_type -atspi_hyperlink_get_type -atspi_hypertext_get_type -atspi_image_get_type -atspi_key_definition_get_type -atspi_match_rule_get_type -atspi_object_get_type -atspi_point_get_type -atspi_range_get_type -atspi_rect_get_type -atspi_relation_get_type -atspi_selection_get_type -atspi_state_set_get_type -atspi_table_get_type -atspi_text_get_type -atspi_text_range_get_type -atspi_value_get_type diff --git a/doc/libatspi/meson.build b/doc/libatspi/meson.build deleted file mode 100644 index ebd23e36..00000000 --- a/doc/libatspi/meson.build +++ /dev/null @@ -1,32 +0,0 @@ -version_xml_conf = configuration_data() -version_xml_conf.set('PACKAGE_VERSION', meson.project_name()) -configure_file(input: 'version.xml.in', - output: 'version.xml', - configuration: version_xml_conf) - -glib_prefix = dependency('glib-2.0').get_variable(pkgconfig: 'prefix') -glib_docpath = join_paths(glib_prefix, 'share', 'gtk-doc', 'html') -docpath = join_paths(atspi_datadir, 'gtk-doc', 'html') - -gnome.gtkdoc('libatspi', - main_xml: 'libatspi-docs.sgml', - src_dir: [ - join_paths(meson.project_source_root(), 'atspi'), - join_paths(meson.project_build_root(), 'atspi'), - ], - dependencies: atspi_dep, - gobject_typesfile: 'libatspi.types', - scan_args: [ - '--rebuild-types', - ], - mkdb_args: [ - '--sgml-mode', - '--output-format=xml', - ], - fixxref_args: [ - '--html-dir=@0@'.format(docpath), - '--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')), - '--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')), - ], - install: true) - diff --git a/doc/libatspi/tmpl/atspi-accessible.sgml b/doc/libatspi/tmpl/atspi-accessible.sgml deleted file mode 100644 index 0e161eed..00000000 --- a/doc/libatspi/tmpl/atspi-accessible.sgml +++ /dev/null @@ -1,334 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtspiAccessible - -<!-- ##### SECTION Short_Description ##### --> -The base interface which is implemented by all accessible objects. - -<!-- ##### SECTION Long_Description ##### --> -<para> -The base interface which is implemented by all accessible objects. -All objects support interfaces for querying their contained 'children' -and position in the accessible-object hierarchy, whether or not they -actually have children. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiAccessible ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiAccessibleClass ##### --> -<para> - -</para> - -@parent_class: - -<!-- ##### FUNCTION atspi_role_get_name ##### --> -<para> - -</para> - -@role: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_name ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_description ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_parent ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_child_count ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_child_at_index ##### --> -<para> - -</para> - -@obj: -@child_index: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_index_in_parent ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_relation_set ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_role ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_role_name ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_localized_role_name ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_state_set ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_attributes ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_attributes_as_array ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_toolkit_name ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_toolkit_version ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_application ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_action ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_collection ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_component ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_document ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_editable_text ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_hyperlink ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_hypertext ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_image ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_selection ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_table ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_text ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_value ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_interfaces ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_accessible_get_accessible_id ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-action.sgml b/doc/libatspi/tmpl/atspi-action.sgml deleted file mode 100644 index d8802a1e..00000000 --- a/doc/libatspi/tmpl/atspi-action.sgml +++ /dev/null @@ -1,82 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-action - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiAction ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_action_get_n_actions ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_action_get_description ##### --> -<para> - -</para> - -@obj: -@i: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_action_get_key_binding ##### --> -<para> - -</para> - -@obj: -@i: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_action_get_name ##### --> -<para> - -</para> - -@obj: -@i: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_action_do_action ##### --> -<para> - -</para> - -@obj: -@i: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-application.sgml b/doc/libatspi/tmpl/atspi-application.sgml deleted file mode 100644 index e6a63164..00000000 --- a/doc/libatspi/tmpl/atspi-application.sgml +++ /dev/null @@ -1,47 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-application - -<!-- ##### SECTION Short_Description ##### --> - An interface identifying the root object associated - with a running application. - -<!-- ##### SECTION Long_Description ##### --> -<para> - An interface identifying an object which is the root of the - hierarchy associated with a running application. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiApplication ##### --> -<para> - -</para> - -@parent: -@hash: -@bus_name: -@bus: -@root: -@cache: -@toolkit_name: -@toolkit_version: -@atspi_version: -@time_added: - -<!-- ##### STRUCT AtspiApplicationClass ##### --> -<para> - -</para> - -@parent_class: - diff --git a/doc/libatspi/tmpl/atspi-collection.sgml b/doc/libatspi/tmpl/atspi-collection.sgml deleted file mode 100644 index 1e604b22..00000000 --- a/doc/libatspi/tmpl/atspi-collection.sgml +++ /dev/null @@ -1,99 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-collection - -<!-- ##### SECTION Short_Description ##### --> -An interface designed to allow accessibles which satisfy a set of -criteria to be returned. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An interface designed to allow accessibles which satisfy a set of -criteria to be returned. This interface can be used to avoid iteration -or client-side search of the object tree. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiCollection ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_collection_is_ancestor_of ##### --> -<para> - -</para> - -@collection: -@test: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_collection_get_matches ##### --> -<para> - -</para> - -@collection: -@rule: -@sortby: -@count: -@traverse: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_collection_get_matches_to ##### --> -<para> - -</para> - -@collection: -@current_object: -@rule: -@sortby: -@tree: -@limit_scope: -@count: -@traverse: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_collection_get_matches_from ##### --> -<para> - -</para> - -@collection: -@current_object: -@rule: -@sortby: -@tree: -@count: -@traverse: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_collection_get_active_descendant ##### --> -<para> - -</para> - -@collection: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-component.sgml b/doc/libatspi/tmpl/atspi-component.sgml deleted file mode 100644 index 546137e2..00000000 --- a/doc/libatspi/tmpl/atspi-component.sgml +++ /dev/null @@ -1,194 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-component - -<!-- ##### SECTION Short_Description ##### --> - An interface implemented by objects which have onscreen visual - representations. - -<!-- ##### SECTION Long_Description ##### --> -<para> - The Component interface is implemented by objects which occupy on-screen - space, e.g. objects which have onscreen visual representations. The methods - in Component allow clients to identify where the objects lie in the onscreen - coordinate system, their relative size, stacking order, and position. It - also provides a mechanism whereby keyboard focus may be transferred to - specific user interface elements programmatically. This is a 2D API. - Coordinates of 3D objects are projected into the 2-dimensional screen view - for purposes of this interface. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiRect ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_TYPE_RECT ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION atspi_rect_copy ##### --> -<para> - -</para> - -@src: -@Returns: - - -<!-- ##### STRUCT AtspiPoint ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_TYPE_POINT ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION atspi_point_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION atspi_point_copy ##### --> -<para> - -</para> - -@src: -@Returns: - - -<!-- ##### FUNCTION atspi_component_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### STRUCT AtspiComponent ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_component_contains ##### --> -<para> - -</para> - -@obj: -@x: -@y: -@ctype: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_component_get_accessible_at_point ##### --> -<para> - -</para> - -@obj: -@x: -@y: -@ctype: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_component_get_extents ##### --> -<para> - -</para> - -@obj: -@ctype: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_component_get_position ##### --> -<para> - -</para> - -@obj: -@ctype: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_component_get_size ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_component_get_layer ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_component_get_mdi_z_order ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_component_grab_focus ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_component_get_alpha ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-constants.sgml b/doc/libatspi/tmpl/atspi-constants.sgml deleted file mode 100644 index 76f4d1b3..00000000 --- a/doc/libatspi/tmpl/atspi-constants.sgml +++ /dev/null @@ -1,500 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-constants - -<!-- ##### SECTION Short_Description ##### --> -Constant definitions needed by multiple interfaces. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Constant definitions needed by multiple interfaces. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### ENUM AtspiLocaleType ##### --> -<para> - -</para> - -@ATSPI_LOCALE_TYPE_MESSAGES: -@ATSPI_LOCALE_TYPE_COLLATE: -@ATSPI_LOCALE_TYPE_CTYPE: -@ATSPI_LOCALE_TYPE_MONETARY: -@ATSPI_LOCALE_TYPE_NUMERIC: -@ATSPI_LOCALE_TYPE_TIME: - -<!-- ##### MACRO ATSPI_LOCALE_TYPE ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiScrollType ##### --> -<para> - -</para> - -@ATSPI_SCROLL_TOP_LEFT: -@ATSPI_SCROLL_BOTTOM_RIGHT: -@ATSPI_SCROLL_TOP_EDGE: -@ATSPI_SCROLL_BOTTOM_EDGE: -@ATSPI_SCROLL_LEFT_EDGE: -@ATSPI_SCROLL_RIGHT_EDGE: -@ATSPI_SCROLL_ANYWHERE: - -<!-- ##### MACRO ATSPI_SCROLLTYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiCoordType ##### --> -<para> - -</para> - -@ATSPI_COORD_TYPE_SCREEN: -@ATSPI_COORD_TYPE_WINDOW: -@ATSPI_COORD_TYPE_PARENT: - -<!-- ##### MACRO ATSPI_COORD_TYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiCollectionSortOrder ##### --> -<para> - -</para> - -@ATSPI_Collection_SORT_ORDER_INVALID: -@ATSPI_Collection_SORT_ORDER_CANONICAL: -@ATSPI_Collection_SORT_ORDER_FLOW: -@ATSPI_Collection_SORT_ORDER_TAB: -@ATSPI_Collection_SORT_ORDER_REVERSE_CANONICAL: -@ATSPI_Collection_SORT_ORDER_REVERSE_FLOW: -@ATSPI_Collection_SORT_ORDER_REVERSE_TAB: -@ATSPI_Collection_SORT_ORDER_LAST_DEFINED: - -<!-- ##### MACRO ATSPI_SORTORDER_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiCollectionMatchType ##### --> -<para> - -</para> - -@ATSPI_Collection_MATCH_INVALID: -@ATSPI_Collection_MATCH_ALL: -@ATSPI_Collection_MATCH_ANY: -@ATSPI_Collection_MATCH_NONE: -@ATSPI_Collection_MATCH_EMPTY: -@ATSPI_Collection_MATCH_LAST_DEFINED: - -<!-- ##### MACRO ATSPI_MATCHTYPES_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiCollectionTreeTraversalType ##### --> -<para> - -</para> - -@ATSPI_Collection_TREE_RESTRICT_CHILDREN: -@ATSPI_Collection_TREE_RESTRICT_SIBLING: -@ATSPI_Collection_TREE_INORDER: -@ATSPI_Collection_TREE_LAST_DEFINED: - -<!-- ##### MACRO ATSPI_TREETRAVERSALTYPE ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiComponentLayer ##### --> -<para> - -</para> - -@ATSPI_LAYER_INVALID: -@ATSPI_LAYER_BACKGROUND: -@ATSPI_LAYER_CANVAS: -@ATSPI_LAYER_WIDGET: -@ATSPI_LAYER_MDI: -@ATSPI_LAYER_POPUP: -@ATSPI_LAYER_OVERLAY: -@ATSPI_LAYER_WINDOW: -@ATSPI_LAYER_LAST_DEFINED: - -<!-- ##### MACRO ATSPI_COMPONENTLAYER_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiTextBoundaryType ##### --> -<para> - -</para> - -@ATSPI_TEXT_BOUNDARY_CHAR: -@ATSPI_TEXT_BOUNDARY_WORD_START: -@ATSPI_TEXT_BOUNDARY_WORD_END: -@ATSPI_TEXT_BOUNDARY_SENTENCE_START: -@ATSPI_TEXT_BOUNDARY_SENTENCE_END: -@ATSPI_TEXT_BOUNDARY_LINE_START: -@ATSPI_TEXT_BOUNDARY_LINE_END: - -<!-- ##### MACRO ATSPI_TEXT_BOUNDARY_TYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiTextClipType ##### --> -<para> - -</para> - -@ATSPI_TEXT_CLIP_NONE: -@ATSPI_TEXT_CLIP_MIN: -@ATSPI_TEXT_CLIP_MAX: -@ATSPI_TEXT_CLIP_BOTH: - -<!-- ##### MACRO ATSPI_TEXT_CLIP_TYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiStateType ##### --> -<para> - -</para> - -@ATSPI_STATE_INVALID: -@ATSPI_STATE_ACTIVE: -@ATSPI_STATE_ARMED: -@ATSPI_STATE_BUSY: -@ATSPI_STATE_CHECKED: -@ATSPI_STATE_COLLAPSED: -@ATSPI_STATE_DEFUNCT: -@ATSPI_STATE_EDITABLE: -@ATSPI_STATE_ENABLED: -@ATSPI_STATE_EXPANDABLE: -@ATSPI_STATE_EXPANDED: -@ATSPI_STATE_FOCUSABLE: -@ATSPI_STATE_FOCUSED: -@ATSPI_STATE_HAS_TOOLTIP: -@ATSPI_STATE_HORIZONTAL: -@ATSPI_STATE_ICONIFIED: -@ATSPI_STATE_MODAL: -@ATSPI_STATE_MULTI_LINE: -@ATSPI_STATE_MULTISELECTABLE: -@ATSPI_STATE_OPAQUE: -@ATSPI_STATE_PRESSED: -@ATSPI_STATE_RESIZABLE: -@ATSPI_STATE_SELECTABLE: -@ATSPI_STATE_SELECTED: -@ATSPI_STATE_SENSITIVE: -@ATSPI_STATE_SHOWING: -@ATSPI_STATE_SINGLE_LINE: -@ATSPI_STATE_STALE: -@ATSPI_STATE_TRANSIENT: -@ATSPI_STATE_VERTICAL: -@ATSPI_STATE_VISIBLE: -@ATSPI_STATE_MANAGES_DESCENDANTS: -@ATSPI_STATE_INDETERMINATE: -@ATSPI_STATE_REQUIRED: -@ATSPI_STATE_TRUNCATED: -@ATSPI_STATE_ANIMATED: -@ATSPI_STATE_INVALID_ENTRY: -@ATSPI_STATE_SUPPORTS_AUTOCOMPLETION: -@ATSPI_STATE_SELECTABLE_TEXT: -@ATSPI_STATE_IS_DEFAULT: -@ATSPI_STATE_VISITED: -@ATSPI_STATE_CHECKABLE: -@ATSPI_STATE_HAS_POPUP: -@ATSPI_STATE_READ_ONLY: -@ATSPI_STATE_LAST_DEFINED: - -<!-- ##### MACRO ATSPI_STATETYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiKeyEventType ##### --> -<para> - -</para> - -@ATSPI_KEY_PRESSED: -@ATSPI_KEY_RELEASED: - -<!-- ##### MACRO ATSPI_KEYEVENTTYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiEventType ##### --> -<para> - -</para> - -@ATSPI_KEY_PRESSED_EVENT: -@ATSPI_KEY_RELEASED_EVENT: -@ATSPI_BUTTON_PRESSED_EVENT: -@ATSPI_BUTTON_RELEASED_EVENT: - -<!-- ##### MACRO ATSPI_EVENTTYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiKeySynthType ##### --> -<para> - -</para> - -@ATSPI_KEY_PRESS: -@ATSPI_KEY_RELEASE: -@ATSPI_KEY_PRESSRELEASE: -@ATSPI_KEY_SYM: -@ATSPI_KEY_STRING: -@ATSPI_KEY_LOCKMODIFIERS: -@ATSPI_KEY_UNLOCKMODIFIERS: - -<!-- ##### MACRO ATSPI_KEYSYNTHTYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiModifierType ##### --> -<para> - -</para> - -@ATSPI_MODIFIER_SHIFT: -@ATSPI_MODIFIER_SHIFTLOCK: -@ATSPI_MODIFIER_CONTROL: -@ATSPI_MODIFIER_ALT: -@ATSPI_MODIFIER_META: -@ATSPI_MODIFIER_META2: -@ATSPI_MODIFIER_META3: -@ATSPI_MODIFIER_NUMLOCK: - -<!-- ##### MACRO ATSPI_MODIFIERTYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiRelationType ##### --> -<para> - -</para> - -@ATSPI_RELATION_NULL: -@ATSPI_RELATION_LABEL_FOR: -@ATSPI_RELATION_LABELLED_BY: -@ATSPI_RELATION_CONTROLLER_FOR: -@ATSPI_RELATION_CONTROLLED_BY: -@ATSPI_RELATION_MEMBER_OF: -@ATSPI_RELATION_TOOLTIP_FOR: -@ATSPI_RELATION_NODE_CHILD_OF: -@ATSPI_RELATION_NODE_PARENT_OF: -@ATSPI_RELATION_EXTENDED: -@ATSPI_RELATION_FLOWS_TO: -@ATSPI_RELATION_FLOWS_FROM: -@ATSPI_RELATION_SUBWINDOW_OF: -@ATSPI_RELATION_EMBEDS: -@ATSPI_RELATION_EMBEDDED_BY: -@ATSPI_RELATION_POPUP_FOR: -@ATSPI_RELATION_PARENT_WINDOW_OF: -@ATSPI_RELATION_DESCRIPTION_FOR: -@ATSPI_RELATION_DESCRIBED_BY: -@ATSPI_RELATION_DETAILS: -@ATSPI_RELATION_DETAILS_FOR: -@ATSPI_RELATION_ERROR_MESSAGE: -@ATSPI_RELATION_ERROR_FOR: -@ATSPI_RELATION_LAST_DEFINED: - -<!-- ##### MACRO ATSPI_RELATIONTYPE_COUNT ##### --> -<para> - -</para> - - - -<!-- ##### ENUM AtspiRole ##### --> -<para> - -</para> - -@ATSPI_ROLE_INVALID: -@ATSPI_ROLE_ACCELERATOR_LABEL: -@ATSPI_ROLE_ALERT: -@ATSPI_ROLE_ANIMATION: -@ATSPI_ROLE_ARROW: -@ATSPI_ROLE_CALENDAR: -@ATSPI_ROLE_CANVAS: -@ATSPI_ROLE_CHECK_BOX: -@ATSPI_ROLE_CHECK_MENU_ITEM: -@ATSPI_ROLE_COLOR_CHOOSER: -@ATSPI_ROLE_COLUMN_HEADER: -@ATSPI_ROLE_COMBO_BOX: -@ATSPI_ROLE_DATE_EDITOR: -@ATSPI_ROLE_DESKTOP_ICON: -@ATSPI_ROLE_DESKTOP_FRAME: -@ATSPI_ROLE_DIAL: -@ATSPI_ROLE_DIALOG: -@ATSPI_ROLE_DIRECTORY_PANE: -@ATSPI_ROLE_DRAWING_AREA: -@ATSPI_ROLE_FILE_CHOOSER: -@ATSPI_ROLE_FILLER: -@ATSPI_ROLE_FOCUS_TRAVERSABLE: -@ATSPI_ROLE_FONT_CHOOSER: -@ATSPI_ROLE_FRAME: -@ATSPI_ROLE_GLASS_PANE: -@ATSPI_ROLE_HTML_CONTAINER: -@ATSPI_ROLE_ICON: -@ATSPI_ROLE_IMAGE: -@ATSPI_ROLE_INTERNAL_FRAME: -@ATSPI_ROLE_LABEL: -@ATSPI_ROLE_LAYERED_PANE: -@ATSPI_ROLE_LIST: -@ATSPI_ROLE_LIST_ITEM: -@ATSPI_ROLE_MENU: -@ATSPI_ROLE_MENU_BAR: -@ATSPI_ROLE_MENU_ITEM: -@ATSPI_ROLE_OPTION_PANE: -@ATSPI_ROLE_PAGE_TAB: -@ATSPI_ROLE_PAGE_TAB_LIST: -@ATSPI_ROLE_PANEL: -@ATSPI_ROLE_PASSWORD_TEXT: -@ATSPI_ROLE_POPUP_MENU: -@ATSPI_ROLE_PROGRESS_BAR: -@ATSPI_ROLE_PUSH_BUTTON: -@ATSPI_ROLE_PUSH_BUTTON_MENU: -@ATSPI_ROLE_RADIO_BUTTON: -@ATSPI_ROLE_RADIO_MENU_ITEM: -@ATSPI_ROLE_ROOT_PANE: -@ATSPI_ROLE_ROW_HEADER: -@ATSPI_ROLE_SCROLL_BAR: -@ATSPI_ROLE_SCROLL_PANE: -@ATSPI_ROLE_SEPARATOR: -@ATSPI_ROLE_SLIDER: -@ATSPI_ROLE_SPIN_BUTTON: -@ATSPI_ROLE_SPLIT_PANE: -@ATSPI_ROLE_STATUS_BAR: -@ATSPI_ROLE_TABLE: -@ATSPI_ROLE_TABLE_CELL: -@ATSPI_ROLE_TABLE_COLUMN_HEADER: -@ATSPI_ROLE_TABLE_ROW_HEADER: -@ATSPI_ROLE_TEAROFF_MENU_ITEM: -@ATSPI_ROLE_TERMINAL: -@ATSPI_ROLE_TEXT: -@ATSPI_ROLE_TOGGLE_BUTTON: -@ATSPI_ROLE_TOOL_BAR: -@ATSPI_ROLE_TOOL_TIP: -@ATSPI_ROLE_TREE: -@ATSPI_ROLE_TREE_TABLE: -@ATSPI_ROLE_UNKNOWN: -@ATSPI_ROLE_VIEWPORT: -@ATSPI_ROLE_WINDOW: -@ATSPI_ROLE_EXTENDED: -@ATSPI_ROLE_HEADER: -@ATSPI_ROLE_FOOTER: -@ATSPI_ROLE_PARAGRAPH: -@ATSPI_ROLE_RULER: -@ATSPI_ROLE_APPLICATION: -@ATSPI_ROLE_AUTOCOMPLETE: -@ATSPI_ROLE_EDITBAR: -@ATSPI_ROLE_EMBEDDED: -@ATSPI_ROLE_ENTRY: -@ATSPI_ROLE_CHART: -@ATSPI_ROLE_CAPTION: -@ATSPI_ROLE_DOCUMENT_FRAME: -@ATSPI_ROLE_HEADING: -@ATSPI_ROLE_PAGE: -@ATSPI_ROLE_SECTION: -@ATSPI_ROLE_REDUNDANT_OBJECT: -@ATSPI_ROLE_FORM: -@ATSPI_ROLE_LINK: -@ATSPI_ROLE_INPUT_METHOD_WINDOW: -@ATSPI_ROLE_TABLE_ROW: -@ATSPI_ROLE_TREE_ITEM: -@ATSPI_ROLE_DOCUMENT_SPREADSHEET: -@ATSPI_ROLE_DOCUMENT_PRESENTATION: -@ATSPI_ROLE_DOCUMENT_TEXT: -@ATSPI_ROLE_DOCUMENT_WEB: -@ATSPI_ROLE_DOCUMENT_EMAIL: -@ATSPI_ROLE_COMMENT: -@ATSPI_ROLE_LIST_BOX: -@ATSPI_ROLE_GROUPING: -@ATSPI_ROLE_IMAGE_MAP: -@ATSPI_ROLE_NOTIFICATION: -@ATSPI_ROLE_INFO_BAR: -@ATSPI_ROLE_LEVEL_BAR: -@ATSPI_ROLE_TITLE_BAR: -@ATSPI_ROLE_BLOCK_QUOTE: -@ATSPI_ROLE_AUDIO: -@ATSPI_ROLE_VIDEO: -@ATSPI_ROLE_DEFINITION: -@ATSPI_ROLE_ARTICLE: -@ATSPI_ROLE_LANDMARK: -@ATSPI_ROLE_LOG: -@ATSPI_ROLE_MARQUEE: -@ATSPI_ROLE_MATH: -@ATSPI_ROLE_RATING: -@ATSPI_ROLE_TIMER: -@ATSPI_ROLE_STATIC: -@ATSPI_ROLE_MATH_FRACTION: -@ATSPI_ROLE_MATH_ROOT: -@ATSPI_ROLE_SUBSCRIPT: -@ATSPI_ROLE_SUPERSCRIPT: -@ATSPI_ROLE_DESCRIPTION_LIST: -@ATSPI_ROLE_DESCRIPTION_TERM: -@ATSPI_ROLE_DESCRIPTION_VALUE: -@ATSPI_ROLE_LAST_DEFINED: - -<!-- ##### MACRO ATSPI_ROLE_COUNT ##### --> -<para> - -</para> - - - diff --git a/doc/libatspi/tmpl/atspi-device-listener.sgml b/doc/libatspi/tmpl/atspi-device-listener.sgml deleted file mode 100644 index f1f3de17..00000000 --- a/doc/libatspi/tmpl/atspi-device-listener.sgml +++ /dev/null @@ -1,98 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-devicelistener - -<!-- ##### SECTION Short_Description ##### --> -An interface for creating and manipulating -device listeners. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An interface for creating and manipulating -device listeners with callback functions. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### USER_FUNCTION AtspiDeviceListenerCB ##### --> -<para> - -</para> - -@stroke: -@user_data: -@Returns: - - -<!-- ##### USER_FUNCTION AtspiDeviceListenerSimpleCB ##### --> -<para> - -</para> - -@stroke: -@Returns: - - -<!-- ##### STRUCT AtspiDeviceListener ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiDeviceListenerClass ##### --> -<para> - -</para> - -@parent_class: -@device_event: - -<!-- ##### FUNCTION atspi_device_listener_new ##### --> -<para> - -</para> - -@callback: -@user_data: -@callback_destroyed: -@Returns: - - -<!-- ##### FUNCTION atspi_device_listener_new_simple ##### --> -<para> - -</para> - -@callback: -@callback_destroyed: -@Returns: - - -<!-- ##### FUNCTION atspi_device_listener_add_callback ##### --> -<para> - -</para> - -@listener: -@callback: -@callback_destroyed: -@user_data: - - -<!-- ##### FUNCTION atspi_device_listener_remove_callback ##### --> -<para> - -</para> - -@listener: -@callback: - - diff --git a/doc/libatspi/tmpl/atspi-document.sgml b/doc/libatspi/tmpl/atspi-document.sgml deleted file mode 100644 index 5162ed2c..00000000 --- a/doc/libatspi/tmpl/atspi-document.sgml +++ /dev/null @@ -1,59 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-document - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiDocument ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_document_get_locale ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_document_get_attribute_value ##### --> -<para> - -</para> - -@obj: -@attribute: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_document_get_attributes ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-editabletext.sgml b/doc/libatspi/tmpl/atspi-editabletext.sgml deleted file mode 100644 index 3fa05bd1..00000000 --- a/doc/libatspi/tmpl/atspi-editabletext.sgml +++ /dev/null @@ -1,104 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-editabletext - -<!-- ##### SECTION Short_Description ##### --> -An interface that provides methods for modifying textual content -of components which support editing. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Derived from atspi-text, the atspi-editabletext interface -provides methods for modifying textual content of components -which support editing. EditableText also interacts with the -system clipboard via copy, cut, and paste methods. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiEditableText ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_editable_text_set_attributes ##### --> -<para> - -</para> - -@obj: -@attributes: -@start_pos: -@end_pos: -@Returns: - - -<!-- ##### FUNCTION atspi_editable_text_insert_text ##### --> -<para> - -</para> - -@obj: -@position: -@text: -@length: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_editable_text_copy_text ##### --> -<para> - -</para> - -@obj: -@start_pos: -@end_pos: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_editable_text_cut_text ##### --> -<para> - -</para> - -@obj: -@start_pos: -@end_pos: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_editable_text_delete_text ##### --> -<para> - -</para> - -@obj: -@start_pos: -@end_pos: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_editable_text_paste_text ##### --> -<para> - -</para> - -@obj: -@position: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-event-listener.sgml b/doc/libatspi/tmpl/atspi-event-listener.sgml deleted file mode 100644 index 5cf1a87d..00000000 --- a/doc/libatspi/tmpl/atspi-event-listener.sgml +++ /dev/null @@ -1,156 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-event-listener - -<!-- ##### SECTION Short_Description ##### --> -A generic interface implemented by objects for the receipt of event -notifications. - -<!-- ##### SECTION Long_Description ##### --> -<para> -A generic interface implemented by objects for the receipt of event -notifications. atspi-event-listener is the interface via which clients of -the atspi-registry receive notification of changes to an application's user -interface and content. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### USER_FUNCTION AtspiEventListenerCB ##### --> -<para> - -</para> - -@event: -@user_data: - - -<!-- ##### USER_FUNCTION AtspiEventListenerSimpleCB ##### --> -<para> - -</para> - -@event: - - -<!-- ##### STRUCT AtspiEventListener ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiEventListenerClass ##### --> -<para> - -</para> - -@parent_class: - -<!-- ##### FUNCTION atspi_event_listener_get_type ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION atspi_event_listener_new ##### --> -<para> - -</para> - -@callback: -@user_data: -@callback_destroyed: -@Returns: - - -<!-- ##### FUNCTION atspi_event_listener_new_simple ##### --> -<para> - -</para> - -@callback: -@callback_destroyed: -@Returns: - - -<!-- ##### FUNCTION atspi_event_listener_register ##### --> -<para> - -</para> - -@listener: -@event_type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_event_listener_register_from_callback ##### --> -<para> - -</para> - -@callback: -@user_data: -@callback_destroyed: -@event_type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_event_listener_register_no_data ##### --> -<para> - -</para> - -@callback: -@callback_destroyed: -@event_type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_event_listener_deregister ##### --> -<para> - -</para> - -@listener: -@event_type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_event_listener_deregister_from_callback ##### --> -<para> - -</para> - -@callback: -@user_data: -@event_type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_event_listener_deregister_no_data ##### --> -<para> - -</para> - -@callback: -@event_type: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-hyperlink.sgml b/doc/libatspi/tmpl/atspi-hyperlink.sgml deleted file mode 100644 index 5942ad39..00000000 --- a/doc/libatspi/tmpl/atspi-hyperlink.sgml +++ /dev/null @@ -1,114 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-hyperlink - -<!-- ##### SECTION Short_Description ##### --> -Instances of atspi-hyperlink are the means by which end users -and clients interact with linked content. - -<!-- ##### SECTION Long_Description ##### --> -<para> - Instances of atspi-hyperlink are returned by - atspi-hypertext objects, and are the means by - which end users and clients interact with linked, - and in some cases embedded, content. These instances - may have multiple "anchors", where an anchor corresponds to a - reference to a particular resource with a corresponding resource - identified (URI). -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiHyperlink ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiHyperlinkClass ##### --> -<para> - -</para> - -@parent_class: - -<!-- ##### FUNCTION atspi_hyperlink_get_n_anchors ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_hyperlink_get_uri ##### --> -<para> - -</para> - -@obj: -@i: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_hyperlink_get_object ##### --> -<para> - -</para> - -@obj: -@i: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_hyperlink_get_index_range ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_hyperlink_get_start_index ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_hyperlink_get_end_index ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_hyperlink_is_valid ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-hypertext.sgml b/doc/libatspi/tmpl/atspi-hypertext.sgml deleted file mode 100644 index 5448f619..00000000 --- a/doc/libatspi/tmpl/atspi-hypertext.sgml +++ /dev/null @@ -1,65 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-hypertext - -<!-- ##### SECTION Short_Description ##### --> -An interface used for objects which implement linking between -multiple resource locations. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An interface used for objects which implement linking between -multiple resource or content locations, or multiple 'markers' -within a single document. A hypertext instance is associated -with one or more hyperlinks which are associated with particular -offests within the hypertext's content. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiHypertext ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_hypertext_get_n_links ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_hypertext_get_link ##### --> -<para> - -</para> - -@obj: -@link_index: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_hypertext_get_link_index ##### --> -<para> - -</para> - -@obj: -@character_offset: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-image.sgml b/doc/libatspi/tmpl/atspi-image.sgml deleted file mode 100644 index 2b7a36ec..00000000 --- a/doc/libatspi/tmpl/atspi-image.sgml +++ /dev/null @@ -1,80 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-image - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiImage ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_image_get_image_description ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_image_get_image_size ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_image_get_image_position ##### --> -<para> - -</para> - -@obj: -@ctype: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_image_get_image_extents ##### --> -<para> - -</para> - -@obj: -@ctype: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_image_get_image_locale ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-listener-private.sgml b/doc/libatspi/tmpl/atspi-listener-private.sgml deleted file mode 100644 index f529533a..00000000 --- a/doc/libatspi/tmpl/atspi-listener-private.sgml +++ /dev/null @@ -1,22 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-listener-private - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - diff --git a/doc/libatspi/tmpl/atspi-matchrule.sgml b/doc/libatspi/tmpl/atspi-matchrule.sgml deleted file mode 100644 index b52922b9..00000000 --- a/doc/libatspi/tmpl/atspi-matchrule.sgml +++ /dev/null @@ -1,54 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-matchrule - -<!-- ##### SECTION Short_Description ##### --> -An interface that allows the definition of match rules -for accessible objects. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An interface that allows the definition of match rules -for accessible objects. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiMatchRule ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiMatchRuleClass ##### --> -<para> - -</para> - -@parent_class: - -<!-- ##### FUNCTION atspi_match_rule_new ##### --> -<para> - -</para> - -@states: -@statematchtype: -@attributes: -@attributematchtype: -@roles: -@rolematchtype: -@interfaces: -@interfacematchtype: -@invert: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-misc-private.sgml b/doc/libatspi/tmpl/atspi-misc-private.sgml deleted file mode 100644 index aa4c96c8..00000000 --- a/doc/libatspi/tmpl/atspi-misc-private.sgml +++ /dev/null @@ -1,357 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-misc-private - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiReference ##### --> -<para> - -</para> - -@name: -@path: - -<!-- ##### MACRO ATSPI_DBUS_NAME_REGISTRY ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_PATH_REGISTRY ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_REGISTRY ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_PATH_NULL ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_PATH_ROOT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_PATH_DEC ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_DEC ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_DEVICE_EVENT_LISTENER ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_CACHE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_ACCESSIBLE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_ACTION ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_APPLICATION ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_COLLECTION ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_COMPONENT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_DOCUMENT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_EDITABLE_TEXT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_EVENT_KEYBOARD ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_EVENT_MOUSE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_EVENT_OBJECT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_HYPERLINK ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_HYPERTEXT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_IMAGE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_SELECTION ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_TABLE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_TEXT ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_VALUE ##### --> -<para> - -</para> - - - -<!-- ##### MACRO ATSPI_DBUS_INTERFACE_SOCKET ##### --> -<para> - -</para> - - - -<!-- ##### VARIABLE atspi_path_dec ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_path_registry ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_path_root ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_bus_registry ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_accessible ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_action ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_application ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_collection ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_component ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_dec ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_device_event_listener ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_document ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_editable_text ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_hyperlink ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_hypertext ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_image ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_registry ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_selection ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_table ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_table_cell ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_text ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_cache ##### --> -<para> - -</para> - - -<!-- ##### VARIABLE atspi_interface_value ##### --> -<para> - -</para> - - diff --git a/doc/libatspi/tmpl/atspi-misc.sgml b/doc/libatspi/tmpl/atspi-misc.sgml deleted file mode 100644 index 06656a48..00000000 --- a/doc/libatspi/tmpl/atspi-misc.sgml +++ /dev/null @@ -1,53 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-misc - -<!-- ##### SECTION Short_Description ##### --> -Miscellaneous methods for using AT-SPI services. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Miscellaneous methods for using AT-SPI services. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION atspi_init ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION atspi_event_main ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION atspi_event_quit ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION atspi_exit ##### --> -<para> - -</para> - -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-object.sgml b/doc/libatspi/tmpl/atspi-object.sgml deleted file mode 100644 index 568af9a0..00000000 --- a/doc/libatspi/tmpl/atspi-object.sgml +++ /dev/null @@ -1,35 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtspiObject - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiObject ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiObjectClass ##### --> -<para> - -</para> - -@parent_class: - diff --git a/doc/libatspi/tmpl/atspi-registry.sgml b/doc/libatspi/tmpl/atspi-registry.sgml deleted file mode 100644 index a8e9569c..00000000 --- a/doc/libatspi/tmpl/atspi-registry.sgml +++ /dev/null @@ -1,133 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-registry - -<!-- ##### SECTION Short_Description ##### --> -A service through which applications providing accessibility services -can rendezvous with consumers of those services. - -<!-- ##### SECTION Long_Description ##### --> -<para> -A service through which applications providing accessibility services (servers) -can rendezvous with consumers of those services (Assistive Technologies). The -atspi-registry is the first "port of call" for accessible applications and for -assistive technologies wishing to query and interact with those applications. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### FUNCTION atspi_key_definition_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION atspi_get_desktop_count ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION atspi_get_desktop ##### --> -<para> - -</para> - -@i: -@Returns: - - -<!-- ##### FUNCTION atspi_get_desktop_list ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION atspi_register_keystroke_listener ##### --> -<para> - -</para> - -@listener: -@key_set: -@modmask: -@event_types: -@sync_type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_deregister_keystroke_listener ##### --> -<para> - -</para> - -@listener: -@key_set: -@modmask: -@event_types: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_register_device_event_listener ##### --> -<para> - -</para> - -@listener: -@event_types: -@filter: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_deregister_device_event_listener ##### --> -<para> - -</para> - -@listener: -@filter: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_generate_keyboard_event ##### --> -<para> - -</para> - -@keyval: -@keystring: -@synth_type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_generate_mouse_event ##### --> -<para> - -</para> - -@x: -@y: -@name: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-relation.sgml b/doc/libatspi/tmpl/atspi-relation.sgml deleted file mode 100644 index dc548e62..00000000 --- a/doc/libatspi/tmpl/atspi-relation.sgml +++ /dev/null @@ -1,66 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-relation - -<!-- ##### SECTION Short_Description ##### --> - An interface via which non-hierarchical relationships - are indicated. - -<!-- ##### SECTION Long_Description ##### --> -<para> - An interface via which non-hierarchical relationships - are indicated. An instance of this interface represents - a "one-to-many" correspondance. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiRelation ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiRelationClass ##### --> -<para> - -</para> - -@parent_class: - -<!-- ##### FUNCTION atspi_relation_get_relation_type ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_relation_get_n_targets ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atspi_relation_get_target ##### --> -<para> - -</para> - -@obj: -@i: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-selection.sgml b/doc/libatspi/tmpl/atspi-selection.sgml deleted file mode 100644 index 6c7a102b..00000000 --- a/doc/libatspi/tmpl/atspi-selection.sgml +++ /dev/null @@ -1,118 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-selection - -<!-- ##### SECTION Short_Description ##### --> -An interface which indicates that an object exposes a 'selection' model, -allowing the selection of one or more of its children. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An interface which indicates that an object exposes a 'selection' -model, allowing the selection of one or more of its children. -Read-only Selection instances are possible, in which case the -interface is used to programmatically determine the selected-ness -of its children. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiSelection ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_selection_get_n_selected_children ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_selection_get_selected_child ##### --> -<para> - -</para> - -@obj: -@selected_child_index: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_selection_select_child ##### --> -<para> - -</para> - -@obj: -@child_index: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_selection_deselect_selected_child ##### --> -<para> - -</para> - -@obj: -@selected_child_index: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_selection_deselect_child ##### --> -<para> - -</para> - -@obj: -@child_index: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_selection_is_child_selected ##### --> -<para> - -</para> - -@obj: -@child_index: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_selection_select_all ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_selection_clear_selection ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-stateset.sgml b/doc/libatspi/tmpl/atspi-stateset.sgml deleted file mode 100644 index dc65b8d5..00000000 --- a/doc/libatspi/tmpl/atspi-stateset.sgml +++ /dev/null @@ -1,122 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-stateset - -<!-- ##### SECTION Short_Description ##### --> -The atspi-stateset objects implement wrappers around a -bitmap of accessible states. - -<!-- ##### SECTION Long_Description ##### --> -<para> -The atspi-stateset objects implement wrappers around a -bitmap of accessible states. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiStateSet ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiStateSetClass ##### --> -<para> - -</para> - -@parent_class: - -<!-- ##### FUNCTION atspi_state_set_new ##### --> -<para> - -</para> - -@states: -@Returns: - - -<!-- ##### FUNCTION atspi_state_set_set_by_name ##### --> -<para> - -</para> - -@set: -@name: -@enabled: - - -<!-- ##### FUNCTION atspi_state_set_add ##### --> -<para> - -</para> - -@set: -@state: - - -<!-- ##### FUNCTION atspi_state_set_compare ##### --> -<para> - -</para> - -@set: -@set2: -@Returns: - - -<!-- ##### FUNCTION atspi_state_set_contains ##### --> -<para> - -</para> - -@set: -@state: -@Returns: - - -<!-- ##### FUNCTION atspi_state_set_equals ##### --> -<para> - -</para> - -@set: -@set2: -@Returns: - - -<!-- ##### FUNCTION atspi_state_set_get_states ##### --> -<para> - -</para> - -@set: -@Returns: - - -<!-- ##### FUNCTION atspi_state_set_is_empty ##### --> -<para> - -</para> - -@set: -@Returns: - - -<!-- ##### FUNCTION atspi_state_set_remove ##### --> -<para> - -</para> - -@set: -@state: - - diff --git a/doc/libatspi/tmpl/atspi-table.sgml b/doc/libatspi/tmpl/atspi-table.sgml deleted file mode 100644 index a90cea48..00000000 --- a/doc/libatspi/tmpl/atspi-table.sgml +++ /dev/null @@ -1,324 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-table - -<!-- ##### SECTION Short_Description ##### --> -An interface used by containers whose data is arranged in a tabular form. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An interface used by containers whose contained data is arranged -in a tabular (i.e. row-column) form. Tables may resemble -a two-dimensional grid, as in a spreadsheet, or may feature objects -which span multiple rows and/or columns, but whose bounds are -aligned on a row/column matrix. Objects within tables are children -of the table object, and they may be referenced either via a child -index or via a row/column pair. Table 'cells' may implement other -interfaces, such as Text, Action, Image, and Component, and should do -so as appropriate to their onscreen rresentation and/or behavior. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiTable ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_table_get_caption ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_summary ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_n_rows ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_n_columns ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_accessible_at ##### --> -<para> - -</para> - -@obj: -@row: -@column: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_index_at ##### --> -<para> - -</para> - -@obj: -@row: -@column: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_row_at_index ##### --> -<para> - -</para> - -@obj: -@index: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_column_at_index ##### --> -<para> - -</para> - -@obj: -@index: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_row_description ##### --> -<para> - -</para> - -@obj: -@row: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_column_description ##### --> -<para> - -</para> - -@obj: -@column: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_row_extent_at ##### --> -<para> - -</para> - -@obj: -@row: -@column: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_column_extent_at ##### --> -<para> - -</para> - -@obj: -@row: -@column: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_row_header ##### --> -<para> - -</para> - -@obj: -@row: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_column_header ##### --> -<para> - -</para> - -@obj: -@column: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_n_selected_rows ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_selected_rows ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_selected_columns ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_n_selected_columns ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_is_row_selected ##### --> -<para> - -</para> - -@obj: -@row: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_is_column_selected ##### --> -<para> - -</para> - -@obj: -@column: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_add_row_selection ##### --> -<para> - -</para> - -@obj: -@row: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_add_column_selection ##### --> -<para> - -</para> - -@obj: -@column: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_remove_row_selection ##### --> -<para> - -</para> - -@obj: -@row: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_remove_column_selection ##### --> -<para> - -</para> - -@obj: -@column: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_get_row_column_extents_at_index ##### --> -<para> - -</para> - -@obj: -@index: -@row: -@col: -@row_extents: -@col_extents: -@is_selected: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_table_is_selected ##### --> -<para> - -</para> - -@obj: -@row: -@column: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-text.sgml b/doc/libatspi/tmpl/atspi-text.sgml deleted file mode 100644 index 961edcbd..00000000 --- a/doc/libatspi/tmpl/atspi-text.sgml +++ /dev/null @@ -1,336 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-text - -<!-- ##### SECTION Short_Description ##### --> -An interface implemented by objects which place textual -information onscreen. - -<!-- ##### SECTION Long_Description ##### --> -<para> -The text interface should be implemented by objects which place textual -information onscreen as character strings or glyphs. The text interface -allows access to textual content including display attributes and -semantic hints associated with runs of text, and to bounding boc -information for glyphs and substrings. It also alows portions of text to -be selected, if the objects StateSet includes STATE_SELECTABLE_TEXT. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiRange ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_TYPE_RANGE ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION atspi_range_copy ##### --> -<para> - -</para> - -@src: -@Returns: - - -<!-- ##### STRUCT AtspiTextRange ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_TYPE_TEXT_RANGE ##### --> -<para> - -</para> - - - -<!-- ##### FUNCTION atspi_text_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### STRUCT AtspiText ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_text_range_get_type ##### --> -<para> - -</para> - -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_character_count ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_text ##### --> -<para> - -</para> - -@obj: -@start_offset: -@end_offset: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_caret_offset ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_attributes ##### --> -<para> - -</para> - -@obj: -@offset: -@start_offset: -@end_offset: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_attribute_run ##### --> -<para> - -</para> - -@obj: -@offset: -@include_defaults: -@start_offset: -@end_offset: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_attribute_value ##### --> -<para> - -</para> - -@obj: -@offset: -@attribute_name: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_default_attributes ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_set_caret_offset ##### --> -<para> - -</para> - -@obj: -@new_offset: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_text_before_offset ##### --> -<para> - -</para> - -@obj: -@offset: -@type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_text_at_offset ##### --> -<para> - -</para> - -@obj: -@offset: -@type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_text_after_offset ##### --> -<para> - -</para> - -@obj: -@offset: -@type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_character_at_offset ##### --> -<para> - -</para> - -@obj: -@offset: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_character_extents ##### --> -<para> - -</para> - -@obj: -@offset: -@type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_offset_at_point ##### --> -<para> - -</para> - -@obj: -@x: -@y: -@type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_range_extents ##### --> -<para> - -</para> - -@obj: -@start_offset: -@end_offset: -@type: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_bounded_ranges ##### --> -<para> - -</para> - -@obj: -@x: -@y: -@width: -@height: -@type: -@clipTypeX: -@clipTypeY: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_n_selections ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_get_selection ##### --> -<para> - -</para> - -@obj: -@selection_num: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_add_selection ##### --> -<para> - -</para> - -@obj: -@start_offset: -@end_offset: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_remove_selection ##### --> -<para> - -</para> - -@obj: -@selection_num: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_text_set_selection ##### --> -<para> - -</para> - -@obj: -@selection_num: -@start_offset: -@end_offset: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/atspi-types.sgml b/doc/libatspi/tmpl/atspi-types.sgml deleted file mode 100644 index 987b7fa2..00000000 --- a/doc/libatspi/tmpl/atspi-types.sgml +++ /dev/null @@ -1,187 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-types - -<!-- ##### SECTION Short_Description ##### --> -Type definitions needed by multiple interfaces. - -<!-- ##### SECTION Long_Description ##### --> -<para> -Type definitions needed by multiple interfaces. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiAccessible ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiAction ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiCollection ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiComponent ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiDocument ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiEditableText ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiHyperlink ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiHypertext ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiImage ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiSelection ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiTable ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiTableCell ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiText ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiValue ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF AtspiControllerEventMask ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF AtspiKeyMaskType ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF AtspiKeyEventMask ##### --> -<para> - -</para> - - -<!-- ##### TYPEDEF AtspiDeviceEventMask ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiDeviceEvent ##### --> -<para> - -</para> - -@type: -@id: -@hw_code: -@modifiers: -@timestamp: -@event_string: -@is_text: - -<!-- ##### STRUCT AtspiEventListenerMode ##### --> -<para> - -</para> - -@synchronous: -@preemptive: -@global: - -<!-- ##### STRUCT AtspiKeyDefinition ##### --> -<para> - -</para> - - -<!-- ##### STRUCT AtspiEvent ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_TYPE_EVENT ##### --> -<para> - -</para> - - - -<!-- ##### TYPEDEF AtspiKeystrokeListener ##### --> -<para> - -</para> - - -<!-- ##### ENUM AtspiKeyListenerSyncType ##### --> -<para> - -</para> - -@ATSPI_KEYLISTENER_NOSYNC: -@ATSPI_KEYLISTENER_SYNCHRONOUS: -@ATSPI_KEYLISTENER_CANCONSUME: -@ATSPI_KEYLISTENER_ALL_WINDOWS: - diff --git a/doc/libatspi/tmpl/atspi-value.sgml b/doc/libatspi/tmpl/atspi-value.sgml deleted file mode 100644 index 59f3cfc0..00000000 --- a/doc/libatspi/tmpl/atspi-value.sgml +++ /dev/null @@ -1,83 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atspi-value - -<!-- ##### SECTION Short_Description ##### --> -An interface supporting a one-dimensional scalar -to be modified, or which reflects its value. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An interface supporting a one-dimensional scalar -to be modified, or which reflects its value. If -STATE_EDITABLE is not present, the value is -treated as "read only". -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtspiValue ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_value_get_minimum_value ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_value_get_current_value ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_value_get_maximum_value ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_value_set_current_value ##### --> -<para> - -</para> - -@obj: -@new_value: -@error: -@Returns: - - -<!-- ##### FUNCTION atspi_value_get_minimum_increment ##### --> -<para> - -</para> - -@obj: -@error: -@Returns: - - diff --git a/doc/libatspi/tmpl/libatspi-unused.sgml b/doc/libatspi/tmpl/libatspi-unused.sgml deleted file mode 100644 index 33ae0612..00000000 --- a/doc/libatspi/tmpl/libatspi-unused.sgml +++ /dev/null @@ -1,82 +0,0 @@ -<!-- ##### MACRO ATSPI_CACHE_CHILDREN ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_CACHE_DESCRIPTION ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_CACHE_INTERFACES ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_CACHE_NAME ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_CACHE_PARENT ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_CACHE_ROLE ##### --> -<para> - -</para> - - -<!-- ##### MACRO ATSPI_CACHE_STATES ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_accessible_new ##### --> -<para> - -</para> - -@app: -@path: -@Returns: - -<!-- ##### FUNCTION atspi_dbus_handle_deviceEvent ##### --> -<para> - -</para> - -@bus: -@message: -@data: -@Returns: - -<!-- ##### FUNCTION atspi_document_get_type ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atspi_hyperlink_new ##### --> -<para> - -</para> - -@app: -@path: -@Returns: - -<!-- ##### FUNCTION atspi_image_get_type ##### --> -<para> - -</para> - - diff --git a/doc/libatspi/version.xml.in b/doc/libatspi/version.xml.in deleted file mode 100644 index a24f9877..00000000 --- a/doc/libatspi/version.xml.in +++ /dev/null @@ -1 +0,0 @@ -@PACKAGE_VERSION@ diff --git a/doc/logo.png b/doc/logo.png Binary files differnew file mode 100644 index 00000000..bc4ede7b --- /dev/null +++ b/doc/logo.png diff --git a/doc/meson.build b/doc/meson.build index 5fcf20e2..0de4f72e 100644 --- a/doc/meson.build +++ b/doc/meson.build @@ -1,2 +1,74 @@ -subdir('libatspi') -subdir('atk') +dependency('gi-docgen', version: '>= 2021.1', + fallback: ['gi-docgen', 'dummy_dep'], + native: true, + required: get_option('docs')) + +gidocgen = find_program('gi-docgen') + +docs_dir = atspi_datadir / 'doc' + +gidocgen_common_args = [ + '--quiet', + '--no-namespace-dir', + '--fatal-warnings', +] + +################################ ATK +atk_expand_content_files =[] + +atk_toml_data = configuration_data() +atk_toml_data.set('VERSION', meson.project_version()) + +atk_toml = configure_file( + input: 'atk.toml.in', + output: 'atk.toml', + configuration: atk_toml_data +) + +custom_target('atk-doc', + input: [ atk_toml, atk_gir[0] ], + output: 'atk', + command: [ + gidocgen, + 'generate', + gidocgen_common_args, + '--config=@INPUT0@', + '--output-dir=@OUTPUT@', + '--content-dir=@0@'.format(meson.current_source_dir()), + '@INPUT1@', + ], + install: true, + install_dir: docs_dir, + depend_files: atk_expand_content_files, +) + + +################################ libatspi +libatspi_expand_content_files = [] + +libatspi_toml_data = configuration_data() +libatspi_toml_data.set('VERSION', meson.project_version()) + +libatspi_toml = configure_file( + input: 'libatspi.toml.in', + output: 'libatspi.toml', + configuration: libatspi_toml_data +) + +custom_target('libatspi-doc', + input: [ libatspi_toml, libatspi_gir[0] ], + output: 'libatspi', + command: [ + gidocgen, + 'generate', + gidocgen_common_args, + '--config=@INPUT0@', + '--output-dir=@OUTPUT@', + '--content-dir=@0@'.format(meson.current_source_dir()), + '@INPUT1@', + ], + install: true, + install_dir: docs_dir, + depend_files: libatspi_expand_content_files, +) + diff --git a/doc/urlmap.js b/doc/urlmap.js new file mode 100644 index 00000000..13eab868 --- /dev/null +++ b/doc/urlmap.js @@ -0,0 +1,17 @@ +// SPDX-FileCopyrightText: 2021 GNOME Foundation +// SPDX-License-Identifier: LGPL-2.1-or-later + +// A map between namespaces and base URLs for their online documentation +baseURLs = [ + [ 'GLib', 'https://docs.gtk.org/glib/' ], + [ 'GObject', 'https://docs.gtk.org/gobject/' ], + [ 'Gio', 'https://docs.gtk.org/gio/' ], + [ 'Gdk', 'https://docs.gtk.org/gdk3/' ], + [ 'GdkX11', 'https://docs.gtk.org/gdk3-x11/' ], + [ 'Gtk', 'https://docs.gtk.org/gtk3/' ], + [ 'Pango', 'https://docs.gtk.org/Pango/' ], + [ 'PangoCairo', 'https://docs.gtk.org/PangoCairo/' ], + [ 'GdkPixbuf', 'https://docs.gtk.org/gdk-pixbuf/' ], + [ 'Atk', 'https://gnome.pages.gitlab.gnome.org/at-spi2-core/atk/' ], + [ 'Atspi', 'https://gnome.pages.gitlab.gnome.org/at-spi2-core/libatspi/' ], +] diff --git a/subprojects/gi-docgen.wrap b/subprojects/gi-docgen.wrap new file mode 100644 index 00000000..333e77a1 --- /dev/null +++ b/subprojects/gi-docgen.wrap @@ -0,0 +1,6 @@ +[wrap-git] +directory=gi-docgen +url=https://gitlab.gnome.org/GNOME/gi-docgen.git +push-url=git@gitlab.gnome.org:GNOME/gi-docgen.git +revision=main +depth=1 diff --git a/tests/atk/testvalue.c b/tests/atk/testvalue.c index 6bc8a54e..441f7f14 100644 --- a/tests/atk/testvalue.c +++ b/tests/atk/testvalue.c @@ -22,8 +22,9 @@ #include <atk/atk.h> /** - * SECTION:testvalue - * @Short_description: this example serves as a unit test for AtkValue + * TestValue: + * + * this example serves as a unit test for AtkValue * and also as an example of how to implement #AtkValue on a given * GObject. * |
