Atk_1_0_gir_INCLUDES = GObject-2.0
Atk_1_0_gir_CFLAGS = $(INCLUDES)
Atk_1_0_gir_LIBS = libatk-1.0.la
-Atk_1_0_gir_SCANNERFLAGS = --pkg-export atk
+Atk_1_0_gir_SCANNERFLAGS = --pkg-export atk --warn-all
Atk_1_0_gir_FILES = \
$(addprefix $(srcdir)/, $(introspection_sources)) \
$(introspection_generated_sources)
* Gets a reference to the accessible child, if one exists, at the
* coordinate point specified by @x and @y.
*
- * Returns: a reference to the accessible child, if one exists
+ * Returns: (transfer full): a reference to the accessible child, if one exists
**/
AtkObject*
atk_component_ref_accessible_at_point (AtkComponent *component,
* up to the caller to check atk_document_get_type to determine
* how to cast this pointer.
*
- * Returns: a %gpointer that points to an instance of the DOM.
+ * Returns: (transfer none): a %gpointer that points to an instance of the DOM.
**/
gpointer
atk_document_get_document (AtkDocument *document)
*
* Since: 1.12
*
- * Returns: An AtkAttributeSet containing the explicitly
+ * Returns: (transfer none): An AtkAttributeSet containing the explicitly
* set name-value-pair attributes associated with this document
* as a whole.
**/
*
* Gets the accessible object for the specified @obj.
*
- * Returns: a #AtkObject which is the accessible object for the @obj
+ * Returns: (transfer none): a #AtkObject which is the accessible object for
+ * the @obj
**/
AtkObject*
atk_gobject_accessible_for_object (GObject *obj)
*
* Gets the GObject for which @obj is the accessible object.
*
- * Returns: a #GObject which is the object for which @obj is the accessible object
+ * Returns: (transfer none): a #GObject which is the object for which @obj is
+ * the accessible object
**/
GObject *
atk_gobject_accessible_get_object (AtkGObjectAccessible *obj)
*
* Multiple anchors are primarily used by client-side image maps.
*
- * Returns: an #AtkObject associated with this hyperlinks i-th anchor
+ * Returns: (transfer none): an #AtkObject associated with this hyperlinks
+ * i-th anchor
**/
AtkObject*
atk_hyperlink_get_object (AtkHyperlink *link,
*
* Gets the hyperlink associated with this object.
*
- * Returns an AtkHyperlink object which points to this implementing AtkObject.
+ * Returns: (transfer full): an AtkHyperlink object which points to this
+ * implementing AtkObject.
*
* Since: 1.12
**/
* Gets the link in this hypertext document at index
* @link_index
*
- * Returns: the link in this hypertext document at
+ * Returns: (transfer none): the link in this hypertext document at
* index @link_index
**/
AtkHyperlink*
*
* Gets the accessible parent of the accessible.
*
- * Returns: a #AtkObject representing the accessible parent of the accessible
+ * Returns: (transfer none): a #AtkObject representing the accessible parent
+ * of the accessible
**/
AtkObject*
atk_object_get_parent (AtkObject *accessible)
* The accessible children are 0-based so the first accessible child is
* at index 0, the second at index 1 and so on.
*
- * Returns: an #AtkObject representing the specified accessible child
- * of the accessible.
+ * Returns: (transfer full): an #AtkObject representing the specified
+ * accessible child of the accessible.
**/
AtkObject*
atk_object_ref_accessible_child (AtkObject *accessible,
*
* Gets the #AtkRelationSet associated with the object.
*
- * Returns: an #AtkRelationSet representing the relation set of the object.
+ * Returns: (transfer full): an #AtkRelationSet representing the relation set
+ * of the object.
**/
AtkRelationSet*
atk_object_ref_relation_set (AtkObject *accessible)
* Gets a reference to the state set of the accessible; the caller must
* unreference it when it is no longer needed.
*
- * Returns: a reference to an #AtkStateSet which is the state
+ * Returns: (transfer full): a reference to an #AtkStateSet which is the state
* set of the accessible
**/
AtkStateSet*
/**
* atk_object_set_description:
* @accessible: an #AtkObject
- * @description : a character string to be set as the accessible description
+ * @description: a character string to be set as the accessible description
*
* Sets the accessible description of the accessible.
**/
/**
* atk_object_set_parent:
* @accessible: an #AtkObject
- * @parent : an #AtkObject to be set as the accessible parent
+ * @parent: an #AtkObject to be set as the accessible parent
*
* Sets the accessible parent of the accessible.
**/
/**
* atk_object_set_role:
* @accessible: an #AtkObject
- * @role : an #AtkRole to be set as the role
+ * @role: an #AtkRole to be set as the role
*
* Sets the role of the accessible.
**/
/**
* atk_object_connect_property_change_handler:
* @accessible: an #AtkObject
- * @handler : a function to be called when a property changes its value
+ * @handler: a function to be called when a property changes its value
*
* Specifies a function to be called when a property changes value.
*
/**
* atk_object_remove_property_change_handler:
* @accessible: an #AtkObject
- * @handler_id : a guint which identifies the handler to be removed.
+ * @handler_id: a guint which identifies the handler to be removed.
*
* Removes a property change handler.
**/
* atk_object_notify_state_change:
* @accessible: an #AtkObject
* @state: an #AtkState whose state is changed
- * @value : a gboolean which indicates whether the state is being set on or off
+ * @value: a gboolean which indicates whether the state is being set on or off
*
* Emits a state-change signal for the specified state.
**/
* Gets a reference to an object's #AtkObject implementation, if
* the object implements #AtkObjectIface
*
- * Returns: a reference to an object's #AtkObject implementation
+ * Returns: (transfer full): a reference to an object's #AtkObject
+ * implementation
*/
AtkObject *
atk_implementor_ref_accessible (AtkImplementor *implementor)
*
* Since: 1.12
*
- * Returns: an #AtkAttributeSet consisting of all explicit properties/annotations applied to
- * the object, or an empty set if the object has no name-value pair attributes assigned to it.
+ * Returns: (transfer none): an #AtkAttributeSet consisting of all explicit
+ * properties/annotations applied to the object, or an empty set if the object
+ * has no name-value pair attributes assigned to it.
*/
AtkAttributeSet *
atk_object_get_attributes (AtkObject *accessible)
* Provides an #AtkObject that implements an accessibility interface
* on behalf of @obj
*
- * Returns: an #AtkObject that implements an accessibility interface
- * on behalf of @obj
+ * Returns: (transfer full): an #AtkObject that implements an accessibility
+ * interface on behalf of @obj
**/
AtkObject*
atk_object_factory_create_accessible (AtkObjectFactory *factory,
* Gets an #AtkObjectFactory appropriate for creating #AtkObjects
* appropriate for @type.
*
- * Returns: an #AtkObjectFactory appropriate for creating #AtkObjects
- * appropriate for @type.
+ * Returns: (transfer none): an #AtkObjectFactory appropriate for creating
+ * #AtkObjects appropriate for @type.
**/
AtkObjectFactory*
atk_registry_get_factory (AtkRegistry *registry,
}
/**
- *atk_get_default_registry:
+ * atk_get_default_registry:
*
* Gets a default implementation of the #AtkObjectFactory/type
* registry.
* to associate an #AtkObjectFactory subclass with the GType of objects
* for whom accessibility information will be provided.
*
- * Returns: a default implementation of the #AtkObjectFactory/type
- * registry
+ * Returns: (transfer full): a default implementation of the
+ * #AtkObjectFactory/type registry
**/
AtkRegistry*
atk_get_default_registry (void)
*
* Gets the target list of @relation
*
- * Returns: the target list of @relation
+ * Returns: (transfer none): the target list of @relation
**/
GPtrArray*
atk_relation_get_target (AtkRelation *relation)
}
/**
- * atk_relation_set_get_relation
+ * atk_relation_set_get_relation:
* @set: an #AtkRelationSet
* @i: a gint representing a position in the set, starting from 0.
*
* Determines the relation at the specified position in the relation set.
*
- * Returns: a #AtkRelation, which is the relation at position i in the set.
+ * Returns: (transfer none): a #AtkRelation, which is the relation at
+ * position i in the set.
**/
AtkRelation*
atk_relation_set_get_relation (AtkRelationSet *set,
*
* Finds a relation that matches the specified type.
*
- * Returns: an #AtkRelation, which is a relation matching the specified type.
+ * Returns: (transfer none): an #AtkRelation, which is a relation matching the
+ * specified type.
**/
AtkRelation*
atk_relation_set_get_relation_by_type (AtkRelationSet *set,
* use type checking/interface checking macros or the
* atk_get_accessible_value() convenience method.
*
- * Returns: an #AtkObject representing the selected accessible , or %NULL
- * if @selection does not implement this interface.
+ * Returns: (transfer full): an #AtkObject representing the selected
+ * accessible , or %NULL if @selection does not implement this interface.
**/
AtkObject*
atk_selection_ref_selection (AtkSelection *obj,
* Constructs the intersection of the two sets, returning %NULL if the
* intersection is empty.
*
- * Returns: a new #AtkStateSet which is the intersection of the two sets.
+ * Returns: (transfer full): a new #AtkStateSet which is the intersection of
+ * the two sets.
**/
AtkStateSet*
atk_state_set_and_sets (AtkStateSet *set,
*
* Constructs the union of the two sets.
*
- * Returns: a new #AtkStateSet which is the union of the two sets,
- * returning %NULL is empty.
+ * Returns: (transfer full): a new #AtkStateSet which is the union of the two
+ * sets, returning %NULL is empty.
**/
AtkStateSet*
atk_state_set_or_sets (AtkStateSet *set,
* The set returned by this operation contains the states in exactly
* one of the two sets.
*
- * Returns: a new #AtkStateSet which contains the states which are
- * in exactly one of the two sets.
+ * Returns: (transfer full): a new #AtkStateSet which contains the states
+ * which are in exactly one of the two sets.
**/
AtkStateSet*
atk_state_set_xor_sets (AtkStateSet *set,
*
* Gets the content in the specified mime type.
*
- * Returns: A #GIOChannel which contains the content in the specified mime
- * type.
+ * Returns: (transfer full): A #GIOChannel which contains the content in the
+ * specified mime type.
**/
GIOChannel*
atk_streamable_content_get_stream (AtkStreamableContent *streamable,
*
* Get a reference to the table cell at @row, @column.
*
- * Returns: a AtkObject* representing the referred to accessible
+ * Returns: (transfer full): a AtkObject* representing the referred to
+ * accessible
**/
AtkObject*
atk_table_ref_at (AtkTable *table,
*
* Gets the caption for the @table.
*
- * Returns: a AtkObject* representing the table caption, or %NULL
- * if value does not implement this interface.
+ * Returns: (transfer none): a AtkObject* representing the table caption, or
+ * %NULL if value does not implement this interface.
**/
AtkObject*
atk_table_get_caption (AtkTable *table)
*
* Gets the column header of a specified column in an accessible table.
*
- * Returns: a AtkObject* representing the specified column header, or
- * %NULL if value does not implement this interface.
+ * Returns: (transfer none): a AtkObject* representing the specified column
+ * header, or %NULL if value does not implement this interface.
**/
AtkObject*
atk_table_get_column_header (AtkTable *table, gint column)
*
* Gets the row header of a specified row in an accessible table.
*
- * Returns: a AtkObject* representing the specified row header, or
- * %NULL if value does not implement this interface.
+ * Returns: (transfer none): a AtkObject* representing the specified row
+ * header, or %NULL if value does not implement this interface.
**/
AtkObject*
atk_table_get_row_header (AtkTable *table, gint row)
*
* Gets the summary description of the table.
*
- * Returns: a AtkObject* representing a summary description of the table,
- * or zero if value does not implement this interface.
+ * Returns: (transfer full): a AtkObject* representing a summary description
+ * of the table, or zero if value does not implement this interface.
**/
AtkObject*
atk_table_get_summary (AtkTable *table)
}
/**
- *atk_text_get_run_attributes:
+ * atk_text_get_run_attributes:
*@text: an #AtkText
*@offset: the offset at which to get the attributes, -1 means the offset of
*the character to be inserted at the caret location.
*attributes that can be returned. Note that other attributes may also be
*returned.
*
- *Returns: an #AtkAttributeSet which contains the attributes explicitly set
- *at @offset. This #AtkAttributeSet should be freed by a call to
- *atk_attribute_set_free().
+ *Returns: (transfer full): an #AtkAttributeSet which contains the attributes
+ * explicitly set at @offset. This #AtkAttributeSet should be freed by a call
+ * to atk_attribute_set_free().
**/
AtkAttributeSet*
atk_text_get_run_attributes (AtkText *text,
}
/**
- *atk_text_get_default_attributes:
+ * atk_text_get_default_attributes:
*@text: an #AtkText
*
*Creates an #AtkAttributeSet which consists of the default values of
*attributes that can be returned. Note that other attributes may also be
*returned.
*
- *Returns: an #AtkAttributeSet which contains the default values of attributes.
- *at @offset. This #AtkAttributeSet should be freed by a call to
- *atk_attribute_set_free().
+ *Returns: (transfer full): an #AtkAttributeSet which contains the default
+ * values of attributes. at @offset. this #atkattributeset should be freed by
+ * a call to atk_attribute_set_free().
*/
AtkAttributeSet*
atk_text_get_default_attributes (AtkText *text)
*
* Gets the root accessible container for the current application.
*
- * Returns: the root accessible container for the current application
+ * Returns: (transfer none): the root accessible container for the current
+ * application
**/
AtkObject*
atk_get_root (void)
*
* Since: 1.6
*
- * Returns: the currently focused object for the current application
+ * Returns: (transfer none): the currently focused object for the current
+ * application
**/
AtkObject*
atk_get_focus_object (void)
* supported are events of type "focus:". Most clients of ATK will prefer to
* attach signal handlers for the various ATK signals instead.
*
- * @see: atk_add_focus_tracker.
+ * see atk_add_focus_tracker.
**/
typedef void (*AtkEventListener) (AtkObject* obj);
/**
* called in order to initialize the per-object event registration system
* used by #AtkEventListener, if any preparation is required.
*
- * @see: atk_focus_tracker_init.
+ * see atk_focus_tracker_init.
**/
typedef void (*AtkEventListenerInit) (void);
/**
* discarded without being passed to the normal GUI recipient; FALSE (zero) if the
* event dispatch to the client application should proceed as normal.
*
- * @see: atk_add_key_event_listener.
+ * see atk_add_key_event_listener.
**/
typedef gint (*AtkKeySnoopFunc) (AtkKeyEventStruct *event,
gpointer func_data);
@target:
+<!-- ##### FUNCTION atk_relation_remove_target ##### -->
+<para>
+
+</para>
+
+@relation:
+@target:
+@Returns:
+
+
@Returns:
+<!-- ##### FUNCTION atk_get_version ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
+<!-- ##### MACRO ATK_DEFINE_TYPE ##### -->
+<para>
+
+</para>
+
+@TN:
+@t_n:
+@T_P:
+
+
+<!-- ##### MACRO ATK_DEFINE_TYPE_EXTENDED ##### -->
+<para>
+
+</para>
+
+@TN:
+@t_n:
+@T_P:
+@_f_:
+@_C_:
+
+
+<!-- ##### MACRO ATK_DEFINE_TYPE_WITH_CODE ##### -->
+<para>
+
+</para>
+
+@TN:
+@t_n:
+@T_P:
+@_C_:
+
+
+<!-- ##### MACRO ATK_DEFINE_ABSTRACT_TYPE ##### -->
+<para>
+
+</para>
+
+@TN:
+@t_n:
+@T_P:
+
+
+<!-- ##### MACRO ATK_DEFINE_ABSTRACT_TYPE_WITH_CODE ##### -->
+<para>
+
+</para>
+
+@TN:
+@t_n:
+@T_P:
+@_C_:
+
+