[atkmm] Regenerate docs.xml and .defs files

From: Kjell Ahlstedt <kjellahl src gnome org>
To: commits-list gnome org
Cc:
Subject: [atkmm] Regenerate docs.xml and .defs files
Date: Sat, 19 Dec 2020 08:20:34 +0000 (UTC)
commit b8638b7d725a5e4cd1d29789048adf8acbe8b216
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Sat Dec 19 09:18:26 2020 +0100

    Regenerate docs.xml and .defs files

 atk/src/atk_docs.xml     | 135 ++++++++++++++++++++++++++++++++++++++---------
 atk/src/atk_enums.defs   |  10 +++-
 atk/src/atk_methods.defs |  18 ++++++-
 3 files changed, 134 insertions(+), 29 deletions(-)
---
diff --git a/atk/src/atk_docs.xml b/atk/src/atk_docs.xml
index c4c26dc..230d2fd 100644
--- a/atk/src/atk_docs.xml
+++ b/atk/src/atk_docs.xml
@@ -1149,6 +1149,24 @@ inserted, e.g. in revision history or a content view providing suggestions
 from reviewers. (Since: 2.34)
 </parameter_description>
 </parameter>
+<parameter name="ATK_ROLE_MARK">
+<parameter_description> A run of content that is marked or highlighted, such as for
+reference purposes, or to call it out as having a special purpose. If the
+marked content has an associated section in the document elaborating on the
+reason for the mark, then %ATK_RELATION_DETAILS should be used on the mark
+to point to that associated section. In addition, the reciprocal relation
+%ATK_RELATION_DETAILS_FOR should be used on the associated content section
+to point back to the mark. (Since: 2.36)
+</parameter_description>
+</parameter>
+<parameter name="ATK_ROLE_SUGGESTION">
+<parameter_description> A container for content that is called out as a proposed
+change from the current version of the document, such as by a reviewer of the
+content. This role should include either %ATK_ROLE_CONTENT_DELETION and/or
+%ATK_ROLE_CONTENT_INSERTION children, in any order, to indicate what the
+actual change is. (Since: 2.36)
+</parameter_description>
+</parameter>
 <parameter name="ATK_ROLE_LAST_DEFINED">
 <parameter_description> not a valid role, used for finding end of the enumeration
 </parameter_description>
@@ -1165,33 +1183,33 @@ Since: 2.30
 </description>
 <parameters>
 <parameter name="ATK_SCROLL_TOP_LEFT">
-<parameter_description> Scroll the object vertically and horizontally to the top
-left corner of the window.
+<parameter_description> Scroll the object vertically and horizontally to bring
+its top left corner to the top left corner of the window.
 </parameter_description>
 </parameter>
 <parameter name="ATK_SCROLL_BOTTOM_RIGHT">
-<parameter_description> Scroll the object vertically and horizontally to the
-bottom right corner of the window.
+<parameter_description> Scroll the object vertically and horizontally to
+bring its bottom right corner to the bottom right corner of the window.
 </parameter_description>
 </parameter>
 <parameter name="ATK_SCROLL_TOP_EDGE">
-<parameter_description> Scroll the object vertically to the top edge of the
-window.
+<parameter_description> Scroll the object vertically to bring its top edge to
+the top edge of the window.
 </parameter_description>
 </parameter>
 <parameter name="ATK_SCROLL_BOTTOM_EDGE">
-<parameter_description> Scroll the object vertically to the bottom edge of
-the window.
+<parameter_description> Scroll the object vertically to bring its bottom
+edge to the bottom edge of the window.
 </parameter_description>
 </parameter>
 <parameter name="ATK_SCROLL_LEFT_EDGE">
-<parameter_description> Scroll the object vertically and horizontally to the
-left edge of the window.
+<parameter_description> Scroll the object vertically and horizontally to bring
+its left edge to the left edge of the window.
 </parameter_description>
 </parameter>
 <parameter name="ATK_SCROLL_RIGHT_EDGE">
-<parameter_description> Scroll the object vertically and horizontally to the
-right edge of the window.
+<parameter_description> Scroll the object vertically and horizontally to
+bring its right edge to the right edge of the window.
 </parameter_description>
 </parameter>
 <parameter name="ATK_SCROLL_ANYWHERE">
@@ -1795,7 +1813,7 @@ Describes the text attributes supported
 </parameter_description>
 </parameter>
 <parameter name="ATK_TEXT_ATTR_RISE">
-<parameter_description> Number of pixels that the characters are risen above the baseline
+<parameter_description> Number of pixels that the characters are risen above the baseline. See also 
ATK_TEXT_ATTR_TEXT_POSITION.
 </parameter_description>
 </parameter>
 <parameter name="ATK_TEXT_ATTR_UNDERLINE">
@@ -1866,6 +1884,10 @@ Describes the text attributes supported
 <parameter_description> The slant style of the text, if set. Values are &quot;normal&quot;, 
&quot;oblique&quot; or &quot;italic&quot;
 </parameter_description>
 </parameter>
+<parameter name="ATK_TEXT_ATTR_TEXT_POSITION">
+<parameter_description> The vertical position with respect to the baseline. Values are &quot;baseline&quot;, 
&quot;super&quot;, or &quot;sub&quot;. Note that a super or sub text attribute refers to position with 
respect to the baseline of the prior character.
+</parameter_description>
+</parameter>
 <parameter name="ATK_TEXT_ATTR_LAST_DEFINED">
 <parameter_description> not a valid text attribute, used for finding end of enumeration
 </parameter_description>
@@ -2550,6 +2572,9 @@ Since: 1.12
 <description>
 Gets the rectangle which gives the extent of the @component.
 
+If the extent can not be obtained (e.g. a non-embedded plug or missing
+support), all of x, y, width, height are set to -1.
+
 
 </description>
 <parameters>
@@ -2622,6 +2647,9 @@ container.
 Gets the position of @component in the form of 
 a point specifying @component's top-left corner.
 
+If the position can not be obtained (e.g. a non-embedded plug or missing
+support), x and y are set to -1.
+
 Deprecated: Since 2.12. Use atk_component_get_extents() instead.
 
 </description>
@@ -2651,6 +2679,9 @@ or to the components top level window
 <description>
 Gets the size of the @component in terms of width and height.
 
+If the size can not be obtained (e.g. a non-embedded plug or missing
+support), width and height are set to -1.
+
 Deprecated: Since 2.12. Use atk_component_get_extents() instead.
 
 </description>
@@ -2771,8 +2802,8 @@ Since: 2.30
 
 <function name="atk_component_scroll_to_point">
 <description>
-Makes an object visible on the screen at a given position by scrolling all
-necessary parents.
+Move the top-left of @component to a given position of the screen by
+scrolling all necessary parents.
 
 Since: 2.30
 
@@ -3764,6 +3795,9 @@ Since: 1.12
 Gets the position of the image in the form of a point specifying the
 images top-left corner.
 
+If the position can not be obtained (e.g. missing support), x and y are set
+to -1.
+
 </description>
 <parameters>
 <parameter name="image">
@@ -3793,6 +3827,9 @@ Get the width and height in pixels for the specified image.
 The values of @width and @height are returned as -1 if the
 values cannot be obtained (for instance, if the object is not onscreen).
 
+If the size can not be obtained (e.g. missing support), x and y are set
+to -1.
+
 </description>
 <parameters>
 <parameter name="image">
@@ -4576,6 +4613,34 @@ Since: 1.30
 </return>
 </function>
 
+<function name="atk_plug_set_child">
+<description>
+Sets @child as accessible child of @plug and @plug as accessible parent of
+@child. @child can be NULL.
+
+In some cases, one can not use the AtkPlug type directly as accessible
+object for the toplevel widget of the application. For instance in the gtk
+case, GtkPlugAccessible can not inherit both from GtkWindowAccessible and
+from AtkPlug. In such a case, one can create, in addition to the standard
+accessible object for the toplevel widget, an AtkPlug object, and make the
+former the child of the latter by calling atk_plug_set_child().
+
+Since: 2.35.0
+
+</description>
+<parameters>
+<parameter name="plug">
+<parameter_description> an #AtkPlug to be set as accessible parent of @child.
+</parameter_description>
+</parameter>
+<parameter name="child">
+<parameter_description> an #AtkObject to be set as accessible child of @plug.
+</parameter_description>
+</parameter>
+</parameters>
+<return></return>
+</function>
+
 <function name="atk_range_copy">
 <description>
 Returns a new #AtkRange that is a exact copy of @src
@@ -6806,6 +6871,9 @@ Gets the character count.
 
 <function name="atk_text_get_character_extents">
 <description>
+If the extent can not be obtained (e.g. missing support), all of x, y, width,
+height are set to -1.
+
 Get the bounding box containing the glyph representing the character at 
 a particular text offset. 
 
@@ -6916,6 +6984,9 @@ widget window
 <description>
 Get the bounding box for text within the specified range.
 
+If the extents can not be obtained (e.g. or missing support), the rectangle
+fields are set to -1.
+
 Since: 1.3
 
 </description>
@@ -7272,11 +7343,7 @@ moving or deleting a selected region can change the numbering.
 
 <function name="atk_text_scroll_substring_to">
 <description>
-Makes @text visible on the screen by scrolling all necessary parents.
-
-Contrary to atk_text_set_position, this does not actually move
-@text in its parent, this only makes the parents scroll so that the
-object shows up on the screen, given its current position within the parents.
+Makes a substring of @text visible on the screen by scrolling all necessary parents.
 
 Since: 2.32
 
@@ -7288,11 +7355,11 @@ Since: 2.32
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> start position
+<parameter_description> start offset in the @text
 </parameter_description>
 </parameter>
 <parameter name="end_offset">
-<parameter_description> end position, or -1 for the end of the string.
+<parameter_description> end offset in the @text, or -1 for the end of the text.
 </parameter_description>
 </parameter>
 <parameter name="type">
@@ -7306,8 +7373,8 @@ Since: 2.32
 
 <function name="atk_text_scroll_substring_to_point">
 <description>
-Makes an object visible on the screen at a given position by scrolling all
-necessary parents.
+Move the top-left of a substring of @text to a given position of the screen
+by scrolling all necessary parents.
 
 Since: 2.32
 
@@ -7319,11 +7386,11 @@ Since: 2.32
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> start position
+<parameter_description> start offset in the @text
 </parameter_description>
 </parameter>
 <parameter name="end_offset">
-<parameter_description> end position, or -1 for the end of the string.
+<parameter_description> end offset in the @text, or -1 for the end of the text.
 </parameter_description>
 </parameter>
 <parameter name="coords">
@@ -7348,6 +7415,22 @@ parent object.
 <description>
 Sets the caret (cursor) position to the specified @offset.
 
+In the case of rich-text content, this method should either grab focus
+or move the sequential focus navigation starting point (if the application
+supports this concept) as if the user had clicked on the new caret position.
+Typically, this means that the target of this operation is the node containing
+the new caret position or one of its ancestors. In other words, after this
+method is called, if the user advances focus, it should move to the first
+focusable node following the new caret position.
+
+Calling this method should also scroll the application viewport in a way
+that matches the behavior of the application's typical caret motion or tab
+navigation as closely as possible. This also means that if the application's
+caret motion or focus navigation does not trigger a scroll operation, this
+method should not trigger one either. If the application does not have a caret
+motion or focus navigation operation, this method should try to scroll the new
+caret position into view while minimizing unnecessary scroll motion.
+
 
 </description>
 <parameters>
diff --git a/atk/src/atk_enums.defs b/atk/src/atk_enums.defs
index 862e042..a43eb86 100644
--- a/atk/src/atk_enums.defs
+++ b/atk/src/atk_enums.defs
@@ -171,6 +171,8 @@
 ;;   ATK_ROLE_FOOTNOTE,
 ;;   ATK_ROLE_CONTENT_DELETION,
 ;;   ATK_ROLE_CONTENT_INSERTION,
+;;   ATK_ROLE_MARK,
+;;   ATK_ROLE_SUGGESTION,
 ;;   ATK_ROLE_LAST_DEFINED
 ;; } AtkRole;
 
@@ -303,7 +305,9 @@
     '("footnote" "ATK_ROLE_FOOTNOTE" "122")
     '("content-deletion" "ATK_ROLE_CONTENT_DELETION" "123")
     '("content-insertion" "ATK_ROLE_CONTENT_INSERTION" "124")
-    '("last-defined" "ATK_ROLE_LAST_DEFINED" "125")
+    '("mark" "ATK_ROLE_MARK" "125")
+    '("suggestion" "ATK_ROLE_SUGGESTION" "126")
+    '("last-defined" "ATK_ROLE_LAST_DEFINED" "127")
   )
 )
 
@@ -528,6 +532,7 @@
 ;;   ATK_TEXT_ATTR_STRETCH,
 ;;   ATK_TEXT_ATTR_VARIANT,
 ;;   ATK_TEXT_ATTR_STYLE,
+;;   ATK_TEXT_ATTR_TEXT_POSITION,
 ;;   ATK_TEXT_ATTR_LAST_DEFINED
 ;; } AtkTextAttribute;
 
@@ -563,7 +568,8 @@
     '("stretch" "ATK_TEXT_ATTR_STRETCH" "25")
     '("variant" "ATK_TEXT_ATTR_VARIANT" "26")
     '("style" "ATK_TEXT_ATTR_STYLE" "27")
-    '("last-defined" "ATK_TEXT_ATTR_LAST_DEFINED" "28")
+    '("text-position" "ATK_TEXT_ATTR_TEXT_POSITION" "28")
+    '("last-defined" "ATK_TEXT_ATTR_LAST_DEFINED" "29")
   )
 )
 
diff --git a/atk/src/atk_methods.defs b/atk/src/atk_methods.defs
index a831142..93909e2 100644
--- a/atk/src/atk_methods.defs
+++ b/atk/src/atk_methods.defs
@@ -344,6 +344,8 @@
     '("footnote" "ATK_ROLE_FOOTNOTE")
     '("content-deletion" "ATK_ROLE_CONTENT_DELETION")
     '("content-insertion" "ATK_ROLE_CONTENT_INSERTION")
+    '("mark" "ATK_ROLE_MARK")
+    '("suggestion" "ATK_ROLE_SUGGESTION")
     '("last-defined" "ATK_ROLE_LAST_DEFINED")
   )
 )
@@ -479,6 +481,7 @@
     '("stretch" "ATK_TEXT_ATTR_STRETCH")
     '("variant" "ATK_TEXT_ATTR_VARIANT")
     '("style" "ATK_TEXT_ATTR_STYLE")
+    '("text-position" "ATK_TEXT_ATTR_TEXT_POSITION")
     '("last-defined" "ATK_TEXT_ATTR_LAST_DEFINED")
   )
 )
@@ -640,6 +643,10 @@
 
 
 
+;; From atk-autocleanups.h
+
+
+
 ;; From atkcomponent.h
 
 (define-function atk_rectangle_get_type
@@ -1483,6 +1490,15 @@
   (return-type "AtkObject*")
 )
 
+(define-method set_child
+  (of-object "AtkPlug")
+  (c-name "atk_plug_set_child")
+  (return-type "none")
+  (parameters
+    '("AtkObject*" "child")
+  )
+)
+
 (define-method get_id
   (of-object "AtkPlug")
   (c-name "atk_plug_get_id")
@@ -1830,7 +1846,7 @@
   (c-name "atk_socket_embed")
   (return-type "none")
   (parameters
-    '("gchar*" "plug_id")
+    '("const-gchar*" "plug_id")
   )
 )
[Date Prev][Date Next] [Thread Prev][Thread Next] [Thread Index] [Date Index] [Author Index]