Top |
GtkTreeStore * | gtk_tree_store_new () |
GtkTreeStore * | gtk_tree_store_newv () |
void | gtk_tree_store_set_column_types () |
void | gtk_tree_store_set_value () |
void | gtk_tree_store_set () |
void | gtk_tree_store_set_valist () |
void | gtk_tree_store_set_valuesv () |
gboolean | gtk_tree_store_remove () |
void | gtk_tree_store_insert () |
void | gtk_tree_store_insert_before () |
void | gtk_tree_store_insert_after () |
void | gtk_tree_store_insert_with_values () |
void | gtk_tree_store_insert_with_valuesv () |
void | gtk_tree_store_prepend () |
void | gtk_tree_store_append () |
gboolean | gtk_tree_store_is_ancestor () |
gint | gtk_tree_store_iter_depth () |
void | gtk_tree_store_clear () |
gboolean | gtk_tree_store_iter_is_valid () |
void | gtk_tree_store_reorder () |
void | gtk_tree_store_swap () |
void | gtk_tree_store_move_before () |
void | gtk_tree_store_move_after () |
GtkTreeStore implements GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest, GtkTreeSortable and GtkBuildable.
GtkTreeStore * gtk_tree_store_new (gint n_columns
,...
);
Creates a new tree store as with n_columns
columns each of the types passed
in. Note that only types derived from standard GObject fundamental types
are supported.
As an example, gtk_tree_store_new (3, G_TYPE_INT, G_TYPE_STRING,
GDK_TYPE_PIXBUF);
will create a new GtkTreeStore with three columns, of type
GtkTreeStore * gtk_tree_store_newv (gint n_columns
,GType *types
);
Non vararg creation function. Used primarily by language bindings.
void gtk_tree_store_set_column_types (GtkTreeStore *tree_store
,gint n_columns
,GType *types
);
This function is meant primarily for GObjects that inherit from GtkTreeStore, and should only be used when constructing a new GtkTreeStore. It will not function after a row has been added, or a method on the GtkTreeModel interface is called.
void gtk_tree_store_set_value (GtkTreeStore *tree_store
,GtkTreeIter *iter
,gint column
,GValue *value
);
Sets the data in the cell specified by iter
and column
.
The type of value
must be convertible to the type of the
column.
tree_store |
||
iter |
A valid GtkTreeIter for the row being modified |
|
column |
column number to modify |
|
value |
new value for the cell |
void gtk_tree_store_set (GtkTreeStore *tree_store
,GtkTreeIter *iter
,...
);
Sets the value of one or more cells in the row referenced by iter
.
The variable argument list should contain integer column numbers,
each column number followed by the value to be set.
The list is terminated by a -1. For example, to set column 0 with type
G_TYPE_STRING
to "Foo", you would write
gtk_tree_store_set (store, iter, 0, "Foo", -1)
.
The value will be referenced by the store if it is a G_TYPE_OBJECT
, and it
will be copied if it is a G_TYPE_STRING
or G_TYPE_BOXED
.
tree_store |
||
iter |
A valid GtkTreeIter for the row being modified |
|
Varargs |
pairs of column number and value, terminated with -1 |
void gtk_tree_store_set_valist (GtkTreeStore *tree_store
,GtkTreeIter *iter
,va_list var_args
);
See gtk_tree_store_set()
; this version takes a va_list for
use by language bindings.
tree_store |
||
iter |
A valid GtkTreeIter for the row being modified |
|
var_args |
va_list of column/value pairs |
void gtk_tree_store_set_valuesv (GtkTreeStore *tree_store
,GtkTreeIter *iter
,gint *columns
,GValue *values
,gint n_values
);
A variant of gtk_tree_store_set_valist()
which takes
the columns and values as two arrays, instead of varargs. This
function is mainly intended for language bindings or in case
the number of columns to change is not known until run-time.
tree_store |
||
iter |
A valid GtkTreeIter for the row being modified |
|
columns |
an array of column numbers. |
[array length=n_values] |
values |
an array of GValues. |
[array length=n_values] |
n_values |
the length of the |
Since: 2.12
gboolean gtk_tree_store_remove (GtkTreeStore *tree_store
,GtkTreeIter *iter
);
Removes iter
from tree_store
. After being removed, iter
is set to the
next valid row at that level, or invalidated if it previously pointed to the
last one.
void gtk_tree_store_insert (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *parent
,gint position
);
Creates a new row at position
. If parent is non-NULL
, then the row will be
made a child of parent
. Otherwise, the row will be created at the toplevel.
If position
is larger than the number of rows at that level, then the new
row will be inserted to the end of the list. iter
will be changed to point
to this new row. The row will be empty after this function is called. To
fill in values, you need to call gtk_tree_store_set()
or
gtk_tree_store_set_value()
.
tree_store |
||
iter |
An unset GtkTreeIter to set to the new row. |
[out] |
parent |
A valid GtkTreeIter, or |
[allow-none] |
position |
position to insert the new row |
void gtk_tree_store_insert_before (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *parent
,GtkTreeIter *sibling
);
Inserts a new row before sibling
. If sibling
is NULL
, then the row will
be appended to parent
's children. If parent
and sibling
are NULL
, then
the row will be appended to the toplevel. If both sibling
and parent
are
set, then parent
must be the parent of sibling
. When sibling
is set,
parent
is optional.
iter
will be changed to point to this new row. The row will be empty after
this function is called. To fill in values, you need to call
gtk_tree_store_set()
or gtk_tree_store_set_value()
.
tree_store |
||
iter |
An unset GtkTreeIter to set to the new row. |
[out] |
parent |
A valid GtkTreeIter, or |
[allow-none] |
sibling |
A valid GtkTreeIter, or |
[allow-none] |
void gtk_tree_store_insert_after (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *parent
,GtkTreeIter *sibling
);
Inserts a new row after sibling
. If sibling
is NULL
, then the row will be
prepended to parent
's children. If parent
and sibling
are NULL
, then
the row will be prepended to the toplevel. If both sibling
and parent
are
set, then parent
must be the parent of sibling
. When sibling
is set,
parent
is optional.
iter
will be changed to point to this new row. The row will be empty after
this function is called. To fill in values, you need to call
gtk_tree_store_set()
or gtk_tree_store_set_value()
.
tree_store |
||
iter |
An unset GtkTreeIter to set to the new row. |
[out] |
parent |
A valid GtkTreeIter, or |
[allow-none] |
sibling |
A valid GtkTreeIter, or |
[allow-none] |
void gtk_tree_store_insert_with_values (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *parent
,gint position
,...
);
Creates a new row at position
. iter
will be changed to point to this
new row. If position
is larger than the number of rows on the list, then
the new row will be appended to the list. The row will be filled with
the values given to this function.
Calling
gtk_tree_store_insert_with_values (tree_store, iter, position, ...)
has the same effect as calling
1 2 |
gtk_tree_store_insert (tree_store, iter, position); gtk_tree_store_set (tree_store, iter, ...); |
with the different that the former will only emit a row_inserted signal,
while the latter will emit row_inserted, row_changed and if the tree store
is sorted, rows_reordered. Since emitting the rows_reordered signal
repeatedly can affect the performance of the program,
gtk_tree_store_insert_with_values()
should generally be preferred when
inserting rows in a sorted tree store.
tree_store |
||
iter |
An unset GtkTreeIter to set the new row, or |
[out][allow-none] |
parent |
A valid GtkTreeIter, or |
[allow-none] |
position |
position to insert the new row |
|
Varargs |
pairs of column number and value, terminated with -1 |
Since: 2.10
void gtk_tree_store_insert_with_valuesv (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *parent
,gint position
,gint *columns
,GValue *values
,gint n_values
);
A variant of gtk_tree_store_insert_with_values()
which takes
the columns and values as two arrays, instead of varargs. This
function is mainly intended for language bindings.
tree_store |
||
iter |
An unset GtkTreeIter to set the new row, or |
[out][allow-none] |
parent |
A valid GtkTreeIter, or |
[allow-none] |
position |
position to insert the new row |
|
columns |
an array of column numbers. |
[array length=n_values] |
values |
an array of GValues. |
[array length=n_values] |
n_values |
the length of the |
Since: 2.10
void gtk_tree_store_prepend (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *parent
);
Prepends a new row to tree_store
. If parent
is non-NULL
, then it will prepend
the new row before the first child of parent
, otherwise it will prepend a row
to the top level. iter
will be changed to point to this new row. The row
will be empty after this function is called. To fill in values, you need to
call gtk_tree_store_set()
or gtk_tree_store_set_value()
.
tree_store |
||
iter |
An unset GtkTreeIter to set to the prepended row. |
[out] |
parent |
A valid GtkTreeIter, or |
[allow-none] |
void gtk_tree_store_append (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *parent
);
Appends a new row to tree_store
. If parent
is non-NULL
, then it will append the
new row after the last child of parent
, otherwise it will append a row to
the top level. iter
will be changed to point to this new row. The row will
be empty after this function is called. To fill in values, you need to call
gtk_tree_store_set()
or gtk_tree_store_set_value()
.
tree_store |
||
iter |
An unset GtkTreeIter to set to the appended row. |
[out] |
parent |
A valid GtkTreeIter, or |
[allow-none] |
gboolean gtk_tree_store_is_ancestor (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *descendant
);
Returns TRUE
if iter
is an ancestor of descendant
. That is, iter
is the
parent (or grandparent or great-grandparent) of descendant
.
gint gtk_tree_store_iter_depth (GtkTreeStore *tree_store
,GtkTreeIter *iter
);
Returns the depth of iter
. This will be 0 for anything on the root level, 1
for anything down a level, etc.
void
gtk_tree_store_clear (GtkTreeStore *tree_store
);
Removes all rows from tree_store
gboolean gtk_tree_store_iter_is_valid (GtkTreeStore *tree_store
,GtkTreeIter *iter
);
WARNING: This function is slow. Only use it for debugging and/or testing purposes.
Checks if the given iter is a valid iter for this GtkTreeStore.
Since: 2.2
void gtk_tree_store_reorder (GtkTreeStore *tree_store
,GtkTreeIter *parent
,gint *new_order
);
Reorders the children of parent
in tree_store
to follow the order
indicated by new_order
. Note that this function only works with
unsorted stores.
tree_store |
A GtkTreeStore. |
|
parent |
A GtkTreeIter. |
|
new_order |
an array of integers mapping the new position of each child
to its old position before the re-ordering,
i.e. |
[array] |
Since: 2.2
void gtk_tree_store_swap (GtkTreeStore *tree_store
,GtkTreeIter *a
,GtkTreeIter *b
);
Swaps a
and b
in the same level of tree_store
. Note that this function
only works with unsorted stores.
Since: 2.2
void gtk_tree_store_move_before (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *position
);
Moves iter
in tree_store
to the position before position
. iter
and
position
should be in the same level. Note that this function only
works with unsorted stores. If position
is NULL
, iter
will be
moved to the end of the level.
tree_store |
A GtkTreeStore. |
|
iter |
A GtkTreeIter. |
|
position |
A GtkTreeIter or |
[allow-none] |
Since: 2.2
void gtk_tree_store_move_after (GtkTreeStore *tree_store
,GtkTreeIter *iter
,GtkTreeIter *position
);
Moves iter
in tree_store
to the position after position
. iter
and
position
should be in the same level. Note that this function only
works with unsorted stores. If position
is NULL
, iter
will be moved
to the start of the level.
Since: 2.2