diff options
author | Federico Mena Quintero <federico@gnome.org> | 2022-05-23 12:33:06 -0500 |
---|---|---|
committer | Federico Mena Quintero <federico@gnome.org> | 2022-05-23 12:33:06 -0500 |
commit | 092270bd2b9a161c2a0f779f6db8da39104ef808 (patch) | |
tree | 7999df3d83288ca65fae82df2d949b720436112d /doc | |
parent | c81ab75514b3159be1b11d7e3c66041cd8f23c75 (diff) | |
parent | 92d7bbb5613a11a7b318c669704811193ffde8d3 (diff) | |
download | at-spi2-core-092270bd2b9a161c2a0f779f6db8da39104ef808.tar.gz |
Merge the atk repository into at-spi2-core
Diffstat (limited to 'doc')
-rw-r--r-- | doc/atk/atk-docs.xml | 146 | ||||
-rw-r--r-- | doc/atk/atk-sections.txt | 785 | ||||
-rw-r--r-- | doc/atk/meson.build | 32 | ||||
-rw-r--r-- | doc/xml/gtkdocentities.ent.in | 8 | ||||
-rw-r--r-- | doc/xml/meson.build | 14 |
5 files changed, 985 insertions, 0 deletions
diff --git a/doc/atk/atk-docs.xml b/doc/atk/atk-docs.xml new file mode 100644 index 00000000..f3dfccef --- /dev/null +++ b/doc/atk/atk-docs.xml @@ -0,0 +1,146 @@ +<?xml version="1.0"?> +<!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" +[ + <!ENTITY % local.common.attrib "xmlns:xi CDATA #FIXED 'http://www.w3.org/2003/XInclude'"> + <!ENTITY % gtkdocentities SYSTEM "xml/gtkdocentities.ent"> + %gtkdocentities; +]> + +<book> + <bookinfo> + <title>ATK - Accessibility Toolkit</title> + <releaseinfo>for ATK &package_version;</releaseinfo> + </bookinfo> + + <chapter id="overview"> + <title>Overview</title> + <para> + GNOME provides support for accessibility devices using the ATK + framework. This framework defines a set of interfaces to which + graphical interface components adhere. This allows, for instance, + screen readers to read the text of an interface and interact with its + controls. ATK support is built into GTK+ and the rest of the GNOME + platform, so any application using GTK+ will have reasonable + accessibility support for free. + </para> + + <para> + Nonetheless, you should be aware of accessibility issues when when + developing your applications. Although GTK+ interfaces provide + reasonable accessibility by default, you can often improve how well + your program behaves with accessibility tools by providing additional + information to ATK. If you develop custom widgets, you should ensure + that they expose their properties to ATK + </para> + + </chapter> + + <chapter id="base-object"> + <title>Base accessibility object</title> + <xi:include href="xml/atkobject.xml"/> + </chapter> + + <chapter id="toolkit"> + <title>Event and toolkit support</title> + <xi:include href="xml/atkutil.xml"/> + </chapter> + + <chapter id="interfaces"> + <title>ATK Interfaces</title> + <xi:include href="xml/atkaction.xml"/> + <xi:include href="xml/atkcomponent.xml"/> + <xi:include href="xml/atkdocument.xml"/> + <xi:include href="xml/atkeditabletext.xml"/> + <xi:include href="xml/atkhyperlinkimpl.xml"/> + <xi:include href="xml/atkhypertext.xml"/> + <xi:include href="xml/atkimage.xml"/> + <xi:include href="xml/atkselection.xml"/> + <xi:include href="xml/atkstreamablecontent.xml"/> + <xi:include href="xml/atktable.xml"/> + <xi:include href="xml/atktablecell.xml"/> + <xi:include href="xml/atktext.xml"/> + <xi:include href="xml/atkvalue.xml"/> + <xi:include href="xml/atkwindow.xml"/> + </chapter> + + <chapter id="data"> + <title>Basic accessible data types</title> + <xi:include href="xml/atkrange.xml"/> + <xi:include href="xml/atkrelation.xml"/> + <xi:include href="xml/atkrelationset.xml"/> + <xi:include href="xml/atkstate.xml"/> + <xi:include href="xml/atkstateset.xml"/> + </chapter> + + <chapter id="accessibles"> + <title>Custom accessible objects</title> + <xi:include href="xml/atkgobjectaccessible.xml"/> + <xi:include href="xml/atkhyperlink.xml"/> + <xi:include href="xml/atknoopobject.xml"/> + <xi:include href="xml/atkplug.xml"/> + <xi:include href="xml/atksocket.xml"/> + </chapter> + + <chapter id="utilities"> + <title>Utilities</title> + <xi:include href="xml/atknoopobjectfactory.xml"/> + <xi:include href="xml/atkobjectfactory.xml"/> + <xi:include href="xml/atkregistry.xml"/> + <xi:include href="xml/atkversion.xml"/> + </chapter> + + <chapter id="deprecated"> + <title>Deprecated Interfaces</title> + <xi:include href="xml/atkmisc.xml"/> + </chapter> + + <index id="api-index-full"> + <title>Index of all symbols</title> + </index> + <index id="api-index-deprecated" role="deprecated"> + <title>Index of deprecated symbols</title> + </index> + <index id="api-index-1-3" role="1.3"> + <title>Index of new symbols in 1.3</title> + </index> + <index id="api-index-1-4" role="1.4"> + <title>Index of new symbols in 1.4</title> + </index> + <index id="api-index-1-6" role="1.6"> + <title>Index of new symbols in 1.6</title> + </index> + <index id="api-index-1-9" role="1.9"> + <title>Index of new symbols in 1.9</title> + </index> + <index id="api-index-1-12" role="1.12"> + <title>Index of new symbols in 1.12</title> + </index> + <index id="api-index-1-13" role="1.13"> + <title>Index of new symbols in 1.13</title> + </index> + <index id="api-index-1-20" role="1.20"> + <title>Index of new symbols in 1.20</title> + </index> + <index id="api-index-1-22" role="1.22"> + <title>Index of new symbols in 1.22</title> + </index> + <index id="api-index-1-30" role="1.30"> + <title>Index of new symbols in 1.30</title> + </index> + <index id="api-index-2-2" role="2.2"> + <title>Index of new symbols in 2.2</title> + </index> + <index id="api-index-2-8" role="2.8"> + <title>Index of new symbols in 2.8</title> + </index> + <index id="api-index-2-10" role="2.10"> + <title>Index of new symbols in 2.10</title> + </index> + <index id="api-index-2-12" role="2.12"> + <title>Index of new symbols in 2.12</title> + </index> + + <xi:include href="xml/annotation-glossary.xml"><xi:fallback/></xi:include> +</book> + diff --git a/doc/atk/atk-sections.txt b/doc/atk/atk-sections.txt new file mode 100644 index 00000000..6bf2bfb3 --- /dev/null +++ b/doc/atk/atk-sections.txt @@ -0,0 +1,785 @@ +<INCLUDE>atk/atk.h</INCLUDE> + +<SECTION> +<FILE>atkaction</FILE> +<TITLE>AtkAction</TITLE> +AtkAction +AtkActionIface +atk_action_do_action +atk_action_get_n_actions +atk_action_get_description +atk_action_get_name +atk_action_get_localized_name +atk_action_get_keybinding +atk_action_set_description +<SUBSECTION Standard> +ATK_ACTION +ATK_IS_ACTION +ATK_TYPE_ACTION +ATK_ACTION_GET_IFACE +atk_action_get_type +</SECTION> + +<SECTION> +<FILE>atkcomponent</FILE> +<TITLE>AtkComponent</TITLE> +AtkComponent +AtkComponentIface +AtkFocusHandler +AtkRectangle +atk_component_add_focus_handler +atk_component_contains +atk_component_get_extents +atk_component_get_layer +atk_component_get_mdi_zorder +atk_component_get_position +atk_component_get_size +atk_component_grab_focus +atk_component_ref_accessible_at_point +atk_component_remove_focus_handler +atk_component_set_extents +atk_component_set_position +atk_component_set_size +atk_component_get_alpha +AtkScrollType +atk_component_scroll_to +atk_component_scroll_to_point +<SUBSECTION Standard> +ATK_COMPONENT +ATK_IS_COMPONENT +ATK_TYPE_COMPONENT +ATK_TYPE_RECTANGLE +ATK_TYPE_SCROLL_TYPE +ATK_COMPONENT_GET_IFACE +atk_component_get_type +atk_rectangle_get_type +atk_scroll_type_get_type +</SECTION> + +<SECTION> +<FILE>atkdocument</FILE> +<TITLE>AtkDocument</TITLE> +AtkDocument +AtkDocumentIface +atk_document_get_document_type +atk_document_get_document +atk_document_get_attribute_value +atk_document_set_attribute_value +atk_document_get_attributes +atk_document_get_locale +atk_document_get_current_page_number +atk_document_get_page_count +<SUBSECTION Standard> +ATK_DOCUMENT +ATK_IS_DOCUMENT +ATK_TYPE_DOCUMENT +ATK_DOCUMENT_GET_IFACE +atk_document_get_type +</SECTION> + +<SECTION> +<FILE>atkeditabletext</FILE> +<TITLE>AtkEditableText</TITLE> +AtkEditableText +atk_editable_text_set_run_attributes +atk_editable_text_set_text_contents +atk_editable_text_insert_text +atk_editable_text_copy_text +atk_editable_text_cut_text +atk_editable_text_delete_text +atk_editable_text_paste_text +<SUBSECTION Standard> +AtkEditableTextIface +ATK_EDITABLE_TEXT +ATK_IS_EDITABLE_TEXT +ATK_TYPE_EDITABLE_TEXT +ATK_EDITABLE_TEXT_GET_IFACE +atk_editable_text_get_type +</SECTION> + +<SECTION> +<FILE>atkhypertext</FILE> +<TITLE>AtkHypertext</TITLE> +AtkHypertext +atk_hypertext_get_link +atk_hypertext_get_n_links +atk_hypertext_get_link_index +<SUBSECTION Standard> +AtkHypertextIface +ATK_HYPERTEXT +ATK_IS_HYPERTEXT +ATK_TYPE_HYPERTEXT +ATK_HYPERTEXT_GET_IFACE +atk_hypertext_get_type +</SECTION> + +<SECTION> +<FILE>atkimage</FILE> +<TITLE>AtkImage</TITLE> +AtkImage +atk_image_get_image_position +atk_image_get_image_description +atk_image_set_image_description +atk_image_get_image_size +atk_image_get_image_locale +<SUBSECTION Standard> +AtkImageIface +ATK_IMAGE +ATK_IS_IMAGE +ATK_TYPE_IMAGE +ATK_IMAGE_GET_IFACE +atk_image_get_type +</SECTION> + +<SECTION> +<FILE>atknoopobject</FILE> +<TITLE>AtkNoOpObject</TITLE> +AtkNoOpObject +atk_no_op_object_new +<SUBSECTION Standard> +ATK_NO_OP_OBJECT +ATK_IS_NO_OP_OBJECT +ATK_TYPE_NO_OP_OBJECT +atk_no_op_object_get_type +ATK_NO_OP_OBJECT_CLASS +ATK_IS_NO_OP_OBJECT_CLASS +ATK_NO_OP_OBJECT_GET_CLASS +AtkNoOpObjectClass +</SECTION> + +<SECTION> +<FILE>atknoopobjectfactory</FILE> +<TITLE>AtkNoOpObjectFactory</TITLE> +AtkNoOpObjectFactory +atk_no_op_object_factory_new +<SUBSECTION Standard> +ATK_NO_OP_OBJECT_FACTORY +ATK_IS_NO_OP_OBJECT_FACTORY +ATK_TYPE_NO_OP_OBJECT_FACTORY +atk_no_op_object_factory_get_type +ATK_NO_OP_OBJECT_FACTORY_CLASS +ATK_IS_NO_OP_OBJECT_FACTORY_CLASS +ATK_NO_OP_OBJECT_FACTORY_GET_CLASS +AtkNoOpObjectFactoryClass +</SECTION> + +<SECTION> +<FILE>atkobject</FILE> +<TITLE>AtkObject</TITLE> +AtkObject +AtkRole +atk_role_register +AtkLayer +AtkImplementor +AtkAttribute +AtkAttributeSet +AtkPropertyValues +AtkFunction +AtkPropertyChangeHandler +atk_implementor_ref_accessible +atk_object_get_name +atk_object_get_description +atk_object_get_parent +atk_object_peek_parent +atk_object_get_n_accessible_children +atk_object_ref_accessible_child +atk_object_ref_relation_set +atk_object_get_layer +atk_object_get_mdi_zorder +atk_object_get_role +atk_object_ref_state_set +atk_object_get_index_in_parent +atk_object_set_name +atk_object_set_description +atk_object_set_parent +atk_object_set_role +atk_object_connect_property_change_handler +atk_object_remove_property_change_handler +atk_object_notify_state_change +atk_object_initialize +atk_object_add_relationship +atk_object_remove_relationship +atk_object_get_attributes +atk_object_get_object_locale +atk_object_get_accessible_id +atk_object_set_accessible_id +atk_role_get_name +atk_role_get_localized_name +atk_role_for_name +<SUBSECTION Standard> +AtkImplementorIface +ATK_OBJECT +ATK_IS_OBJECT +ATK_TYPE_OBJECT +ATK_IMPLEMENTOR_GET_IFACE +ATK_OBJECT_CLASS +ATK_IS_OBJECT_CLASS +ATK_OBJECT_GET_CLASS +ATK_TYPE_IMPLEMENTOR +ATK_IS_IMPLEMENTOR +ATK_IMPLEMENTOR +ATK_TYPE_ROLE +ATK_TYPE_LAYER +ATK_TYPE_SCROLL_TYPE +atk_implementor_get_type +atk_object_get_type +atk_role_get_type +atk_layer_get_type +AtkObjectClass +</SECTION> + +<SECTION> +<FILE>atkobjectfactory</FILE> +<TITLE>AtkObjectFactory</TITLE> +AtkObjectFactory +atk_object_factory_create_accessible +atk_object_factory_get_accessible_type +atk_object_factory_invalidate +<SUBSECTION Standard> +ATK_OBJECT_FACTORY +ATK_IS_OBJECT_FACTORY +ATK_TYPE_OBJECT_FACTORY +atk_object_factory_get_type +ATK_OBJECT_FACTORY_CLASS +ATK_IS_OBJECT_FACTORY_CLASS +ATK_OBJECT_FACTORY_GET_CLASS +AtkObjectFactoryClass +</SECTION> + +<SECTION> +<FILE>atkregistry</FILE> +<TITLE>AtkRegistry</TITLE> +AtkRegistry +atk_registry_set_factory_type +atk_registry_get_factory_type +atk_registry_get_factory +atk_get_default_registry +<SUBSECTION Standard> +ATK_REGISTRY +ATK_IS_REGISTRY +ATK_TYPE_REGISTRY +atk_registry_get_type +ATK_REGISTRY_CLASS +ATK_IS_REGISTRY_CLASS +ATK_REGISTRY_GET_CLASS +AtkRegistryClass +</SECTION> + +<SECTION> +<FILE>atkrelation</FILE> +<TITLE>AtkRelation</TITLE> +AtkRelation +AtkRelationType +atk_relation_type_register +atk_relation_type_get_name +atk_relation_type_for_name +atk_relation_new +atk_relation_get_relation_type +atk_relation_get_target +atk_relation_add_target +atk_relation_remove_target +<SUBSECTION Standard> +ATK_RELATION +ATK_IS_RELATION +ATK_TYPE_RELATION +ATK_TYPE_RELATION_TYPE +atk_relation_get_type +atk_relation_type_get_type +ATK_RELATION_CLASS +ATK_IS_RELATION_CLASS +ATK_RELATION_GET_CLASS +AtkRelationClass +</SECTION> + +<SECTION> +<FILE>atkrelationset</FILE> +<TITLE>AtkRelationSet</TITLE> +AtkRelationSet +atk_relation_set_new +atk_relation_set_contains +atk_relation_set_contains_target +atk_relation_set_remove +atk_relation_set_add +atk_relation_set_get_n_relations +atk_relation_set_get_relation +atk_relation_set_get_relation_by_type +atk_relation_set_add_relation_by_type +<SUBSECTION Standard> +ATK_RELATION_SET +ATK_IS_RELATION_SET +ATK_TYPE_RELATION_SET +atk_relation_set_get_type +ATK_RELATION_SET_CLASS +ATK_IS_RELATION_SET_CLASS +ATK_RELATION_SET_GET_CLASS +AtkRelationSetClass +</SECTION> + +<SECTION> +<FILE>atkselection</FILE> +<TITLE>AtkSelection</TITLE> +AtkSelection +atk_selection_add_selection +atk_selection_clear_selection +atk_selection_ref_selection +atk_selection_get_selection_count +atk_selection_is_child_selected +atk_selection_remove_selection +atk_selection_select_all_selection +<SUBSECTION Standard> +AtkSelectionIface +ATK_SELECTION +ATK_IS_SELECTION +ATK_TYPE_SELECTION +ATK_SELECTION_GET_IFACE +atk_selection_get_type +</SECTION> + +<SECTION> +<FILE>atkstateset</FILE> +<TITLE>AtkStateSet</TITLE> +AtkStateSet +atk_state_set_new +atk_state_set_is_empty +atk_state_set_add_state +atk_state_set_add_states +atk_state_set_clear_states +atk_state_set_contains_state +atk_state_set_contains_states +atk_state_set_remove_state +atk_state_set_and_sets +atk_state_set_or_sets +atk_state_set_xor_sets +<SUBSECTION Standard> +ATK_STATE_SET +ATK_IS_STATE_SET +ATK_TYPE_STATE_SET +atk_state_set_get_type +ATK_STATE_SET_CLASS +ATK_IS_STATE_SET_CLASS +ATK_STATE_SET_GET_CLASS +AtkStateSetClass +</SECTION> + +<SECTION> +<FILE>atktable</FILE> +<TITLE>AtkTable</TITLE> +AtkTable +atk_table_ref_at +atk_table_get_index_at +atk_table_get_column_at_index +atk_table_get_row_at_index +atk_table_get_n_columns +atk_table_get_n_rows +atk_table_get_column_extent_at +atk_table_get_row_extent_at +atk_table_get_caption +atk_table_get_column_description +atk_table_get_row_description +atk_table_get_column_header +atk_table_get_row_header +atk_table_get_summary +atk_table_set_caption +atk_table_set_row_description +atk_table_set_column_description +atk_table_set_row_header +atk_table_set_column_header +atk_table_set_summary +atk_table_get_selected_columns +atk_table_get_selected_rows +atk_table_is_column_selected +atk_table_is_row_selected +atk_table_is_selected +atk_table_add_column_selection +atk_table_add_row_selection +atk_table_remove_column_selection +atk_table_remove_row_selection +<SUBSECTION Standard> +AtkTableIface +ATK_TABLE +ATK_IS_TABLE +ATK_TYPE_TABLE +ATK_TABLE_GET_IFACE +atk_table_get_type +</SECTION> + +<SECTION> +<FILE>atktablecell</FILE> +<TITLE>AtkTableCell</TITLE> +AtkTableCell +AtkTableCellIface +atk_table_cell_get_column_span +atk_table_cell_get_column_header_cells +atk_table_cell_get_position +atk_table_cell_get_row_span +atk_table_cell_get_row_header_cells +atk_table_cell_get_row_column_span +atk_table_cell_get_table +<SUBSECTION Standard> +ATK_TABLE_CELL +ATK_IS_TABLE_CELL +ATK_TYPE_TABLE_CELL +ATK_TABLE_CELL_GET_IFACE +atk_table_cell_get_type +</SECTION> + +<SECTION> +<FILE>atktext</FILE> +<TITLE>AtkText</TITLE> +AtkText +AtkTextIface +AtkTextBoundary +AtkTextGranularity +AtkTextClipType +AtkTextRange +AtkTextRectangle +AtkTextAttribute +atk_text_get_text +atk_text_get_character_at_offset +atk_text_get_text_after_offset +atk_text_get_text_at_offset +atk_text_get_text_before_offset +atk_text_get_string_at_offset +atk_text_get_caret_offset +atk_text_get_character_extents +atk_text_get_run_attributes +atk_text_get_default_attributes +atk_text_get_character_count +atk_text_get_offset_at_point +atk_text_get_bounded_ranges +atk_text_get_range_extents +atk_text_free_ranges +atk_text_get_n_selections +atk_text_get_selection +atk_text_add_selection +atk_text_remove_selection +atk_text_set_selection +atk_text_set_caret_offset +atk_attribute_set_free +atk_text_attribute_register +atk_text_attribute_get_name +atk_text_attribute_for_name +atk_text_attribute_get_value +atk_text_scroll_substring_to +atk_text_scroll_substring_to_point +<SUBSECTION Standard> +ATK_TEXT +ATK_IS_TEXT +ATK_TYPE_TEXT +ATK_TEXT_GET_IFACE +ATK_TYPE_TEXT_ATTRIBUTE +ATK_TYPE_TEXT_BOUNDARY +ATK_TYPE_TEXT_GRANULARITY +ATK_TYPE_TEXT_CLIP_TYPE +atk_text_get_type +atk_text_attribute_get_type +atk_text_boundary_get_type +atk_text_granularity_get_type +atk_text_clip_type_get_type +atk_text_range_get_type +</SECTION> + +<SECTION> +<FILE>atkvalue</FILE> +<TITLE>AtkValue</TITLE> +AtkValue +AtkValueType +atk_value_get_current_value +atk_value_get_maximum_value +atk_value_get_minimum_value +atk_value_set_current_value +atk_value_get_minimum_increment +atk_value_get_value_and_text +atk_value_get_range +atk_value_get_increment +atk_value_get_sub_ranges +atk_value_set_value +atk_value_type_get_localized_name +atk_value_type_get_name +<SUBSECTION Standard> +AtkValueIface +ATK_VALUE +ATK_IS_VALUE +ATK_TYPE_VALUE +ATK_VALUE_GET_IFACE +atk_value_get_type +ATK_TYPE_VALUE_TYPE +atk_value_type_get_type +</SECTION> + +<SECTION> +<FILE>atkhyperlink</FILE> +<TITLE>AtkHyperlink</TITLE> +AtkHyperlink +AtkHyperlinkStateFlags +atk_hyperlink_get_uri +atk_hyperlink_get_object +atk_hyperlink_get_end_index +atk_hyperlink_get_start_index +atk_hyperlink_is_valid +atk_hyperlink_is_inline +atk_hyperlink_get_n_anchors +atk_hyperlink_is_selected_link +<SUBSECTION Standard> +ATK_HYPERLINK +ATK_IS_HYPERLINK +ATK_TYPE_HYPERLINK +atk_hyperlink_get_type +ATK_HYPERLINK_CLASS +ATK_IS_HYPERLINK_CLASS +ATK_HYPERLINK_GET_CLASS +atk_hyperlink_state_flags_get_type +ATK_TYPE_HYPERLINK_STATE_FLAGS +AtkHyperlinkClass +</SECTION> + +<SECTION> +<FILE>atkhyperlinkimpl</FILE> +<TITLE>AtkHyperlinkImpl</TITLE> +AtkHyperlinkImpl +atk_hyperlink_impl_get_hyperlink +<SUBSECTION Standard> +AtkHyperlinkImplIface +ATK_HYPERLINK_IMPL +ATK_IS_HYPERLINK_IMPL +ATK_TYPE_HYPERLINK_IMPL +atk_hyperlink_impl_get_type +ATK_HYPERLINK_IMPL_GET_IFACE +</SECTION> + +<SECTION> +<FILE>atkstate</FILE> +<TITLE>AtkState</TITLE> +AtkStateType +AtkState +atk_state_type_register +atk_state_type_get_name +atk_state_type_for_name +<SUBSECTION Standard> +ATK_TYPE_STATE_TYPE +atk_state_type_get_type +</SECTION> + +<SECTION> +<FILE>atkstreamablecontent</FILE> +<TITLE>AtkStreamableContent</TITLE> +AtkStreamableContent +atk_streamable_content_get_n_mime_types +atk_streamable_content_get_mime_type +atk_streamable_content_get_stream +atk_streamable_content_get_uri +<SUBSECTION Standard> +AtkStreamableContentIface +ATK_STREAMABLE_CONTENT +ATK_IS_STREAMABLE_CONTENT +ATK_TYPE_STREAMABLE_CONTENT +atk_streamable_content_get_type +ATK_STREAMABLE_CONTENT_GET_IFACE +</SECTION> + +<SECTION> +<FILE>atkutil</FILE> +<TITLE>AtkUtil</TITLE> +AtkUtil +AtkCoordType +atk_add_focus_tracker +atk_remove_focus_tracker +atk_focus_tracker_init +atk_focus_tracker_notify +AtkEventListener +AtkEventListenerInit +atk_add_global_event_listener +atk_remove_global_event_listener +AtkKeyEventStruct +AtkKeyEventType +AtkKeySnoopFunc +atk_add_key_event_listener +atk_remove_key_event_listener +atk_get_root +atk_get_focus_object +atk_get_toolkit_name +atk_get_toolkit_version +atk_get_version +ATK_DEFINE_TYPE +ATK_DEFINE_TYPE_EXTENDED +ATK_DEFINE_TYPE_WITH_CODE +ATK_DEFINE_ABSTRACT_TYPE +ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE +<SUBSECTION Standard> +ATK_UTIL +ATK_IS_UTIL +ATK_TYPE_UTIL +ATK_TYPE_KEY_EVENT_TYPE +ATK_TYPE_COORD_TYPE +atk_util_get_type +atk_key_event_type_get_type +atk_coord_type_get_type +ATK_UTIL_CLASS +ATK_IS_UTIL_CLASS +ATK_UTIL_GET_CLASS +AtkUtilClass +</SECTION> + +<SECTION> +<FILE>atkmisc</FILE> +<TITLE>AtkMisc</TITLE> +AtkMisc +atk_misc_threads_enter +atk_misc_threads_leave +atk_misc_get_instance +<SUBSECTION Standard> +ATK_MISC +ATK_IS_MISC +ATK_TYPE_MISC +ATK_MISC_CLASS +ATK_IS_MISC_CLASS +ATK_MISC_GET_CLASS +AtkMiscClass +atk_misc_get_type +atk_misc_instance +</SECTION> + +<SECTION> +<FILE>atkgobjectaccessible</FILE> +<TITLE>AtkGObjectAccessible</TITLE> +AtkGObjectAccessible +atk_gobject_accessible_for_object +atk_gobject_accessible_get_object +<SUBSECTION Standard> +ATK_GOBJECT_ACCESSIBLE +ATK_IS_GOBJECT_ACCESSIBLE +ATK_TYPE_GOBJECT_ACCESSIBLE +atk_gobject_accessible_get_type +ATK_GOBJECT_ACCESSIBLE_CLASS +ATK_IS_GOBJECT_ACCESSIBLE_CLASS +ATK_GOBJECT_ACCESSIBLE_GET_CLASS +AtkGObjectAccessibleClass +</SECTION> + +<SECTION> +<FILE>atkplug</FILE> +<TITLE>AtkPlug</TITLE> +AtkPlug +atk_plug_new +atk_plug_get_id +<SUBSECTION Standard> +ATK_IS_PLUG +ATK_IS_PLUG_CLASS +ATK_PLUG +ATK_PLUG_CLASS +ATK_PLUG_GET_CLASS +ATK_TYPE_PLUG +AtkPlugClass +atk_plug_get_type +</SECTION> + +<SECTION> +<FILE>atksocket</FILE> +<TITLE>AtkSocket</TITLE> +AtkSocket +atk_socket_new +atk_socket_embed +atk_socket_is_occupied +<SUBSECTION Standard> +ATK_IS_SOCKET +ATK_IS_SOCKET_CLASS +ATK_SOCKET +ATK_SOCKET_CLASS +ATK_SOCKET_GET_CLASS +ATK_TYPE_SOCKET +AtkSocketClass +atk_socket_get_type +</SECTION> + +<SECTION> +<FILE>atkwindow</FILE> +<TITLE>AtkWindow</TITLE> +AtkWindow +<SUBSECTION Standard> +ATK_IS_WINDOW +ATK_IS_WINDOW_CLASS +ATK_WINDOW +ATK_WINDOW_CLASS +ATK_WINDOW_GET_IFACE +ATK_TYPE_WINDOW +AtkWindowClass +atk_window_get_type +</SECTION> + +<SECTION> +<FILE>atkversion</FILE> +<TITLE>Versioning Utilities</TITLE> +ATK_BINARY_AGE +ATK_INTERFACE_AGE +atk_get_major_version +atk_get_minor_version +atk_get_micro_version +atk_get_binary_age +atk_get_interface_age +ATK_MAJOR_VERSION +ATK_MINOR_VERSION +ATK_MICRO_VERSION +ATK_CHECK_VERSION +<SUBSECTION> +ATK_VERSION_2_2 +ATK_VERSION_2_4 +ATK_VERSION_2_6 +ATK_VERSION_2_8 +ATK_VERSION_2_10 +ATK_VERSION_2_12 +ATK_VERSION_2_14 +ATK_VERSION_2_30 +ATK_VERSION_MAX_ALLOWED +ATK_VERSION_MIN_REQUIRED +<SUBSECTION Private> +atk_binary_age +atk_interface_age +atk_major_version +atk_micro_version +atk_minor_version +ATK_VERSION_PREV_STABLE +ATK_VERSION_CUR_STABLE +ATK_UNAVAILABLE +ATK_VAR +ATK_AVAILABLE_IN_ALL +ATK_AVAILABLE_IN_2_2 +ATK_AVAILABLE_IN_2_4 +ATK_AVAILABLE_IN_2_6 +ATK_AVAILABLE_IN_2_8 +ATK_AVAILABLE_IN_2_10 +ATK_AVAILABLE_IN_2_12 +ATK_AVAILABLE_IN_2_14 +ATK_AVAILABLE_IN_2_30 +ATK_DEPRECATED +ATK_DEPRECATED_FOR +ATK_DEPRECATED_IN_2_2 +ATK_DEPRECATED_IN_2_2_FOR +ATK_DEPRECATED_IN_2_30 +ATK_DEPRECATED_IN_2_30_FOR +ATK_DEPRECATED_IN_2_4 +ATK_DEPRECATED_IN_2_4_FOR +ATK_DEPRECATED_IN_2_6 +ATK_DEPRECATED_IN_2_6_FOR +ATK_DEPRECATED_IN_2_8 +ATK_DEPRECATED_IN_2_8_FOR +ATK_DEPRECATED_IN_2_10 +ATK_DEPRECATED_IN_2_10_FOR +ATK_DEPRECATED_IN_2_12 +ATK_DEPRECATED_IN_2_12_FOR +ATK_DEPRECATED_IN_2_14 +ATK_DEPRECATED_IN_2_14_FOR +</SECTION> + +<SECTION> +<FILE>atkrange</FILE> +<TITLE>AtkRange</TITLE> +atk_range_copy +atk_range_free +atk_range_get_lower_limit +atk_range_get_upper_limit +atk_range_get_description +atk_range_new +<SUBSECTION Standard> +ATK_TYPE_RANGE +atk_range_get_type +</SECTION> diff --git a/doc/atk/meson.build b/doc/atk/meson.build new file mode 100644 index 00000000..1e491e3e --- /dev/null +++ b/doc/atk/meson.build @@ -0,0 +1,32 @@ +subdir('xml') + +private_headers = [ + 'atkmarshal.h', + 'atkintl.h', +] + +glib_prefix = dependency('glib-2.0').get_variable(pkgconfig: 'prefix') +glib_docpath = glib_prefix / 'share/gtk-doc/html' +docpath = atk_datadir / 'gtk-doc/html' + +gnome.gtkdoc('atk', + main_xml: 'atk-docs.xml', + src_dir: atk_inc, + dependencies: libatk_dep, + gobject_typesfile: 'atk.types', + scan_args: [ + '--rebuild-types', + '--deprecated-guards=ATK_DISABLE_DEPRECATED', + '--ignore-decorators=_ATK_EXTERN', + '--ignore-headers=' + ' '.join(private_headers), + ], + mkdb_args: [ + '--output-format=xml', + ], + fixxref_args: [ + '--html-dir=@0@'.format(docpath), + '--extra-dir=@0@'.format(join_paths(glib_docpath, 'glib')), + '--extra-dir=@0@'.format(join_paths(glib_docpath, 'gobject')), + ], + install: true, +) diff --git a/doc/xml/gtkdocentities.ent.in b/doc/xml/gtkdocentities.ent.in new file mode 100644 index 00000000..f12c9ff7 --- /dev/null +++ b/doc/xml/gtkdocentities.ent.in @@ -0,0 +1,8 @@ +<!ENTITY package "@PACKAGE@"> +<!ENTITY package_bugreport "@PACKAGE_BUGREPORT@"> +<!ENTITY package_name "@PACKAGE_NAME@"> +<!ENTITY package_string "@PACKAGE_STRING@"> +<!ENTITY package_tarname "@PACKAGE_TARNAME@"> +<!ENTITY package_url "@PACKAGE_URL@"> +<!ENTITY package_version "@PACKAGE_VERSION@"> +<!ENTITY package_api_version "@PACKAGE_API_VERSION@"> diff --git a/doc/xml/meson.build b/doc/xml/meson.build new file mode 100644 index 00000000..2a6a1f0a --- /dev/null +++ b/doc/xml/meson.build @@ -0,0 +1,14 @@ +ent_conf = configuration_data() +ent_conf.set('PACKAGE', meson.project_name()) +ent_conf.set('PACKAGE_BUGREPORT', 'https://gitlab.gnome.org/GNOME/atk') +ent_conf.set('PACKAGE_NAME', meson.project_name()) +ent_conf.set('PACKAGE_STRING', meson.project_name()) +ent_conf.set('PACKAGE_TARNAME', '@0@-@1@'.format(meson.project_name(), meson.project_version())) +ent_conf.set('PACKAGE_URL', 'https://developer.gnome.org/atk/stable') +ent_conf.set('PACKAGE_VERSION', meson.project_version()) +ent_conf.set('PACKAGE_API_VERSION', atk_api_version) +configure_file( + input: 'gtkdocentities.ent.in', + output: 'gtkdocentities.ent', + configuration: ent_conf, +) |