summaryrefslogtreecommitdiff
path: root/gtk
diff options
context:
space:
mode:
authorMatthias Clasen <mclasen@redhat.com>2005-03-17 03:23:23 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2005-03-17 03:23:23 +0000
commit7049dbf12f63594c3244ab02fac797e156f3bc26 (patch)
tree4785fdb550e2d344677ec5d444a503c25b1cfce1 /gtk
parent09d7eafb15099362c0ed611d775b1f2fe5f17f94 (diff)
downloadgtk+-7049dbf12f63594c3244ab02fac797e156f3bc26.tar.gz
Typo fix in the docs.
2005-03-16 Matthias Clasen <mclasen@redhat.com> * gtk/gtkprogressbar.c (gtk_progress_bar_get_ellipsize): Typo fix in the docs. * gtk/gtkmenutoolbutton.c (gtk_menu_tool_button_set_arrow_tooltip): Typo fix in the docs. * gtk/gtkiconview.c (gtk_icon_view_get_columns) (gtk_icon_view_set_columns, gtk_icon_view_set_item_width) (gtk_icon_view_get_item_width, gtk_icon_view_set_spacing) (gtk_icon_view_get_spacing, gtk_icon_view_set_row_spacing) (gtk_icon_view_set_column_spacing, gtk_icon_view_get_row_spacing) (gtk_icon_view_get_column_spacing, gtk_icon_view_set_margin) (gtk_icon_view_get_margin): Add docs. * gtk/gtkcellview.c (gtk_cell_view_get_displayed_row): Add docs.
Diffstat (limited to 'gtk')
-rw-r--r--gtk/gtkiconview.c155
-rw-r--r--gtk/gtkmenutoolbutton.c2
-rw-r--r--gtk/gtkprogressbar.c2
3 files changed, 145 insertions, 14 deletions
diff --git a/gtk/gtkiconview.c b/gtk/gtkiconview.c
index c36301f399..205e0d2e82 100644
--- a/gtk/gtkiconview.c
+++ b/gtk/gtkiconview.c
@@ -3702,8 +3702,21 @@ gtk_icon_view_get_orientation (GtkIconView *icon_view)
return icon_view->priv->orientation;
}
-void gtk_icon_view_set_columns (GtkIconView *icon_view,
- gint columns)
+/**
+ * gtk_icon_view_set_columns:
+ * @icon_view: a #GtkIconView
+ * @columns: the number of columns
+ *
+ * Sets the ::columns property which determines in how
+ * many columns the icons are arranged. If @columns is
+ * -1, the number of columns will be chosen automatically
+ * to fill the available area.
+ *
+ * Since: 2.6
+ */
+void
+gtk_icon_view_set_columns (GtkIconView *icon_view,
+ gint columns)
{
g_return_if_fail (GTK_IS_ICON_VIEW (icon_view));
@@ -3717,6 +3730,16 @@ void gtk_icon_view_set_columns (GtkIconView *icon_view,
}
}
+/**
+ * gtk_icon_view_get_columns:
+ * @icon_view: a #GtkIconView
+ *
+ * Returns the value of the ::columns property.
+ *
+ * Return value: the number of columns, or -1
+ *
+ * Since: 2.6
+ */
gint
gtk_icon_view_get_columns (GtkIconView *icon_view)
{
@@ -3725,8 +3748,20 @@ gtk_icon_view_get_columns (GtkIconView *icon_view)
return icon_view->priv->columns;
}
-void gtk_icon_view_set_item_width (GtkIconView *icon_view,
- gint item_width)
+/**
+ * gtk_icon_view_set_item_width:
+ * @icon_view: a #GtkIconView
+ * @item_width: the width for each item
+ *
+ * Sets the ::item-width property which specifies the width
+ * to use for each item. If it is set to -1, the icon view will
+ * automatically determine a suitable item size.
+ *
+ * Since: 2.6
+ */
+void
+gtk_icon_view_set_item_width (GtkIconView *icon_view,
+ gint item_width)
{
g_return_if_fail (GTK_IS_ICON_VIEW (icon_view));
@@ -3741,6 +3776,16 @@ void gtk_icon_view_set_item_width (GtkIconView *icon_view,
}
}
+/**
+ * gtk_icon_view_get_item_width:
+ * @icon_view: a #GtkIconView
+ *
+ * Returns the value of the ::item-width property.
+ *
+ * Return value: the width of a single item, or -1
+ *
+ * Since: 2.6
+ */
gint
gtk_icon_view_get_item_width (GtkIconView *icon_view)
{
@@ -3750,8 +3795,20 @@ gtk_icon_view_get_item_width (GtkIconView *icon_view)
}
-void gtk_icon_view_set_spacing (GtkIconView *icon_view,
- gint spacing)
+/**
+ * gtk_icon_view_set_item_width:
+ * @icon_view: a #GtkIconView
+ * @spacing: the spacing
+ *
+ * Sets the ::spacing property which specifies the space
+ * which is inserted between the cells (i.e. the icon and
+ * the text) of an item.
+ *
+ * Since: 2.6
+ */
+void
+gtk_icon_view_set_spacing (GtkIconView *icon_view,
+ gint spacing)
{
g_return_if_fail (GTK_IS_ICON_VIEW (icon_view));
@@ -3766,6 +3823,16 @@ void gtk_icon_view_set_spacing (GtkIconView *icon_view,
}
}
+/**
+ * gtk_icon_view_get_spacing:
+ * @icon_view: a #GtkIconView
+ *
+ * Returns the value of the ::spacing property.
+ *
+ * Return value: the space between cells
+ *
+ * Since: 2.6
+ */
gint
gtk_icon_view_get_spacing (GtkIconView *icon_view)
{
@@ -3774,8 +3841,19 @@ gtk_icon_view_get_spacing (GtkIconView *icon_view)
return icon_view->priv->spacing;
}
-void gtk_icon_view_set_row_spacing (GtkIconView *icon_view,
- gint row_spacing)
+/**
+ * gtk_icon_view_set_row_spacing:
+ * @icon_view: a #GtkIconView
+ * @spacing: the row spacing
+ *
+ * Sets the ::row-spacing property which specifies the space
+ * which is inserted between the rows of the icon view.
+ *
+ * Since: 2.6
+ */
+void
+gtk_icon_view_set_row_spacing (GtkIconView *icon_view,
+ gint row_spacing)
{
g_return_if_fail (GTK_IS_ICON_VIEW (icon_view));
@@ -3790,6 +3868,16 @@ void gtk_icon_view_set_row_spacing (GtkIconView *icon_view,
}
}
+/**
+ * gtk_icon_view_get_row_spacing:
+ * @icon_view: a #GtkIconView
+ *
+ * Returns the value of the ::row-spacing property.
+ *
+ * Return value: the space between rows
+ *
+ * Since: 2.6
+ */
gint
gtk_icon_view_get_row_spacing (GtkIconView *icon_view)
{
@@ -3798,8 +3886,19 @@ gtk_icon_view_get_row_spacing (GtkIconView *icon_view)
return icon_view->priv->row_spacing;
}
-void gtk_icon_view_set_column_spacing (GtkIconView *icon_view,
- gint column_spacing)
+/**
+ * gtk_icon_view_set_column_spacing:
+ * @icon_view: a #GtkIconView
+ * @spacing: the column spacing
+ *
+ * Sets the ::column-spacing property which specifies the space
+ * which is inserted between the columns of the icon view.
+ *
+ * Since: 2.6
+ */
+void
+gtk_icon_view_set_column_spacing (GtkIconView *icon_view,
+ gint column_spacing)
{
g_return_if_fail (GTK_IS_ICON_VIEW (icon_view));
@@ -3814,6 +3913,16 @@ void gtk_icon_view_set_column_spacing (GtkIconView *icon_view,
}
}
+/**
+ * gtk_icon_view_get_column_spacing:
+ * @icon_view: a #GtkIconView
+ *
+ * Returns the value of the ::column-spacing property.
+ *
+ * Return value: the space between columns
+ *
+ * Since: 2.6
+ */
gint
gtk_icon_view_get_column_spacing (GtkIconView *icon_view)
{
@@ -3822,8 +3931,20 @@ gtk_icon_view_get_column_spacing (GtkIconView *icon_view)
return icon_view->priv->column_spacing;
}
-void gtk_icon_view_set_margin (GtkIconView *icon_view,
- gint margin)
+/**
+ * gtk_icon_view_set_marging:
+ * @icon_view: a #GtkIconView
+ * @spacing: the margin
+ *
+ * Sets the ::margin property which specifies the space
+ * which is inserted at the top, bottom, left and right
+ * of the icon view.
+ *
+ * Since: 2.6
+ */
+void
+gtk_icon_view_set_margin (GtkIconView *icon_view,
+ gint margin)
{
g_return_if_fail (GTK_IS_ICON_VIEW (icon_view));
@@ -3838,6 +3959,16 @@ void gtk_icon_view_set_margin (GtkIconView *icon_view,
}
}
+/**
+ * gtk_icon_view_get_margin:
+ * @icon_view: a #GtkIconView
+ *
+ * Returns the value of the ::margin property.
+ *
+ * Return value: the space at the borders
+ *
+ * Since: 2.6
+ */
gint
gtk_icon_view_get_margin (GtkIconView *icon_view)
{
diff --git a/gtk/gtkmenutoolbutton.c b/gtk/gtkmenutoolbutton.c
index 6448d6e154..ad6932630f 100644
--- a/gtk/gtkmenutoolbutton.c
+++ b/gtk/gtkmenutoolbutton.c
@@ -586,7 +586,7 @@ gtk_menu_tool_button_get_menu (GtkMenuToolButton *button)
}
/**
- * gtk_menu_tool_set_arrow_tooltip:
+ * gtk_menu_tool_button_set_arrow_tooltip:
* @button: a #GtkMenuToolButton
* @tooltips: the #GtkTooltips object to be used
* @tip_text: text to be used as tooltip text for tool_item
diff --git a/gtk/gtkprogressbar.c b/gtk/gtkprogressbar.c
index 6482eb4249..1ba4cbf5a3 100644
--- a/gtk/gtkprogressbar.c
+++ b/gtk/gtkprogressbar.c
@@ -1253,7 +1253,7 @@ gtk_progress_bar_set_ellipsize (GtkProgressBar *pbar,
}
/**
- * gtk_pgrogress_bar_get_ellipsize:
+ * gtk_progress_bar_get_ellipsize:
* @pbar: a #GtkProgressBar
*
* Returns the ellipsizing position of the progressbar.