Commit 2f0d4033 authored by Pavel Holejsovsky's avatar Pavel Holejsovsky
Browse files

[GI] Add missing (transfer) annotations

parent 9b88eb35
......@@ -150,7 +150,7 @@ gdk_cursor_init (GdkCursor *cursor)
*
* Adds a reference to @cursor.
*
* Return value: Same @cursor that was passed in
* Return value: (transfer full): Same @cursor that was passed in
*
* Deprecated: 3.0: Use g_object_ref() instead
*/
......
......@@ -1756,7 +1756,7 @@ gdk_display_real_get_app_launch_context (GdkDisplay *display)
* Returns a #GdkAppLaunchContext suitable for launching
* applications on the given display.
*
* Returns: a new #GdkAppLaunchContext for @display.
* Returns: (transfer full): a new #GdkAppLaunchContext for @display.
* Free with g_object_unref() when done
*
* Since: 3.0
......
......@@ -335,7 +335,7 @@ gdk_display_manager_open_display (GdkDisplayManager *manager,
*
* Finds or creates an atom corresponding to a given string.
*
* Returns: the atom corresponding to @atom_name.
* Returns: (transfer none): the atom corresponding to @atom_name.
*/
GdkAtom
gdk_atom_intern (const gchar *atom_name,
......@@ -361,7 +361,7 @@ gdk_atom_intern (const gchar *atom_name,
* ever unload the module again (e.g. do not use this function in
* GTK+ theme engines).
*
* Returns: the atom corresponding to @atom_name
* Returns: (transfer none): the atom corresponding to @atom_name
*
* Since: 2.10
*/
......
......@@ -445,7 +445,7 @@ gdk_drag_drop_succeeded (GdkDragContext *context)
*
* Returns the selection atom for the current source window.
*
* Return value: the selection atom, or %GDK_NONE
* Return value: (transfer none): the selection atom, or %GDK_NONE
*/
GdkAtom
gdk_drag_get_selection (GdkDragContext *context)
......
......@@ -1165,7 +1165,7 @@ gdk_event_set_source_device (GdkEvent *event,
* If the event does not contain a device field, this function will
* return %NULL.
*
* Returns: a #GdkDevice, or %NULL
* Returns: (transfer none): a #GdkDevice, or %NULL.
*
* Since: 3.0
**/
......
......@@ -334,7 +334,7 @@ gdk_offscreen_window_get_device_state (GdkWindow *window,
* If you need to keep this around over window resizes, you need to
* add a reference to it.
*
* Returns: The offscreen surface, or %NULL if not offscreen
* Returns: (transfer none): The offscreen surface, or %NULL if not offscreen
*/
cairo_surface_t *
gdk_offscreen_window_get_surface (GdkWindow *window)
......
......@@ -384,7 +384,8 @@ gdk_window_class_init (GdkWindowClass *klass)
* The ::pick-embedded-child signal is emitted to find an embedded
* child at the given position.
*
* Returns: the #GdkWindow of the embedded child at @x, @y, or %NULL
* Returns: (transfer none): the #GdkWindow of the embedded child at
* @x, @y, or %NULL
*
* Since: 2.18
*/
......@@ -6584,8 +6585,8 @@ gdk_window_set_background_pattern (GdkWindow *window,
* does not have its own background and reuses the parent's, %NULL is
* returned and you'll have to query it yourself.
*
* Returns: The pattern to use for the background or %NULL to use the
* parent's background.
* Returns: (transfer none): The pattern to use for the background or
* %NULL to use the parent's background.
*
* Since: 2.22
**/
......@@ -6622,9 +6623,10 @@ update_cursor_foreach (GdkDisplay *display,
* there is no custom cursor set on the specified window, and it is
* using the cursor for its parent window.
*
* Return value: a #GdkCursor, or %NULL. The returned object is owned
* by the #GdkWindow and should not be unreferenced directly. Use
* gdk_window_set_cursor() to unset the cursor of the window
* Return value: (transfer none): a #GdkCursor, or %NULL. The returned
* object is owned by the #GdkWindow and should not be unreferenced
* directly. Use gdk_window_set_cursor() to unset the cursor of the
* window
*
* Since: 2.18
*/
......@@ -6686,9 +6688,10 @@ gdk_window_set_cursor (GdkWindow *window,
* there is no custom cursor set on the specified window, and it is
* using the cursor for its parent window.
*
* Returns: a #GdkCursor, or %NULL. The returned object is owned
* by the #GdkWindow and should not be unreferenced directly. Use
* gdk_window_set_cursor() to unset the cursor of the window
* Returns: (transfer none): a #GdkCursor, or %NULL. The returned
* object is owned by the #GdkWindow and should not be unreferenced
* directly. Use gdk_window_set_cursor() to unset the cursor of the
* window
*
* Since: 3.0
**/
......
......@@ -1854,7 +1854,8 @@ gdk_x11_lookup_xdisplay (Display *xdisplay)
* Given the root window ID of one of the screen's of a #GdkDisplay,
* finds the screen.
*
* Return value: the #GdkScreen corresponding to @xrootwin, or %NULL.
* Return value: (transfer none): the #GdkScreen corresponding to
* @xrootwin, or %NULL.
**/
GdkScreen *
_gdk_x11_display_screen_for_xrootwin (GdkDisplay *display,
......
......@@ -462,8 +462,8 @@ _gdk_x11_screen_list_visuals (GdkScreen *screen)
*
* Looks up the #GdkVisual for a particular screen and X Visual ID.
*
* Returns: the #GdkVisual (owned by the screen object), or %NULL
* if the visual ID wasn't found.
* Returns: (transfer none): the #GdkVisual (owned by the screen
* object), or %NULL if the visual ID wasn't found.
*
* Since: 2.2
*/
......
......@@ -1706,9 +1706,9 @@ gtk_about_dialog_set_translator_credits (GtkAboutDialog *about,
*
* Returns the pixbuf displayed as logo in the about dialog.
*
* Return value: the pixbuf displayed as logo. The pixbuf is
* owned by the about dialog. If you want to keep a reference
* to it, you have to call g_object_ref() on it.
* Return value: (transfer none): the pixbuf displayed as logo. The
* pixbuf is owned by the about dialog. If you want to keep a
* reference to it, you have to call g_object_ref() on it.
*
* Since: 2.6
*/
......
......@@ -378,8 +378,8 @@ gtk_accel_groups_from_object (GObject *object)
* @find_func: (scope call): a function to filter the entries
* of @accel_group with
* @data: data to pass to @find_func
* @returns: the key of the first entry passing @find_func. The key is
* owned by GTK+ and must not be freed.
* @returns: (transfer none): the key of the first entry passing
* @find_func. The key is owned by GTK+ and must not be freed.
*
* Finds the first entry in an accelerator group for which
* @find_func returns %TRUE and returns its #GtkAccelKey.
......@@ -851,7 +851,8 @@ gtk_accel_group_query (GtkAccelGroup *accel_group,
/**
* gtk_accel_group_from_accel_closure:
* @closure: a #GClosure
* @returns: (allow-none): the #GtkAccelGroup to which @closure is connected, or %NULL.
* @returns: (transfer none): the #GtkAccelGroup to which @closure
* is connected, or %NULL.
*
* Finds the #GtkAccelGroup to which @closure is connected;
* see gtk_accel_group_connect().
......
......@@ -1706,8 +1706,9 @@ gtk_action_get_accel_path (GtkAction *action)
*
* Since: 2.8
*
* Returns: the accel closure for this action. The returned closure is
* owned by GTK+ and must not be unreffed or modified.
* Returns: (transfer none): the accel closure for this action. The
* returned closure is owned by GTK+ and must not be unreffed
* or modified.
*/
GClosure *
gtk_action_get_accel_closure (GtkAction *action)
......
......@@ -650,7 +650,7 @@ gtk_binding_set_by_class (gpointer object_class)
* either be a name used for gtk_binding_set_new() or the type name of
* a class used in gtk_binding_set_by_class().
*
* Return value: %NULL or the specified binding set
* Return value: (transfer none): %NULL or the specified binding set
*/
GtkBindingSet*
gtk_binding_set_find (const gchar *set_name)
......
......@@ -1907,7 +1907,7 @@ get_cell_by_position (GtkCellRenderer *renderer,
* Gets the #GtkCellRenderer at @x and @y coordinates inside @area and optionally
* returns the full cell allocation for it inside @cell_area.
*
* Return value: the #GtkCellRenderer at @x and @y.
* Return value: (transfer none): the #GtkCellRenderer at @x and @y.
*
* Since: 3.0
*/
......@@ -2433,8 +2433,8 @@ gtk_cell_area_class_install_cell_property (GtkCellAreaClass *aclass,
*
* Finds a cell property of a cell area class by name.
*
* Return value: (allow-none): the #GParamSpec of the child property or %NULL if @aclass has no
* child property with that name.
* Return value: (transfer none): the #GParamSpec of the child property
* or %NULL if @aclass has no child property with that name.
*
* Since: 3.0
*/
......@@ -2993,7 +2993,7 @@ gtk_cell_area_set_focus_cell (GtkCellArea *area,
*
* Retrieves the currently focused cell for @area
*
* Return value: the currently focused cell in @area.
* Return value: (transfer none): the currently focused cell in @area.
*
* Since: 3.0
*/
......@@ -3177,7 +3177,8 @@ gtk_cell_area_get_focus_siblings (GtkCellArea *area,
* then chose to activate the focus cell for which the event
* cell may have been a sibling.
*
* Return value: the #GtkCellRenderer for which @renderer is a sibling, or %NULL.
* Return value: (transfer none): the #GtkCellRenderer for which @renderer
* is a sibling, or %NULL.
*
* Since: 3.0
*/
......@@ -3320,7 +3321,7 @@ gtk_cell_area_set_edit_widget (GtkCellArea *area,
* Gets the #GtkCellRenderer in @area that is currently
* being edited.
*
* Return value: The currently edited #GtkCellRenderer
* Return value: (transfer none): The currently edited #GtkCellRenderer
*
* Since: 3.0
*/
......@@ -3343,7 +3344,7 @@ gtk_cell_area_get_edited_cell (GtkCellArea *area)
* Gets the #GtkCellEditable widget currently used
* to edit the currently edited cell.
*
* Return value: The currently active #GtkCellEditable widget
* Return value: (transfer none): The currently active #GtkCellEditable widget
*
* Since: 3.0
*/
......
......@@ -348,7 +348,7 @@ gtk_cell_area_context_real_allocate (GtkCellAreaContext *context,
* that the #GtkCellArea is configured with in order to
* compute a proper allocation.
*
* Return value: the #GtkCellArea this context was created by.
* Return value: (transfer none): the #GtkCellArea this context was created by.
*
* Since: 3.0
*/
......
......@@ -1196,10 +1196,10 @@ gtk_container_class_install_child_property (GtkContainerClass *cclass,
/**
* gtk_container_class_find_child_property:
* @cclass: a #GtkContainerClass
* @cclass: (type GtkContainerClass): a #GtkContainerClass
* @property_name: the name of the child property to find
* @returns: (allow-none): the #GParamSpec of the child property or %NULL if @class has no
* child property with that name.
* @returns: (transfer none): the #GParamSpec of the child property or
* %NULL if @class has no child property with that name.
*
* Finds a child property of a container class by name.
*/
......@@ -1951,8 +1951,9 @@ gtk_container_set_focus_child (GtkContainer *container,
* currently focused widget. That can be obtained by calling
* gtk_window_get_focus().
*
* Returns: The child widget which will recieve the focus inside @container when
* the @conatiner is focussed, or %NULL if none is set.
* Returns: (transfer none): The child widget which will receive the
* focus inside @container when the @conatiner is focussed,
* or %NULL if none is set.
*
* Since: 2.14
**/
......
......@@ -1355,7 +1355,7 @@ gtk_drag_dest_unset (GtkWidget *widget)
* Returns the list of targets this widget can accept from
* drag-and-drop.
*
* Return value: the #GtkTargetList, or %NULL if none
* Return value: (transfer none): the #GtkTargetList, or %NULL if none
**/
GtkTargetList*
gtk_drag_dest_get_target_list (GtkWidget *widget)
......@@ -1666,8 +1666,8 @@ _gtk_drag_dest_handle_event (GtkWidget *toplevel,
* that case, they will have to implement a drag_motion handler that
* passes the correct target list to this function.
*
* Return value: first target that the source offers and the dest can
* accept, or %GDK_NONE
* Return value: (transfer none): first target that the source offers
* and the dest can accept, or %GDK_NONE
**/
GdkAtom
gtk_drag_dest_find_target (GtkWidget *widget,
......@@ -2544,7 +2544,7 @@ gtk_drag_begin_internal (GtkWidget *widget,
* (remember to free the event with gdk_event_free() when you are done).
* If you can really not pass a real event, pass #NULL instead.
*
* Return value: the context for this drag.
* Return value: (transfer none): the context for this drag.
**/
GdkDragContext *
gtk_drag_begin (GtkWidget *widget,
......@@ -2657,7 +2657,7 @@ gtk_drag_source_unset (GtkWidget *widget)
* Gets the list of targets this widget can provide for
* drag-and-drop.
*
* Return value: the #GtkTargetList, or %NULL if none
* Return value: (transfer none): the #GtkTargetList, or %NULL if none
*
* Since: 2.4
**/
......
......@@ -251,7 +251,7 @@ gtk_icon_factory_add (GtkIconFactory *factory,
* widget that will display the icon, instead of using this
* function directly, so that themes are taken into account.
*
* Return value: icon set of @stock_id.
* Return value: (transfer none): icon set of @stock_id.
*/
GtkIconSet *
gtk_icon_factory_lookup (GtkIconFactory *factory,
......@@ -330,7 +330,7 @@ _gtk_icon_factory_ensure_default_icons (void)
* using this function directly, so that themes are taken into
* account.
*
* Return value: a #GtkIconSet, or %NULL
* Return value: (transfer none): a #GtkIconSet, or %NULL
*/
GtkIconSet *
gtk_icon_factory_lookup_default (const gchar *stock_id)
......
......@@ -2036,7 +2036,8 @@ gtk_label_set_attributes (GtkLabel *label,
* effective attributes for the label, use
* pango_layout_get_attribute (gtk_label_get_layout (label)).
*
* Return value: the attribute list, or %NULL if none was set.
* Return value: (transfer none): the attribute list, or %NULL
* if none was set.
**/
PangoAttrList *
gtk_label_get_attributes (GtkLabel *label)
......
......@@ -2384,9 +2384,9 @@ gtk_invoke_key_snoopers (GtkWidget *grab_widget,
* the current event will be the #GdkEventButton that triggered
* the ::clicked signal.
*
* Return value: a copy of the current event, or %NULL if there is
* no current event. The returned event must be freed with
* gdk_event_free().
* Return value: (transfer full): a copy of the current event, or
* %NULL if there is no current event. The returned event must be
* freed with gdk_event_free().
*/
GdkEvent*
gtk_get_current_event (void)
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment