| Top | |
|
|
|
| float | alignment | Read / Write |
| gboolean | clickable | Read / Write |
| gboolean | expand | Read / Write |
| int | fixed-width | Read / Write |
| int | max-width | Read / Write |
| int | min-width | Read / Write |
| gboolean | reorderable | Read / Write |
| gboolean | resizable | Read / Write |
| GtkTreeViewColumnSizing | sizing | Read / Write |
| int | sort-column-id | Read / Write |
| gboolean | sort-indicator | Read / Write |
| GtkSortType | sort-order | Read / Write |
| int | spacing | Read / Write |
| char * | title | Read / Write |
| gboolean | visible | Read / Write |
| GtkWidget * | widget | Read / Write |
| int | width | Read |
void (*GtkTreeCellDataFunc) (GtkTreeViewColumn *tree_column,GtkCellRenderer *cell,GtkTreeModel *tree_model,GtkTreeIter *iter,gpointer data);
GtkTreeViewColumn *
gtk_tree_view_column_new (void);
Creates a new GtkTreeViewColumn.
GtkTreeViewColumn * gtk_tree_view_column_new_with_attributes (const gchar *title,GtkCellRenderer *cell,...);
Creates a new GtkTreeViewColumn with a number of default values. This is
equivalent to calling gtk_tree_view_column_set_title(),
gtk_tree_view_column_pack_start(), and
gtk_tree_view_column_set_attributes() on the newly created GtkTreeViewColumn.
Here's a simple example:
1 2 3 4 5 6 7 8 9 10 11 12 |
enum { TEXT_COLUMN, COLOR_COLUMN, N_COLUMNS }; ... { GtkTreeViewColumn *column; GtkCellRenderer *renderer = gtk_cell_renderer_text_new (); column = gtk_tree_view_column_new_with_attributes ("Title", renderer, "text", TEXT_COLUMN, "foreground", COLOR_COLUMN, NULL); } |
title |
The title to set the header to. |
|
cell |
The GtkCellRenderer. |
|
Varargs |
A |
void gtk_tree_view_column_pack_start (GtkTreeViewColumn *tree_column,GtkCellRenderer *cell,gboolean expand);
Packs the cell
into the beginning of the column. If expand
is FALSE, then
the cell
is allocated no more space than it needs. Any unused space is divided
evenly between cells for which expand
is TRUE.
tree_column |
||
cell |
The GtkCellRenderer. |
|
expand |
|
void gtk_tree_view_column_pack_end (GtkTreeViewColumn *tree_column,GtkCellRenderer *cell,gboolean expand);
Adds the cell
to end of the column. If expand
is FALSE, then the cell
is allocated no more space than it needs. Any unused space is divided
evenly between cells for which expand
is TRUE.
tree_column |
||
cell |
The GtkCellRenderer. |
|
expand |
|
void
gtk_tree_view_column_clear (GtkTreeViewColumn *tree_column);
Unsets all the mappings on all renderers on the tree_column
.
GList *
gtk_tree_view_column_get_cell_renderers
(GtkTreeViewColumn *tree_column);
gtk_tree_view_column_get_cell_renderers has been deprecated since version 2.18 and should not be used in newly-written code.
use gtk_cell_layout_get_cells() instead.
Returns a newly-allocated GList of all the cell renderers in the column,
in no particular order. The list must be freed with g_list_free().
void gtk_tree_view_column_add_attribute (GtkTreeViewColumn *tree_column,GtkCellRenderer *cell_renderer,const gchar *attribute,gint column);
Adds an attribute mapping to the list in tree_column
. The column
is the
column of the model to get a value from, and the attribute
is the
parameter on cell_renderer
to be set from the value. So for example
if column 2 of the model contains strings, you could have the
"text" attribute of a GtkCellRendererText get its values from
column 2.
tree_column |
||
cell_renderer |
the GtkCellRenderer to set attributes on |
|
attribute |
An attribute on the renderer |
|
column |
The column position on the model to get the attribute from. |
void gtk_tree_view_column_set_attributes (GtkTreeViewColumn *tree_column,GtkCellRenderer *cell_renderer,...);
Sets the attributes in the list as the attributes of tree_column
.
The attributes should be in attribute/column order, as in
gtk_tree_view_column_add_attribute(). All existing attributes
are removed, and replaced with the new attributes.
tree_column |
||
cell_renderer |
the GtkCellRenderer we're setting the attributes of |
|
Varargs |
A |
void gtk_tree_view_column_set_cell_data_func (GtkTreeViewColumn *tree_column,GtkCellRenderer *cell_renderer,GtkTreeCellDataFunc func,gpointer func_data,GDestroyNotify destroy);
Sets the GtkTreeViewColumnFunc to use for the column. This
function is used instead of the standard attributes mapping for
setting the column value, and should set the value of tree_column
's
cell renderer as appropriate. func
may be NULL to remove an
older one.
void gtk_tree_view_column_clear_attributes (GtkTreeViewColumn *tree_column,GtkCellRenderer *cell_renderer);
Clears all existing attributes previously set with
gtk_tree_view_column_set_attributes().
void gtk_tree_view_column_set_spacing (GtkTreeViewColumn *tree_column,gint spacing);
Sets the spacing field of tree_column
, which is the number of pixels to
place between cell renderers packed into it.
gint
gtk_tree_view_column_get_spacing (GtkTreeViewColumn *tree_column);
Returns the spacing of tree_column
.
void gtk_tree_view_column_set_visible (GtkTreeViewColumn *tree_column,gboolean visible);
Sets the visibility of tree_column
.
gboolean
gtk_tree_view_column_get_visible (GtkTreeViewColumn *tree_column);
Returns TRUE if tree_column
is visible.
void gtk_tree_view_column_set_resizable (GtkTreeViewColumn *tree_column,gboolean resizable);
If resizable
is TRUE, then the user can explicitly resize the column by
grabbing the outer edge of the column button. If resizable is TRUE and
sizing mode of the column is GTK_TREE_VIEW_COLUMN_AUTOSIZE, then the sizing
mode is changed to GTK_TREE_VIEW_COLUMN_GROW_ONLY.
gboolean
gtk_tree_view_column_get_resizable (GtkTreeViewColumn *tree_column);
Returns TRUE if the tree_column
can be resized by the end user.
void gtk_tree_view_column_set_sizing (GtkTreeViewColumn *tree_column,GtkTreeViewColumnSizing type);
Sets the growth behavior of tree_column
to type
.
GtkTreeViewColumnSizing
gtk_tree_view_column_get_sizing (GtkTreeViewColumn *tree_column);
Returns the current type of tree_column
.
gint
gtk_tree_view_column_get_width (GtkTreeViewColumn *tree_column);
Returns the current size of tree_column
in pixels.
gint
gtk_tree_view_column_get_fixed_width (GtkTreeViewColumn *tree_column);
Gets the fixed width of the column. This value is only meaning may not be the actual width of the column on the screen, just what is requested.
void gtk_tree_view_column_set_fixed_width (GtkTreeViewColumn *tree_column,gint fixed_width);
Sets the size of the column in pixels. This is meaningful only if the sizing type is GTK_TREE_VIEW_COLUMN_FIXED. The size of the column is clamped to the min/max width for the column. Please note that the min/max width of the column doesn't actually affect the "fixed_width" property of the widget, just the actual size when displayed.
void gtk_tree_view_column_set_min_width (GtkTreeViewColumn *tree_column,gint min_width);
Sets the minimum width of the tree_column
. If min_width
is -1, then the
minimum width is unset.
gint
gtk_tree_view_column_get_min_width (GtkTreeViewColumn *tree_column);
Returns the minimum width in pixels of the tree_column
, or -1 if no minimum
width is set.
void gtk_tree_view_column_set_max_width (GtkTreeViewColumn *tree_column,gint max_width);
Sets the maximum width of the tree_column
. If max_width
is -1, then the
maximum width is unset. Note, the column can actually be wider than max
width if it's the last column in a view. In this case, the column expands to
fill any extra space.
gint
gtk_tree_view_column_get_max_width (GtkTreeViewColumn *tree_column);
Returns the maximum width in pixels of the tree_column
, or -1 if no maximum
width is set.
void
gtk_tree_view_column_clicked (GtkTreeViewColumn *tree_column);
Emits the "clicked" signal on the column. This function will only work if
tree_column
is clickable.
void gtk_tree_view_column_set_title (GtkTreeViewColumn *tree_column,const gchar *title);
Sets the title of the tree_column
. If a custom widget has been set, then
this value is ignored.
const gchar *
gtk_tree_view_column_get_title (GtkTreeViewColumn *tree_column);
Returns the title of the widget.
void gtk_tree_view_column_set_expand (GtkTreeViewColumn *tree_column,gboolean expand);
Sets the column to take available extra space. This space is shared equally
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
gboolean
gtk_tree_view_column_get_expand (GtkTreeViewColumn *tree_column);
Return TRUE if the column expands to take any available space.
Since: 2.4
void gtk_tree_view_column_set_clickable (GtkTreeViewColumn *tree_column,gboolean clickable);
Sets the header to be active if active
is TRUE. When the header is active,
then it can take keyboard focus, and can be clicked.
gboolean
gtk_tree_view_column_get_clickable (GtkTreeViewColumn *tree_column);
Returns TRUE if the user can click on the header for the column.
void gtk_tree_view_column_set_widget (GtkTreeViewColumn *tree_column,GtkWidget *widget);
Sets the widget in the header to be widget
. If widget is NULL, then the
header button is set with a GtkLabel set to the title of tree_column
.
GtkWidget *
gtk_tree_view_column_get_widget (GtkTreeViewColumn *tree_column);
Returns the GtkWidget in the button on the column header.
If a custom widget has not been set then NULL is returned.
void gtk_tree_view_column_set_alignment (GtkTreeViewColumn *tree_column,gfloat xalign);
Sets the alignment of the title or custom widget inside the column header. The alignment determines its location inside the button -- 0.0 for left, 0.5 for center, 1.0 for right.
gfloat
gtk_tree_view_column_get_alignment (GtkTreeViewColumn *tree_column);
Returns the current x alignment of tree_column
. This value can range
between 0.0 and 1.0.
void gtk_tree_view_column_set_reorderable (GtkTreeViewColumn *tree_column,gboolean reorderable);
If reorderable
is TRUE, then the column can be reordered by the end user
dragging the header.
gboolean
gtk_tree_view_column_get_reorderable (GtkTreeViewColumn *tree_column);
Returns TRUE if the tree_column
can be reordered by the user.
void gtk_tree_view_column_set_sort_column_id (GtkTreeViewColumn *tree_column,gint sort_column_id);
Sets the logical sort_column_id
that this column sorts on when this column
is selected for sorting. Doing so makes the column header clickable.
gint
gtk_tree_view_column_get_sort_column_id
(GtkTreeViewColumn *tree_column);
Gets the logical sort_column_id
that the model sorts on when this
column is selected for sorting.
See gtk_tree_view_column_set_sort_column_id().
void gtk_tree_view_column_set_sort_indicator (GtkTreeViewColumn *tree_column,gboolean setting);
Call this function with a setting
of TRUE to display an arrow in
the header button indicating the column is sorted. Call
gtk_tree_view_column_set_sort_order() to change the direction of
the arrow.
gboolean
gtk_tree_view_column_get_sort_indicator
(GtkTreeViewColumn *tree_column);
Gets the value set by gtk_tree_view_column_set_sort_indicator().
void gtk_tree_view_column_set_sort_order (GtkTreeViewColumn *tree_column,GtkSortType order);
Changes the appearance of the sort indicator.
This does not actually sort the model. Use
gtk_tree_view_column_set_sort_column_id() if you want automatic sorting
support. This function is primarily for custom sorting behavior, and should
be used in conjunction with gtk_tree_sortable_set_sort_column() to do
that. For custom models, the mechanism will vary.
The sort indicator changes direction to indicate normal sort or reverse sort.
Note that you must have the sort indicator enabled to see anything when
calling this function; see gtk_tree_view_column_set_sort_indicator().
GtkSortType
gtk_tree_view_column_get_sort_order (GtkTreeViewColumn *tree_column);
Gets the value set by gtk_tree_view_column_set_sort_order().
void gtk_tree_view_column_cell_set_cell_data (GtkTreeViewColumn *tree_column,GtkTreeModel *tree_model,GtkTreeIter *iter,gboolean is_expander,gboolean is_expanded);
Sets the cell renderer based on the tree_model
and iter
. That is, for
every attribute mapping in tree_column
, it will get a value from the set
column on the iter
, and use that value to set the attribute on the cell
renderer. This is used primarily by the GtkTreeView.
tree_column |
||
tree_model |
The GtkTreeModel to to get the cell renderers attributes from. |
|
iter |
The GtkTreeIter to to get the cell renderer's attributes from. |
|
is_expander |
|
|
is_expanded |
|
void gtk_tree_view_column_cell_get_size (GtkTreeViewColumn *tree_column,const GdkRectangle *cell_area,gint *x_offset,gint *y_offset,gint *width,gint *height);
Obtains the width and height needed to render the column. This is used primarily by the GtkTreeView.
tree_column |
||
cell_area |
The area a cell in the column will be allocated, or |
[allow-none] |
x_offset |
location to return x offset of a cell relative to |
[out][allow-none] |
y_offset |
location to return y offset of a cell relative to |
[out][allow-none] |
width |
location to return width needed to render a cell, or |
[out][allow-none] |
height |
location to return height needed to render a cell, or |
[out][allow-none] |
gboolean gtk_tree_view_column_cell_get_position (GtkTreeViewColumn *tree_column,GtkCellRenderer *cell_renderer,gint *start_pos,gint *width);
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.
gboolean
gtk_tree_view_column_cell_is_visible (GtkTreeViewColumn *tree_column);
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()
void gtk_tree_view_column_focus_cell (GtkTreeViewColumn *tree_column,GtkCellRenderer *cell);
Sets the current keyboard focus to be at cell
, if the column contains
2 or more editable and activatable cells.
Since: 2.2
void
gtk_tree_view_column_queue_resize (GtkTreeViewColumn *tree_column);
Flags the column, and the cell renderers added to this column, to have their sizes renegotiated.
Since: 2.8
GtkWidget *
gtk_tree_view_column_get_tree_view (GtkTreeViewColumn *tree_column);
Returns the GtkTreeView wherein tree_column
has been inserted.
If column
is currently not inserted in any tree view, NULL is
returned.
Since: 2.12
“alignment” property “alignment” float
X Alignment of the column header text or widget.
Owner: GtkTreeViewColumn
Flags: Read / Write
Allowed values: [0,1]
Default value: 0
“clickable” property “clickable” gboolean
Whether the header can be clicked.
Owner: GtkTreeViewColumn
Flags: Read / Write
Default value: FALSE
“expand” property “expand” gboolean
Column gets share of extra width allocated to the widget.
Owner: GtkTreeViewColumn
Flags: Read / Write
Default value: FALSE
“fixed-width” property “fixed-width” int
Current fixed width of the column.
Owner: GtkTreeViewColumn
Flags: Read / Write
Allowed values: >= 1
Default value: 1
“max-width” property “max-width” int
Maximum allowed width of the column.
Owner: GtkTreeViewColumn
Flags: Read / Write
Allowed values: >= -1
Default value: -1
“min-width” property “min-width” int
Minimum allowed width of the column.
Owner: GtkTreeViewColumn
Flags: Read / Write
Allowed values: >= -1
Default value: -1
“reorderable” property “reorderable” gboolean
Whether the column can be reordered around the headers.
Owner: GtkTreeViewColumn
Flags: Read / Write
Default value: FALSE
“resizable” property “resizable” gboolean
Column is user-resizable.
Owner: GtkTreeViewColumn
Flags: Read / Write
Default value: FALSE
“sizing” property“sizing” GtkTreeViewColumnSizing
Resize mode of the column.
Owner: GtkTreeViewColumn
Flags: Read / Write
Default value: GTK_TREE_VIEW_COLUMN_GROW_ONLY
“sort-column-id” property “sort-column-id” int
Logical sort column ID this column sorts on when selected for sorting. Setting the sort column ID makes the column header
clickable. Set to -1 to make the column unsortable.
Owner: GtkTreeViewColumn
Flags: Read / Write
Allowed values: >= -1
Default value: -1
Since: 2.18
“sort-indicator” property “sort-indicator” gboolean
Whether to show a sort indicator.
Owner: GtkTreeViewColumn
Flags: Read / Write
Default value: FALSE
“sort-order” property“sort-order” GtkSortType
Sort direction the sort indicator should indicate.
Owner: GtkTreeViewColumn
Flags: Read / Write
Default value: GTK_SORT_ASCENDING
“spacing” property “spacing” int
Space which is inserted between cells.
Owner: GtkTreeViewColumn
Flags: Read / Write
Allowed values: >= 0
Default value: 0
“title” property “title” char *
Title to appear in column header.
Owner: GtkTreeViewColumn
Flags: Read / Write
Default value: ""
“visible” property “visible” gboolean
Whether to display the column.
Owner: GtkTreeViewColumn
Flags: Read / Write
Default value: TRUE
“widget” property“widget” GtkWidget *
Widget to put in column header button instead of column title.
Owner: GtkTreeViewColumn
Flags: Read / Write
“clicked” signalvoid user_function (GtkTreeViewColumn *treeviewcolumn, gpointer user_data)
Flags: Run Last