*
* Returns a description of the specified action of the object.
*
- * Returns: a description string, or %NULL if @action does not
- * implement this interface.
+ * Returns: (nullable): a description string, or %NULL if @action does
+ * not implement this interface.
**/
const gchar*
atk_action_get_description (AtkAction *obj,
* i.e. the result of some actions via atk_action_do_action() may be
* NIL.
*
- * Returns: a name string, or %NULL if @action does not implement this
- * interface.
+ * Returns: (nullable): a name string, or %NULL if @action does not
+ * implement this interface.
**/
const gchar*
atk_action_get_name (AtkAction *obj,
*
* Returns the localized name of the specified action of the object.
*
- * Returns: a name string, or %NULL if @action does not implement this
- * interface.
+ * Returns: (nullable): a name string, or %NULL if @action does not
+ * implement this interface.
**/
const gchar*
atk_action_get_localized_name (AtkAction *obj,
* for the German locale. If, hypothetically, this menu item lacked a mnemonic,
* it would be represented by ";;Ctrl+N" and ";;Strg+N" respectively.
*
- * Returns: the keybinding which can be used to activate this action,
- * or %NULL if there is no keybinding for this action.
+ * Returns: (nullable): the keybinding which can be used to activate
+ * this action, or %NULL if there is no keybinding for this action.
*
**/
const gchar*
* Gets a reference to the accessible child, if one exists, at the
* coordinate point specified by @x and @y.
*
- * Returns: (transfer full): a reference to the accessible child, if one exists
+ * Returns: (nullable) (transfer full): a reference to the accessible
+ * child, if one exists
**/
AtkObject*
atk_component_ref_accessible_at_point (AtkComponent *component,
*
* Since: 1.12
*
- * Returns: 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.
+ * 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.
*/
const gchar *
atk_document_get_attribute_value (AtkDocument *document,
*
* Since ATK 1.12
*
- * Returns: a string corresponding to the POSIX LC_MESSAGES locale
- * used by the image description, or NULL if the image does not
- * specify a locale.
+ * 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.
*
*/
const gchar*
* use type checking/interface checking macros or the
* atk_get_accessible_value() convenience method.
*
- * Returns: (transfer full): an #AtkObject representing the selected
- * accessible , or %NULL if @selection does not implement this interface.
+ * Returns: (nullable) (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 union of the two sets.
*
- * Returns: (transfer full): a new #AtkStateSet which is the union of the two
- * sets, returning %NULL is empty.
+ * Returns: (nullable) (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,
* Note that it is possible for get_uri to return NULL but for
* get_stream to work nonetheless, since not all GIOChannels connect to URIs.
*
- * Returns: Returns a string representing a URI, or NULL if no corresponding URI
- * can be constructed.
+ * Returns: (nullable): Returns a string representing a URI, or %NULL
+ * if no corresponding URI can be constructed.
*
* Since: 1.12
**/
*
* Gets the caption for the @table.
*
- * Returns: (transfer none): a AtkObject* representing the table caption, or
- * %NULL if value does not implement this interface.
+ * Returns: (nullable) (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: (transfer none): a AtkObject* representing the specified column
- * header, or %NULL if value does not implement this interface.
+ * Returns: (nullable) (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 description text of the specified row in the table
*
- * Returns: a gchar* representing the row description, or %NULL
- * if value does not implement this interface.
+ * Returns: (nullable) a gchar* representing the row description, or
+ * %NULL if value does not implement this interface.
**/
const gchar*
atk_table_get_row_description (AtkTable *table,
*
* Gets the row header of a specified row in an accessible table.
*
- * Returns: (transfer none): a AtkObject* representing the specified row
- * header, or %NULL if value does not implement this interface.
+ * Returns: (nullable) (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)
*
* 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,
*
* 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,
*
* Gets the range of this object.
*
- * Returns: (transfer full): a newly allocated #AtkRange that
- * represents the minimum, maximum and descriptor (if available) of
- * @obj. NULL if that range is not defined.
+ * Returns: (nullable) (transfer full): a newly allocated #AtkRange
+ * that represents the minimum, maximum and descriptor (if available)
+ * of @obj. NULL if that range is not defined.
*
* Since: 2.12
**/