diff options
author | Colin Walters <walters@verbum.org> | 2009-12-10 08:23:40 -0200 |
---|---|---|
committer | Johan Dahlin <johan@gnome.org> | 2009-12-16 17:22:01 -0200 |
commit | 6529c07614ebfbfac73f526efb057d8a8e3a7354 (patch) | |
tree | 6470d8b8af29900905a07ff7838d180cec8fd36e /gtk/gtkwindow.c | |
parent | b3c48a4501d77c15ae236f1fe4514cc02de187f3 (diff) | |
download | gtk+-6529c07614ebfbfac73f526efb057d8a8e3a7354.tar.gz |
[introspection] Merge in Gtk-custom.c annotations
The Gtk-custom.c file in gir-repository contained a number of
introspection annotations. Merge those into the GTK source files.
Some documentation was moved from the tmpl/ files to accomodate
the addition of annotations.
Diffstat (limited to 'gtk/gtkwindow.c')
-rw-r--r-- | gtk/gtkwindow.c | 51 |
1 files changed, 26 insertions, 25 deletions
diff --git a/gtk/gtkwindow.c b/gtk/gtkwindow.c index 98747b26a8..3a35731b5b 100644 --- a/gtk/gtkwindow.c +++ b/gtk/gtkwindow.c @@ -1551,7 +1551,7 @@ gtk_window_get_role (GtkWindow *window) /** * gtk_window_set_focus: * @window: a #GtkWindow - * @focus: widget to be the new focus widget, or %NULL to unset + * @focus: (allow-none): widget to be the new focus widget, or %NULL to unset * any focus widget for the toplevel window. * * If @focus is not the current focus widget, and is focusable, sets @@ -1606,7 +1606,7 @@ _gtk_window_internal_set_focus (GtkWindow *window, /** * gtk_window_set_default: * @window: a #GtkWindow - * @default_widget: widget to be the default, or %NULL to unset the + * @default_widget: (allow-none): widget to be the default, or %NULL to unset the * default widget for the toplevel. * * The default widget is the widget that's activated when the user @@ -1960,9 +1960,9 @@ gtk_window_activate_focus (GtkWindow *window) * Note that this is the widget that would have the focus * if the toplevel window focused; if the toplevel window * is not focused then <literal>GTK_WIDGET_HAS_FOCUS (widget)</literal> will - * not be %TRUE for the widget. - * - * Return value: the currently focused widget, or %NULL if there is none. + * not be %TRUE for the widget. + * + * Return value: (transfer none): the currently focused widget, or %NULL if there is none. **/ GtkWidget * gtk_window_get_focus (GtkWindow *window) @@ -2071,8 +2071,8 @@ gtk_window_get_modal (GtkWindow *window) * callbacks that might destroy the widgets, you <emphasis>must</emphasis> call * <literal>g_list_foreach (result, (GFunc)g_object_ref, NULL)</literal> first, and * then unref all the widgets afterwards. - * - * Return value: list of toplevel widgets + * + * Return value: (element-type GtkWidget) (transfer container): list of toplevel widgets **/ GList* gtk_window_list_toplevels (void) @@ -2242,7 +2242,7 @@ gtk_window_unset_transient_for (GtkWindow *window) /** * gtk_window_set_transient_for: * @window: a #GtkWindow - * @parent: parent window + * @parent: (allow-none): parent window * * Dialog windows should be set transient for the main application * window they were spawned from. This allows <link @@ -2319,7 +2319,7 @@ gtk_window_set_transient_for (GtkWindow *window, * Fetches the transient parent for this window. See * gtk_window_set_transient_for(). * - * Return value: the transient parent for this window, or %NULL + * Return value: (transfer none): the transient parent for this window, or %NULL * if no transient parent has been set. **/ GtkWindow * @@ -3414,8 +3414,8 @@ gtk_window_set_icon_list (GtkWindow *window, * Retrieves the list of icons set by gtk_window_set_icon_list(). * The list is copied, but the reference count on each * member won't be incremented. - * - * Return value: copy of window's icon list + * + * Return value: (element-type GdkPixbuf) (transfer container): copy of window's icon list **/ GList* gtk_window_get_icon_list (GtkWindow *window) @@ -3435,8 +3435,8 @@ gtk_window_get_icon_list (GtkWindow *window) /** * gtk_window_set_icon: * @window: a #GtkWindow - * @icon: icon image, or %NULL - * + * @icon: (allow-none): icon image, or %NULL + * * Sets up the icon representing a #GtkWindow. This icon is used when * the window is minimized (also known as iconified). Some window * managers or desktop environments may also place it in the window @@ -3490,11 +3490,11 @@ update_themed_icon (GtkIconTheme *icon_theme, /** * gtk_window_set_icon_name: * @window: a #GtkWindow - * @name: the name of the themed icon + * @name: (allow-none): the name of the themed icon * * Sets the icon for the window from a named themed icon. See - * the docs for #GtkIconTheme for more details. - * + * the docs for #GtkIconTheme for more details. + * * Note that this has nothing to do with the WM_ICON_NAME * property which is mentioned in the ICCCM. * @@ -3558,8 +3558,8 @@ gtk_window_get_icon_name (GtkWindow *window) * Gets the value set by gtk_window_set_icon() (or if you've * called gtk_window_set_icon_list(), gets the first icon in * the icon list). - * - * Return value: icon for window + * + * Return value: (transfer none): icon for window **/ GdkPixbuf* gtk_window_get_icon (GtkWindow *window) @@ -3994,8 +3994,8 @@ gtk_window_resize (GtkWindow *window, /** * gtk_window_get_size: * @window: a #GtkWindow - * @width: return location for width, or %NULL - * @height: return location for height, or %NULL + * @width: (out): return location for width, or %NULL + * @height: (out): return location for height, or %NULL * * Obtains the current size of @window. If @window is not onscreen, * it returns the size GTK+ will suggest to the <link @@ -7254,7 +7254,7 @@ gtk_window_set_gravity (GtkWindow *window, * * Gets the value set by gtk_window_set_gravity(). * - * Return value: window gravity + * Return value: (transfer none): window gravity **/ GdkGravity gtk_window_get_gravity (GtkWindow *window) @@ -7470,7 +7470,7 @@ gtk_window_check_screen (GtkWindow *window) * * Returns the #GdkScreen associated with @window. * - * Return value: a #GdkScreen. + * Return value: (transfer none): a #GdkScreen. * * Since: 2.2 */ @@ -7655,7 +7655,8 @@ gtk_window_group_remove_window (GtkWindowGroup *window_group, * * Returns a list of the #GtkWindows that belong to @window_group. * - * Returns: A newly-allocated list of windows inside the group. + * Returns: (element-type GtkWidget) (transfer container): A newly-allocated list of + * windows inside the group. * * Since: 2.14 **/ @@ -7686,9 +7687,9 @@ gtk_window_group_list_windows (GtkWindowGroup *window_group) * * Returns the group for @window or the default group, if * @window is %NULL or if @window does not have an explicit - * window group. + * window group. * - * Returns: the #GtkWindowGroup for a window or the default group + * Returns: (transfer none): the #GtkWindowGroup for a window or the default group * * Since: 2.10 */ |