diff options
| author | Alejandro Piñeiro <apinheiro@igalia.com> | 2013-08-12 17:07:46 +0200 |
|---|---|---|
| committer | Alejandro Piñeiro <apinheiro@igalia.com> | 2013-08-12 21:06:36 +0200 |
| commit | 0f1e31ad2451b1e00f631e217d9d29d306404f2d (patch) | |
| tree | 9df22ec49c982912979aa6b907dd25dc27fccd96 /docs | |
| parent | c568794a6f75cc9cc297b24978bc7480ee689bea (diff) | |
| download | atk-0f1e31ad2451b1e00f631e217d9d29d306404f2d.tar.gz | |
doc: removing several .sgml files and fixing gtk-doc warnings
The static documentation of those .sgml (so the reason of
tracking those objects) where moved to the source files.
Some other stuff was changed in order to prevent gtk-doc warnings
(like replacing "Returns blah" for the correct "Returns: blah")
https://bugzilla.gnome.org/show_bug.cgi?id=684665
Diffstat (limited to 'docs')
27 files changed, 8 insertions, 3686 deletions
diff --git a/docs/Makefile.am b/docs/Makefile.am index f83cad7..11ef943 100644 --- a/docs/Makefile.am +++ b/docs/Makefile.am @@ -8,6 +8,8 @@ DOC_MODULE=atk # The top-level SGML file. DOC_MAIN_SGML_FILE=atk-docs.sgml +# Extra options to supply to gtkdoc-scan +SCAN_OPTIONS=--deprecated-guards=G_DISABLE_DEPRECATED # The directory containing the source code (if it contains documentation). DOC_SOURCE_DIR=../atk diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt index fe10941..e50f673 100644 --- a/docs/atk-sections.txt +++ b/docs/atk-sections.txt @@ -2,6 +2,7 @@ <FILE>atkaction</FILE> <TITLE>AtkAction</TITLE> AtkAction +AtkActionIface atk_action_do_action atk_action_get_n_actions atk_action_get_description @@ -10,7 +11,6 @@ atk_action_get_localized_name atk_action_get_keybinding atk_action_set_description <SUBSECTION Standard> -AtkActionIface ATK_ACTION ATK_IS_ACTION ATK_TYPE_ACTION @@ -22,6 +22,9 @@ atk_action_get_type <FILE>atkcomponent</FILE> <TITLE>AtkComponent</TITLE> AtkComponent +AtkComponentIface +AtkFocusHandler +AtkRectangle atk_component_add_focus_handler atk_component_contains atk_component_get_extents @@ -37,14 +40,11 @@ atk_component_set_position atk_component_set_size atk_component_get_alpha <SUBSECTION Standard> -AtkComponentIface ATK_COMPONENT ATK_IS_COMPONENT ATK_TYPE_COMPONENT ATK_TYPE_RECTANGLE ATK_COMPONENT_GET_IFACE -AtkFocusHandler -AtkRectangle atk_component_get_type atk_rectangle_get_type </SECTION> @@ -53,6 +53,7 @@ atk_rectangle_get_type <FILE>atkdocument</FILE> <TITLE>AtkDocument</TITLE> AtkDocument +AtkDocumentIface atk_document_get_document_type atk_document_get_document atk_document_get_attribute_value @@ -60,7 +61,6 @@ atk_document_set_attribute_value atk_document_get_attributes atk_document_get_locale <SUBSECTION Standard> -AtkDocumentIface ATK_DOCUMENT ATK_IS_DOCUMENT ATK_TYPE_DOCUMENT @@ -392,6 +392,7 @@ atk_table_get_type <FILE>atktext</FILE> <TITLE>AtkText</TITLE> AtkText +AtkTextIface AtkTextBoundary AtkTextClipType AtkTextRange @@ -425,7 +426,6 @@ atk_text_attribute_get_name atk_text_attribute_for_name atk_text_attribute_get_value <SUBSECTION Standard> -AtkTextIface ATK_TEXT ATK_IS_TEXT ATK_TYPE_TEXT diff --git a/docs/tmpl/atk.sgml b/docs/tmpl/atk.sgml deleted file mode 100644 index 961a73e..0000000 --- a/docs/tmpl/atk.sgml +++ /dev/null @@ -1,18 +0,0 @@ -<!-- ##### SECTION Title ##### --> -atk - -<!-- ##### SECTION Short_Description ##### --> - - -<!-- ##### SECTION Long_Description ##### --> -<para> - -</para> - - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - - diff --git a/docs/tmpl/atkaction.sgml b/docs/tmpl/atkaction.sgml deleted file mode 100644 index 79ee27e..0000000 --- a/docs/tmpl/atkaction.sgml +++ /dev/null @@ -1,125 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkAction - -<!-- ##### SECTION Short_Description ##### --> -The ATK interface provided by UI components which the user can -activate/interact with, - -<!-- ##### SECTION Long_Description ##### --> -<para> -#AtkAction should be implemented by instances of #AtkObject classes with -which the user can interact directly, i.e. buttons, checkboxes, -scrollbars, e.g. components which are not "passive" -providers of UI information. -</para> -<para> -Exceptions: when the user interaction is already covered by -another appropriate interface such as #AtkEditableText (insert/delete -text, etc.) or #AtkValue (set value) then these actions should not be -exposed by #AtkAction as well. -</para> -<para> -Also note that the #AtkAction API is limited in that parameters may not -be passed to the object being activated; thus the action must be -self-contained and specifiable via only a single "verb". Concrete -examples include "press", "release", "click" for buttons, "drag" -(meaning initiate drag) and "drop" for drag sources and drop targets, -etc. -</para> -<para> -Though most UI interactions on components should be invocable via -keyboard as well as mouse, there will generally be a close mapping -between "mouse actions" that are possible on a component and the -AtkActions. Where mouse and keyboard actions are redundant in effect, -#AtkAction should expose only one action rather than exposing redundant -actions if possible. By convention we have been using "mouse centric" -terminology for #AtkAction names. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkAction ##### --> -<para> -The AtkAction structure does not contain any fields. -</para> - - -<!-- ##### FUNCTION atk_action_do_action ##### --> -<para> - -</para> - -@action: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_action_get_n_actions ##### --> -<para> - -</para> - -@action: -@Returns: - - -<!-- ##### FUNCTION atk_action_get_description ##### --> -<para> - -</para> - -@action: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_action_get_name ##### --> -<para> - -</para> - -@action: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_action_get_localized_name ##### --> -<para> - -</para> - -@action: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_action_get_keybinding ##### --> -<para> - -</para> - -@action: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_action_set_description ##### --> -<para> - -</para> - -@action: -@i: -@desc: -@Returns: - - diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml deleted file mode 100644 index df7a84a..0000000 --- a/docs/tmpl/atkcomponent.sgml +++ /dev/null @@ -1,199 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkComponent - -<!-- ##### SECTION Short_Description ##### --> -The ATK interface provided by UI components which occupy a physical area on -the screen. - -<!-- ##### SECTION Long_Description ##### --> -<para> -#AtkComponent should be implemented by most if not all UI elements with -an actual on-screen presence, i.e. components which can be said to have -a screen-coordinate bounding box. Virtually all widgets will need to -have #AtkComponent implementations provided for their corresponding -#AtkObject class. In short, only UI elements which are *not* GUI -elements will omit this ATK interface. -</para> -<para> -A possible exception might be textual information with a transparent -background, in which case text glyph bounding box information is -provided by #AtkText. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkComponent ##### --> -<para> -The AtkComponent structure does not contain any fields. - -</para> - - -<!-- ##### SIGNAL AtkComponent::bounds-changed ##### --> -<para> -The 'bounds-changed" signal is emitted when the bposition or size of the -a component changes. -</para> - -@atkcomponent: the object which received the signal. -@arg1: The AtkRectangle giving the new position and size. - -<!-- ##### FUNCTION atk_component_add_focus_handler ##### --> -<para> - -</para> - -@component: -@handler: -@Returns: - - -<!-- ##### FUNCTION atk_component_contains ##### --> -<para> - -</para> - -@component: -@x: -@y: -@coord_type: -@Returns: - - -<!-- ##### FUNCTION atk_component_get_extents ##### --> -<para> - -</para> - -@component: -@x: -@y: -@width: -@height: -@coord_type: - - -<!-- ##### FUNCTION atk_component_get_layer ##### --> -<para> - -</para> - -@component: -@Returns: - - -<!-- ##### FUNCTION atk_component_get_mdi_zorder ##### --> -<para> - -</para> - -@component: -@Returns: - - -<!-- ##### FUNCTION atk_component_get_position ##### --> -<para> - -</para> - -@component: -@x: -@y: -@coord_type: - - -<!-- ##### FUNCTION atk_component_get_size ##### --> -<para> - -</para> - -@component: -@width: -@height: - - -<!-- ##### FUNCTION atk_component_grab_focus ##### --> -<para> - -</para> - -@component: -@Returns: - - -<!-- ##### FUNCTION atk_component_ref_accessible_at_point ##### --> -<para> - -</para> - -@component: -@x: -@y: -@coord_type: -@Returns: - - -<!-- ##### FUNCTION atk_component_remove_focus_handler ##### --> -<para> - -</para> - -@component: -@handler_id: - - -<!-- ##### FUNCTION atk_component_set_extents ##### --> -<para> - -</para> - -@component: -@x: -@y: -@width: -@height: -@coord_type: -@Returns: - - -<!-- ##### FUNCTION atk_component_set_position ##### --> -<para> - -</para> - -@component: -@x: -@y: -@coord_type: -@Returns: - - -<!-- ##### FUNCTION atk_component_set_size ##### --> -<para> - -</para> - -@component: -@width: -@height: -@Returns: - - -<!-- ##### FUNCTION atk_component_get_alpha ##### --> -<para> - -</para> - -@component: -@Returns: - - diff --git a/docs/tmpl/atkdocument.sgml b/docs/tmpl/atkdocument.sgml deleted file mode 100644 index 935ac0c..0000000 --- a/docs/tmpl/atkdocument.sgml +++ /dev/null @@ -1,126 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkDocument - -<!-- ##### SECTION Short_Description ##### --> -The ATK interface which represents the toplevel container for document content. - -<!-- ##### SECTION Long_Description ##### --> -<para> -The AtkDocument interface should be supported by any object whose content is a -representation or view of a document. The AtkDocument interface should appear -on the toplevel container for the document content; however AtkDocument -instances may be nested (i.e. an AtkDocument may be a descendant of another -AtkDocument) in those cases where one document contains "embedded content" -which can reasonably be considered a document in its own right. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkDocument ##### --> -<para> -The AtkDocument structure does not contain any fields. - - -</para> - - -<!-- ##### SIGNAL AtkDocument::load-complete ##### --> -<para> -The 'load-complete' signal is emitted when a pending load of a static -document has completed. This signal is to be expected by ATK clients -if and when AtkDocument implementors expose ATK_STATE_BUSY. If the state -of an AtkObject which implements AtkDocument does not include ATK_STATE_BUSY, -it should be safe for clients to assume that the AtkDocument's static contents -are fully loaded into the container. (Dynamic document contents should -be exposed via other signals.) -</para> - -@atkdocument: the object which received the signal. - -<!-- ##### SIGNAL AtkDocument::load-stopped ##### --> -<para> -The 'load-stopped' signal is emitted when a pending load of document contents -is cancelled, paused, or otherwise interrupted by the user or application -logic. It should not however be -emitted while waiting for a resource (for instance while blocking on a file or -network read) unless a user-significant timeout has occurred. -</para> - -@atkdocument: the object which received the signal. - -<!-- ##### SIGNAL AtkDocument::reload ##### --> -<para> -The 'reload' signal is emitted when the contents of a document is refreshed -from its source. Once 'reload' has been emitted, a matching 'load-complete' -or 'load-stopped' signal should follow, which clients may await before -interrogating ATK for the latest document content. -</para> - -@atkdocument: the object which received the signal. - -<!-- ##### FUNCTION atk_document_get_document_type ##### --> -<para> - -</para> - -@document: -@Returns: - - -<!-- ##### FUNCTION atk_document_get_document ##### --> -<para> - -</para> - -@document: -@Returns: - - -<!-- ##### FUNCTION atk_document_get_attribute_value ##### --> -<para> - -</para> - -@document: -@attribute_name: -@Returns: - - -<!-- ##### FUNCTION atk_document_set_attribute_value ##### --> -<para> - -</para> - -@document: -@attribute_name: -@attribute_value: -@Returns: - - -<!-- ##### FUNCTION atk_document_get_attributes ##### --> -<para> - -</para> - -@document: -@Returns: - - -<!-- ##### FUNCTION atk_document_get_locale ##### --> -<para> - -</para> - -@document: -@Returns: - - diff --git a/docs/tmpl/atkeditabletext.sgml b/docs/tmpl/atkeditabletext.sgml deleted file mode 100644 index ed00800..0000000 --- a/docs/tmpl/atkeditabletext.sgml +++ /dev/null @@ -1,106 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkEditableText - -<!-- ##### SECTION Short_Description ##### --> -The ATK interface implemented by components containing user-editable text content. - -<!-- ##### SECTION Long_Description ##### --> -<para> -#AtkEditableText should be implemented by UI components which contain -text which the user can edit, via the #AtkObject corresponding to that -component (see #AtkObject). -</para> -<para> -#AtkEditableText is a subclass of #AtkText, and as such, an object which -implements #AtkEditableText is by definition an #AtkText implementor as well. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#AtkText -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkEditableText ##### --> -<para> -The AtkEditableText structure does not contain any fields. - -</para> - - -<!-- ##### FUNCTION atk_editable_text_set_run_attributes ##### --> -<para> - -</para> - -@text: -@attrib_set: -@start_offset: -@end_offset: -@Returns: - - -<!-- ##### FUNCTION atk_editable_text_set_text_contents ##### --> -<para> - -</para> - -@text: -@string: - - -<!-- ##### FUNCTION atk_editable_text_insert_text ##### --> -<para> - -</para> - -@text: -@string: -@length: -@position: - - -<!-- ##### FUNCTION atk_editable_text_copy_text ##### --> -<para> - -</para> - -@text: -@start_pos: -@end_pos: - - -<!-- ##### FUNCTION atk_editable_text_cut_text ##### --> -<para> - -</para> - -@text: -@start_pos: -@end_pos: - - -<!-- ##### FUNCTION atk_editable_text_delete_text ##### --> -<para> - -</para> - -@text: -@start_pos: -@end_pos: - - -<!-- ##### FUNCTION atk_editable_text_paste_text ##### --> -<para> - -</para> - -@text: -@position: - - diff --git a/docs/tmpl/atkgobjectaccessible.sgml b/docs/tmpl/atkgobjectaccessible.sgml deleted file mode 100644 index baaef5b..0000000 --- a/docs/tmpl/atkgobjectaccessible.sgml +++ /dev/null @@ -1,51 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkGObjectAccessible - -<!-- ##### SECTION Short_Description ##### --> -This object class is derived from AtkObject and can be used as a basis -implementing accessible objects. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This object class is derived from AtkObject. It can be used as a basis for -implementing accessible objects for GObjects which are not derived from -GtkWidget. One example of its use is in providing an accessible object -for GnomeCanvasItem in the GAIL library. - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkGObjectAccessible ##### --> -<para> -The AtkGObjectAccessible structure should not be accessed directly. -</para> - - -<!-- ##### FUNCTION atk_gobject_accessible_for_object ##### --> -<para> - -</para> - -@obj: -@Returns: - - -<!-- ##### FUNCTION atk_gobject_accessible_get_object ##### --> -<para> - -</para> - -@obj: -@Returns: - - diff --git a/docs/tmpl/atkhyperlink.sgml b/docs/tmpl/atkhyperlink.sgml deleted file mode 100644 index edd4855..0000000 --- a/docs/tmpl/atkhyperlink.sgml +++ /dev/null @@ -1,142 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkHyperlink - -<!-- ##### SECTION Short_Description ##### --> -An ATK object which encapsulates a link or set of links in a hypertext document. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An ATK object which encapsulates a link or set of links -(for instance in the case of client-side image maps) in a hypertext document. -It may implement the AtkAction interface. AtkHyperlink may also be used -to refer to inline embedded content, since it allows specification of a start -and end offset within the host AtkHypertext object. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkHyperlink ##### --> -<para> -The AtkHyperlink structure should not be accessed directly. - -</para> - - -<!-- ##### SIGNAL AtkHyperlink::link-activated ##### --> -<para> -The signal link-activated is emitted when a link is activated. -</para> - -@atkhyperlink: the object which received the signal. - -<!-- ##### ARG AtkHyperlink:end-index ##### --> -<para> - -</para> - -<!-- ##### ARG AtkHyperlink:number-of-anchors ##### --> -<para> - -</para> - -<!-- ##### ARG AtkHyperlink:selected-link ##### --> -<para> - -</para> - -<!-- ##### ARG AtkHyperlink:start-index ##### --> -<para> - -</para> - -<!-- ##### ENUM AtkHyperlinkStateFlags ##### --> -<para> - -</para> - -@ATK_HYPERLINK_IS_INLINE: - -<!-- ##### FUNCTION atk_hyperlink_get_uri ##### --> -<para> - -</para> - -@link_: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_hyperlink_get_object ##### --> -<para> - -</para> - -@link_: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_hyperlink_get_end_index ##### --> -<para> - -</para> - -@link_: -@Returns: - - -<!-- ##### FUNCTION atk_hyperlink_get_start_index ##### --> -<para> - -</para> - -@link_: -@Returns: - - -<!-- ##### FUNCTION atk_hyperlink_is_valid ##### --> -<para> - -</para> - -@link_: -@Returns: - - -<!-- ##### FUNCTION atk_hyperlink_is_inline ##### --> -<para> - -</para> - -@link_: -@Returns: - - -<!-- ##### FUNCTION atk_hyperlink_get_n_anchors ##### --> -<para> - -</para> - -@link_: -@Returns: - - -<!-- ##### FUNCTION atk_hyperlink_is_selected_link ##### --> -<para> - -</para> - -@link_: -@Returns: -@Deprecated: Please use ATK_STATE_SELECTED to indicate when a hyperlink within a Hypertext container is selected. - - diff --git a/docs/tmpl/atkhyperlinkimpl.sgml b/docs/tmpl/atkhyperlinkimpl.sgml deleted file mode 100644 index 0c80a9c..0000000 --- a/docs/tmpl/atkhyperlinkimpl.sgml +++ /dev/null @@ -1,55 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkHyperlinkImpl - -<!-- ##### SECTION Short_Description ##### --> -An interface from which the AtkHyperlink associated with an -AtkObject may be obtained. - -<!-- ##### SECTION Long_Description ##### --> -<para> -AtkHyperlinkImpl allows AtkObjects to -refer to their associated AtkHyperlink instance, if one -exists. AtkHyperlinkImpl differs from AtkHyperlink in that -AtkHyperlinkImpl is an interface, whereas AtkHyperlink is -a object type. The AtkHyperlinkImpl interface allows -a client to query an AtkObject for the availability of -an associated AtkHyperlink instance, and obtain that -instance. It is thus particularly useful in cases where -embedded content or inline content within a text object -is present, since the embedding text object implements -AtkHypertext and the inline/embedded objects are -exposed as children which implement AtkHyperlinkImpl, -in addition to their being obtainable via AtkHypertext:getLink -followed by AtkHyperlink:getObject. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkHyperlinkImpl ##### --> -<para> -A queryable interface which allows AtkHyperlink instances associated with an -AtkObject to be obtained. AtkHyperlinkImpl corresponds to AT-SPI's -Hyperlink interface, and differs from AtkHyperlink in that AtkHyperlink -is an object type, rather than an interface, and thus cannot be directly -queried. -</para> - - -<!-- ##### FUNCTION atk_hyperlink_impl_get_hyperlink ##### --> -<para> - -</para> - -@obj: -@Returns: - - diff --git a/docs/tmpl/atkhypertext.sgml b/docs/tmpl/atkhypertext.sgml deleted file mode 100644 index c3f1c01..0000000 --- a/docs/tmpl/atkhypertext.sgml +++ /dev/null @@ -1,70 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkHypertext - -<!-- ##### SECTION Short_Description ##### --> -The ATK interface which provides standard mechanism for manipulating hyperlinks. - -<!-- ##### 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 offsets within the Hypertext's included -content. While this interface is derived from Text, there is no requirement that Hypertext instances have textual content; they may implement Image as well, and Hyperlinks need not have non-zero text offsets. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -AtkHyperlink -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkHypertext ##### --> -<para> -The AtkHypertext structure does not contain any fields. -</para> - - -<!-- ##### SIGNAL AtkHypertext::link-selected ##### --> -<para> -The "link-selected" signal is emitted by an AtkHyperText object when one of -the hyperlinks associated with the object is selected. -</para> - -@atkhypertext: the object which received the signal. -@arg1: the index of the hyperlink which is selected - -<!-- ##### FUNCTION atk_hypertext_get_link ##### --> -<para> - -</para> - -@hypertext: -@link_index: -@Returns: - - -<!-- ##### FUNCTION atk_hypertext_get_n_links ##### --> -<para> - -</para> - -@hypertext: -@Returns: - - -<!-- ##### FUNCTION atk_hypertext_get_link_index ##### --> -<para> - -</para> - -@hypertext: -@char_index: -@Returns: - - diff --git a/docs/tmpl/atkimage.sgml b/docs/tmpl/atkimage.sgml deleted file mode 100644 index 8a5957b..0000000 --- a/docs/tmpl/atkimage.sgml +++ /dev/null @@ -1,90 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkImage - -<!-- ##### SECTION Short_Description ##### --> -The ATK Interface implemented by components which expose image or pixmap -content on-screen. - -<!-- ##### SECTION Long_Description ##### --> -<para> -#AtkImage should be implemented by #AtkObject subtypes on behalf of -components which display image/pixmap information onscreen, and which -provide information (other than just widget borders, etc.) via that -image content. For instance, icons, buttons with icons, toolbar -elements, and image viewing panes typically should implement #AtkImage. -</para> -<para> -#AtkImage primarily provides two types of information: coordinate -information (useful for screen review mode of screenreaders, and for use -by onscreen magnifiers), and descriptive information. The descriptive -information is provided for alternative, text-only presentation of the -most significant information present in the image. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkImage ##### --> -<para> -The AtkImage structure does not contain any fields. - -</para> - - -<!-- ##### FUNCTION atk_image_get_image_position ##### --> -<para> - -</para> - -@image: -@x: -@y: -@coord_type: - - -<!-- ##### FUNCTION atk_image_get_image_description ##### --> -<para> - -</para> - -@image: -@Returns: - - -<!-- ##### FUNCTION atk_image_set_image_description ##### --> -<para> - -</para> - -@image: -@description: -@Returns: - - -<!-- ##### FUNCTION atk_image_get_image_size ##### --> -<para> - -</para> - -@image: -@width: -@height: - - -<!-- ##### FUNCTION atk_image_get_image_locale ##### --> -<para> - -</para> - -@image: -@Returns: - - diff --git a/docs/tmpl/atknoopobject.sgml b/docs/tmpl/atknoopobject.sgml deleted file mode 100644 index ab8ffed..0000000 --- a/docs/tmpl/atknoopobject.sgml +++ /dev/null @@ -1,39 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkNoOpObject - -<!-- ##### SECTION Short_Description ##### --> -An AtkObject which purports to implement all ATK interfaces. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An AtkNoOpObject is an AtkObject which purports to implement all ATK -interfaces. It is the type of AtkObject which is created if an accessible -object is requested for an object type for which no factory type is specified. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkNoOpObject ##### --> -<para> -The AtkNoOpObject structure should not be accessed directly. -</para> - - -<!-- ##### FUNCTION atk_no_op_object_new ##### --> -<para> - -</para> - -@obj: -@Returns: - - diff --git a/docs/tmpl/atknoopobjectfactory.sgml b/docs/tmpl/atknoopobjectfactory.sgml deleted file mode 100644 index 092ec79..0000000 --- a/docs/tmpl/atknoopobjectfactory.sgml +++ /dev/null @@ -1,40 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkNoOpObjectFactory - -<!-- ##### SECTION Short_Description ##### --> -The AtkObjectFactory which creates an AtkNoOpObject. - -<!-- ##### SECTION Long_Description ##### --> -<para> -The AtkObjectFactory which creates an AtkNoOpObject. An instance of this is -created by an AtkRegistry if no factory type has not been specified to -create an accessible object of a particular type. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkNoOpObjectFactory ##### --> -<para> -The AtkNoOpObjectFactory structure should not be accessed directly. - -</para> - - -<!-- ##### FUNCTION atk_no_op_object_factory_new ##### --> -<para> - -</para> - -@void: -@Returns: - - diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml deleted file mode 100644 index 42d1a50..0000000 --- a/docs/tmpl/atkobject.sgml +++ /dev/null @@ -1,581 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkObject - -<!-- ##### SECTION Short_Description ##### --> - -The base object class for the Accessibility Toolkit API. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This class is the primary class for accessibility support via -the Accessibility ToolKit (ATK). Objects which are instances -of #AtkObject (or instances of AtkObject-derived types) are -queried for properties which relate basic (and generic) properties of a -UI component such as name and description. Instances of #AtkObject -may also be queried as to whether they implement other ATK interfaces -(e.g. #AtkAction, #AtkComponent, etc.), as appropriate to the role -which a given UI component plays in a user interface. -</para> -<para>All UI components in an application which provide useful -information or services to the user must provide corresponding -#AtkObject instances on request (in GTK+, for instance, usually -on a call to #gtk_widget_get_accessible ()), either via ATK support -built into the toolkit for the widget class or ancestor class, or in -the case of custom widgets, if the inherited #AtkObject implementation -is insufficient, via instances of a new #AtkObject subclass. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -See also: #AtkObjectFactory, #AtkRegistry. -( GTK+ users see also #GtkAccessible). -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkObject ##### --> -<para> -The AtkObject structure should not be accessed directly. - -</para> - - -<!-- ##### SIGNAL AtkObject::active-descendant-changed ##### --> -<para> -The "active-descendant-changed" signal is emitted by an object which has -the state ATK_STATE_MANAGES_DESCENDANTS when the focus object in the -object changes. For instance, a table will emit the signal when the cell -in the table which has focus changes. -</para> - -@atkobject: the object which received the signal. -@arg1: the newly focused object. - -<!-- ##### SIGNAL AtkObject::children-changed ##### --> -<para> -The signal "children-changed" is emitted when a child is added or -removed form an object. It supports two details: "add" and "remove" -</para> - -@atkobject: the object which received the signal. -@arg1: The index of the added or removed child -@arg2: A gpointer to the child AtkObject which was added or removed - -<!-- ##### SIGNAL AtkObject::focus-event ##### --> -<para> -The signal "focus-event" is emitted when an object gains or loses focus. -</para> - -@atkobject: the object which received the signal. -@arg1: A boolean value which indicates whether the object gained or lost focus. - -<!-- ##### SIGNAL AtkObject::property-change ##### --> -<para> -The signal "property-change" is emitted when an object's property -value changes. The detail identifies the name of the property whose -value has changed. -</para> - -@atkobject: the object which received the signal. -@arg1: The new value of the property which changed. - -<!-- ##### SIGNAL AtkObject::state-change ##### --> -<para> -The "state-change" signal is emitted when an object's state changes. -The detail value identifies the state type which has changed. -</para> - -@atkobject: the object which received the signal. -@arg1: The name of the state which has changed -@arg2: A boolean which indicates whether the state has been set or unset. - -<!-- ##### SIGNAL AtkObject::visible-data-changed ##### --> -<para> -The "visible-data-changed" signal is emitted when the visual appearance of -the object changed. -</para> - -@atkobject: the object which received the signal. - -<!-- ##### ARG AtkObject:accessible-component-layer ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-component-mdi-zorder ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-description ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-hypertext-nlinks ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-name ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-parent ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-role ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-caption ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-caption-object ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-column-description ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-column-header ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-row-description ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-row-header ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-table-summary ##### --> -<para> - -</para> - -<!-- ##### ARG AtkObject:accessible-value ##### --> -<para> - -</para> - -<!-- ##### ENUM AtkRole ##### --> -<para> -</para> - -@ATK_ROLE_INVALID: -@ATK_ROLE_ACCEL_LABEL: -@ATK_ROLE_ALERT: -@ATK_ROLE_ANIMATION: -@ATK_ROLE_ARROW: -@ATK_ROLE_CALENDAR: -@ATK_ROLE_CANVAS: -@ATK_ROLE_CHECK_BOX: -@ATK_ROLE_CHECK_MENU_ITEM: -@ATK_ROLE_COLOR_CHOOSER: -@ATK_ROLE_COLUMN_HEADER: -@ATK_ROLE_COMBO_BOX: -@ATK_ROLE_DATE_EDITOR: -@ATK_ROLE_DESKTOP_ICON: -@ATK_ROLE_DESKTOP_FRAME: -@ATK_ROLE_DIAL: -@ATK_ROLE_DIALOG: -@ATK_ROLE_DIRECTORY_PANE: -@ATK_ROLE_DRAWING_AREA: -@ATK_ROLE_FILE_CHOOSER: -@ATK_ROLE_FILLER: -@ATK_ROLE_FONT_CHOOSER: -@ATK_ROLE_FRAME: -@ATK_ROLE_GLASS_PANE: -@ATK_ROLE_HTML_CONTAINER: -@ATK_ROLE_ICON: -@ATK_ROLE_IMAGE: -@ATK_ROLE_INTERNAL_FRAME: -@ATK_ROLE_LABEL: -@ATK_ROLE_LAYERED_PANE: -@ATK_ROLE_LIST: -@ATK_ROLE_LIST_ITEM: -@ATK_ROLE_MENU: -@ATK_ROLE_MENU_BAR: -@ATK_ROLE_MENU_ITEM: -@ATK_ROLE_OPTION_PANE: -@ATK_ROLE_PAGE_TAB: -@ATK_ROLE_PAGE_TAB_LIST: -@ATK_ROLE_PANEL: -@ATK_ROLE_PASSWORD_TEXT: -@ATK_ROLE_POPUP_MENU: -@ATK_ROLE_PROGRESS_BAR: -@ATK_ROLE_PUSH_BUTTON: -@ATK_ROLE_RADIO_BUTTON: -@ATK_ROLE_RADIO_MENU_ITEM: -@ATK_ROLE_ROOT_PANE: -@ATK_ROLE_ROW_HEADER: -@ATK_ROLE_SCROLL_BAR: -@ATK_ROLE_SCROLL_PANE: -@ATK_ROLE_SEPARATOR: -@ATK_ROLE_SLIDER: -@ATK_ROLE_SPLIT_PANE: -@ATK_ROLE_SPIN_BUTTON: -@ATK_ROLE_STATUSBAR: -@ATK_ROLE_TABLE: -@ATK_ROLE_TABLE_CELL: -@ATK_ROLE_TABLE_COLUMN_HEADER: -@ATK_ROLE_TABLE_ROW_HEADER: -@ATK_ROLE_TEAR_OFF_MENU_ITEM: -@ATK_ROLE_TERMINAL: -@ATK_ROLE_TEXT: -@ATK_ROLE_TOGGLE_BUTTON: -@ATK_ROLE_TOOL_BAR: -@ATK_ROLE_TOOL_TIP: -@ATK_ROLE_TREE: -@ATK_ROLE_TREE_TABLE: -@ATK_ROLE_UNKNOWN: -@ATK_ROLE_VIEWPORT: -@ATK_ROLE_WINDOW: -@ATK_ROLE_HEADER: -@ATK_ROLE_FOOTER: -@ATK_ROLE_PARAGRAPH: -@ATK_ROLE_RULER: -@ATK_ROLE_APPLICATION: -@ATK_ROLE_AUTOCOMPLETE: -@ATK_ROLE_EDITBAR: -@ATK_ROLE_EMBEDDED: -@ATK_ROLE_ENTRY: -@ATK_ROLE_CHART: -@ATK_ROLE_CAPTION: -@ATK_ROLE_DOCUMENT_FRAME: -@ATK_ROLE_HEADING: -@ATK_ROLE_PAGE: -@ATK_ROLE_SECTION: -@ATK_ROLE_REDUNDANT_OBJECT: -@ATK_ROLE_FORM: -@ATK_ROLE_LINK: -@ATK_ROLE_INPUT_METHOD_WINDOW: -@ATK_ROLE_LAST_DEFINED: - -<!-- ##### FUNCTION atk_role_register ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### ENUM AtkLayer ##### --> -<para> -</para> - -@ATK_LAYER_INVALID: -@ATK_LAYER_BACKGROUND: -@ATK_LAYER_CANVAS: -@ATK_LAYER_WIDGET: -@ATK_LAYER_MDI: -@ATK_LAYER_POPUP: -@ATK_LAYER_OVERLAY: -@ATK_LAYER_WINDOW: - -<!-- ##### STRUCT AtkImplementor ##### --> -<para> -The AtkImplementor interface is implemented by objects for which AtkObject peers may be obtained via calls to iface->(ref_accessible)(implementor); -</para> - - -<!-- ##### STRUCT AtkPropertyValues ##### --> -<para> -The Atk PropertyValue structure is used when notifying a change in property. -Currently, the only property for which old_value is used is -accessible-state; for instance if there is a focus change the -property change handler will be called for the object which lost the focus -with the old_value containing the AtkState value corresponding to focused -and the property change handler will be called for the object which -received the focus with the new_value containing the AtkState value -corresponding to focused. - -</para> - -@property_name: -@old_value: -@new_value: - -<!-- ##### USER_FUNCTION AtkFunction ##### --> -<para> -An AtkFunction is a function definition used for padding which has been added -to class and interface structures to allow for expansion in the future. - -</para> - -@data: a gpointer to parameter data. -@Returns: Nothing useful, this is only a dummy prototype. - - -<!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### --> -<para> -An AtkPropertyChangeHandler is a function which is executed when an AtkObject's property changes value. It is specified in a call to -atk_object_connect_property_change_handler(). -</para> - -@Param1: an #AtkObject -@Param2: an #AtkPropertyValues - - -<!-- ##### FUNCTION atk_implementor_ref_accessible ##### --> -<para> - -</para> - -@implementor: -@Returns: - - -<!-- ##### FUNCTION atk_object_get_name ##### --> -<para> - -</para> - -@accessible: -@Returns: - - -<!-- ##### FUNCTION atk_object_get_description ##### --> -<para> - -</para> - -@accessible: -@Returns: - - -<!-- ##### FUNCTION atk_object_get_parent ##### --> -<para> - -</para> - -@accessible: -@Returns: - - -<!-- ##### FUNCTION atk_object_get_n_accessible_children ##### --> -<para> - -</para> - -@accessible: -@Returns: - - -<!-- ##### FUNCTION atk_object_ref_accessible_child ##### --> -<para> - -</para> - -@accessible: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_object_ref_relation_set ##### --> -<para> - -</para> - -@accessible: -@Returns: - - -<!-- ##### FUNCTION atk_object_get_layer ##### --> -<para> - -</para> - -@accessible: -@Returns: -@Deprecated: Use atk_component_get_layer instead. - - -<!-- ##### FUNCTION atk_object_get_mdi_zorder ##### --> -<para> - -</para> - -@accessible: -@Returns: -@Deprecated: Use atk_component_get_mdi_zorder instead. - - -<!-- ##### FUNCTION atk_object_get_role ##### --> -<para> - -</para> - -@accessible: -@Returns: - - -<!-- ##### FUNCTION atk_object_ref_state_set ##### --> -<para> - -</para> - -@accessible: -@Returns: - - -<!-- ##### FUNCTION atk_object_get_index_in_parent ##### --> -<para> - -</para> - -@accessible: -@Returns: - - -<!-- ##### FUNCTION atk_object_set_name ##### --> -<para> - -</para> - -@accessible: -@name: - - -<!-- ##### FUNCTION atk_object_set_description ##### --> -<para> - -</para> - -@accessible: -@description: - - -<!-- ##### FUNCTION atk_object_set_parent ##### --> -<para> - -</para> - -@accessible: -@parent: - - -<!-- ##### FUNCTION atk_object_set_role ##### --> -<para> - -</para> - -@accessible: -@role: - - -<!-- ##### FUNCTION atk_object_connect_property_change_handler ##### --> -<para> - -</para> - -@accessible: -@handler: -@Returns: - - -<!-- ##### FUNCTION atk_object_remove_property_change_handler ##### --> -<para> - -</para> - -@accessible: -@handler_id: - - -<!-- ##### FUNCTION atk_object_notify_state_change ##### --> -<para> - -</para> - -@accessible: -@state: -@value: - - -<!-- ##### FUNCTION atk_object_initialize ##### --> -<para> - -</para> - -@accessible: -@data: - - -<!-- ##### FUNCTION atk_object_add_relationship ##### --> -<para> - -</para> - -@object: -@relationship: -@target: -@Returns: - - -<!-- ##### FUNCTION atk_object_remove_relationship ##### --> -<para> - -</para> - -@object: -@relationship: -@target: -@Returns: - - -<!-- ##### FUNCTION atk_object_get_attributes ##### --> -<para> - -</para> - -@accessible: -@Returns: - - -<!-- ##### FUNCTION atk_role_get_name ##### --> -<para> - -</para> - -@role: -@Returns: - - -<!-- ##### FUNCTION atk_role_get_localized_name ##### --> -<para> - -</para> - -@role: -@Returns: - - -<!-- ##### FUNCTION atk_role_for_name ##### --> -<para> - -</para> - -@name: -@Returns: - - diff --git a/docs/tmpl/atkobjectfactory.sgml b/docs/tmpl/atkobjectfactory.sgml deleted file mode 100644 index d278c2c..0000000 --- a/docs/tmpl/atkobjectfactory.sgml +++ /dev/null @@ -1,62 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkObjectFactory - -<!-- ##### SECTION Short_Description ##### --> -The base object class for a factory used to create accessible objects for -objects of a specific GType. - -<!-- ##### SECTION Long_Description ##### --> -<para> -This class is the base object class for a factory used to create an -accessible object for a specific GType. The function -atk_registry_set_factory_type() is normally called to store -in the registry the factory type to be used to create an accessible of a -particular GType. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -AtkRegistry - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkObjectFactory ##### --> -<para> -The AtkObjectFactory structure should not be accessed directly. - -</para> - - -<!-- ##### FUNCTION atk_object_factory_create_accessible ##### --> -<para> - -</para> - -@factory: -@obj: -@Returns: - - -<!-- ##### FUNCTION atk_object_factory_get_accessible_type ##### --> -<para> - -</para> - -@factory: -@Returns: - - -<!-- ##### FUNCTION atk_object_factory_invalidate ##### --> -<para> - -</para> - -@factory: - - diff --git a/docs/tmpl/atkregistry.sgml b/docs/tmpl/atkregistry.sgml deleted file mode 100644 index f67e111..0000000 --- a/docs/tmpl/atkregistry.sgml +++ /dev/null @@ -1,73 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkRegistry - -<!-- ##### SECTION Short_Description ##### --> -An object used to store the GType of the factories used to create an accessible -object for an object of a particular GType. - -<!-- ##### SECTION Long_Description ##### --> -<para> -The AtkRegistry is normally used to create appropriate ATK "peers" for user -interface components. Application developers usually need only interact with -the AtkRegistry by associating appropriate ATK implementation classes with -GObject classes via the atk_registry_set_factory_type call, passing the -appropriate GType for application custom widget classes. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkRegistry ##### --> -<para> -The AtkRegistry structure should not be accessed directly. - -</para> - - -<!-- ##### FUNCTION atk_registry_set_factory_type ##### --> -<para> - -</para> - -@registry: -@type: -@factory_type: - - -<!-- ##### FUNCTION atk_registry_get_factory_type ##### --> -<para> - -</para> - -@registry: -@type: -@Returns: - - -<!-- ##### FUNCTION atk_registry_get_factory ##### --> -<para> - -</para> - -@registry: -@type: -@Returns: - - -<!-- ##### FUNCTION atk_get_default_registry ##### --> -<para> - -</para> - -@void: -@Returns: - - diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml deleted file mode 100644 index d83f1e8..0000000 --- a/docs/tmpl/atkrelation.sgml +++ /dev/null @@ -1,143 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkRelation - -<!-- ##### SECTION Short_Description ##### --> -An object used to describe a relation between a object and one or more -other objects. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An AtkRelation describes a relation between an object and one or more -other objects. The actual relations that an object has with other objects -are defined as an AtkRelationSet, which is a set of AtkRelations. - - -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkRelation ##### --> -<para> -The AtkRelation structure should not be accessed directly. - -</para> - - -<!-- ##### ARG AtkRelation:relation-type ##### --> -<para> - -</para> - -<!-- ##### ARG AtkRelation:target ##### --> -<para> - -</para> - -<!-- ##### ENUM AtkRelationType ##### --> -<para> - -</para> - -@ATK_RELATION_NULL: -@ATK_RELATION_CONTROLLED_BY: -@ATK_RELATION_CONTROLLER_FOR: -@ATK_RELATION_LABEL_FOR: -@ATK_RELATION_LABELLED_BY: -@ATK_RELATION_MEMBER_OF: -@ATK_RELATION_NODE_CHILD_OF: -@ATK_RELATION_FLOWS_TO: -@ATK_RELATION_FLOWS_FROM: -@ATK_RELATION_SUBWINDOW_OF: -@ATK_RELATION_EMBEDS: -@ATK_RELATION_EMBEDDED_BY: -@ATK_RELATION_POPUP_FOR: -@ATK_RELATION_PARENT_WINDOW_OF: -@ATK_RELATION_DESCRIBED_BY: -@ATK_RELATION_DESCRIPTION_FOR: -@ATK_RELATION_NODE_PARENT_OF: -@ATK_RELATION_LAST_DEFINED: - -<!-- ##### FUNCTION atk_relation_type_register ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION atk_relation_type_get_name ##### --> -<para> - -</para> - -@type: -@Returns: - - -<!-- ##### FUNCTION atk_relation_type_for_name ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION atk_relation_new ##### --> -<para> - -</para> - -@targets: -@n_targets: -@relationship: -@Returns: - - -<!-- ##### FUNCTION atk_relation_get_relation_type ##### --> -<para> - -</para> - -@relation: -@Returns: - - -<!-- ##### FUNCTION atk_relation_get_target ##### --> -<para> - -</para> - -@relation: -@Returns: - - -<!-- ##### FUNCTION atk_relation_add_target ##### --> -<para> - -</para> - -@relation: -@target: - - -<!-- ##### FUNCTION atk_relation_remove_target ##### --> -<para> - -</para> - -@relation: -@target: -@Returns: - - diff --git a/docs/tmpl/atkrelationset.sgml b/docs/tmpl/atkrelationset.sgml deleted file mode 100644 index f2f1633..0000000 --- a/docs/tmpl/atkrelationset.sgml +++ /dev/null @@ -1,110 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkRelationSet - -<!-- ##### SECTION Short_Description ##### --> -A set of AtkRelations, normally the set of AtkRelations which an AtkObject has. - -<!-- ##### SECTION Long_Description ##### --> -<para> -The AtkRelationSet held by an object establishes its relationships with -objects beyond the normal "parent/child" hierarchical relationships that all -user interface objects have. AtkRelationSets establish whether objects are -labelled or controlled by other components, share group membership with other -components (for instance within a radio-button group), or share content which -"flows" between them, among other types of possible relationships. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkRelationSet ##### --> -<para> -The AtkRelationSet structure should not be accessed directly. - -</para> - - -<!-- ##### FUNCTION atk_relation_set_new ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION atk_relation_set_contains ##### --> -<para> - -</para> - -@set: -@relationship: -@Returns: - - -<!-- ##### FUNCTION atk_relation_set_remove ##### --> -<para> - -</para> - -@set: -@relation: - - -<!-- ##### FUNCTION atk_relation_set_add ##### --> -<para> - -</para> - -@set: -@relation: - - -<!-- ##### FUNCTION atk_relation_set_get_n_relations ##### --> -<para> - -</para> - -@set: -@Returns: - - -<!-- ##### FUNCTION atk_relation_set_get_relation ##### --> -<para> - -</para> - -@set: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_relation_set_get_relation_by_type ##### --> -<para> - -</para> - -@set: -@relationship: -@Returns: - - -<!-- ##### FUNCTION atk_relation_set_add_relation_by_type ##### --> -<para> - -</para> - -@set: -@relationship: -@target: - - diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml deleted file mode 100644 index 37fed31..0000000 --- a/docs/tmpl/atkselection.sgml +++ /dev/null @@ -1,115 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkSelection - -<!-- ##### SECTION Short_Description ##### --> - -The ATK interface implemented by container objects whose #AtkObject children -can be selected. - -<!-- ##### SECTION Long_Description ##### --> -<para> -#AtkSelection should be implemented by UI components with children which -are exposed by #atk_object_ref_child and #atk_object_get_n_children, if -the use of the parent UI component ordinarily involves selection of one -or more of the objects corresponding to those #AtkObject children - for -example, selectable lists. -</para> -<para> -Note that other types of "selection" (for instance text selection) are -accomplished a other ATK interfaces - #AtkSelection is limited to the -selection/deselection of children. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#AtkText -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkSelection ##### --> -<para> -The AtkAction structure does not contain any fields. - -</para> - - -<!-- ##### SIGNAL AtkSelection::selection-changed ##### --> -<para> -The "selection-changed" signal is emitted by an object which implements -AtkSelection interface when the selection changes. -</para> - -@atkselection: the object which received the signal. - -<!-- ##### FUNCTION atk_selection_add_selection ##### --> -<para> - -</para> - -@selection: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_selection_clear_selection ##### --> -<para> - -</para> - -@selection: -@Returns: - - -<!-- ##### FUNCTION atk_selection_ref_selection ##### --> -<para> - -</para> - -@selection: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_selection_get_selection_count ##### --> -<para> - -</para> - -@selection: -@Returns: - - -<!-- ##### FUNCTION atk_selection_is_child_selected ##### --> -<para> - -</para> - -@selection: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_selection_remove_selection ##### --> -<para> - -</para> - -@selection: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_selection_select_all_selection ##### --> -<para> - -</para> - -@selection: -@Returns: - - diff --git a/docs/tmpl/atkstate.sgml b/docs/tmpl/atkstate.sgml deleted file mode 100644 index 0e3f771..0000000 --- a/docs/tmpl/atkstate.sgml +++ /dev/null @@ -1,103 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkState - -<!-- ##### SECTION Short_Description ##### --> -An AtkState describes a component's particular state. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An AtkState describes a component's particular state. The actual state of -an component is described by its AtkStateSet, which is a set of AtkStates. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### ENUM AtkStateType ##### --> -<para> - -</para> - -@ATK_STATE_INVALID: -@ATK_STATE_ACTIVE: -@ATK_STATE_ARMED: -@ATK_STATE_BUSY: -@ATK_STATE_CHECKED: -@ATK_STATE_DEFUNCT: -@ATK_STATE_EDITABLE: -@ATK_STATE_ENABLED: -@ATK_STATE_EXPANDABLE: -@ATK_STATE_EXPANDED: -@ATK_STATE_FOCUSABLE: -@ATK_STATE_FOCUSED: -@ATK_STATE_HORIZONTAL: -@ATK_STATE_ICONIFIED: -@ATK_STATE_MODAL: -@ATK_STATE_MULTI_LINE: -@ATK_STATE_MULTISELECTABLE: -@ATK_STATE_OPAQUE: -@ATK_STATE_PRESSED: -@ATK_STATE_RESIZABLE: -@ATK_STATE_SELECTABLE: -@ATK_STATE_SELECTED: -@ATK_STATE_SENSITIVE: -@ATK_STATE_SHOWING: -@ATK_STATE_SINGLE_LINE: -@ATK_STATE_STALE: -@ATK_STATE_TRANSIENT: -@ATK_STATE_VERTICAL: -@ATK_STATE_VISIBLE: -@ATK_STATE_MANAGES_DESCENDANTS: -@ATK_STATE_INDETERMINATE: -@ATK_STATE_TRUNCATED: -@ATK_STATE_REQUIRED: -@ATK_STATE_INVALID_ENTRY: -@ATK_STATE_SUPPORTS_AUTOCOMPLETION: -@ATK_STATE_SELECTABLE_TEXT: -@ATK_STATE_DEFAULT: -@ATK_STATE_ANIMATED: -@ATK_STATE_VISITED: -@ATK_STATE_LAST_DEFINED: - -<!-- ##### TYPEDEF AtkState ##### --> -<para> -The AtkState value should not be referenceed directly. - -</para> - - -<!-- ##### FUNCTION atk_state_type_register ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION atk_state_type_get_name ##### --> -<para> - -</para> - -@type: -@Returns: - - -<!-- ##### FUNCTION atk_state_type_for_name ##### --> -<para> - -</para> - -@name: -@Returns: - - diff --git a/docs/tmpl/atkstateset.sgml b/docs/tmpl/atkstateset.sgml deleted file mode 100644 index 35ac7a9..0000000 --- a/docs/tmpl/atkstateset.sgml +++ /dev/null @@ -1,136 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkStateSet - -<!-- ##### SECTION Short_Description ##### --> -An AtkStateSet determines a component's state set. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An AtkStateSet determines a component's state set. It is composed of a set -of AtkStates. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkStateSet ##### --> -<para> - -</para> - - -<!-- ##### FUNCTION atk_state_set_new ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION atk_state_set_is_empty ##### --> -<para> - -</para> - -@set: -@Returns: - - -<!-- ##### FUNCTION atk_state_set_add_state ##### --> -<para> - -</para> - -@set: -@type: -@Returns: - - -<!-- ##### FUNCTION atk_state_set_add_states ##### --> -<para> - -</para> - -@set: -@types: -@n_types: - - -<!-- ##### FUNCTION atk_state_set_clear_states ##### --> -<para> - -</para> - -@set: - - -<!-- ##### FUNCTION atk_state_set_contains_state ##### --> -<para> - -</para> - -@set: -@type: -@Returns: - - -<!-- ##### FUNCTION atk_state_set_contains_states ##### --> -<para> - -</para> - -@set: -@types: -@n_types: -@Returns: - - -<!-- ##### FUNCTION atk_state_set_remove_state ##### --> -<para> - -</para> - -@set: -@type: -@Returns: - - -<!-- ##### FUNCTION atk_state_set_and_sets ##### --> -<para> - -</para> - -@set: -@compare_set: -@Returns: - - -<!-- ##### FUNCTION atk_state_set_or_sets ##### --> -<para> - -</para> - -@set: -@compare_set: -@Returns: - - -<!-- ##### FUNCTION atk_state_set_xor_sets ##### --> -<para> - -</para> - -@set: -@compare_set: -@Returns: - - diff --git a/docs/tmpl/atkstreamablecontent.sgml b/docs/tmpl/atkstreamablecontent.sgml deleted file mode 100644 index 7135f94..0000000 --- a/docs/tmpl/atkstreamablecontent.sgml +++ /dev/null @@ -1,83 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkStreamableContent - -<!-- ##### SECTION Short_Description ##### --> -The ATK interface which provides access to streamable content. - -<!-- ##### SECTION Long_Description ##### --> -<para> -An interface whereby an object allows its backing content to be streamed to -clients. Typical implementors would be images or icons, HTML content, or -multimedia display/rendering widgets. -</para> -<para> -Negotiation of content type is allowed. Clients may examine the backing data -and transform, convert, or parse the content in order to present it in an alternate form to end-users. -</para> -<para> -The AtkStreamableContent interface is particularly useful for saving, -printing, or post-processing entire documents, or for persisting alternate -views of a document. If document content itself is being serialized, -stored, or converted, then use of the AtkStreamableContent interface can help -address performance issues. Unlike most ATK interfaces, -this interface is not strongly tied to the current user-agent view of the -a particular document, but may in some cases give access to the underlying model data. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkStreamableContent ##### --> -<para> -The AtkStreamableContent structure does not contain any fields. - -</para> - - -<!-- ##### FUNCTION atk_streamable_content_get_n_mime_types ##### --> -<para> - -</para> - -@streamable: -@Returns: - - -<!-- ##### FUNCTION atk_streamable_content_get_mime_type ##### --> -<para> - -</para> - -@streamable: -@i: -@Returns: - - -<!-- ##### FUNCTION atk_streamable_content_get_stream ##### --> -<para> - -</para> - -@streamable: -@mime_type: -@Returns: - - -<!-- ##### FUNCTION atk_streamable_content_get_uri ##### --> -<para> - -</para> - -@streamable: -@mime_type: -@Returns: - - diff --git a/docs/tmpl/atktable.sgml b/docs/tmpl/atktable.sgml deleted file mode 100644 index 2eff438..0000000 --- a/docs/tmpl/atktable.sgml +++ /dev/null @@ -1,403 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkTable - -<!-- ##### SECTION Short_Description ##### --> -The ATK interface implemented for UI components which contain tabular or -row/column information. - -<!-- ##### SECTION Long_Description ##### --> -<para> -#AtkTable should be implemented by components which present elements -ordered via rows and columns. It may also be used to present -tree-structured information if the nodes of the trees can be said to -contain multiple "columns". Individual elements of an #AtkTable are -typically referred to as "cells", and these cells are exposed by -#AtkTable as child #AtkObjects of the #AtkTable. Both row/column and -child-index-based access to these children is provided. -</para> -<para> -Children of #AtkTable are frequently "lightweight" objects, that is, -they may not have backing widgets in the host UI toolkit. They are -therefore often transient. -</para> -<para> -Since tables are often very complex, #AtkTable includes provision for -offering simplified summary information, as well as row and column -headers and captions. Headers and captions are #AtkObjects which may -implement other interfaces (#AtkText, #AtkImage, etc.) as appropriate. -#AtkTable summaries may themselves be (simplified) #AtkTables, etc. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> -#AtkObject, #ATK_STATE_TRANSIENT -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkTable ##### --> -<para> -The AtkTable structure does not contain any fields. - -</para> - - -<!-- ##### SIGNAL AtkTable::column-deleted ##### --> -<para> -The "column-deleted" signal is emitted by an object which implements the -AtkTable interface when a column is deleted. -</para> - -@atktable: the object which received the signal. -@arg1: The index of the first column deleted. -@arg2: The number of columns deleted. - -<!-- ##### SIGNAL AtkTable::column-inserted ##### --> -<para> -The "column-inserted" signal is emitted by an object which implements the -AtkTable interface when a column is inserted. - -</para> - -@atktable: the object which received the signal. -@arg1: The index of the column inserted. -@arg2: The number of colums inserted. - -<!-- ##### SIGNAL AtkTable::column-reordered ##### --> -<para> -The "column-reordered" signal is emitted by an object which implements the -AtkTable interface when the columns are reordered. -</para> - -@atktable: the object which received the signal. - -<!-- ##### SIGNAL AtkTable::model-changed ##### --> -<para> -The "model-changed" signal is emitted by an object which implements the -AtkTable interface when the model displayed by the table changes. -</para> - -@atktable: the object which received the signal. - -<!-- ##### SIGNAL AtkTable::row-deleted ##### --> -<para> -The "row-deleted" signal is emitted by an object which implements the -AtkTable interface when a row is deleted. - -</para> - -@atktable: the object which received the signal. -@arg1: The index of the first row deleted. -@arg2: The number of rows deleted. - -<!-- ##### SIGNAL AtkTable::row-inserted ##### --> -<para> -The "row-inserted" signal is emitted by an object which implements the -AtkTable interface when a row is inserted. -</para> - -@atktable: the object which received the signal. -@arg1: The index of the first row inserted. -@arg2: The number of rows inserted. - -<!-- ##### SIGNAL AtkTable::row-reordered ##### --> -<para> -The "row-reordered" signal is emitted by an object which implements the -AtkTable interface when the rows are reordered. -</para> - -@atktable: the object which received the signal. - -<!-- ##### FUNCTION atk_table_ref_at ##### --> -<para> - -</para> - -@table: -@row: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_index_at ##### --> -<para> - -</para> - -@table: -@row: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_column_at_index ##### --> -<para> - -</para> - -@table: -@index_: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_row_at_index ##### --> -<para> - -</para> - -@table: -@index_: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_n_columns ##### --> -<para> - -</para> - -@table: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_n_rows ##### --> -<para> - -</para> - -@table: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_column_extent_at ##### --> -<para> - -</para> - -@table: -@row: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_row_extent_at ##### --> -<para> - -</para> - -@table: -@row: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_caption ##### --> -<para> - -</para> - -@table: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_column_description ##### --> -<para> - -</para> - -@table: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_row_description ##### --> -<para> - -</para> - -@table: -@row: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_column_header ##### --> -<para> - -</para> - -@table: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_row_header ##### --> -<para> - -</para> - -@table: -@row: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_summary ##### --> -<para> - -</para> - -@table: -@Returns: - - -<!-- ##### FUNCTION atk_table_set_caption ##### --> -<para> - -</para> - -@table: -@caption: - - -<!-- ##### FUNCTION atk_table_set_row_description ##### --> -<para> - -</para> - -@table: -@row: -@description: - - -<!-- ##### FUNCTION atk_table_set_column_description ##### --> -<para> - -</para> - -@table: -@column: -@description: - - -<!-- ##### FUNCTION atk_table_set_row_header ##### --> -<para> - -</para> - -@table: -@row: -@header: - - -<!-- ##### FUNCTION atk_table_set_column_header ##### --> -<para> - -</para> - -@table: -@column: -@header: - - -<!-- ##### FUNCTION atk_table_set_summary ##### --> -<para> - -</para> - -@table: -@accessible: - - -<!-- ##### FUNCTION atk_table_get_selected_columns ##### --> -<para> - -</para> - -@table: -@selected: -@Returns: - - -<!-- ##### FUNCTION atk_table_get_selected_rows ##### --> -<para> - -</para> - -@table: -@selected: -@Returns: - - -<!-- ##### FUNCTION atk_table_is_column_selected ##### --> -<para> - -</para> - -@table: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_is_row_selected ##### --> -<para> - -</para> - -@table: -@row: -@Returns: - - -<!-- ##### FUNCTION atk_table_is_selected ##### --> -<para> - -</para> - -@table: -@row: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_add_column_selection ##### --> -<para> - -</para> - -@table: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_add_row_selection ##### --> -<para> - -</para> - -@table: -@row: -@Returns: - - -<!-- ##### FUNCTION atk_table_remove_column_selection ##### --> -<para> - -</para> - -@table: -@column: -@Returns: - - -<!-- ##### FUNCTION atk_table_remove_row_selection ##### --> -<para> - -</para> - -@table: -@row: -@Returns: - - diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml deleted file mode 100644 index af3360e..0000000 --- a/docs/tmpl/atktext.sgml +++ /dev/null @@ -1,474 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkText - -<!-- ##### SECTION Short_Description ##### --> -The ATK interface implemented by components with text content. - -<!-- ##### SECTION Long_Description ##### --> -<para> -#AtkText should be implemented by #AtkObjects on behalf of widgets that -have text content which is either attributed or otherwise non-trivial. -#AtkObjects whose text content is simple, unattributed, and very brief -may expose that content via #atk_object_get_name instead; however if the -text is editable, multi-line, typically longer than three or four words, -attributed, selectable, or if the object already uses the 'name' ATK -property for other information, the #AtkText interface should be used -to expose the text content. In the case of editable text content, -#AtkEditableText (a subtype of the #AtkText interface) should be -implemented instead. -</para> -<para> -#AtkText provides not only traversal facilities and change notification -for text content, but also caret tracking and glyph bounding box -calculations. Note that the text strings are exposed as UTF-8, and are -therefore potentially multi-byte, and caret-to-byte offset mapping makes -no assumptions about the character length; also bounding box -glyph-to-offset mapping may be complex for languages which use ligatures. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkText ##### --> -<para> -The AtkText structure does not contain any fields. - -</para> - - -<!-- ##### SIGNAL AtkText::text-attributes-changed ##### --> -<para> -The "text-attributes-changed" signal is emitted when the text attributes of -the text of an object which implements AtkText changes. -</para> - -@atktext: the object which received the signal. - -<!-- ##### SIGNAL AtkText::text-caret-moved ##### --> -<para> -The "text-caret-moved" signal is emitted when the caret position of -the text of an object which implements AtkText changes. -</para> - -@atktext: the object which received the signal. -@arg1: The new position of the text caret. - -<!-- ##### SIGNAL AtkText::text-changed ##### --> -<para> -The "text-changed" signal is emitted when the text of the object which -implements the AtkText interface changes, This signal will have a detail -which is either "insert" or "delete" which identifies whether the text -change was an insertion or a deletion -</para> - -@atktext: the object which received the signal. -@arg1: The position (character offset) of the insertion or deletion. -@arg2: The length (in characters) of text inserted or deleted. - -<!-- ##### SIGNAL AtkText::text-insert ##### --> -<para> - -</para> - -@atktext: the object which received the signal. -@arg1: -@arg2: -@arg3: - -<!-- ##### SIGNAL AtkText::text-remove ##### --> -<para> - -</para> - -@atktext: the object which received the signal. -@arg1: -@arg2: -@arg3: - -<!-- ##### SIGNAL AtkText::text-selection-changed ##### --> -<para> -The "text-selection-changed" signal is emitted when the selected text of -an object which implements AtkText changes. - -</para> - -@atktext: the object which received the signal. - -<!-- ##### SIGNAL AtkText::text-update ##### --> -<para> - -</para> - -@atktext: the object which received the signal. -@arg1: -@arg2: -@arg3: -@arg4: - -<!-- ##### ENUM AtkTextBoundary ##### --> -<para> - -</para> - -@ATK_TEXT_BOUNDARY_CHAR: -@ATK_TEXT_BOUNDARY_WORD_START: -@ATK_TEXT_BOUNDARY_WORD_END: -@ATK_TEXT_BOUNDARY_SENTENCE_START: -@ATK_TEXT_BOUNDARY_SENTENCE_END: -@ATK_TEXT_BOUNDARY_LINE_START: -@ATK_TEXT_BOUNDARY_LINE_END: - -<!-- ##### ENUM AtkTextClipType ##### --> -<para> - -</para> - -@ATK_TEXT_CLIP_NONE: -@ATK_TEXT_CLIP_MIN: -@ATK_TEXT_CLIP_MAX: -@ATK_TEXT_CLIP_BOTH: - -<!-- ##### STRUCT AtkTextRange ##### --> -<para> - -</para> - -@bounds: -@start_offset: -@end_offset: -@content: - -<!-- ##### STRUCT AtkTextRectangle ##### --> -<para> - -</para> - -@x: -@y: -@width: -@height: - -<!-- ##### STRUCT AtkAttribute ##### --> -<para> - -</para> - -@name: -@value: - -<!-- ##### TYPEDEF AtkAttributeSet ##### --> -<para> - -</para> - - -<!-- ##### ENUM AtkTextAttribute ##### --> -<para> - -</para> - -@ATK_TEXT_ATTR_INVALID: -@ATK_TEXT_ATTR_LEFT_MARGIN: -@ATK_TEXT_ATTR_RIGHT_MARGIN: -@ATK_TEXT_ATTR_INDENT: -@ATK_TEXT_ATTR_INVISIBLE: -@ATK_TEXT_ATTR_EDITABLE: -@ATK_TEXT_ATTR_PIXELS_ABOVE_LINES: -@ATK_TEXT_ATTR_PIXELS_BELOW_LINES: -@ATK_TEXT_ATTR_PIXELS_INSIDE_WRAP: -@ATK_TEXT_ATTR_BG_FULL_HEIGHT: -@ATK_TEXT_ATTR_RISE: -@ATK_TEXT_ATTR_UNDERLINE: -@ATK_TEXT_ATTR_STRIKETHROUGH: -@ATK_TEXT_ATTR_SIZE: -@ATK_TEXT_ATTR_SCALE: -@ATK_TEXT_ATTR_WEIGHT: -@ATK_TEXT_ATTR_LANGUAGE: -@ATK_TEXT_ATTR_FAMILY_NAME: -@ATK_TEXT_ATTR_BG_COLOR: -@ATK_TEXT_ATTR_FG_COLOR: -@ATK_TEXT_ATTR_BG_STIPPLE: -@ATK_TEXT_ATTR_FG_STIPPLE: -@ATK_TEXT_ATTR_WRAP_MODE: -@ATK_TEXT_ATTR_DIRECTION: -@ATK_TEXT_ATTR_JUSTIFICATION: -@ATK_TEXT_ATTR_STRETCH: -@ATK_TEXT_ATTR_VARIANT: -@ATK_TEXT_ATTR_STYLE: -@ATK_TEXT_ATTR_LAST_DEFINED: - -<!-- ##### FUNCTION atk_text_get_text ##### --> -<para> - -</para> - -@text: -@start_offset: -@end_offset: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_character_at_offset ##### --> -<para> - -</para> - -@text: -@offset: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_text_after_offset ##### --> -<para> - -</para> - -@text: -@offset: -@boundary_type: -@start_offset: -@end_offset: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_text_at_offset ##### --> -<para> - -</para> - -@text: -@offset: -@boundary_type: -@start_offset: -@end_offset: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_text_before_offset ##### --> -<para> - -</para> - -@text: -@offset: -@boundary_type: -@start_offset: -@end_offset: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_caret_offset ##### --> -<para> - -</para> - -@text: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_character_extents ##### --> -<para> - -</para> - -@text: -@offset: -@x: -@y: -@width: -@height: -@coords: - - -<!-- ##### FUNCTION atk_text_get_run_attributes ##### --> -<para> - -</para> - -@text: -@offset: -@start_offset: -@end_offset: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_default_attributes ##### --> -<para> - -</para> - -@text: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_character_count ##### --> -<para> - -</para> - -@text: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_offset_at_point ##### --> -<para> - -</para> - -@text: -@x: -@y: -@coords: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_bounded_ranges ##### --> -<para> - -</para> - -@text: -@rect: -@coord_type: -@x_clip_type: -@y_clip_type: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_range_extents ##### --> -<para> - -</para> - -@text: -@start_offset: -@end_offset: -@coord_type: -@rect: - - -<!-- ##### FUNCTION atk_text_free_ranges ##### --> -<para> - -</para> - -@ranges: - - -<!-- ##### FUNCTION atk_text_get_n_selections ##### --> -<para> - -</para> - -@text: -@Returns: - - -<!-- ##### FUNCTION atk_text_get_selection ##### --> -<para> - -</para> - -@text: -@selection_num: -@start_offset: -@end_offset: -@Returns: - - -<!-- ##### FUNCTION atk_text_add_selection ##### --> -<para> - -</para> - -@text: -@start_offset: -@end_offset: -@Returns: - - -<!-- ##### FUNCTION atk_text_remove_selection ##### --> -<para> - -</para> - -@text: -@selection_num: -@Returns: - - -<!-- ##### FUNCTION atk_text_set_selection ##### --> -<para> - -</para> - -@text: -@selection_num: -@start_offset: -@end_offset: -@Returns: - - -<!-- ##### FUNCTION atk_text_set_caret_offset ##### --> -<para> - -</para> - -@text: -@offset: -@Returns: - - -<!-- ##### FUNCTION atk_attribute_set_free ##### --> -<para> - -</para> - -@attrib_set: - - -<!-- ##### FUNCTION atk_text_attribute_register ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION atk_text_attribute_get_name ##### --> -<para> - -</para> - -@attr: -@Returns: - - -<!-- ##### FUNCTION atk_text_attribute_for_name ##### --> -<para> - -</para> - -@name: -@Returns: - - -<!-- ##### FUNCTION atk_text_attribute_get_value ##### --> -<para> - -</para> - -@attr: -@index_: -@Returns: - - diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml deleted file mode 100644 index 6331d36..0000000 --- a/docs/tmpl/atkutil.sgml +++ /dev/null @@ -1,254 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkUtil - -<!-- ##### SECTION Short_Description ##### --> -A set of ATK utility functions for event and toolkit support. - -<!-- ##### SECTION Long_Description ##### --> -<para> -A set of ATK utility functions which are used to support event registration of -various types, and obtaining the 'root' accessible of a process and -information about the current ATK implementation and toolkit version. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkUtil ##### --> -<para> -The AtkUtil struct does not contain any fields. -</para> - - -<!-- ##### ENUM AtkCoordType ##### --> -<para> - -</para> - -@ATK_XY_SCREEN: -@ATK_XY_WINDOW: - -<!-- ##### FUNCTION atk_add_focus_tracker ##### --> -<para> - -</para> - -@focus_tracker: -@Returns: - - -<!-- ##### FUNCTION atk_remove_focus_tracker ##### --> -<para> - -</para> - -@tracker_id: - - -<!-- ##### FUNCTION atk_focus_tracker_init ##### --> -<para> - -</para> - -@init: - - -<!-- ##### FUNCTION atk_focus_tracker_notify ##### --> -<para> - -</para> - -@object: - - -<!-- ##### USER_FUNCTION AtkEventListener ##### --> -<para> - -</para> - -@obj: - - -<!-- ##### USER_FUNCTION AtkEventListenerInit ##### --> -<para> - -</para> - -@void: - - -<!-- ##### FUNCTION atk_add_global_event_listener ##### --> -<para> - -</para> - -@listener: -@event_type: -@Returns: - - -<!-- ##### FUNCTION atk_remove_global_event_listener ##### --> -<para> - -</para> - -@listener_id: - - -<!-- ##### STRUCT AtkKeyEventStruct ##### --> -<para> - -</para> - -@type: -@state: -@keyval: -@length: -@string: -@keycode: -@timestamp: - -<!-- ##### ENUM AtkKeyEventType ##### --> -<para> - -</para> - -@ATK_KEY_EVENT_PRESS: -@ATK_KEY_EVENT_RELEASE: -@ATK_KEY_EVENT_LAST_DEFINED: - -<!-- ##### USER_FUNCTION AtkKeySnoopFunc ##### --> -<para> - -</para> - -@event: -@func_data: -@Returns: - - -<!-- ##### FUNCTION atk_add_key_event_listener ##### --> -<para> - -</para> - -@listener: -@data: -@Returns: - - -<!-- ##### FUNCTION atk_remove_key_event_listener ##### --> -<para> - -</para> - -@listener_id: - - -<!-- ##### FUNCTION atk_get_root ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION atk_get_focus_object ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION atk_get_toolkit_name ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION atk_get_toolkit_version ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### FUNCTION atk_get_version ##### --> -<para> - -</para> - -@void: -@Returns: - - -<!-- ##### MACRO ATK_DEFINE_TYPE ##### --> -<para> - -</para> - -@TN: -@t_n: -@T_P: - - -<!-- ##### MACRO ATK_DEFINE_TYPE_EXTENDED ##### --> -<para> - -</para> - -@TN: -@t_n: -@T_P: -@_f_: -@_C_: - - -<!-- ##### MACRO ATK_DEFINE_TYPE_WITH_CODE ##### --> -<para> - -</para> - -@TN: -@t_n: -@T_P: -@_C_: - - -<!-- ##### MACRO ATK_DEFINE_ABSTRACT_TYPE ##### --> -<para> - -</para> - -@TN: -@t_n: -@T_P: - - -<!-- ##### MACRO ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE ##### --> -<para> - -</para> - -@TN: -@t_n: -@T_P: -@_C_: - - diff --git a/docs/tmpl/atkvalue.sgml b/docs/tmpl/atkvalue.sgml deleted file mode 100644 index 55ed1fe..0000000 --- a/docs/tmpl/atkvalue.sgml +++ /dev/null @@ -1,82 +0,0 @@ -<!-- ##### SECTION Title ##### --> -AtkValue - -<!-- ##### SECTION Short_Description ##### --> -The ATK interface implemented by valuators and components which display or -select a value from a bounded range of values. - -<!-- ##### SECTION Long_Description ##### --> -<para> -#AtkValue should be implemented for components which either display a -value from a bounded range, or which allow the user to specify a value -from a bounded range, or both. For instance, most sliders and range -controls, as well as dials, should have #AtkObject representations which -implement #AtkValue on the component's behalf. #AtKValues may be -read-only, in which case attempts to alter the value return FALSE to -indicate failure. -</para> - -<!-- ##### SECTION See_Also ##### --> -<para> - -</para> - -<!-- ##### SECTION Stability_Level ##### --> - - -<!-- ##### SECTION Image ##### --> - - -<!-- ##### STRUCT AtkValue ##### --> -<para> -The AtkValue structure does not contain any fields. - -</para> - - -<!-- ##### FUNCTION atk_value_get_current_value ##### --> -<para> - -</para> - -@obj: -@value: - - -<!-- ##### FUNCTION atk_value_get_maximum_value ##### --> -<para> - -</para> - -@obj: -@value: - - -<!-- ##### FUNCTION atk_value_get_minimum_value ##### --> -<para> - -</para> - -@obj: -@value: - - -<!-- ##### FUNCTION atk_value_set_current_value ##### --> -<para> - -</para> - -@obj: -@value: -@Returns: - - -<!-- ##### FUNCTION atk_value_get_minimum_increment ##### --> -<para> - -</para> - -@obj: -@value: - - |