diff options
author | Brian Cameron <bcameron@src.gnome.org> | 2001-05-29 11:01:30 +0000 |
---|---|---|
committer | Brian Cameron <bcameron@src.gnome.org> | 2001-05-29 11:01:30 +0000 |
commit | 93f5a36f7eac8c9a92d042e6103aeb38fa368bf1 (patch) | |
tree | 131dcbad208e60cdaccc1839d28c89d04a704bd5 /docs | |
parent | 8d1a537326438843b0ebf740d431905641271d56 (diff) | |
download | atk-93f5a36f7eac8c9a92d042e6103aeb38fa368bf1.tar.gz |
Adding atk docs SGML template files
Diffstat (limited to 'docs')
-rw-r--r-- | docs/tmpl/atk-unused.sgml | 0 | ||||
-rw-r--r-- | docs/tmpl/atk.sgml | 18 | ||||
-rw-r--r-- | docs/tmpl/atkaction.sgml | 75 | ||||
-rw-r--r-- | docs/tmpl/atkcomponent.sgml | 176 | ||||
-rw-r--r-- | docs/tmpl/atkeditabletext.sgml | 118 | ||||
-rw-r--r-- | docs/tmpl/atkhyperlink.sgml | 73 | ||||
-rw-r--r-- | docs/tmpl/atkhypertext.sgml | 72 | ||||
-rw-r--r-- | docs/tmpl/atkimage.sgml | 94 | ||||
-rw-r--r-- | docs/tmpl/atknoopobject.sgml | 25 | ||||
-rw-r--r-- | docs/tmpl/atknoopobjectfactory.sgml | 24 | ||||
-rw-r--r-- | docs/tmpl/atkobject.sgml | 297 | ||||
-rw-r--r-- | docs/tmpl/atkobjectfactory.sgml | 35 | ||||
-rw-r--r-- | docs/tmpl/atkregistry.sgml | 55 | ||||
-rw-r--r-- | docs/tmpl/atkrelation.sgml | 67 | ||||
-rw-r--r-- | docs/tmpl/atkrelationset.sgml | 84 | ||||
-rw-r--r-- | docs/tmpl/atkselection.sgml | 103 | ||||
-rw-r--r-- | docs/tmpl/atkstate.sgml | 86 | ||||
-rw-r--r-- | docs/tmpl/atkstateset.sgml | 124 | ||||
-rw-r--r-- | docs/tmpl/atktable.sgml | 300 | ||||
-rw-r--r-- | docs/tmpl/atktext.sgml | 218 | ||||
-rw-r--r-- | docs/tmpl/atkutil.sgml | 48 | ||||
-rw-r--r-- | docs/tmpl/atkvalue.sgml | 76 |
22 files changed, 2168 insertions, 0 deletions
diff --git a/docs/tmpl/atk-unused.sgml b/docs/tmpl/atk-unused.sgml new file mode 100644 index 0000000..e69de29 --- /dev/null +++ b/docs/tmpl/atk-unused.sgml diff --git a/docs/tmpl/atk.sgml b/docs/tmpl/atk.sgml new file mode 100644 index 0000000..961a73e --- /dev/null +++ b/docs/tmpl/atk.sgml @@ -0,0 +1,18 @@ +<!-- ##### 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 new file mode 100644 index 0000000..f17ccbb --- /dev/null +++ b/docs/tmpl/atkaction.sgml @@ -0,0 +1,75 @@ +<!-- ##### SECTION Title ##### --> +AtkAction + +<!-- ##### SECTION Short_Description ##### --> +accessibility interface for objects that can perform actions + +<!-- ##### SECTION Long_Description ##### --> +<para> +The interface AtkAction should be supported by any object that can +perform one or more actions. The interface provides the standard +mechanism for an assitive technology to determine what those actions +are as well as tell the object to perform them. Any object that can +be manipulated should support this interface. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT AtkAction ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkActionIface ##### --> +<para> + +</para> + +@parent: +@do_action: +@get_n_actions: +@get_description: +@get_keybinding: + +<!-- ##### FUNCTION atk_action_do_action ##### --> +<para> + +</para> + +@action: +@i: + + +<!-- ##### FUNCTION atk_action_get_n_actions ##### --> +<para> + +</para> + +@action: +@Returns: + + +<!-- ##### FUNCTION atk_action_get_description ##### --> +<para> + +</para> + +@action: +@i: +@Returns: + + +<!-- ##### FUNCTION atk_action_get_keybinding ##### --> +<para> + +</para> + +@action: +@i: +@Returns: + + diff --git a/docs/tmpl/atkcomponent.sgml b/docs/tmpl/atkcomponent.sgml new file mode 100644 index 0000000..78b0b24 --- /dev/null +++ b/docs/tmpl/atkcomponent.sgml @@ -0,0 +1,176 @@ +<!-- ##### SECTION Title ##### --> +AtkComponent + +<!-- ##### SECTION Short_Description ##### --> +accessibility interface for objects that are rendered on the screen + +<!-- ##### SECTION Long_Description ##### --> +<para> +The AtkComponent interface should be supported by any object that is +rendered on the screen. The interface provides the standard mechanism +for an assistive technology to determine and set the graphical +representation of an object. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT AtkComponent ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkComponentIface ##### --> +<para> + +</para> + +@parent: +@add_focus_handler: +@contains: +@get_accessible_at_point: +@get_extents: +@get_position: +@get_position_on_screen: +@get_size: +@grab_focus: +@remove_focus_handler: +@set_extents: +@set_position: +@set_size: + +<!-- ##### USER_FUNCTION AtkFocusHandler ##### --> +<para> + +</para> + +@Param1: +@Param2: + + +<!-- ##### FUNCTION atk_component_add_focus_handler ##### --> +<para> + +</para> + +@component: +@handler: +@Returns: + + +<!-- ##### FUNCTION atk_component_contains ##### --> +<para> + +</para> + +@component: +@x: +@y: +@Returns: + + +<!-- ##### FUNCTION atk_component_get_accessible_at_point ##### --> +<para> + +</para> + +@component: +@x: +@y: +@Returns: + + +<!-- ##### FUNCTION atk_component_get_extents ##### --> +<para> + +</para> + +@component: +@x: +@y: +@width: +@height: + + +<!-- ##### FUNCTION atk_component_get_position ##### --> +<para> + +</para> + +@component: +@x: +@y: + + +<!-- ##### FUNCTION atk_component_get_position_on_screen ##### --> +<para> + +</para> + +@component: +@x: +@y: + + +<!-- ##### FUNCTION atk_component_get_size ##### --> +<para> + +</para> + +@component: +@width: +@height: + + +<!-- ##### FUNCTION atk_component_grab_focus ##### --> +<para> + +</para> + +@component: + + +<!-- ##### FUNCTION atk_component_remove_focus_handler ##### --> +<para> + +</para> + +@component: +@handler_id: + + +<!-- ##### FUNCTION atk_component_set_extents ##### --> +<para> + +</para> + +@component: +@x: +@y: +@width: +@height: + + +<!-- ##### FUNCTION atk_component_set_position ##### --> +<para> + +</para> + +@component: +@x: +@y: + + +<!-- ##### FUNCTION atk_component_set_size ##### --> +<para> + +</para> + +@component: +@width: +@height: + + diff --git a/docs/tmpl/atkeditabletext.sgml b/docs/tmpl/atkeditabletext.sgml new file mode 100644 index 0000000..f18a47d --- /dev/null +++ b/docs/tmpl/atkeditabletext.sgml @@ -0,0 +1,118 @@ +<!-- ##### SECTION Title ##### --> +AtkEditableText + +<!-- ##### SECTION Short_Description ##### --> +accessibility interface for editable text widgets + +<!-- ##### SECTION Long_Description ##### --> +<para> +AtkEditableText is used to support access in an "accessibility" context +to editing features of editable text widgets. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT AtkEditableText ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkEditableTextIface ##### --> +<para> + +</para> + +@parent_interface: +@select_text: +@set_attributes: +@set_text_contents: +@insert_text: +@copy_text: +@cut_text: +@delete_text: +@paste_text: + +<!-- ##### FUNCTION atk_editable_text_select_text ##### --> +<para> + +</para> + +@text: +@start_pos: +@end_pos: + + +<!-- ##### FUNCTION atk_editable_text_set_attributes ##### --> +<para> + +</para> + +@text: +@start_pos: +@end_pos: +@attributes: + + +<!-- ##### 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/atkhyperlink.sgml b/docs/tmpl/atkhyperlink.sgml new file mode 100644 index 0000000..acd00eb --- /dev/null +++ b/docs/tmpl/atkhyperlink.sgml @@ -0,0 +1,73 @@ +<!-- ##### SECTION Title ##### --> +AtkHyperlink + +<!-- ##### SECTION Short_Description ##### --> +encapsulates a link or set of links in a hypertext document + +<!-- ##### SECTION Long_Description ##### --> +<para> +AtkHyperLink encapsulates a link or set of links in a hypertext document. +It implements the AtkAction interface. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### 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_get_n_anchors ##### --> +<para> + +</para> + +@link: +@Returns: + + diff --git a/docs/tmpl/atkhypertext.sgml b/docs/tmpl/atkhypertext.sgml new file mode 100644 index 0000000..2adbfdc --- /dev/null +++ b/docs/tmpl/atkhypertext.sgml @@ -0,0 +1,72 @@ +<!-- ##### SECTION Title ##### --> +AtkHypertext + +<!-- ##### SECTION Short_Description ##### --> +the base class for all classes that present hypertext information +on the display + +<!-- ##### SECTION Long_Description ##### --> +<para> +The AtkHypertext class is the base class for all classes that present +hypertext information on the display. This class provides the standard +mechanism for an assistive technology to access that text via its +content, attributes, and spatial location. It also provides standard +mechanisms for manipulating hyperlinks. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT AtkHypertext ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkHypertextIface ##### --> +<para> + +</para> + +@parent: +@get_link: +@get_n_links: +@get_link_index: + +<!-- ##### STRUCT AtkHyperLink ##### --> +<para> + +</para> + + +<!-- ##### 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 new file mode 100644 index 0000000..2aa60e6 --- /dev/null +++ b/docs/tmpl/atkimage.sgml @@ -0,0 +1,94 @@ +<!-- ##### SECTION Title ##### --> +AtkImage + +<!-- ##### SECTION Short_Description ##### --> +accessibility interface for objects that have an associated image + +<!-- ##### SECTION Long_Description ##### --> +<para> +The AtkImage interface should be supported by any object that has an +associated image. This interface provides the standard mechanism for +an assistive technology to get descriptive information about images. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT AtkImage ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkImageIface ##### --> +<para> + +</para> + +@parent: +@get_storage_type: +@get_image_description: +@get_image_height: +@get_image_width: +@set_image_description: + +<!-- ##### ENUM AtkImageType ##### --> +<para> + +</para> + +@ATK_IMAGE_EMPTY: +@ATK_IMAGE_PIXMAP: +@ATK_IMAGE_IMAGE: +@ATK_IMAGE_PIXBUF: +@ATK_IMAGE_STOCK: +@ATK_IMAGE_ICON_SET: + +<!-- ##### FUNCTION atk_image_get_storage_type ##### --> +<para> + +</para> + +@image: +@Returns: + + +<!-- ##### FUNCTION atk_image_get_image_description ##### --> +<para> + +</para> + +@image: +@Returns: + + +<!-- ##### FUNCTION atk_image_get_image_height ##### --> +<para> + +</para> + +@image: +@Returns: + + +<!-- ##### FUNCTION atk_image_get_image_width ##### --> +<para> + +</para> + +@image: +@Returns: + + +<!-- ##### FUNCTION atk_image_set_image_description ##### --> +<para> + +</para> + +@image: +@description: +@Returns: + + diff --git a/docs/tmpl/atknoopobject.sgml b/docs/tmpl/atknoopobject.sgml new file mode 100644 index 0000000..eb2114f --- /dev/null +++ b/docs/tmpl/atknoopobject.sgml @@ -0,0 +1,25 @@ +<!-- ##### SECTION Title ##### --> +AtkNoOpObject + +<!-- ##### SECTION Short_Description ##### --> +provides non-functioning stub #AtkObjects + +<!-- ##### SECTION Long_Description ##### --> +<para> +Provides non-functioning stub #AtkObjects. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION atk_no_op_object_new ##### --> +<para> + +</para> + +@obj: +@Returns: + + diff --git a/docs/tmpl/atknoopobjectfactory.sgml b/docs/tmpl/atknoopobjectfactory.sgml new file mode 100644 index 0000000..96ff764 --- /dev/null +++ b/docs/tmpl/atknoopobjectfactory.sgml @@ -0,0 +1,24 @@ +<!-- ##### SECTION Title ##### --> +AtkNoOpObjectFactory + +<!-- ##### SECTION Short_Description ##### --> +an #AtkObjectFactory which creates non-functioning stub #AtkObjects + +<!-- ##### SECTION Long_Description ##### --> +<para> +An #AtkObjectFactory which creates non-functioning stub #AtkObjects. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION atk_no_op_object_factory_new ##### --> +<para> + +</para> + +@Returns: + + diff --git a/docs/tmpl/atkobject.sgml b/docs/tmpl/atkobject.sgml new file mode 100644 index 0000000..3dde031 --- /dev/null +++ b/docs/tmpl/atkobject.sgml @@ -0,0 +1,297 @@ +<!-- ##### SECTION Title ##### --> +AtkObject + +<!-- ##### SECTION Short_Description ##### --> +represents the minimum information all accessable objects return + +<!-- ##### SECTION Long_Description ##### --> +<para> +AtkObject represents the minimum information all accessible objects +return. This information includes accessible name, accessible +description, role and state of the object, as well information about +its parent and children. It is also possible to obtain more specific +accessibility information about a component if it supports one or more +of the following interfaces: +</para> + +<!-- ##### SECTION See_Also ##### --> +<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_STATUS_BAR: +@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_TEXT: +@ATK_ROLE_TOGGLE_BUTTON: +@ATK_ROLE_TOOL_BAR: +@ATK_ROLE_TOOL_TIP: +@ATK_ROLE_TREE: +@ATK_ROLE_UNKNOWN: +@ATK_ROLE_VIEWPORT: +@ATK_ROLE_WINDOW: +@ATK_ROLE_LAST_DEFINED: + +<!-- ##### FUNCTION atk_role_register ##### --> +<para> + +</para> + +@name: +@Returns: + + +<!-- ##### STRUCT AtkImplementor ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkImplementorIface ##### --> +<para> + +</para> + +@parent: +@ref_accessible: + +<!-- ##### STRUCT AtkRelationSet ##### --> +<para> + +</para> + +@parent: +@relations: + +<!-- ##### STRUCT AtkStateSet ##### --> +<para> + +</para> + +@parent: + +<!-- ##### STRUCT AtkPropertyValues ##### --> +<para> + +</para> + +@property_name: +@old_value: +@new_value: + +<!-- ##### USER_FUNCTION AtkPropertyChangeHandler ##### --> +<para> + +</para> + +@Param1: +@Param2: + + +<!-- ##### 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_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: + + diff --git a/docs/tmpl/atkobjectfactory.sgml b/docs/tmpl/atkobjectfactory.sgml new file mode 100644 index 0000000..ec56949 --- /dev/null +++ b/docs/tmpl/atkobjectfactory.sgml @@ -0,0 +1,35 @@ +<!-- ##### SECTION Title ##### --> +AtkObjectFactory + +<!-- ##### SECTION Short_Description ##### --> +factory for creating #AtkObjects + +<!-- ##### SECTION Long_Description ##### --> +<para> +A factory for creating #AtkObjects. + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION atk_object_factory_create_accessible ##### --> +<para> + +</para> + +@factory: +@obj: +@Returns: + + +<!-- ##### FUNCTION atk_object_factory_invalidate ##### --> +<para> + +</para> + +@factory: + + diff --git a/docs/tmpl/atkregistry.sgml b/docs/tmpl/atkregistry.sgml new file mode 100644 index 0000000..ebc68ec --- /dev/null +++ b/docs/tmpl/atkregistry.sgml @@ -0,0 +1,55 @@ +<!-- ##### SECTION Title ##### --> +AtkRegistry + +<!-- ##### SECTION Short_Description ##### --> +registry for registering new #AtkObject factories + +<!-- ##### SECTION Long_Description ##### --> +<para> +A registry for registering new #AtkObject factories. + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</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> + +@Returns: + + diff --git a/docs/tmpl/atkrelation.sgml b/docs/tmpl/atkrelation.sgml new file mode 100644 index 0000000..a357252 --- /dev/null +++ b/docs/tmpl/atkrelation.sgml @@ -0,0 +1,67 @@ +<!-- ##### SECTION Title ##### --> +AtkRelation + +<!-- ##### SECTION Short_Description ##### --> +defines the functional relationship between two #AtkObjects + +<!-- ##### SECTION Long_Description ##### --> +<para> +Defines the functional relationship between two #AtkObjects. +</para> + +<!-- ##### SECTION See_Also ##### --> +<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_LAST_DEFINED: + +<!-- ##### FUNCTION atk_relation_type_register ##### --> +<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: + + diff --git a/docs/tmpl/atkrelationset.sgml b/docs/tmpl/atkrelationset.sgml new file mode 100644 index 0000000..6a12432 --- /dev/null +++ b/docs/tmpl/atkrelationset.sgml @@ -0,0 +1,84 @@ +<!-- ##### SECTION Title ##### --> +AtkRelationSet + +<!-- ##### SECTION Short_Description ##### --> +a set of #AtkRelations, which define the functional relationships +between #AtkObjects + +<!-- ##### SECTION Long_Description ##### --> +<para> +A set of #AtkRelations, which define the functional relationships +between #AtkObjects. + +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION atk_relation_set_new ##### --> +<para> + +</para> + +@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: + + diff --git a/docs/tmpl/atkselection.sgml b/docs/tmpl/atkselection.sgml new file mode 100644 index 0000000..ef903bb --- /dev/null +++ b/docs/tmpl/atkselection.sgml @@ -0,0 +1,103 @@ +<!-- ##### SECTION Title ##### --> +atkselection + +<!-- ##### SECTION Short_Description ##### --> +accessibility interface for determining what the current selected +children are, as well as modify the selection set + +<!-- ##### SECTION Long_Description ##### --> +<para> +This AtkSelection interface provides the standard mechanism for an +assistive technology to determine what the current selected children are, +as well as modify the selection set. Any object that has children that +can be selected should support the AtkSelection interface. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT AtkSelection ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkSelectionIface ##### --> +<para> + +</para> + +@parent: +@add_selection: +@clear_selection: +@ref_selection: +@get_selection_count: +@is_child_selected: +@remove_selection: +@select_all_selection: + +<!-- ##### FUNCTION atk_selection_add_selection ##### --> +<para> + +</para> + +@selection: +@i: + + +<!-- ##### FUNCTION atk_selection_clear_selection ##### --> +<para> + +</para> + +@selection: + + +<!-- ##### 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: + + +<!-- ##### FUNCTION atk_selection_select_all_selection ##### --> +<para> + +</para> + +@selection: + + diff --git a/docs/tmpl/atkstate.sgml b/docs/tmpl/atkstate.sgml new file mode 100644 index 0000000..b7027f3 --- /dev/null +++ b/docs/tmpl/atkstate.sgml @@ -0,0 +1,86 @@ +<!-- ##### SECTION Title ##### --> +AtkState + +<!-- ##### SECTION Short_Description ##### --> +describes an objects particular state + +<!-- ##### SECTION Long_Description ##### --> +<para> +AtkState describes an objects particular state. The actual state of the +object is defined as an #AtkStateSet, which is a composed set of +AtkStates. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### ENUM AtkStateType ##### --> +<para> + +</para> + +@ATK_STATE_INVALID: +@ATK_STATE_ACTIVE: +@ATK_STATE_ARMED: +@ATK_STATE_BUSY: +@ATK_STATE_CHECKED: +@ATK_STATE_COLLAPSED: +@ATK_STATE_DEFUNCT: +@ATK_STATE_EDITABLE: +@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_TRANSIENT: +@ATK_STATE_VERTICAL: +@ATK_STATE_VISIBLE: +@ATK_STATE_LAST_DEFINED: + +<!-- ##### TYPEDEF AtkState ##### --> +<para> + +</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 new file mode 100644 index 0000000..972f435 --- /dev/null +++ b/docs/tmpl/atkstateset.sgml @@ -0,0 +1,124 @@ +<!-- ##### SECTION Title ##### --> +AtkStateSet + +<!-- ##### SECTION Short_Description ##### --> +determines an object's state set + +<!-- ##### SECTION Long_Description ##### --> +<para> +AtkStateSet determines an object's state set. The state set of an object +is a set of AtkState objects and describes the current +overall state of the object, such as whether it is active, has focus, etc. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### FUNCTION atk_state_set_new ##### --> +<para> + +</para> + +@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/atktable.sgml b/docs/tmpl/atktable.sgml new file mode 100644 index 0000000..986273e --- /dev/null +++ b/docs/tmpl/atktable.sgml @@ -0,0 +1,300 @@ +<!-- ##### SECTION Title ##### --> +AtkTable + +<!-- ##### SECTION Short_Description ##### --> +a user-interface component that presents data in two-dimensional table format + +<!-- ##### SECTION Long_Description ##### --> +<para> +AtkTable describes a user-interface component that presents data in +two-dimensional table format. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT AtkTable ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkTableIface ##### --> +<para> + +</para> + +@parent: +@ref_at: +@get_index_at: +@get_row_at_index: +@get_column_at_index: +@get_caption: +@get_n_columns: +@get_column_description: +@get_column_extent_at: +@get_column_header: +@get_n_rows: +@get_row_description: +@get_row_extent_at: +@get_row_header: +@get_summary: +@get_selected_columns: +@get_selected_rows: +@is_column_selected: +@is_row_selected: +@is_selected: +@set_caption: +@set_column_description: +@set_column_header: +@set_row_description: +@set_row_header: +@set_summary: + +<!-- ##### 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_row_at_index ##### --> +<para> + +</para> + +@table: +@index: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_column_at_index ##### --> +<para> + +</para> + +@table: +@index: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_caption ##### --> +<para> + +</para> + +@table: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_n_columns ##### --> +<para> + +</para> + +@table: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_column_description ##### --> +<para> + +</para> + +@table: +@column: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_column_extent_at ##### --> +<para> + +</para> + +@table: +@row: +@column: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_column_header ##### --> +<para> + +</para> + +@table: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_n_rows ##### --> +<para> + +</para> + +@table: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_row_description ##### --> +<para> + +</para> + +@table: +@r: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_row_extent_at ##### --> +<para> + +</para> + +@table: +@row: +@column: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_row_header ##### --> +<para> + +</para> + +@table: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_summary ##### --> +<para> + +</para> + +@table: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_selected_columns ##### --> +<para> + +</para> + +@table: +@Returns: + + +<!-- ##### FUNCTION atk_table_get_selected_rows ##### --> +<para> + +</para> + +@table: +@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_set_caption ##### --> +<para> + +</para> + +@table: +@accessible: + + +<!-- ##### FUNCTION atk_table_set_column_description ##### --> +<para> + +</para> + +@table: +@column: +@accessible: + + +<!-- ##### FUNCTION atk_table_set_column_header ##### --> +<para> + +</para> + +@table: +@column: +@header: + + +<!-- ##### FUNCTION atk_table_set_row_description ##### --> +<para> + +</para> + +@table: +@row: +@accessible: + + +<!-- ##### FUNCTION atk_table_set_row_header ##### --> +<para> + +</para> + +@table: +@row: +@header: + + +<!-- ##### FUNCTION atk_table_set_summary ##### --> +<para> + +</para> + +@table: +@accessible: + + diff --git a/docs/tmpl/atktext.sgml b/docs/tmpl/atktext.sgml new file mode 100644 index 0000000..8ae9d43 --- /dev/null +++ b/docs/tmpl/atktext.sgml @@ -0,0 +1,218 @@ +<!-- ##### SECTION Title ##### --> +AtkText + +<!-- ##### SECTION Short_Description ##### --> +accessibility interface for text widgets + +<!-- ##### SECTION Long_Description ##### --> +<para> +AtkText provides an accessibility interface for text widgets +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT AtkText ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkTextIface ##### --> +<para> + +</para> + +@parent: +@get_text: +@get_text_after_offset: +@get_text_at_offset: +@get_character_at_offset: +@get_text_before_offset: +@get_caret_offset: +@get_row_col_at_offset: +@get_range_attributes: +@get_character_extents: +@get_character_count: +@get_offset_at_point: +@get_selected_text: +@get_selection_bounds: +@set_selection_bounds: +@set_caret_offset: +@text_changed: +@caret_changed: + +<!-- ##### ENUM AtkTextBoundary ##### --> +<para> + +</para> + +@ATK_TEXT_BOUNDARY_CHAR: +@ATK_TEXT_BOUNDARY_CURSOR_POS: +@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: + +<!-- ##### 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: +@Returns: + + +<!-- ##### FUNCTION atk_text_get_text_at_offset ##### --> +<para> + +</para> + +@text: +@offset: +@boundary_type: +@Returns: + + +<!-- ##### FUNCTION atk_text_get_text_before_offset ##### --> +<para> + +</para> + +@text: +@offset: +@boundary_type: +@Returns: + + +<!-- ##### FUNCTION atk_text_get_caret_offset ##### --> +<para> + +</para> + +@text: +@Returns: + + +<!-- ##### FUNCTION atk_text_get_row_col_at_offset ##### --> +<para> + +</para> + +@text: +@offset: +@row: +@col: + + +<!-- ##### FUNCTION atk_text_get_range_attributes ##### --> +<para> + +</para> + +@text: +@start_offset: +@end_offset: +@Returns: + + +<!-- ##### FUNCTION atk_text_get_character_extents ##### --> +<para> + +</para> + +@text: +@offset: +@x: +@y: +@length: +@width: + + +<!-- ##### FUNCTION atk_text_get_character_count ##### --> +<para> + +</para> + +@text: +@Returns: + + +<!-- ##### FUNCTION atk_text_get_offset_at_point ##### --> +<para> + +</para> + +@text: +@x: +@y: +@Returns: + + +<!-- ##### FUNCTION atk_text_get_selected_text ##### --> +<para> + +</para> + +@text: +@Returns: + + +<!-- ##### FUNCTION atk_text_get_selection_bounds ##### --> +<para> + +</para> + +@text: +@start_offset: +@end_offset: + + +<!-- ##### FUNCTION atk_text_set_selection_bounds ##### --> +<para> + +</para> + +@text: +@start_offset: +@end_offset: +@Returns: + + +<!-- ##### FUNCTION atk_text_set_caret_offset ##### --> +<para> + +</para> + +@text: +@offset: +@Returns: + + diff --git a/docs/tmpl/atkutil.sgml b/docs/tmpl/atkutil.sgml new file mode 100644 index 0000000..3ab9197 --- /dev/null +++ b/docs/tmpl/atkutil.sgml @@ -0,0 +1,48 @@ +<!-- ##### SECTION Title ##### --> +AtkUtil + +<!-- ##### SECTION Short_Description ##### --> + + +<!-- ##### SECTION Long_Description ##### --> +<para> +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### 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> + +@add_function: + + +<!-- ##### FUNCTION atk_focus_tracker_notify ##### --> +<para> + +</para> + +@object: + + diff --git a/docs/tmpl/atkvalue.sgml b/docs/tmpl/atkvalue.sgml new file mode 100644 index 0000000..611271c --- /dev/null +++ b/docs/tmpl/atkvalue.sgml @@ -0,0 +1,76 @@ +<!-- ##### SECTION Title ##### --> +AtkValue + +<!-- ##### SECTION Short_Description ##### --> +the standard mechanism for an assistive technology to +determine and set numerical values as well as get minimum +and maximum values + +<!-- ##### SECTION Long_Description ##### --> +<para> +The AtkValue interface should be supported by any object that +supports a numerical value (e.g., a scroll bar). This interface +provides the standard mechanism for an assistive technology to +determine and set the numerical value as well as get the minimum +and maximum values. +</para> + +<!-- ##### SECTION See_Also ##### --> +<para> + +</para> + +<!-- ##### STRUCT AtkValue ##### --> +<para> + +</para> + + +<!-- ##### STRUCT AtkValueIface ##### --> +<para> + +</para> + +@parent: +@get_current_value: +@get_maximum_value: +@get_minimum_value: +@set_current_value: + +<!-- ##### 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: + + |