summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAlejandro Piñeiro <apinheiro@igalia.com>2019-06-17 19:25:54 +0000
committerAlejandro Piñeiro <apinheiro@igalia.com>2019-06-17 19:25:54 +0000
commit7d51f36ae68f5e25ab21fb27eda8143b826a365e (patch)
tree39b947f4817a1c0c39c97e85076795031ca0d790
parentecbbaaa6e7a4b0519a2aa27daf2f823860fa4f8a (diff)
parentb7bf5f1fad26051892b0adb23936813798292583 (diff)
downloadatk-7d51f36ae68f5e25ab21fb27eda8143b826a365e.tar.gz
Merge branch 'docs-fixes' into 'master'
Documentation and build fixes See merge request GNOME/atk!3
-rw-r--r--atk.pc.in11
-rw-r--r--atk/atkaction.h23
-rw-r--r--atk/atkcomponent.h74
-rw-r--r--atk/atkdocument.c40
-rw-r--r--atk/atkimage.c6
-rw-r--r--atk/atkobject.c16
-rw-r--r--atk/atkobject.h131
-rw-r--r--atk/atkplug.c25
-rw-r--r--atk/atksocket.c25
-rw-r--r--atk/atkstate.h16
-rw-r--r--atk/atktablecell.h20
-rw-r--r--atk/atkutil.c11
-rw-r--r--atk/meson.build99
-rw-r--r--docs/atk-sections.txt63
-rw-r--r--docs/atk.types28
-rw-r--r--docs/meson.build49
-rw-r--r--docs/xml/meson.build8
-rw-r--r--meson.build23
-rw-r--r--tests/meson.build27
19 files changed, 382 insertions, 313 deletions
diff --git a/atk.pc.in b/atk.pc.in
deleted file mode 100644
index 51ce841..0000000
--- a/atk.pc.in
+++ /dev/null
@@ -1,11 +0,0 @@
-prefix=@prefix@
-exec_prefix=@exec_prefix@
-libdir=@libdir@
-includedir=@includedir@
-
-Name: Atk
-Description: Accessibility Toolkit
-Version: @VERSION@
-Requires: gobject-2.0
-Libs: -L${libdir} -latk-@ATK_API_VERSION@
-Cflags: -I${includedir}/atk-1.0
diff --git a/atk/atkaction.h b/atk/atkaction.h
index 1314071..d2eba28 100644
--- a/atk/atkaction.h
+++ b/atk/atkaction.h
@@ -29,11 +29,6 @@
G_BEGIN_DECLS
/*
- * The interface AtkAction should be supported by any object that can
- * perform one or more actions. The interface provides the standard
- * mechanism for an assistive 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.
*/
@@ -48,10 +43,28 @@ typedef struct _AtkAction AtkAction;
#endif
typedef struct _AtkActionIface AtkActionIface;
+/**
+ * AtkActionIface:
+ * @do_action:
+ * @get_n_actions:
+ * @get_description:
+ * @get_name:
+ * @get_keybinding:
+ * @set_description:
+ * @get_localized_name:
+ *
+ * The #AtkAction interface should be supported by any object that can
+ * perform one or more actions. The interface provides the standard
+ * mechanism for an assistive 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.
+ */
struct _AtkActionIface
{
+ /*< private >*/
GTypeInterface parent;
+ /*< public >*/
gboolean (*do_action) (AtkAction *action,
gint i);
gint (*get_n_actions) (AtkAction *action);
diff --git a/atk/atkcomponent.h b/atk/atkcomponent.h
index b00650d..72e9f7d 100644
--- a/atk/atkcomponent.h
+++ b/atk/atkcomponent.h
@@ -30,27 +30,27 @@
G_BEGIN_DECLS
/**
- *AtkScrollType:
- *@ATK_SCROLL_TOP_LEFT: Scroll the object vertically and horizontally to the top
- *left corner of the window.
- *@ATK_SCROLL_BOTTOM_RIGHT: Scroll the object vertically and horizontally to the
- *bottom right corner of the window.
- *@ATK_SCROLL_TOP_EDGE: Scroll the object vertically to the top edge of the
- window.
- *@ATK_SCROLL_BOTTOM_EDGE: Scroll the object vertically to the bottom edge of
- *the window.
- *@ATK_SCROLL_LEFT_EDGE: Scroll the object vertically and horizontally to the
- *left edge of the window.
- *@ATK_SCROLL_RIGHT_EDGE: Scroll the object vertically and horizontally to the
- *right edge of the window.
- *@ATK_SCROLL_ANYWHERE: Scroll the object vertically and horizontally so that
- *as much as possible of the object becomes visible. The exact placement is
- *determined by the application.
+ * AtkScrollType:
+ * @ATK_SCROLL_TOP_LEFT: Scroll the object vertically and horizontally to the top
+ * left corner of the window.
+ * @ATK_SCROLL_BOTTOM_RIGHT: Scroll the object vertically and horizontally to the
+ * bottom right corner of the window.
+ * @ATK_SCROLL_TOP_EDGE: Scroll the object vertically to the top edge of the
+ * window.
+ * @ATK_SCROLL_BOTTOM_EDGE: Scroll the object vertically to the bottom edge of
+ * the window.
+ * @ATK_SCROLL_LEFT_EDGE: Scroll the object vertically and horizontally to the
+ * left edge of the window.
+ * @ATK_SCROLL_RIGHT_EDGE: Scroll the object vertically and horizontally to the
+ * right edge of the window.
+ * @ATK_SCROLL_ANYWHERE: Scroll the object vertically and horizontally so that
+ * as much as possible of the object becomes visible. The exact placement is
+ * determined by the application.
*
* Specifies where an object should be placed on the screen when using scroll_to.
*
* Since: 2.30
- **/
+ */
typedef enum {
ATK_SCROLL_TOP_LEFT,
ATK_SCROLL_BOTTOM_RIGHT,
@@ -61,13 +61,6 @@ typedef enum {
ATK_SCROLL_ANYWHERE
} AtkScrollType;
-/*
- * 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.
- */
-
#define ATK_TYPE_COMPONENT (atk_component_get_type ())
#define ATK_IS_COMPONENT(obj) G_TYPE_CHECK_INSTANCE_TYPE ((obj), ATK_TYPE_COMPONENT)
#define ATK_COMPONENT(obj) G_TYPE_CHECK_INSTANCE_CAST ((obj), ATK_TYPE_COMPONENT, AtkComponent)
@@ -122,21 +115,40 @@ GType atk_rectangle_get_type (void);
/**
* AtkComponentIface:
* @add_focus_handler: This virtual function is deprecated since 2.9.4
- * and it should not be overriden. See
- * atk_component_add_focus_handler() for more information.
+ * and it should not be overriden. See atk_component_add_focus_handler()
+ * for more information.
* @get_position: This virtual function is deprecated since 2.12 and
- * it should not be overriden. Use @get_extents instead.
+ * it should not be overriden. Use @AtkComponentIface.get_extents instead.
* @get_size: This virtual function is deprecated since 2.12 and it
- * should not be overriden. Use @get_extents instead.
+ * should not be overriden. Use @AtkComponentIface.get_extents instead.
* @remove_focus_handler: This virtual function is deprecated since
- * 2.9.4 and it should not be overriden. See
- * atk_component_remove_focus_handler() for more information.
+ * 2.9.4 and it should not be overriden. See atk_component_remove_focus_handler()
+ * for more information.
+ * @contains:
+ * @ref_accessible_at_point:
+ * @get_extents:
+ * @grab_focus:
+ * @set_extents:
+ * @set_position:
+ * @set_size:
+ * @get_layer:
+ * @get_mdi_zorder:
+ * @bounds_changed:
+ * @get_alpha:
+ * @scroll_to:
+ * @scroll_to_point:
+ *
+ * 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.
*/
-
struct _AtkComponentIface
{
+ /*< private >*/
GTypeInterface parent;
+ /*< public >*/
guint (* add_focus_handler) (AtkComponent *component,
AtkFocusHandler handler);
diff --git a/atk/atkdocument.c b/atk/atkdocument.c
index ff08ca8..b661c26 100644
--- a/atk/atkdocument.c
+++ b/atk/atkdocument.c
@@ -296,13 +296,15 @@ atk_document_get_attributes (AtkDocument *document)
* atk_document_get_attribute_value: (virtual get_document_attribute_value)
* @document: a #GObject instance that implements AtkDocumentIface
* @attribute_name: a character string representing the name of the attribute
- * whose value is being queried.
+ * whose value is being queried.
*
- * Since: 1.12
+ * Retrieves the value of the given @attribute_name inside @document.
*
* Returns: (nullable): a string value associated with the named
- * attribute for this document, or NULL if a value for
- * #attribute_name has not been specified for this document.
+ * attribute for this document, or %NULL if a value for
+ * @attribute_name has not been specified for this document.
+ *
+ * Since: 1.12
*/
const gchar *
atk_document_get_attribute_value (AtkDocument *document,
@@ -326,16 +328,18 @@ atk_document_get_attribute_value (AtkDocument *document,
/**
* atk_document_set_attribute_value: (virtual set_document_attribute)
- * @document: a #GObject instance that implements AtkDocumentIface
+ * @document: a #GObject instance that implements #AtkDocumentIface
* @attribute_name: a character string representing the name of the attribute
- * whose value is being set.
- * @attribute_value: a string value to be associated with #attribute_name.
+ * whose value is being set.
+ * @attribute_value: a string value to be associated with @attribute_name.
+ *
+ * Sets the value for the given @attribute_name inside @document.
*
* Since: 1.12
*
- * Returns: TRUE if #value is successfully associated with #attribute_name
- * for this document, FALSE otherwise (e.g. if the document does not
- * allow the attribute to be modified).
+ * Returns: %TRUE if @attribute_value is successfully associated
+ * with @attribute_name for this @document, and %FALSE if if the
+ * document does not allow the attribute to be modified
*/
gboolean
atk_document_set_attribute_value (AtkDocument *document,
@@ -362,10 +366,12 @@ atk_document_set_attribute_value (AtkDocument *document,
* atk_document_get_current_page_number:
* @document: the #AtkDocument
*
- * Since: 2.12
+ * Retrieves the current page number inside @document.
*
- * Returns: current page number inside @document. -1 if not
- * implemented, not know by the implementor or irrelevant.
+ * Returns: the current page number inside @document, or -1 if
+ * not implemented, not know by the implementor, or irrelevant.
+ *
+ * Since: 2.12
*/
gint
atk_document_get_current_page_number (AtkDocument *document)
@@ -390,10 +396,12 @@ atk_document_get_current_page_number (AtkDocument *document)
* atk_document_get_page_count:
* @document: the #AtkDocument
*
- * Since: 2.12
+ * Retrieves the total number of pages inside @document.
*
- * Returns: total page count of @document. -1 if not implemented, not
- * know by the implementor or irrelevant.
+ * Returns: total page count of @document, or -1 if not implemented,
+ * not know by the implementor or irrelevant.
+ *
+ * Since: 2.12
*/
gint
atk_document_get_page_count (AtkDocument *document)
diff --git a/atk/atkimage.c b/atk/atkimage.c
index 3a00886..5080150 100644
--- a/atk/atkimage.c
+++ b/atk/atkimage.c
@@ -210,11 +210,13 @@ atk_image_get_image_position (AtkImage *image,
* atk_image_get_image_locale:
* @image: An #AtkImage
*
+ * Retrieves the locale identifier associated to the #AtkImage.
+ *
* Since: 1.12
*
* Returns: (nullable): a string corresponding to the POSIX
- * LC_MESSAGES locale used by the image description, or %NULL if the
- * image does not specify a locale.
+ * `LC_MESSAGES` locale used by the image description, or
+ * %NULL if the image does not specify a locale.
*
*/
const gchar*
diff --git a/atk/atkobject.c b/atk/atkobject.c
index 110bf2e..63986dd 100644
--- a/atk/atkobject.c
+++ b/atk/atkobject.c
@@ -1171,12 +1171,14 @@ atk_object_set_role (AtkObject *accessible,
* @accessible: an #AtkObject
* @handler: a function to be called when a property changes its value
*
- * Deprecated: Since 2.12. Connect directly to property-change or
- * notify signals.
+ * Calls @handler on property changes.
*
* Returns: a #guint which is the handler id used in
- * atk_object_remove_property_change_handler()
- **/
+ * atk_object_remove_property_change_handler()
+ *
+ * Deprecated: 2.12: Connect directly to #AtkObject::property-change or
+ * the relevant #GObject::notify signal for each desired property.
+ */
guint
atk_object_connect_property_change_handler (AtkObject *accessible,
AtkPropertyChangeHandler *handler)
@@ -1198,10 +1200,10 @@ atk_object_connect_property_change_handler (AtkObject *accessible,
* @accessible: an #AtkObject
* @handler_id: a guint which identifies the handler to be removed.
*
- * Deprecated: Since 2.12.
- *
* Removes a property change handler.
- **/
+ *
+ * Deprecated: 2.12: See atk_object_connect_property_change_handler()
+ */
void
atk_object_remove_property_change_handler (AtkObject *accessible,
guint handler_id)
diff --git a/atk/atkobject.h b/atk/atkobject.h
index d196114..0fda2f5 100644
--- a/atk/atkobject.h
+++ b/atk/atkobject.h
@@ -93,7 +93,7 @@ G_BEGIN_DECLS
*@ATK_ROLE_TABLE_COLUMN_HEADER: The header for a column of a table
*@ATK_ROLE_TABLE_ROW_HEADER: The header for a row of a table
*@ATK_ROLE_TEAR_OFF_MENU_ITEM: A menu item used to tear off and reattach its menu
- *@ATK_ROLE_TERMINAL: An object that represents an accessible terminal. @Since: ATK-0.6
+ *@ATK_ROLE_TERMINAL: An object that represents an accessible terminal. (Since: 0.6)
*@ATK_ROLE_TEXT: An interactive widget that supports multiple lines of text and
* optionally accepts user input, but whose purpose is not to solicit user input.
* Thus ATK_ROLE_TEXT is appropriate for the text view in a plain text editor
@@ -105,133 +105,132 @@ G_BEGIN_DECLS
*@ATK_ROLE_TOOL_BAR: A bar or palette usually composed of push buttons or toggle buttons
*@ATK_ROLE_TOOL_TIP: An object that provides information about another object
*@ATK_ROLE_TREE: An object used to represent hierarchical information to the user
- *@ATK_ROLE_TREE_TABLE: An object capable of expanding and collapsing rows as well as showing multiple columns of data. @Since: ATK-0.7
+ *@ATK_ROLE_TREE_TABLE: An object capable of expanding and collapsing rows as well as showing multiple columns of data. (Since: 0.7)
*@ATK_ROLE_UNKNOWN: The object contains some Accessible information, but its role is not known
*@ATK_ROLE_VIEWPORT: An object usually used in a scroll pane
*@ATK_ROLE_WINDOW: A top level window with no title or border.
- *@ATK_ROLE_HEADER: An object that serves as a document header. @Since: ATK-1.1.1
- *@ATK_ROLE_FOOTER: An object that serves as a document footer. @Since: ATK-1.1.1
- *@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content. @Since: ATK-1.1.1
- *@ATK_ROLE_RULER: An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). @Since: ATK-1.1.1
- *@ATK_ROLE_APPLICATION: The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION. @Since: ATK-1.1.4
- *@ATK_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. @Since: ATK-1.3
- *@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar. @Since: ATK-1.5
- *@ATK_ROLE_EMBEDDED: The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context. @Since: ATK-1.7.2
- *@ATK_ROLE_ENTRY: The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present. @Since: ATK-1.11
- *@ATK_ROLE_CHART: The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. @Since: ATK-1.11
- *@ATK_ROLE_CAPTION: The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. @Since: ATK-1.11
- *@ATK_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface. @Since: ATK-1.11
+ *@ATK_ROLE_HEADER: An object that serves as a document header. (Since: 1.1.1)
+ *@ATK_ROLE_FOOTER: An object that serves as a document footer. (Since: 1.1.1)
+ *@ATK_ROLE_PARAGRAPH: An object which is contains a paragraph of text content. (Since: 1.1.1)
+ *@ATK_ROLE_RULER: An object which describes margins and tab stops, etc. for text objects which it controls (should have CONTROLLER_FOR relation to such). (Since: 1.1.1)
+ *@ATK_ROLE_APPLICATION: The object is an application object, which may contain @ATK_ROLE_FRAME objects or other types of accessibles. The root accessible of any application's ATK hierarchy should have ATK_ROLE_APPLICATION. (Since: 1.1.4)
+ *@ATK_ROLE_AUTOCOMPLETE: The object is a dialog or list containing items for insertion into an entry widget, for instance a list of words for completion of a text entry. (Since: 1.3)
+ *@ATK_ROLE_EDITBAR: The object is an editable text object in a toolbar. (Since: 1.5)
+ *@ATK_ROLE_EMBEDDED: The object is an embedded container within a document or panel. This role is a grouping "hint" indicating that the contained objects share a context. (Since: 1.7.2)
+ *@ATK_ROLE_ENTRY: The object is a component whose textual content may be entered or modified by the user, provided @ATK_STATE_EDITABLE is present. (Since: 1.11)
+ *@ATK_ROLE_CHART: The object is a graphical depiction of quantitative data. It may contain multiple subelements whose attributes and/or description may be queried to obtain both the quantitative data and information about how the data is being presented. The LABELLED_BY relation is particularly important in interpreting objects of this type, as is the accessible-description property. (Since: 1.11)
+ *@ATK_ROLE_CAPTION: The object contains descriptive information, usually textual, about another user interface element such as a table, chart, or image. (Since: 1.11)
+ *@ATK_ROLE_DOCUMENT_FRAME: The object is a visual frame or container which contains a view of document content. Document frames may occur within another Document instance, in which case the second document may be said to be embedded in the containing instance. HTML frames are often ROLE_DOCUMENT_FRAME. Either this object, or a singleton descendant, should implement the Document interface. (Since: 1.11)
*@ATK_ROLE_HEADING: The object serves as a heading for content which follows it in a document. The 'heading level' of the heading, if availabe, may be obtained by querying the object's attributes.
- *@ATK_ROLE_PAGE: The object is a containing instance which encapsulates a page of information. @ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model. @Since: ATK-1.11
- *@ATK_ROLE_SECTION: The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. @Since: ATK-1.11
- *@ATK_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients. @Since: ATK-1.11
+ *@ATK_ROLE_PAGE: The object is a containing instance which encapsulates a page of information. @ATK_ROLE_PAGE is used in documents and content which support a paginated navigation model. (Since: 1.11)
+ *@ATK_ROLE_SECTION: The object is a containing instance of document content which constitutes a particular 'logical' section of the document. The type of content within a section, and the nature of the section division itself, may be obtained by querying the object's attributes. Sections may be nested. (Since: 1.11)
+ *@ATK_ROLE_REDUNDANT_OBJECT: The object is redundant with another object in the hierarchy, and is exposed for purely technical reasons. Objects of this role should normally be ignored by clients. (Since: 1.11)
*@ATK_ROLE_FORM: The object is a container for form controls, for instance as part of a
* web form or user-input form within a document. This role is primarily a tag/convenience for
* clients when navigating complex documents, it is not expected that ordinary GUI containers will
- * always have ATK_ROLE_FORM. @Since: ATK-1.12.0
+ * always have ATK_ROLE_FORM. (Since: 1.12.0)
*@ATK_ROLE_LINK: The object is a hypertext anchor, i.e. a "link" in a
* hypertext document. Such objects are distinct from 'inline'
* content which may also use the Hypertext/Hyperlink interfaces
* to indicate the range/location within a text object where
- * an inline or embedded object lies. @Since: ATK-1.12.1
+ * an inline or embedded object lies. (Since: 1.12.1)
*@ATK_ROLE_INPUT_METHOD_WINDOW: The object is a window or similar viewport
* which is used to allow composition or input of a 'complex character',
- * in other words it is an "input method window." @Since: ATK-1.12.1
- *@ATK_ROLE_TABLE_ROW: A row in a table. @Since: ATK-2.1.0
- *@ATK_ROLE_TREE_ITEM: An object that represents an element of a tree. @Since: ATK-2.1.0
- *@ATK_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a spreadsheet. @Since: ATK-2.1.0
- *@ATK_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a presentation or slide content. @Since: ATK-2.1.0
- *@ATK_ROLE_DOCUMENT_TEXT: A document frame which contains textual content, such as found in a word processing application. @Since: ATK-2.1.0
- *@ATK_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other markup suitable for display in a web browser. @Since: ATK-2.1.0
- *@ATK_ROLE_DOCUMENT_EMAIL: A document frame which contains email content to be displayed or composed either in plain text or HTML. @Since: ATK-2.1.0
- *@ATK_ROLE_COMMENT: An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated. @Since: ATK-2.1.0
- *@ATK_ROLE_LIST_BOX: A non-collapsible list of choices the user can select from. @Since: ATK-2.1.0
- *@ATK_ROLE_GROUPING: A group of related widgets. This group typically has a label. @Since: ATK-2.1.0
- *@ATK_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. @Since: ATK-2.1.0
- *@ATK_ROLE_NOTIFICATION: A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. @Since: ATK-2.1.0
- *@ATK_ROLE_INFO_BAR: An object designed to present a message to the user within an existing window. @Since: ATK-2.1.0
- *@ATK_ROLE_LEVEL_BAR: A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. @Since: ATK-2.7.3
+ * in other words it is an "input method window." (Since: 1.12.1)
+ *@ATK_ROLE_TABLE_ROW: A row in a table. (Since: 2.1.0)
+ *@ATK_ROLE_TREE_ITEM: An object that represents an element of a tree. (Since: 2.1.0)
+ *@ATK_ROLE_DOCUMENT_SPREADSHEET: A document frame which contains a spreadsheet. (Since: 2.1.0)
+ *@ATK_ROLE_DOCUMENT_PRESENTATION: A document frame which contains a presentation or slide content. (Since: 2.1.0)
+ *@ATK_ROLE_DOCUMENT_TEXT: A document frame which contains textual content, such as found in a word processing application. (Since: 2.1.0)
+ *@ATK_ROLE_DOCUMENT_WEB: A document frame which contains HTML or other markup suitable for display in a web browser. (Since: 2.1.0)
+ *@ATK_ROLE_DOCUMENT_EMAIL: A document frame which contains email content to be displayed or composed either in plain text or HTML. (Since: 2.1.0)
+ *@ATK_ROLE_COMMENT: An object found within a document and designed to present a comment, note, or other annotation. In some cases, this object might not be visible until activated. (Since: 2.1.0)
+ *@ATK_ROLE_LIST_BOX: A non-collapsible list of choices the user can select from. (Since: 2.1.0)
+ *@ATK_ROLE_GROUPING: A group of related widgets. This group typically has a label. (Since: 2.1.0)
+ *@ATK_ROLE_IMAGE_MAP: An image map object. Usually a graphic with multiple hotspots, where each hotspot can be activated resulting in the loading of another document or section of a document. (Since: 2.1.0)
+ *@ATK_ROLE_NOTIFICATION: A transitory object designed to present a message to the user, typically at the desktop level rather than inside a particular application. (Since: 2.1.0)
+ *@ATK_ROLE_INFO_BAR: An object designed to present a message to the user within an existing window. (Since: 2.1.0)
+ *@ATK_ROLE_LEVEL_BAR: A bar that serves as a level indicator to, for instance, show the strength of a password or the state of a battery. (Since: 2.7.3)
*@ATK_ROLE_TITLE_BAR: A bar that serves as the title of a window or a
- * dialog. @Since: ATK-2.12
+ * dialog. (Since: 2.12)
*@ATK_ROLE_BLOCK_QUOTE: An object which contains a text section
- * that is quoted from another source. @Since: ATK-2.12
- *@ATK_ROLE_AUDIO: An object which represents an audio element. @Since: ATK-2.12
- *@ATK_ROLE_VIDEO: An object which represents a video element. @Since: ATK-2.12
- *@ATK_ROLE_DEFINITION: A definition of a term or concept. @Since: ATK-2.12
+ * that is quoted from another source. (Since: 2.12)
+ *@ATK_ROLE_AUDIO: An object which represents an audio element. (Since: 2.12)
+ *@ATK_ROLE_VIDEO: An object which represents a video element. (Since: 2.12)
+ *@ATK_ROLE_DEFINITION: A definition of a term or concept. (Since: 2.12)
*@ATK_ROLE_ARTICLE: A section of a page that consists of a
* composition that forms an independent part of a document, page, or
- * site. Examples: A blog entry, a news story, a forum post. @Since:
- * ATK-2.12
+ * site. Examples: A blog entry, a news story, a forum post. (Since: 2.12)
*@ATK_ROLE_LANDMARK: A region of a web page intended as a
* navigational landmark. This is designed to allow Assistive
* Technologies to provide quick navigation among key regions within a
- * document. @Since: ATK-2.12
+ * document. (Since: 2.12)
*@ATK_ROLE_LOG: A text widget or container holding log content, such
* as chat history and error logs. In this role there is a
* relationship between the arrival of new items in the log and the
* reading order. The log contains a meaningful sequence and new
* information is added only to the end of the log, not at arbitrary
- * points. @Since: ATK-2.12
+ * points. (Since: 2.12)
*@ATK_ROLE_MARQUEE: A container where non-essential information
* changes frequently. Common usages of marquee include stock tickers
* and ad banners. The primary difference between a marquee and a log
* is that logs usually have a meaningful order or sequence of
- * important content changes. @Since: ATK-2.12
+ * important content changes. (Since: 2.12)
*@ATK_ROLE_MATH: A text widget or container that holds a mathematical
- * expression. @Since: ATK-2.12
+ * expression. (Since: 2.12)
*@ATK_ROLE_RATING: A widget whose purpose is to display a rating,
* such as the number of stars associated with a song in a media
* player. Objects of this role should also implement
- * AtkValue. @Since: ATK-2.12
+ * AtkValue. (Since: 2.12)
*@ATK_ROLE_TIMER: An object containing a numerical counter which
* indicates an amount of elapsed time from a start point, or the time
- * remaining until an end point. @Since: ATK-2.12
+ * remaining until an end point. (Since: 2.12)
*@ATK_ROLE_DESCRIPTION_LIST: An object that represents a list of
* term-value groups. A term-value group represents a individual
* description and consist of one or more names
* (ATK_ROLE_DESCRIPTION_TERM) followed by one or more values
* (ATK_ROLE_DESCRIPTION_VALUE). For each list, there should not be
- * more than one group with the same term name. @Since: ATK-2.12
+ * more than one group with the same term name. (Since: 2.12)
*@ATK_ROLE_DESCRIPTION_TERM: An object that represents a term or phrase
- * with a corresponding definition. @Since: ATK-2.12
+ * with a corresponding definition. (Since: 2.12)
*@ATK_ROLE_DESCRIPTION_VALUE: An object that represents the
- * description, definition or value of a term. @Since: ATK-2.12
+ * description, definition or value of a term. (Since: 2.12)
*@ATK_ROLE_STATIC: A generic non-container object whose purpose is to display a
* brief amount of information to the user and whose role is known by the
* implementor but lacks semantic value for the user. Examples in which
- * ATK_ROLE_STATIC is appropriate include the message displayed in a message box
- * and an image used as an alternative means to display text. ATK_ROLE_STATIC
+ * %ATK_ROLE_STATIC is appropriate include the message displayed in a message box
+ * and an image used as an alternative means to display text. %ATK_ROLE_STATIC
* should not be applied to widgets which are traditionally interactive, objects
* which display a significant amount of content, or any object which has an
* accessible relation pointing to another object. Implementors should expose the
* displayed information through the accessible name of the object. If doing so seems
* inappropriate, it may indicate that a different role should be used. For
- * labels which describe another widget, see ATK_ROLE_LABEL. For text views, see
- * ATK_ROLE_TEXT. For generic containers, see ATK_ROLE_PANEL. For objects whose
- * role is not known by the implementor, see ATK_ROLE_UNKNOWN. @Since: ATK-2.16.
+ * labels which describe another widget, see %ATK_ROLE_LABEL. For text views, see
+ * %ATK_ROLE_TEXT. For generic containers, see %ATK_ROLE_PANEL. For objects whose
+ * role is not known by the implementor, see %ATK_ROLE_UNKNOWN. (Since: 2.16)
*@ATK_ROLE_MATH_FRACTION: An object that represents a mathematical fraction.
- * @Since: ATK-2.16.
+ * (Since: 2.16)
*@ATK_ROLE_MATH_ROOT: An object that represents a mathematical expression
- * displayed with a radical. @Since: ATK-2.16.
+ * displayed with a radical. (Since: 2.16)
*@ATK_ROLE_SUBSCRIPT: An object that contains text that is displayed as a
- * subscript. @Since: ATK-2.16.
+ * subscript. (Since: 2.16)
*@ATK_ROLE_SUPERSCRIPT: An object that contains text that is displayed as a
- * superscript. @Since: ATK-2.16.
- *@ATK_ROLE_FOOTNOTE: An object that contains the text of a footnote. @Since: ATK-2.26.
+ * superscript. (Since: 2.16)
+ *@ATK_ROLE_FOOTNOTE: An object that contains the text of a footnote. (Since: 2.26)
*@ATK_ROLE_CONTENT_DELETION: Content previously deleted or proposed to be
* deleted, e.g. in revision history or a content view providing suggestions
- * from reviewers. @Since: ATK-2.34.
+ * from reviewers. (Since: 2.34)
*@ATK_ROLE_CONTENT_INSERTION: Content previously inserted or proposed to be
* inserted, e.g. in revision history or a content view providing suggestions
- * from reviewers. @Since: ATK-2.34.
+ * from reviewers. (Since: 2.34)
*@ATK_ROLE_LAST_DEFINED: not a valid role, used for finding end of the enumeration
*
* Describes the role of an object
*
- * These are the built-in enumerated roles that UI components can have in
- * ATK. Other roles may be added at runtime, so an AtkRole >=
- * ATK_ROLE_LAST_DEFINED is not necessarily an error.
- **/
+ * These are the built-in enumerated roles that UI components can have
+ * in ATK. Other roles may be added at runtime, so an AtkRole >=
+ * %ATK_ROLE_LAST_DEFINED is not necessarily an error.
+ */
typedef enum
{
ATK_ROLE_INVALID = 0,
diff --git a/atk/atkplug.c b/atk/atkplug.c
index ba6f122..ceb3e5d 100644
--- a/atk/atkplug.c
+++ b/atk/atkplug.c
@@ -40,6 +40,10 @@ G_DEFINE_TYPE_WITH_CODE (AtkPlug, atk_plug, ATK_TYPE_OBJECT,
static void
atk_plug_init (AtkPlug* obj)
{
+ AtkObject *accessible = ATK_OBJECT (obj);
+
+ accessible->role = ATK_ROLE_FILLER;
+ accessible->layer = ATK_LAYER_WIDGET;
}
static void
@@ -53,18 +57,19 @@ atk_component_interface_init (AtkComponentIface *iface)
{
}
-AtkObject*
+/**
+ * atk_plug_new:
+ *
+ * Creates a new #AtkPlug instance.
+ *
+ * Returns: (transfer full): the newly created #AtkPlug
+ *
+ * Since: 1.30
+ */
+AtkObject *
atk_plug_new (void)
{
- AtkObject* accessible;
-
- accessible = g_object_new (ATK_TYPE_PLUG, NULL);
- g_return_val_if_fail (accessible != NULL, NULL);
-
- accessible->role = ATK_ROLE_FILLER;
- accessible->layer = ATK_LAYER_WIDGET;
-
- return accessible;
+ return g_object_new (ATK_TYPE_PLUG, NULL);
}
/**
diff --git a/atk/atksocket.c b/atk/atksocket.c
index 2517b52..c8e03f7 100644
--- a/atk/atksocket.c
+++ b/atk/atksocket.c
@@ -62,7 +62,12 @@ G_DEFINE_TYPE_WITH_CODE (AtkSocket, atk_socket, ATK_TYPE_OBJECT,
static void
atk_socket_init (AtkSocket* obj)
{
+ AtkObject *accessible = ATK_OBJECT (obj);
+
obj->embedded_plug_id = NULL;
+
+ accessible->role = ATK_ROLE_FILLER;
+ accessible->layer = ATK_LAYER_WIDGET;
}
static void
@@ -86,22 +91,22 @@ atk_socket_finalize (GObject *_obj)
G_OBJECT_CLASS (atk_socket_parent_class)->finalize (_obj);
}
-static void atk_component_interface_init (AtkComponentIface *iface)
+static void
+atk_component_interface_init (AtkComponentIface *iface)
{
}
+/**
+ * atk_socket_new:
+ *
+ * Creates a new #AtkSocket.
+ *
+ * Returns: (transfer full): the newly created #AtkSocket instance
+ */
AtkObject*
atk_socket_new (void)
{
- AtkObject* accessible;
-
- accessible = g_object_new (ATK_TYPE_SOCKET, NULL);
- g_return_val_if_fail (accessible != NULL, NULL);
-
- accessible->role = ATK_ROLE_FILLER;
- accessible->layer = ATK_LAYER_WIDGET;
-
- return accessible;
+ return g_object_new (ATK_TYPE_SOCKET, NULL);
}
/**
diff --git a/atk/atkstate.h b/atk/atkstate.h
index 6a88567..b1094eb 100644
--- a/atk/atkstate.h
+++ b/atk/atkstate.h
@@ -79,14 +79,16 @@ G_BEGIN_DECLS
* notification given when the cached data becomes obsolete.
*@ATK_STATE_VERTICAL: Indicates the orientation of this object is vertical
*@ATK_STATE_VISIBLE: Indicates this object is visible, e.g. has been explicitly marked for exposure to the user.
- * @note: STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only
+ * **note**: %ATK_STATE_VISIBLE is no guarantee that the object is actually unobscured on the screen, only
* that it is 'potentially' visible, barring obstruction, being scrolled or clipped out of the
* field of view, or having an ancestor container that has not yet made visible.
- * A widget is potentially onscreen if it has both STATE_VISIBLE and STATE_SHOWING.
- * The absence of STATE_VISIBLE and STATE_SHOWING is semantically equivalent to saying
- * that an object is 'hidden'. See also STATE_TRUNCATED, which applies if a VISIBLE and SHOWING object
- * lies within a viewport which means that its contents are clipped, e.g. a truncated spreadsheet cell or
- * an image within a scrolling viewport. Mostly useful for screen-review and magnification algorithms.
+ * A widget is potentially onscreen if it has both %ATK_STATE_VISIBLE and %ATK_STATE_SHOWING.
+ * The absence of %ATK_STATE_VISIBLE and %ATK_STATE_SHOWING is semantically equivalent to saying
+ * that an object is 'hidden'. See also %ATK_STATE_TRUNCATED, which applies if an object with
+ * %ATK_STATE_VISIBLE and %ATK_STATE_SHOWING set lies within a viewport which means that its
+ * contents are clipped, e.g. a truncated spreadsheet cell or
+ * an image within a scrolling viewport. Mostly useful for screen-review and magnification
+ * algorithms.
*@ATK_STATE_MANAGES_DESCENDANTS: Indicates that "active-descendant-changed" event
* is sent when children become 'active' (i.e. are selected or navigated to onscreen).
* Used to prevent need to enumerate all children in very large containers, like tables.
@@ -117,7 +119,7 @@ G_BEGIN_DECLS
*@ATK_STATE_SELECTABLE_TEXT:Indicates that the object in question supports text selection. It should only be exposed on objects which implement the Text interface, in order to distinguish this state from @ATK_STATE_SELECTABLE, which infers that the object in question is a selectable child of an object which implements Selection. While similar, text selection and subelement selection are distinct operations.
*@ATK_STATE_DEFAULT: Indicates that the object is the "default" active component, i.e. the object which is activated by an end-user press of the "Enter" or "Return" key. Typically a "close" or "submit" button.
*@ATK_STATE_ANIMATED: Indicates that the object changes its appearance dynamically as an inherent part of its presentation. This state may come and go if an object is only temporarily animated on the way to a 'final' onscreen presentation.
- * @note some applications, notably content viewers, may not be able to detect
+ * **note**: some applications, notably content viewers, may not be able to detect
* all kinds of animated content. Therefore the absence of this state should not
* be taken as definitive evidence that the object's visual representation is
* static; this state is advisory.
diff --git a/atk/atktablecell.h b/atk/atktablecell.h
index 53d0dd7..5fd19d2 100644
--- a/atk/atktablecell.h
+++ b/atk/atktablecell.h
@@ -42,24 +42,30 @@ typedef struct _AtkTableCellIface AtkTableCellIface;
/**
* AtkTableCellIface:
* @get_column_span: virtual function that returns the number of
- * columns occupied by this cell accessible. @Since: 2.12
+ * columns occupied by this cell accessible
* @get_column_header_cells: virtual function that returns the column
- * headers as an array of cell accessibles. @Since: 2.12
+ * headers as an array of cell accessibles
* @get_position: virtual function that retrieves the tabular position
- * of this cell. @Since: 2.12
+ * of this cell
* @get_row_span: virtual function that returns the number of rows
- * occupied by this cell. @Since: 2.12
+ * occupied by this cell
* @get_row_header_cells: virtual function that returns the row
- * headers as an array of cell accessibles. @Since: 2.12
+ * headers as an array of cell accessibles
* @get_row_column_span: virtual function that get the row an column
- * indexes and span of this cell. @Since: 2.12
+ * indexes and span of this cell
* @get_table: virtual function that returns a reference to the
- * accessible of the containing table. @Since: 2.12
+ * accessible of the containing table
+ *
+ * AtkTableCell is an interface for cells inside an #AtkTable.
+ *
+ * Since: 2.12
*/
struct _AtkTableCellIface
{
+ /*< private >*/
GTypeInterface parent;
+ /*< public >*/
gint (*get_column_span) (AtkTableCell *cell);
GPtrArray * (*get_column_header_cells) (AtkTableCell *cell);
gboolean (*get_position) (AtkTableCell *cell,
diff --git a/atk/atkutil.c b/atk/atkutil.c
index be9b983..f5efa59 100644
--- a/atk/atkutil.c
+++ b/atk/atkutil.c
@@ -158,13 +158,14 @@ atk_add_focus_tracker (AtkEventListener focus_tracker)
* atk_remove_focus_tracker:
* @tracker_id: the id of the focus tracker to remove
*
- * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
- * to be implemented by ATK itself. If you need focus tracking on your
- * implementation, subscribe to the #AtkObject::state-change "focused" signal.
- *
* Removes the specified focus tracker from the list of functions
* to be called when any object receives focus.
- **/
+ *
+ * Deprecated: 2.9.4: Focus tracking has been dropped as a feature
+ * to be implemented by ATK itself. If you need focus tracking on your
+ * implementation, subscribe to the #AtkObject::state-change "focused"
+ * signal.
+ */
void
atk_remove_focus_tracker (guint tracker_id)
{
diff --git a/atk/meson.build b/atk/meson.build
index 1d2a49c..4760df8 100644
--- a/atk/meson.build
+++ b/atk/meson.build
@@ -34,7 +34,6 @@ atk_sources = [
]
atk_headers = [
- 'atk.h',
'atkaction.h',
'atkcomponent.h',
'atkdocument.h',
@@ -43,12 +42,13 @@ atk_headers = [
'atkhyperlink.h',
'atkhyperlinkimpl.h',
'atkhypertext.h',
+ 'atkimage.h',
+ 'atkmisc.h',
'atknoopobject.h',
'atknoopobjectfactory.h',
'atkobject.h',
'atkobjectfactory.h',
'atkplug.h',
- 'atkimage.h',
'atkrange.h',
'atkregistry.h',
'atkrelation.h',
@@ -63,12 +63,11 @@ atk_headers = [
'atktablecell.h',
'atktext.h',
'atkutil.h',
- 'atkmisc.h',
'atkvalue.h',
'atkwindow.h',
]
-install_headers(atk_headers, subdir: atk_api_path)
+install_headers(atk_headers + ['atk.h'], subdir: atk_api_path)
# Features header
atk_version_conf = configuration_data()
@@ -81,24 +80,26 @@ atk_version_conf.set('LT_CURRENT_MINUS_AGE', '0')
atk_version_conf.set('ATK_VERSION', meson.project_version())
atk_version_h = configure_file(input: 'atkversion.h.in',
- output: 'atkversion.h',
- configuration: atk_version_conf,
- install: true,
- install_dir: join_paths(atk_includedir, atk_api_path))
+ output: 'atkversion.h',
+ configuration: atk_version_conf,
+ install_dir: join_paths(atk_includedir, atk_api_path),
+)
# Marshallers
atk_marshals = gnome.genmarshal('atkmarshal',
- sources: 'atkmarshal.list',
- prefix: 'atk_marshal')
+ sources: 'atkmarshal.list',
+ prefix: 'atk_marshal',
+)
atk_marshal_h = atk_marshals[1]
# Enumerations for GType
atk_enums = gnome.mkenums('atk-enum-types',
- sources: atk_headers,
- c_template: 'atk-enum-types.c.template',
- h_template: 'atk-enum-types.h.template',
- install_dir: join_paths(atk_includedir, atk_api_path),
- install_header: true)
+ sources: atk_headers,
+ c_template: 'atk-enum-types.c.template',
+ h_template: 'atk-enum-types.h.template',
+ install_dir: join_paths(atk_includedir, atk_api_path),
+ install_header: true,
+)
atk_enum_h = atk_enums[1]
atk_cflags = [
@@ -120,36 +121,46 @@ if host_system == 'windows'
atk_sources += atk_win_res
endif
-atk_inc = include_directories('.')
-
-libatk = library('atk-@0@'.format(atk_api_version),
- sources: atk_sources + atk_enums + atk_marshals,
- soversion: atk_soversion,
- version: atk_libversion,
- install: true,
- dependencies: glib_dep,
- include_directories: [ root_inc, atk_inc ],
- c_args: common_cflags + atk_cflags,
- link_args: common_ldflags)
+libatk = library(atk_api_name,
+ sources: atk_sources + atk_enums + atk_marshals,
+ soversion: atk_soversion,
+ version: atk_libversion,
+ install: true,
+ dependencies: glib_dep,
+ include_directories: [ root_inc, atk_inc ],
+ c_args: common_cflags + atk_cflags,
+ link_args: common_ldflags,
+)
-libatk_dep = declare_dependency(link_with: libatk,
- include_directories: [atk_inc, root_inc],
- dependencies: glib_dep,
- sources: atk_enum_h)
+atk_sources_dep = [ atk_enum_h ]
if get_option('introspection')
- gnome.generate_gir(libatk,
- sources: atk_sources + atk_headers + [ atk_enum_h ] + [ atk_version_h ],
- namespace: 'Atk',
- nsversion: atk_api_version,
- identifier_prefix: 'Atk',
- symbol_prefix: 'atk',
- export_packages: 'atk',
- includes: [ 'GObject-2.0' ],
- install: true,
- extra_args: [
- '--quiet',
- '--c-include=atk/atk.h',
- '-DATK_COMPILATION',
- ])
+ atk_sources_dep += gnome.generate_gir(libatk,
+ sources: atk_sources + atk_headers + [ atk_enum_h ] + [ atk_version_h ],
+ namespace: 'Atk',
+ nsversion: atk_api_version,
+ identifier_prefix: 'Atk',
+ symbol_prefix: 'atk',
+ export_packages: 'atk',
+ includes: [ 'GObject-2.0' ],
+ install: true,
+ extra_args: [
+ '--quiet',
+ '--c-include=atk/atk.h',
+ '-DATK_COMPILATION',
+ ],
+ )
endif
+
+libatk_dep = declare_dependency(link_with: libatk,
+ include_directories: atk_inc,
+ dependencies: glib_dep,
+ sources: atk_sources_dep,
+)
+
+pkgconfig.generate(libatk,
+ name: 'Atk',
+ description: 'Accessibility Toolkit',
+ subdirs: atk_api_name,
+ filebase: 'atk',
+)
diff --git a/docs/atk-sections.txt b/docs/atk-sections.txt
index 3639286..6bf2bfb 100644
--- a/docs/atk-sections.txt
+++ b/docs/atk-sections.txt
@@ -1,3 +1,5 @@
+<INCLUDE>atk/atk.h</INCLUDE>
+
<SECTION>
<FILE>atkaction</FILE>
<TITLE>AtkAction</TITLE>
@@ -39,6 +41,7 @@ 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>
@@ -46,9 +49,11 @@ 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>
@@ -411,7 +416,6 @@ atk_table_cell_get_row_header_cells
atk_table_cell_get_row_column_span
atk_table_cell_get_table
<SUBSECTION Standard>
-AtkTableCellIface
ATK_TABLE_CELL
ATK_IS_TABLE_CELL
ATK_TYPE_TABLE_CELL
@@ -479,6 +483,7 @@ atk_text_range_get_type
<FILE>atkvalue</FILE>
<TITLE>AtkValue</TITLE>
AtkValue
+AtkValueType
atk_value_get_current_value
atk_value_get_maximum_value
atk_value_get_minimum_value
@@ -489,6 +494,8 @@ 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
@@ -496,6 +503,8 @@ 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>
@@ -572,7 +581,6 @@ ATK_STREAMABLE_CONTENT_GET_IFACE
<FILE>atkutil</FILE>
<TITLE>AtkUtil</TITLE>
AtkUtil
-AtkUtilClass
AtkCoordType
atk_add_focus_tracker
atk_remove_focus_tracker
@@ -712,17 +720,66 @@ 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_TYPE_RANGE
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/docs/atk.types b/docs/atk.types
deleted file mode 100644
index e1a33e4..0000000
--- a/docs/atk.types
+++ /dev/null
@@ -1,28 +0,0 @@
-#include <atk/atk.h>
-
-atk_action_get_type
-atk_component_get_type
-atk_document_get_type
-atk_editable_text_get_type
-atk_gobject_accessible_get_type
-atk_hyperlink_get_type
-atk_hypertext_get_type
-atk_image_get_type
-atk_implementor_get_type
-atk_misc_get_type
-atk_no_op_object_get_type
-atk_no_op_object_factory_get_type
-atk_object_get_type
-atk_object_factory_get_type
-atk_registry_get_type
-atk_relation_get_type
-atk_relation_set_get_type
-atk_selection_get_type
-atk_state_set_get_type
-atk_streamable_content_get_type
-atk_table_get_type
-atk_table_cell_get_type
-atk_text_get_type
-atk_util_get_type
-atk_value_get_type
-atk_window_get_type \ No newline at end of file
diff --git a/docs/meson.build b/docs/meson.build
index fb26d40..d6b9c8a 100644
--- a/docs/meson.build
+++ b/docs/meson.build
@@ -5,37 +5,28 @@ private_headers = [
'atkintl.h',
]
-content_files = [
-]
-
-html_images = [
-]
-
glib_prefix = dependency('glib-2.0').get_pkgconfig_variable('prefix')
glib_docpath = join_paths(glib_prefix, 'share', 'gtk-doc', 'html')
docpath = join_paths(atk_datadir, 'gtk-doc', 'html')
gnome.gtkdoc('atk',
- main_xml: 'atk-docs.xml',
- src_dir: [
- join_paths(meson.source_root(), 'atk'),
- join_paths(meson.build_root(), 'atk'),
- ],
- 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')),
- ],
- html_assets: html_images,
- install: true)
+ 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/docs/xml/meson.build b/docs/xml/meson.build
index 91280ef..2a6a1f0 100644
--- a/docs/xml/meson.build
+++ b/docs/xml/meson.build
@@ -1,10 +1,14 @@
ent_conf = configuration_data()
ent_conf.set('PACKAGE', meson.project_name())
-ent_conf.set('PACKAGE_BUGREPORT', 'https://bugzilla.gnome.org/enter_bug.cgi?product=atk')
+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)
+configure_file(
+ input: 'gtkdocentities.ent.in',
+ output: 'gtkdocentities.ent',
+ configuration: ent_conf,
+)
diff --git a/meson.build b/meson.build
index 3fec277..f25c6c0 100644
--- a/meson.build
+++ b/meson.build
@@ -20,7 +20,8 @@ atk_interface_age = 1
atk_binary_age = 10000 * atk_major_version + 100 * atk_minor_version + 10 + atk_micro_version
atk_api_version = '1.0'
-atk_api_path = 'atk-@0@/atk'.format(atk_api_version)
+atk_api_name = 'atk-@0@'.format(atk_api_version)
+atk_api_path = '@0@/atk'.format(atk_api_name)
atk_prefix = get_option('prefix')
atk_libdir = join_paths(atk_prefix, get_option('libdir'))
@@ -99,30 +100,14 @@ glib_dep = [dependency('glib-2.0', version: glib_req_version,
dependency('gobject-2.0', version: glib_req_version,
fallback : ['glib', 'libgobject_dep'])]
-# Compat variables for pkgconfig
-pkgconf = configuration_data()
-pkgconf.set('prefix', atk_prefix)
-pkgconf.set('exec_prefix', atk_prefix)
-pkgconf.set('libdir', atk_libdir)
-pkgconf.set('includedir', atk_includedir)
-pkgconf.set('VERSION', meson.project_version())
-pkgconf.set('ATK_API_VERSION', atk_api_version)
-pkgconf.set('srcdir', '.')
-
-foreach pkg: [ 'atk.pc', ]
- configure_file(input: pkg + '.in',
- output: pkg,
- configuration: pkgconf,
- install: true,
- install_dir: join_paths(atk_libdir, 'pkgconfig'))
-endforeach
-
+pkgconfig = import('pkgconfig')
gnome = import('gnome')
# Internal configuration header
configure_file(output: 'config.h', configuration: atk_conf)
root_inc = include_directories('.')
+atk_inc = include_directories('atk')
subdir('atk')
subdir('tests')
diff --git a/tests/meson.build b/tests/meson.build
index 1fbb992..7c1f3ab 100644
--- a/tests/meson.build
+++ b/tests/meson.build
@@ -6,15 +6,20 @@ tests = [
'testvalue',
]
-foreach t: tests
- bin = executable(t, t + '.c',
- dependencies: libatk_dep,
- include_directories: root_inc,
- c_args: common_cflags + [
- '-DG_DISABLE_DEPRECATED',
- ])
- test(t, bin, env: [
- 'G_TEST_SRCDIR=@0@'.format(meson.current_source_dir()),
- 'G_TEST_BUILDDIR=@0@'.format(meson.current_build_dir()),
- ])
+foreach test_name: tests
+ test_src = test_name + '.c'
+ test_bin = executable(test_name, test_src,
+ dependencies: libatk_dep,
+ include_directories: root_inc,
+ c_args: common_cflags + [
+ '-DG_DISABLE_DEPRECATED',
+ ],
+ )
+
+ test(test_name, test_bin,
+ env: [
+ 'G_TEST_SRCDIR=@0@'.format(meson.current_source_dir()),
+ 'G_TEST_BUILDDIR=@0@'.format(meson.current_build_dir()),
+ ],
+ )
endforeach