GNOME.org
 

[atkmm] Regenerate .defs and docs.xml files

commit 417b06f91f66f9b62fff680948460e431e5a49cd
Author: Kjell Ahlstedt <kjellahlstedt gmail com>
Date:   Thu Nov 1 16:48:18 2018 +0100

    Regenerate .defs and docs.xml files
    
    and update atk_docs_override.xml.

 atk/src/atk_docs.xml          | 159 ++++++++++++++++++++++++++++++++++++------
 atk/src/atk_docs_override.xml |   1 +
 atk/src/atk_enums.defs        |  31 +++++++-
 atk/src/atk_methods.defs      |  41 +++++++++++
 atk/src/atk_signals.defs      |   4 +-
 5 files changed, 210 insertions(+), 26 deletions(-)
---
diff --git a/atk/src/atk_docs.xml b/atk/src/atk_docs.xml
index 7969461..05dfbba 100644
--- a/atk/src/atk_docs.xml
+++ b/atk/src/atk_docs.xml
@@ -30,10 +30,15 @@ as atk_component_get_position() and atk_text_get_character_extents()
 </parameter_description>
 </parameter>
 <parameter name="ATK_XY_WINDOW">
-<parameter_description> specifies xy coordinates relative to the widget's 
+<parameter_description> specifies xy coordinates relative to the widget's
 top-level window
 </parameter_description>
 </parameter>
+<parameter name="ATK_XY_PARENT">
+<parameter_description> specifies xy coordinates relative to the widget's
+immediate parent. Since: 2.30
+</parameter_description>
+</parameter>
 </parameters>
 </enum>
 
@@ -337,8 +342,8 @@ notify doesn't support emission hooks.
 </parameter_description>
 </parameter>
 <parameter name="arg1">
-<parameter_description> an #AtkPropertyValues containing the new value of the
-property which changed.
+<parameter_description> an #AtkPropertyValues containing the new
+value of the property which changed.
 </parameter_description>
 </parameter>
 </parameters>
@@ -570,6 +575,53 @@ ATK_2.26.
 </parameters>
 </enum>
 
+<enum name="AtkScrollType">
+<description>
+Specifies where an object should be placed on the screen when using scroll_to.
+
+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>
+</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>
+</parameter>
+<parameter name="ATK_SCROLL_TOP_EDGE">
+<parameter_description> Scroll the object vertically 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>
+</parameter>
+<parameter name="ATK_SCROLL_LEFT_EDGE">
+<parameter_description> Scroll the object vertically and horizontally 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>
+</parameter>
+<parameter name="ATK_SCROLL_ANYWHERE">
+<parameter_description> 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.
+</parameter_description>
+</parameter>
+</parameters>
+</enum>
+
 <signal name="AtkSelection::selection-changed">
 <description>
 The &quot;selection-changed&quot; signal is emitted by an object which
@@ -1858,6 +1910,64 @@ from @component
 <return></return>
 </function>
 
+<function name="atk_component_scroll_to">
+<description>
+Makes @component visible on the screen by scrolling all necessary parents.
+
+Contrary to atk_component_set_position, this does not actually move
+@component 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.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="component">
+<parameter_description> an #AtkComponent
+</parameter_description>
+</parameter>
+<parameter name="type">
+<parameter_description> specify where the object should be made visible.
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether scrolling was successful.
+
+</return>
+</function>
+
+<function name="atk_component_scroll_to_point">
+<description>
+Makes an object visible on the screen at a given position by scrolling all
+necessary parents.
+
+Since: 2.30
+
+</description>
+<parameters>
+<parameter name="component">
+<parameter_description> an #AtkComponent
+</parameter_description>
+</parameter>
+<parameter name="coords">
+<parameter_description> specify whether coordinates are relative to the screen or to the
+parent object.
+</parameter_description>
+</parameter>
+<parameter name="x">
+<parameter_description> x-position where to scroll to
+</parameter_description>
+</parameter>
+<parameter name="y">
+<parameter_description> y-position where to scroll to
+</parameter_description>
+</parameter>
+</parameters>
+<return> whether scrolling was successful.
+
+</return>
+</function>
+
 <function name="atk_component_set_extents">
 <description>
 Sets the extents of @component.
@@ -1897,7 +2007,10 @@ or to the components top level window
 
 <function name="atk_component_set_position">
 <description>
-Sets the postition of @component.
+Sets the position of @component.
+
+Contrary to atk_component_scroll_to, this does not trigger any scrolling,
+this just moves @component in its parent.
 
 
 </description>
@@ -1916,7 +2029,7 @@ Sets the postition of @component.
 </parameter>
 <parameter name="coord_type">
 <parameter_description> specifies whether the coordinates are relative to the screen
-or to the components top level window
+or to the component's top level window
 </parameter_description>
 </parameter>
 </parameters>
@@ -5584,7 +5697,7 @@ Adds a selection bounded by the specified offsets.
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> the start position of the selected region
+<parameter_description> the starting character offset of the selected region
 </parameter_description>
 </parameter>
 <parameter name="end_offset">
@@ -5724,7 +5837,7 @@ element of the array returned by this function will be NULL.
 
 <function name="atk_text_get_caret_offset">
 <description>
-Gets the offset position of the caret (cursor).
+Gets the offset of the position of the caret (cursor).
 
 
 </description>
@@ -5734,7 +5847,7 @@ Gets the offset position of the caret (cursor).
 </parameter_description>
 </parameter>
 </parameters>
-<return> the offset position of the caret (cursor).
+<return> the character offset of position of the caret (cursor).
 </return>
 </function>
 
@@ -5750,7 +5863,7 @@ Gets the specified text.
 </parameter_description>
 </parameter>
 <parameter name="offset">
-<parameter_description> position
+<parameter_description> a character offset within @text
 </parameter_description>
 </parameter>
 </parameters>
@@ -5790,11 +5903,11 @@ a particular text offset.
 </parameter_description>
 </parameter>
 <parameter name="x">
-<parameter_description> Pointer for the x cordinate of the bounding box
+<parameter_description> Pointer for the x coordinate of the bounding box
 </parameter_description>
 </parameter>
 <parameter name="y">
-<parameter_description> Pointer for the y cordinate of the bounding box
+<parameter_description> Pointer for the y coordinate of the bounding box
 </parameter_description>
 </parameter>
 <parameter name="width">
@@ -5935,7 +6048,7 @@ returned.
 </parameter_description>
 </parameter>
 <parameter name="offset">
-<parameter_description> the offset at which to get the attributes, -1 means the offset of
+<parameter_description> the character offset at which to get the attributes, -1 means the offset of
 the character to be inserted at the caret location.
 </parameter_description>
 </parameter>
@@ -5974,12 +6087,12 @@ moving or deleting a selected region can change the numbering.
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> passes back the start position of the selected region
+<parameter_description> passes back the starting character offset of the selected region
 </parameter_description>
 </parameter>
 <parameter name="end_offset">
-<parameter_description> passes back the end position of (e.g. offset immediately past)
-the selected region
+<parameter_description> passes back the ending character offset (offset immediately past)
+of the selected region
 </parameter_description>
 </parameter>
 </parameters>
@@ -6039,7 +6152,7 @@ Since: 2.10
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> the start offset of the returned string, or -1
+<parameter_description> the starting character offset of the returned string, or -1
 if an error has occurred (e.g. invalid offset, not implemented)
 </parameter_description>
 </parameter>
@@ -6068,11 +6181,11 @@ Gets the specified text.
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> start position
+<parameter_description> a starting character offset within @text
 </parameter_description>
 </parameter>
 <parameter name="end_offset">
-<parameter_description> end position, or -1 for the end of the string.
+<parameter_description> an ending character offset within @text, or -1 for the end of the string.
 </parameter_description>
 </parameter>
 </parameters>
@@ -6103,7 +6216,7 @@ Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> the start offset of the returned string
+<parameter_description> the starting character offset of the returned string
 </parameter_description>
 </parameter>
 <parameter name="end_offset">
@@ -6163,7 +6276,7 @@ Deprecated: This method is deprecated since ATK version
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> the start offset of the returned string
+<parameter_description> the starting character offset of the returned string
 </parameter_description>
 </parameter>
 <parameter name="end_offset">
@@ -6199,7 +6312,7 @@ Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> the start offset of the returned string
+<parameter_description> the starting character offset of the returned string
 </parameter_description>
 </parameter>
 <parameter name="end_offset">
@@ -6249,7 +6362,7 @@ Sets the caret (cursor) position to the specified @offset.
 </parameter_description>
 </parameter>
 <parameter name="offset">
-<parameter_description> position
+<parameter_description> the character offset of the new caret position
 </parameter_description>
 </parameter>
 </parameters>
@@ -6277,7 +6390,7 @@ moving or deleting a selected region can change the numbering.
 </parameter_description>
 </parameter>
 <parameter name="start_offset">
-<parameter_description> the new start position of the selection
+<parameter_description> the new starting character offset of the selection
 </parameter_description>
 </parameter>
 <parameter name="end_offset">
diff --git a/atk/src/atk_docs_override.xml b/atk/src/atk_docs_override.xml
index 071f6c3..ead0f9f 100644
--- a/atk/src/atk_docs_override.xml
+++ b/atk/src/atk_docs_override.xml
@@ -2,6 +2,7 @@
 <substitute_type_name from="GObject" to="Glib::Object" />
 <substitute_enumerator_name from_prefix="ATK_RELATION_" to_prefix="Atk::Relation::Type::" />
 <substitute_enumerator_name from="ATK_RELATION_NULL" to="Atk::Relation::Type::NONE" />
+<substitute_enumerator_name from_prefix="ATK_ROLE_" to_prefix="Atk::Role::" />
 <substitute_enumerator_name from_prefix="ATK_STATE_" to_prefix="Atk::StateType::" />
 <!-- These are preprocessor defines. Don't substitute. -->
 <substitute_enumerator_name from_prefix="ATK_ATTRIBUTE_" to_prefix="ATK_ATTRIBUTE_" />
diff --git a/atk/src/atk_enums.defs b/atk/src/atk_enums.defs
index d059ec2..b2e5a7d 100644
--- a/atk/src/atk_enums.defs
+++ b/atk/src/atk_enums.defs
@@ -1,3 +1,30 @@
+;; From atkcomponent.h
+
+;; Original typedef:
+;; typedef enum {
+;;   ATK_SCROLL_TOP_LEFT,
+;;   ATK_SCROLL_BOTTOM_RIGHT,
+;;   ATK_SCROLL_TOP_EDGE,
+;;   ATK_SCROLL_BOTTOM_EDGE,
+;;   ATK_SCROLL_LEFT_EDGE,
+;;   ATK_SCROLL_RIGHT_EDGE,
+;;   ATK_SCROLL_ANYWHERE
+;; } AtkScrollType;
+
+(define-enum-extended ScrollType
+  (in-module "Atk")
+  (c-name "AtkScrollType")
+  (values
+    '("top-left" "ATK_SCROLL_TOP_LEFT" "0")
+    '("bottom-right" "ATK_SCROLL_BOTTOM_RIGHT" "1")
+    '("top-edge" "ATK_SCROLL_TOP_EDGE" "2")
+    '("bottom-edge" "ATK_SCROLL_BOTTOM_EDGE" "3")
+    '("left-edge" "ATK_SCROLL_LEFT_EDGE" "4")
+    '("right-edge" "ATK_SCROLL_RIGHT_EDGE" "5")
+    '("anywhere" "ATK_SCROLL_ANYWHERE" "6")
+  )
+)
+
 ;; From atkhyperlink.h
 
 ;; Original typedef:
@@ -624,7 +651,8 @@
 ;; Original typedef:
 ;; typedef enum {
 ;;   ATK_XY_SCREEN,
-;;   ATK_XY_WINDOW
+;;   ATK_XY_WINDOW,
+;;   ATK_XY_PARENT
 ;; }AtkCoordType;
 
 (define-enum-extended CoordType
@@ -633,6 +661,7 @@
   (values
     '("screen" "ATK_XY_SCREEN" "0")
     '("window" "ATK_XY_WINDOW" "1")
+    '("parent" "ATK_XY_PARENT" "2")
   )
 )
 
diff --git a/atk/src/atk_methods.defs b/atk/src/atk_methods.defs
index 73541f9..8ca74f7 100644
--- a/atk/src/atk_methods.defs
+++ b/atk/src/atk_methods.defs
@@ -190,6 +190,21 @@
 
 ;; Enumerations and flags ...
 
+(define-enum ScrollType
+  (in-module "Atk")
+  (c-name "AtkScrollType")
+  (gtype-id "ATK_TYPE_SCROLL_TYPE")
+  (values
+    '("top-left" "ATK_SCROLL_TOP_LEFT")
+    '("bottom-right" "ATK_SCROLL_BOTTOM_RIGHT")
+    '("top-edge" "ATK_SCROLL_TOP_EDGE")
+    '("bottom-edge" "ATK_SCROLL_BOTTOM_EDGE")
+    '("left-edge" "ATK_SCROLL_LEFT_EDGE")
+    '("right-edge" "ATK_SCROLL_RIGHT_EDGE")
+    '("anywhere" "ATK_SCROLL_ANYWHERE")
+  )
+)
+
 (define-flags HyperlinkStateFlags
   (in-module "Atk")
   (c-name "AtkHyperlinkStateFlags")
@@ -524,6 +539,7 @@
   (values
     '("screen" "ATK_XY_SCREEN")
     '("window" "ATK_XY_WINDOW")
+    '("parent" "ATK_XY_PARENT")
   )
 )
 
@@ -766,6 +782,26 @@
   (return-type "gdouble")
 )
 
+(define-method scroll_to
+  (of-object "AtkComponent")
+  (c-name "atk_component_scroll_to")
+  (return-type "gboolean")
+  (parameters
+    '("AtkScrollType" "type")
+  )
+)
+
+(define-method scroll_to_point
+  (of-object "AtkComponent")
+  (c-name "atk_component_scroll_to_point")
+  (return-type "gboolean")
+  (parameters
+    '("AtkCoordType" "coords")
+    '("gint" "x")
+    '("gint" "y")
+  )
+)
+
 
 
 ;; From atkdocument.h
@@ -2760,6 +2796,11 @@
 
 ;; From atk-enum-types.h
 
+(define-function atk_scroll_type_get_type
+  (c-name "atk_scroll_type_get_type")
+  (return-type "GType")
+)
+
 (define-function atk_hyperlink_state_flags_get_type
   (c-name "atk_hyperlink_state_flags_get_type")
   (return-type "GType")
diff --git a/atk/src/atk_signals.defs b/atk/src/atk_signals.defs
index b379357..cb6d102 100644
--- a/atk/src/atk_signals.defs
+++ b/atk/src/atk_signals.defs
@@ -98,12 +98,12 @@
 
 (define-property accessible-role
   (of-object "AtkObject")
-  (prop-type "GParamInt")
+  (prop-type "GParamEnum")
   (docs "The accessible role of this object")
   (readable #t)
   (writable #t)
   (construct-only #f)
-  (default-value "66")
+  (default-value "ATK_ROLE_UNKNOWN")
 )
 
 (define-property accessible-component-layer
[Date Prev][Date Next]   [Thread Prev][Thread Next]   [Thread Index] [Date Index] [Author Index]