diff options
author | Matthias Clasen <mclasen@redhat.com> | 2010-10-23 23:02:40 +0200 |
---|---|---|
committer | Matthias Clasen <mclasen@redhat.com> | 2010-10-23 23:41:08 +0200 |
commit | 520a6aeb8ff06217373b9f567578850cb3598106 (patch) | |
tree | 5f2f103c1c0de93eb5124d9ce2198e16ee0b914b /gtk | |
parent | d7653e7c0cffc64ccc82edadc5b3c12d8129cd73 (diff) | |
download | gtk+-520a6aeb8ff06217373b9f567578850cb3598106.tar.gz |
Fix up docs
Diffstat (limited to 'gtk')
-rw-r--r-- | gtk/gtk.symbols | 1 | ||||
-rw-r--r-- | gtk/gtkcolorbutton.c | 10 | ||||
-rw-r--r-- | gtk/gtkcombobox.c | 10 | ||||
-rw-r--r-- | gtk/gtkentry.c | 9 | ||||
-rw-r--r-- | gtk/gtkgrid.h | 2 | ||||
-rw-r--r-- | gtk/gtkscrolledwindow.c | 54 | ||||
-rw-r--r-- | gtk/gtktable.c | 2 | ||||
-rw-r--r-- | gtk/gtkwidget.c | 20 |
8 files changed, 94 insertions, 14 deletions
diff --git a/gtk/gtk.symbols b/gtk/gtk.symbols index 6a297bb6aa..c8df972e39 100644 --- a/gtk/gtk.symbols +++ b/gtk/gtk.symbols @@ -754,6 +754,7 @@ gtk_color_button_get_type G_GNUC_CONST gtk_color_button_get_use_alpha gtk_color_button_new gtk_color_button_new_with_color +gtk_color_button_new_with_rgba gtk_color_button_set_alpha gtk_color_button_set_color gtk_color_button_set_title diff --git a/gtk/gtkcolorbutton.c b/gtk/gtkcolorbutton.c index 9548280010..2e2214f85b 100644 --- a/gtk/gtkcolorbutton.c +++ b/gtk/gtkcolorbutton.c @@ -537,6 +537,16 @@ gtk_color_button_new_with_color (const GdkColor *color) return g_object_new (GTK_TYPE_COLOR_BUTTON, "color", color, NULL); } +/** + * gtk_color_button_new_with_rgba: + * @rgba: A #GdkRGBA to set the current color with. + * + * Creates a new color button. + * + * Returns: a new color button + * + * Since: 3.0 + */ GtkWidget * gtk_color_button_new_with_rgba (const GdkRGBA *rgba) { diff --git a/gtk/gtkcombobox.c b/gtk/gtkcombobox.c index 93297921ba..c17326e3df 100644 --- a/gtk/gtkcombobox.c +++ b/gtk/gtkcombobox.c @@ -5871,14 +5871,14 @@ gtk_combo_box_set_title (GtkComboBox *combo_box, * @combo_box: a #GtkComboBox * @fixed: whether to use a fixed popup width * - * Specifies whether the popup's width should be a fixed width matching - * the allocated width of the combo box. + * Specifies whether the popup's width should be a fixed width + * matching the allocated width of the combo box. * * Since: 3.0 **/ void gtk_combo_box_set_popup_fixed_width (GtkComboBox *combo_box, - gboolean fixed) + gboolean fixed) { g_return_if_fail (GTK_IS_COMBO_BOX (combo_box)); @@ -5894,9 +5894,11 @@ gtk_combo_box_set_popup_fixed_width (GtkComboBox *combo_box, * gtk_combo_box_get_popup_fixed_width: * @combo_box: a #GtkComboBox * - * Gets whether the popup uses a fixed width matching + * Gets whether the popup uses a fixed width matching * the allocated width of the combo box. * + * Returns: %TRUE if the popup uses a fixed width + * * Since: 3.0 **/ gboolean diff --git a/gtk/gtkentry.c b/gtk/gtkentry.c index 4d10e36305..053e02baa5 100644 --- a/gtk/gtkentry.c +++ b/gtk/gtkentry.c @@ -6660,9 +6660,11 @@ gtk_entry_set_buffer (GtkEntry *entry, * @entry: a #GtkEntry * @text_area: Return location for the text area. * - * Returns the area where the entry's text is drawn. This function is + * Gets the area where the entry's text is drawn. This function is * useful when drawing something to the entry in a draw callback. * + * If the entry is not realized, @text_area is filled with zeros. + * * See also gtk_entry_get_icon_area(). * * Since: 3.0 @@ -8111,10 +8113,13 @@ gtk_entry_get_current_icon_drag_source (GtkEntry *entry) * @icon_pos: Icon position * @icon_area: Return location for the icon's area * - * Returns the area where entry's icon at @icon_pos is drawn. + * Gets the area where entry's icon at @icon_pos is drawn. * This function is useful when drawing something to the * entry in a draw callback. * + * If the entry is not realized or has no icon at the given position, + * @icon_area is filled with zeros. + * * See also gtk_entry_get_text_area() * * Since: 3.0 diff --git a/gtk/gtkgrid.h b/gtk/gtkgrid.h index 590d9cddeb..860658a0b7 100644 --- a/gtk/gtkgrid.h +++ b/gtk/gtkgrid.h @@ -74,7 +74,7 @@ void gtk_grid_attach (GtkGrid *grid, gint width, gint height); void gtk_grid_attach_next_to (GtkGrid *grid, - GtkWidget *widget, + GtkWidget *child, GtkWidget *sibling, GtkPositionType side, gint width, diff --git a/gtk/gtkscrolledwindow.c b/gtk/gtkscrolledwindow.c index 7906bd6a70..02fe2a5f50 100644 --- a/gtk/gtkscrolledwindow.c +++ b/gtk/gtkscrolledwindow.c @@ -2181,6 +2181,16 @@ gtk_scrolled_window_get_preferred_width_for_height (GtkWidget *widget, GTK_WIDGET_GET_CLASS (widget)->get_preferred_width (widget, minimum_width, natural_width); } +/** + * gtk_scrolled_window_get_min_content_width: + * @scrolled_window: a #GtkScrolledWindow + * + * Gets the minimum content width of @scrolled_window, or -1 if not set. + * + * Returns: the minimum content width + * + * Since: 3.0 + */ gint gtk_scrolled_window_get_min_content_width (GtkScrolledWindow *scrolled_window) { @@ -2189,9 +2199,20 @@ gtk_scrolled_window_get_min_content_width (GtkScrolledWindow *scrolled_window) return scrolled_window->priv->min_content_width; } +/** + * gtk_scrolled_window_set_min_content_width: + * @scrolled_window: a #GtkScrolledWindow + * @width: the minimal content width + * + * Sets the minimum width that @scrolled_window should keep visible. + * Note that this can and (usually will) be smaller than the minimum + * size of the content. + * + * Since: 3.0 + */ void gtk_scrolled_window_set_min_content_width (GtkScrolledWindow *scrolled_window, - gint min_content_width) + gint width) { GtkScrolledWindowPrivate *priv; @@ -2199,9 +2220,9 @@ gtk_scrolled_window_set_min_content_width (GtkScrolledWindow *scrolled_window, priv = scrolled_window->priv; - if (priv->min_content_width != min_content_width) + if (priv->min_content_width != width) { - priv->min_content_width = min_content_width; + priv->min_content_width = width; gtk_widget_queue_resize (GTK_WIDGET (scrolled_window)); @@ -2209,6 +2230,16 @@ gtk_scrolled_window_set_min_content_width (GtkScrolledWindow *scrolled_window, } } +/** + * gtk_scrolled_window_get_min_content_height: + * @scrolled_window: a #GtkScrolledWindow + * + * Gets the minimal content height of @scrolled_window, or -1 if not set. + * + * Returns: the minimal content height + * + * Since: 3.0 + */ gint gtk_scrolled_window_get_min_content_height (GtkScrolledWindow *scrolled_window) { @@ -2217,9 +2248,20 @@ gtk_scrolled_window_get_min_content_height (GtkScrolledWindow *scrolled_window) return scrolled_window->priv->min_content_height; } +/** + * gtk_scrolled_window_set_min_content_height: + * @scrolled_window: a #GtkScrolledWindow + * @height: the minimal content height + * + * Sets the minimum height that @scrolled_window should keep visible. + * Note that this can and (usually will) be smaller than the minimum + * size of the content. + * + * Since: 3.0 + */ void gtk_scrolled_window_set_min_content_height (GtkScrolledWindow *scrolled_window, - gint min_content_height) + gint height) { GtkScrolledWindowPrivate *priv; @@ -2227,9 +2269,9 @@ gtk_scrolled_window_set_min_content_height (GtkScrolledWindow *scrolled_window, priv = scrolled_window->priv; - if (priv->min_content_height != min_content_height) + if (priv->min_content_height != height) { - priv->min_content_height = min_content_height; + priv->min_content_height = height; gtk_widget_queue_resize (GTK_WIDGET (scrolled_window)); diff --git a/gtk/gtktable.c b/gtk/gtktable.c index 7178aa0895..80cf51a5a9 100644 --- a/gtk/gtktable.c +++ b/gtk/gtktable.c @@ -934,7 +934,7 @@ gtk_table_get_homogeneous (GtkTable *table) * @columns: (out) (allow-none): return location for the number * of columns, or %NULL * - * Returns the number of rows and columns in the table. + * Gets the number of rows and columns in the table. * * Since: 2.22 **/ diff --git a/gtk/gtkwidget.c b/gtk/gtkwidget.c index 43f8c377ba..97e89f2c51 100644 --- a/gtk/gtkwidget.c +++ b/gtk/gtkwidget.c @@ -11204,6 +11204,16 @@ gtk_widget_update_computed_expand (GtkWidget *widget) } } +/** + * gtk_widget_queue_compute_expand: + * @widget: a #GtkWidget + * + * Mark @widget as needing to recompute its expand flags. Call + * this function when setting legacy expand child properties + * on the child of a container. + * + * See gtk_widget_compute_expand(). + */ void gtk_widget_queue_compute_expand (GtkWidget *widget) { @@ -13146,6 +13156,16 @@ gtk_widget_send_focus_change (GtkWidget *widget, return res; } +/** + * gtk_widget_in_destruction: + * @widget: a #GtkWidget + * + * Returns whether the widget is currently being destroyed. + * This information can sometimes be used to avoid doing + * unnecessary work. + * + * Returns: %TRUE if @widget is being destroyed + */ gboolean gtk_widget_in_destruction (GtkWidget *widget) { |