Visual Studio builds: Adapt to the Python-fied glib-genmarshal

[platform/upstream/atk.git] / atk / atktext.c

diff --git a/atk/atktext.c b/atk/atktext.c
old mode 100755 (executable)
new mode 100644 (file)
index 9abb7f4..5244015
--- a/atk/atktext.c
+++ b/atk/atktext.c
@@ -17,9 +17,10 @@
  * Boston, MA 02111-1307, USA.
  */
 
-#include "atktext.h"
+#include "config.h"
+
+#include "atk.h"
 #include "atkmarshal.h"
-#include "atk-enum-types.h"
 
 #include <string.h>
 
@@ -200,7 +201,7 @@ atk_text_base_init (AtkTextIface *class)
        * "delete" which identifies whether the text change was an
        * insertion or a deletion.
        *
-       * Deprecated: Since 2.9.4. Use #AtkObject::text-insert or
+       * Deprecated: 2.9.4: Use #AtkObject::text-insert or
        * #AtkObject::text-remove instead.
        */
       atk_text_signals[TEXT_CHANGED] =
@@ -221,7 +222,9 @@ atk_text_base_init (AtkTextIface *class)
        * @arg3: The new text inserted
        *
        * The "text-insert" signal is emitted when a new text is
-       * inserted.
+       * inserted. If the signal was not triggered by the user
+       * (e.g. typing or pasting text), the "system" detail should be
+       * included.
        */
       atk_text_signals[TEXT_INSERT] =
        g_signal_new ("text_insert",
@@ -241,7 +244,9 @@ atk_text_base_init (AtkTextIface *class)
        * @arg3: The old text removed
        *
        * The "text-remove" signal is emitted when a new text is
-       * removed.
+       * removed. If the signal was not triggered by the user
+       * (e.g. typing or pasting text), the "system" detail should be
+       * included.
        */
       atk_text_signals[TEXT_REMOVE] =
        g_signal_new ("text_remove",
@@ -377,8 +382,7 @@ atk_text_get_character_at_offset (AtkText      *text,
  *
  * Gets the specified text.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.3. Please use atk_text_get_string_at_offset() instead.
+ * Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
  *
  * Returns: a newly allocated string containing the text after @offset bounded
  *   by the specified @boundary_type. Use g_free() to free the returned string.
@@ -497,8 +501,7 @@ atk_text_get_text_at_offset (AtkText          *text,
  *
  * Gets the specified text.
  *
- * Deprecated: This method is deprecated since ATK version
- * 2.9.3. Please use atk_text_get_string_at_offset() instead.
+ * Deprecated: 2.9.3: Please use atk_text_get_string_at_offset() instead.
  *
  * Returns: a newly allocated string containing the text before @offset bounded
  *   by the specified @boundary_type. Use g_free() to free the returned string.
@@ -577,11 +580,12 @@ atk_text_get_text_before_offset (AtkText          *text,
  * is from the start of the paragraph at or before the offset to the start
  * of the following paragraph after the offset.
  *
- * Since: 2.9.4
+ * Since: 2.10
  *
- * Returns: a newly allocated string containing the text at the @offset bounded
- *   by the specified @granularity. Use g_free() to free the returned string.
- *   Returns %NULL if the offset is invalid or no implementation is available.
+ * Returns: (nullable): a newly allocated string containing the text
+ *   at the @offset bounded by the specified @granularity. Use
+ *   g_free() to free the returned string.  Returns %NULL if the
+ *   offset is invalid or no implementation is available.
  **/
 gchar* atk_text_get_string_at_offset (AtkText *text,
                                       gint offset,
@@ -649,10 +653,10 @@ atk_text_get_caret_offset (AtkText *text)
  * atk_text_get_character_extents:
  * @text: an #AtkText
  * @offset: The offset of the text character for which bounding information is required.
- * @x: Pointer for the x cordinate of the bounding box
- * @y: Pointer for the y cordinate of the bounding box
- * @width: Pointer for the width of the bounding box
- * @height: Pointer for the height of the bounding box
+ * @x: (out) (optional): Pointer for the x cordinate of the bounding box
+ * @y: (out) (optional): Pointer for the y cordinate of the bounding box
+ * @width: (out) (optional): Pointer for the width of the bounding box
+ * @height: (out) (optional): Pointer for the height of the bounding box
  * @coords: specify whether coordinates are relative to the screen or widget window 
  *
  * Get the bounding box containing the glyph representing the character at 
@@ -1049,7 +1053,7 @@ atk_text_set_caret_offset (AtkText *text,
  * @end_offset: The offset of the text character after the last character 
  *        for which boundary information is required.
  * @coord_type: Specify whether coordinates are relative to the screen or widget window.
- * @rect: A pointer to a AtkTextRectangle which is filled in by this function.
+ * @rect: (out): A pointer to a AtkTextRectangle which is filled in by this function.
  *
  * Get the bounding box for text within the specified range.
  *
@@ -1258,8 +1262,9 @@ atk_text_attribute_for_name (const gchar *name)
  *
  * Gets the value for the index of the #AtkTextAttribute
  *
- * Returns: a string containing the value; this string should not be freed;
- * NULL is returned if there are no values maintained for the attr value. 
+ * Returns: (nullable): a string containing the value; this string
+ * should not be freed; %NULL is returned if there are no values
+ * maintained for the attr value.
  **/
 const gchar*
 atk_text_attribute_get_value (AtkTextAttribute attr,