[gtk+/gi-annotations: 12/31] Update GI annotations in 'Display Widgets'
- From: Pavel Holejsovsky <pholejs src gnome org>
- To: commits-list gnome org
- Cc:
- Subject: [gtk+/gi-annotations: 12/31] Update GI annotations in 'Display Widgets'
- Date: Mon, 17 Jan 2011 05:51:51 +0000 (UTC)
commit 38f9d17a2857163c02ae76c0221acf9cfd035efa
Author: Pavel Holejsovsky <pholejs src gnome org>
Date: Sat Jan 15 20:32:30 2011 +0100
Update GI annotations in 'Display Widgets'
'Display Widgets' group from GTK+ manual are: GtkAccelLabel, GtkImage,
GtkLabel, GtkProgressBar, GtkStatusbar, GtkInfoBar, GtkStatusIcon,
GtkSpinner.
gtk/gtkimage.c | 15 +++++++--------
gtk/gtklabel.c | 11 ++++++-----
gtk/gtkstatusicon.c | 31 ++++++++++++++++---------------
3 files changed, 29 insertions(+), 28 deletions(-)
---
diff --git a/gtk/gtkimage.c b/gtk/gtkimage.c
index dca9566..0055503 100644
--- a/gtk/gtkimage.c
+++ b/gtk/gtkimage.c
@@ -520,7 +520,7 @@ gtk_image_get_property (GObject *object,
/**
* gtk_image_new_from_file:
- * @filename: a filename
+ * @filename: (type filename): a filename
*
* Creates a new #GtkImage displaying the file @filename. If the file
* isn't found or can't be loaded, the resulting #GtkImage will
@@ -726,7 +726,7 @@ gtk_image_new_from_gicon (GIcon *icon,
/**
* gtk_image_set_from_file:
* @image: a #GtkImage
- * @filename: (allow-none): a filename or %NULL
+ * @filename: (type filename) (allow-none): a filename or %NULL
*
* See gtk_image_new_from_file() for details.
**/
@@ -1108,7 +1108,7 @@ gtk_image_get_pixbuf (GtkImage *image)
* @image: a #GtkImage
* @stock_id: (out) (transfer none) (allow-none): place to store a
* stock icon name, or %NULL
- * @size: (out) (allow-none) (type int): place to store a stock icon
+ * @size: (type int) (out) (allow-none): place to store a stock icon
* size, or %NULL
*
* Gets the stock icon name and size being displayed by the #GtkImage.
@@ -1146,7 +1146,7 @@ gtk_image_get_stock (GtkImage *image,
* @image: a #GtkImage
* @icon_set: (out) (transfer none) (allow-none): location to store a
* #GtkIconSet, or %NULL
- * @size: (out) (allow-none) (type int): location to store a stock
+ * @size: (type int) (out) (allow-none): location to store a stock
* icon size, or %NULL
*
* Gets the icon set and size being displayed by the #GtkImage.
@@ -1209,9 +1209,8 @@ gtk_image_get_animation (GtkImage *image)
/**
* gtk_image_get_icon_name:
* @image: a #GtkImage
- * @icon_name: (out) (transfer none) (allow-none): place to store an
- * icon name, or %NULL
- * @size: (out) (allow-none) (type int): place to store an icon size,
+ * @icon_name: (out) (allow-none): place to store an icon name, or %NULL
+ * @size: (type int) (out) (allow-none): place to store an icon size,
* or %NULL
*
* Gets the icon name and size being displayed by the #GtkImage.
@@ -1251,7 +1250,7 @@ gtk_image_get_icon_name (GtkImage *image,
* @image: a #GtkImage
* @gicon: (out) (transfer none) (allow-none): place to store a
* #GIcon, or %NULL
- * @size: (out) (allow-none) (type int): place to store an icon size,
+ * @size: (type int) (out) (allow-none): place to store an icon size,
* or %NULL
*
* Gets the #GIcon and size being displayed by the #GtkImage.
diff --git a/gtk/gtklabel.c b/gtk/gtklabel.c
index 7fff547..272e6de 100644
--- a/gtk/gtklabel.c
+++ b/gtk/gtklabel.c
@@ -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)
@@ -5468,8 +5469,8 @@ gtk_label_select_region (GtkLabel *label,
/**
* gtk_label_get_selection_bounds:
* @label: a #GtkLabel
- * @start: return location for start of selection, as a character offset
- * @end: return location for end of selection, as a character offset
+ * @start: (out): return location for start of selection, as a character offset
+ * @end: (out): return location for end of selection, as a character offset
*
* Gets the selected range of characters in the label, returning %TRUE
* if there's a selection.
@@ -5567,8 +5568,8 @@ gtk_label_get_layout (GtkLabel *label)
/**
* gtk_label_get_layout_offsets:
* @label: a #GtkLabel
- * @x: (allow-none): location to store X offset of layout, or %NULL
- * @y: (allow-none): location to store Y offset of layout, or %NULL
+ * @x: (out) (allow-none): location to store X offset of layout, or %NULL
+ * @y: (out) (allow-none): location to store Y offset of layout, or %NULL
*
* Obtains the coordinates where the label will draw the #PangoLayout
* representing the text in the label; useful to convert mouse events
diff --git a/gtk/gtkstatusicon.c b/gtk/gtkstatusicon.c
index 6e0751e..ad7d7d4 100644
--- a/gtk/gtkstatusicon.c
+++ b/gtk/gtkstatusicon.c
@@ -1185,7 +1185,7 @@ gtk_status_icon_new_from_pixbuf (GdkPixbuf *pixbuf)
/**
* gtk_status_icon_new_from_file:
- * @filename: a filename
+ * @filename: (type filename): a filename
*
* Creates a status icon displaying the file @filename.
*
@@ -1913,7 +1913,7 @@ gtk_status_icon_set_from_pixbuf (GtkStatusIcon *status_icon,
/**
* gtk_status_icon_set_from_file:
* @status_icon: a #GtkStatusIcon
- * @filename: a filename
+ * @filename: (type filename): a filename
*
* Makes @status_icon display the file @filename.
* See gtk_status_icon_new_from_file() for details.
@@ -2337,11 +2337,12 @@ gtk_status_icon_is_embedded (GtkStatusIcon *status_icon)
/**
* gtk_status_icon_position_menu:
* @menu: the #GtkMenu
- * @x: return location for the x position
- * @y: return location for the y position
- * @push_in: whether the first menu item should be offset (pushed in) to be
- * aligned with the menu popup position (only useful for GtkOptionMenu).
- * @user_data: the status icon to position the menu on
+ * @x: (out): return location for the x position
+ * @y: (out): return location for the y position
+ * @push_in: (out): whether the first menu item should be offset
+ * (pushed in) to be aligned with the menu popup position
+ * (only useful for GtkOptionMenu).
+ * @user_data: (type GtkStatusIcon): the status icon to position the menu on
*
* Menu positioning function to use with gtk_menu_popup()
* to position @menu aligned to the status icon @user_data.
@@ -2464,14 +2465,14 @@ gtk_status_icon_position_menu (GtkMenu *menu,
/**
* gtk_status_icon_get_geometry:
* @status_icon: a #GtkStatusIcon
- * @screen: (out) (transfer none) (allow-none): return location for the screen, or %NULL if the
- * information is not needed
- * @area: (out) (allow-none): return location for the area occupied by the status
- * icon, or %NULL
- * @orientation: (out) (allow-none): return location for the orientation of the panel
- * in which the status icon is embedded, or %NULL. A panel
- * at the top or bottom of the screen is horizontal, a panel
- * at the left or right is vertical.
+ * @screen: (out) (transfer none) (allow-none): return location for
+ * the screen, or %NULL if the information is not needed
+ * @area: (out) (allow-none): return location for the area occupied by
+ * the status icon, or %NULL
+ * @orientation: (out) (allow-none): return location for the
+ * orientation of the panel in which the status icon is embedded,
+ * or %NULL. A panel at the top or bottom of the screen is
+ * horizontal, a panel at the left or right is vertical.
*
* Obtains information about the location of the status icon
* on screen. This information can be used to e.g. position
[
Date Prev][
Date Next] [
Thread Prev][
Thread Next]
[
Thread Index]
[
Date Index]
[
Author Index]