Class: Gtk::TreeStore
- Inherits:
-
Object
- Object
- Gtk::TreeStore
- Defined in:
- (unknown)
Instance Method Summary collapse
-
#append(iter, parent) ⇒ nil
Appends a new row to tree_store.
-
#clear ⇒ nil
Removes all rows from tree_store.
-
#insert(iter, parent, position) ⇒ nil
Creates a new row at position.
-
#insert_after(iter, parent, sibling) ⇒ nil
Inserts a new row after sibling.
-
#insert_before(iter, parent, sibling) ⇒ nil
Inserts a new row before sibling.
-
#insert_with_values(iter, parent, position, array) ⇒ nil
Creates a new row at position.
-
#insert_with_valuesv(iter, parent, position, columns, values, n_values) ⇒ nil
A variant of gtk_tree_store_insert_with_values() which takes the columns and values as two arrays, instead of varargs.
-
#is_ancestor(iter, descendant) ⇒ TrueClass
Returns true if iter is an ancestor of descendant.
-
#iter_depth(iter) ⇒ Integer
Returns the depth of iter.
-
#iter_is_valid(iter) ⇒ TrueClass
WARNING: This function is slow.
-
#move_after(iter, position) ⇒ nil
Moves iter in tree_store to the position after position.
-
#move_before(iter, position) ⇒ nil
Moves iter in tree_store to the position before position.
-
#new(n_columns, array) ⇒ Gtk::TreeStore
Creates a new tree store as with n_columns columns each of the types passed in.
-
#newv(n_columns, types) ⇒ Gtk::TreeStore
Non vararg creation function.
-
#prepend(iter, parent) ⇒ nil
Prepends a new row to tree_store.
-
#remove(iter) ⇒ TrueClass
Removes iter from tree_store.
-
#reorder(parent, new_order) ⇒ nil
Reorders the children of parent in tree_store to follow the order indicated by new_order.
-
#set(iter, array) ⇒ nil
Sets the value of one or more cells in the row referenced by iter.
-
#set_column_types(n_columns, types) ⇒ nil
This function is meant primarily for #GObjects that inherit from Gtk::TreeStore, and should only be used when constructing a new Gtk::TreeStore.
-
#set_valist(iter, var_args) ⇒ nil
See gtk_tree_store_set(); this version takes a va_list for use by language bindings.
-
#set_value(iter, column, value) ⇒ nil
Sets the data in the cell specified by iter and column.
-
#set_valuesv(iter, columns, values, n_values) ⇒ nil
A variant of gtk_tree_store_set_valist() which takes the columns and values as two arrays, instead of varargs.
-
#swap(a, b) ⇒ nil
Swaps a and b in the same level of tree_store.
Instance Method Details
#append(iter, parent) ⇒ nil
Appends a new row to tree_store. If parent is non-nil, 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().
#clear ⇒ nil
Removes all rows from tree_store
#insert(iter, parent, position) ⇒ nil
Creates a new row at position. If parent is non-nil, then the row will be made a child of parent. Otherwise, the row will be created at the toplevel. If position is -1 or 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().
#insert_after(iter, parent, sibling) ⇒ nil
Inserts a new row after sibling. If sibling is nil, then the row will be prepended to parent ’s children. If parent and sibling are nil, 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().
#insert_before(iter, parent, sibling) ⇒ nil
Inserts a new row before sibling. If sibling is nil, then the row will be appended to parent ’s children. If parent and sibling are nil, 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().
#insert_with_values(iter, parent, position, array) ⇒ nil
Creates a new row at position. iter will be changed to point to this new row. If position is -1, or 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
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.
#insert_with_valuesv(iter, parent, position, columns, values, n_values) ⇒ nil
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.
#is_ancestor(iter, descendant) ⇒ TrueClass
Returns true if iter is an ancestor of descendant. That is, iter is the parent (or grandparent or great-grandparent) of descendant.
#iter_depth(iter) ⇒ Integer
Returns the depth of iter. This will be 0 for anything on the root level, 1 for anything down a level, etc.
#iter_is_valid(iter) ⇒ TrueClass
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 Gtk::TreeStore.
#move_after(iter, position) ⇒ nil
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 nil, iter will be moved to the start of the level.
#move_before(iter, position) ⇒ nil
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 nil, iter will be moved to the end of the level.
#new(n_columns, array) ⇒ Gtk::TreeStore
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 Gtk::TreeStore with three columns, of type #gint, #gchararray, and Gdk::Pixbuf respectively.
#newv(n_columns, types) ⇒ Gtk::TreeStore
Non vararg creation function. Used primarily by language bindings.
#prepend(iter, parent) ⇒ nil
Prepends a new row to tree_store. If parent is non-nil, 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().
#remove(iter) ⇒ TrueClass
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.
#reorder(parent, new_order) ⇒ nil
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.
#set(iter, array) ⇒ nil
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.
#set_column_types(n_columns, types) ⇒ nil
This function is meant primarily for #GObjects that inherit from Gtk::TreeStore, and should only be used when constructing a new Gtk::TreeStore. It will not function after a row has been added, or a method on the Gtk::TreeModel interface is called.
#set_valist(iter, var_args) ⇒ nil
See gtk_tree_store_set(); this version takes a va_list for use by language bindings.
#set_value(iter, column, value) ⇒ nil
Sets the data in the cell specified by iter and column. The type of value must be convertible to the type of the column.
#set_valuesv(iter, columns, values, n_values) ⇒ nil
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.
#swap(a, b) ⇒ nil
Swaps a and b in the same level of tree_store. Note that this function only works with unsorted stores.