summaryrefslogtreecommitdiff
path: root/gtk
diff options
context:
space:
mode:
authorMatthias Clasen <maclas@gmx.de>2003-04-12 22:25:21 +0000
committerMatthias Clasen <matthiasc@src.gnome.org>2003-04-12 22:25:21 +0000
commit913e6e9ea9c1f92fc3dff71d0395542c7f5a3618 (patch)
treeada9120ba57e96c6e193013a17f88205f2855a6a /gtk
parente2abcc2dea4aa42dcc057f531acfc2208d489685 (diff)
downloadgdk-pixbuf-913e6e9ea9c1f92fc3dff71d0395542c7f5a3618.tar.gz
Document.
2003-04-13 Matthias Clasen <maclas@gmx.de> * gtk/gtktreeviewcolumn.c (gtk_tree_view_column_cell_get_position): Document. * gtk/gtktextbuffer.c (gtk_text_buffer_select_range): * gtk/gtktreeviewcolumn.c (gtk_tree_view_column_[sg]et_expand): * gtk/gtkbutton.c (gtk_button_[sg]et_focus_on_click): Document these as 2.4 additions.
Diffstat (limited to 'gtk')
-rw-r--r--gtk/gtkbutton.c4
-rw-r--r--gtk/gtktextbuffer.c2
-rw-r--r--gtk/gtktreeviewcolumn.c35
3 files changed, 33 insertions, 8 deletions
diff --git a/gtk/gtkbutton.c b/gtk/gtkbutton.c
index 165f60e27..84ebed24e 100644
--- a/gtk/gtkbutton.c
+++ b/gtk/gtkbutton.c
@@ -1262,6 +1262,8 @@ gtk_button_get_use_stock (GtkButton *button)
* Making mouse clicks not grab focus is useful in places like toolbars where
* you don't want the keyboard focus removed from the main area of the
* application.
+ *
+ * Since: 2.4
**/
void
gtk_button_set_focus_on_click (GtkButton *button,
@@ -1288,6 +1290,8 @@ gtk_button_set_focus_on_click (GtkButton *button,
*
* Return value: %TRUE if the button grabs focus when it is clicked with
* the mouse.
+ *
+ * Since: 2.4
**/
gboolean
gtk_button_get_focus_on_click (GtkButton *button)
diff --git a/gtk/gtktextbuffer.c b/gtk/gtktextbuffer.c
index ec50c419c..9f0b12738 100644
--- a/gtk/gtktextbuffer.c
+++ b/gtk/gtktextbuffer.c
@@ -2026,6 +2026,8 @@ gtk_text_buffer_place_cursor (GtkTextBuffer *buffer,
* inefficient since the temporarily-selected region will force stuff
* to be recalculated. This function moves them as a unit, which can
* be optimized.
+ *
+ * Since: 2.4
**/
void
gtk_text_buffer_select_range (GtkTextBuffer *buffer,
diff --git a/gtk/gtktreeviewcolumn.c b/gtk/gtktreeviewcolumn.c
index d6e07c4df..6195bed87 100644
--- a/gtk/gtktreeviewcolumn.c
+++ b/gtk/gtktreeviewcolumn.c
@@ -1642,9 +1642,9 @@ gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,
* gtk_tree_view_column_get_resizable:
* @tree_column: A #GtkTreeViewColumn
*
- * Returns #TRUE if the @tree_column can be resized by the end user.
+ * Returns %TRUE if the @tree_column can be resized by the end user.
*
- * Return value: #TRUE, if the @tree_column can be resized.
+ * Return value: %TRUE, if the @tree_column can be resized.
**/
gboolean
gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column)
@@ -1956,6 +1956,8 @@ gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column)
* amongst all columns that have the expand set to %TRUE. If no column has this
* option set, then the last column gets all extra space. By default, every
* column is created with this %FALSE.
+ *
+ * Since: 2.4
**/
void
gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
@@ -1985,6 +1987,8 @@ gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,
* Return %TRUE if the column expands to take any available space.
*
* Return value: %TRUE, if the column expands
+ *
+ * Since: 2.4
**/
gboolean
gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column)
@@ -2124,9 +2128,9 @@ gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column)
/**
* gtk_tree_view_column_set_reorderable:
* @tree_column: A #GtkTreeViewColumn
- * @reorderable: #TRUE, if the column can be reordered.
+ * @reorderable: %TRUE, if the column can be reordered.
*
- * If @reorderable is #TRUE, then the column can be reordered by the end user
+ * If @reorderable is %TRUE, then the column can be reordered by the end user
* dragging the header.
**/
void
@@ -2150,9 +2154,9 @@ gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,
* gtk_tree_view_column_get_reorderable:
* @tree_column: A #GtkTreeViewColumn
*
- * Returns #TRUE if the @tree_column can be reordered by the user.
+ * Returns %TRUE if the @tree_column can be reordered by the user.
*
- * Return value: #TRUE if the @tree_column can be reordered by the user.
+ * Return value: %TRUE if the @tree_column can be reordered by the user.
**/
gboolean
gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column)
@@ -3209,11 +3213,11 @@ _gtk_tree_view_column_cell_draw_focus (GtkTreeViewColumn *tree_column,
* gtk_tree_view_column_cell_is_visible:
* @tree_column: A #GtkTreeViewColumn
*
- * Returns #TRUE if any of the cells packed into the @tree_column are visible.
+ * Returns %TRUE if any of the cells packed into the @tree_column are visible.
* For this to be meaningful, you must first initialize the cells with
* gtk_tree_view_column_cell_set_cell_data()
*
- * Return value: #TRUE, if any of the cells packed into the @tree_column are currently visible
+ * Return value: %TRUE, if any of the cells packed into the @tree_column are currently visible
**/
gboolean
gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column)
@@ -3390,6 +3394,20 @@ _gtk_tree_view_column_get_neighbor_sizes (GtkTreeViewColumn *column,
}
}
+/**
+ * gtk_tree_view_column_cell_get_position:
+ * @tree_column: a #GtkTreeViewColumn
+ * @cell: a #GtkCellRenderer
+ * @start_pos: return location for the horizontal position of @cell within
+ * @tree_column, may be %NULL
+ * @width: return location for the width of @cell, may be %NULL
+ *
+ * Obtains the horizontal position and size of a cell in a column. If the
+ * cell is not found in the column, @start_pos and @width are not changed and
+ * %FALSE is returned.
+ *
+ * Return value: %TRUE if @cell belongs to @tree_column.
+ */
gboolean
gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
GtkCellRenderer *cell_renderer,
@@ -3425,3 +3443,4 @@ gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,
return found_cell;
}
+