Back to Seed Clases

Gtk

Classes

Interfaces

Structs

Unions

DitherInfo

Enums

GObject.Object
parent-child marker Gtk.TreeModelSort

Class Gtk.TreeModelSort

Import line:	Gtk = imports.gi.Gtk;
GIR File:	Gtk-2.0.gir
C documentation:	GtkTreeModelSort
Class :	TreeModelSort
Implements:	Gtk.TreeDragSource, Gtk.TreeModel, Gtk.TreeSortable
Extends:	GObject.Object
	Show / Hide Inherited methods, properties and signals

Properties
Properties		Defined By
	changed_id : Number read only	Gtk.TreeModelSort
	child_flags : Number read only	Gtk.TreeModelSort
	child_model : Gtk.TreeModel read only	Gtk.TreeModelSort
	default_sort_data : void* read only	Gtk.TreeModelSort
	default_sort_destroy : [object Object] read only	Gtk.TreeModelSort
	default_sort_func : [object Object] read only	Gtk.TreeModelSort
	deleted_id : Number read only	Gtk.TreeModelSort
	has_child_toggled_id : Number read only	Gtk.TreeModelSort
	inserted_id : Number read only	Gtk.TreeModelSort
	model : Gtk.TreeModel	Gtk.TreeModelSort
	order : Gtk.SortType read only	Gtk.TreeModelSort
	parent : GObject.Object read only	Gtk.TreeModelSort
	reordered_id : Number read only	Gtk.TreeModelSort
	root : void* read only	Gtk.TreeModelSort
	sort_column_id : Number read only	Gtk.TreeModelSort
	sort_list : Array read only	Gtk.TreeModelSort
	stamp : Number read only	Gtk.TreeModelSort
	zero_ref_count : Number read only	Gtk.TreeModelSort

Methods / Constructors
Method / Constructor		Defined By
	new Gtk.TreeModelSort (Object *properties) Create a new Gtk.TreeModelSort Create a new Gtk.TreeModelSort Parameters: Object properties*
	new Gtk.TreeModelSort.with_model (TreeModel *child_model) : Gtk.TreeModelSort Create a new Gtk.TreeModelSort Create a new Gtk.TreeModelSort Parameters: Gtk.TreeModel child_model* Required (not null) Returns: Gtk.TreeModelSort
	clear_cache () : none This function should almost never be called. This function should almost never be called. It clears the tree_model_sort of any cached iterators that haven't been reffed with gtk_tree_model_ref_node(). This might be useful if the child model being sorted is static (and doesn't change often) and there has been a lot of unreffed access to nodes. As a side effect of this function, all unreffed iters will be invalid. Returns: none	Gtk.TreeModelSort
	convert_child_iter_to_iter (TreeIter *sort_iter, TreeIter child_iter) : Boolean Sets sort_iter* to point to the row in tree_model_sort that corresponds to the row pointed at by child_iter. Sets sort_iter to point to the row in tree_model_sort that corresponds to the row pointed at by child_iter. If sort_iter was not set, FALSE valid iterator pointer to a visible row in the child model. Parameters: Gtk.TreeIter sort_iter Required (not null) Gtk.TreeIter child_iter Required (not null) Returns: Boolean	Gtk.TreeModelSort
	convert_child_path_to_path (TreePath *child_path) : Gtk.TreePath Converts child_path* to a path relative to tree_model_sort. Converts child_path to a path relative to tree_model_sort. That is, point to the same row in the sorted model. If child_path isn't a valid path on the child model, then NULL is returned. Parameters: Gtk.TreePath child_path Required (not null) Returns: Gtk.TreePath	Gtk.TreeModelSort
	convert_iter_to_child_iter (TreeIter *child_iter, TreeIter sorted_iter) : none Sets child_iter* to point to the row pointed to by sorted_iter. Sets child_iter to point to the row pointed to by sorted_iter. Parameters: Gtk.TreeIter child_iter Required (not null) Gtk.TreeIter sorted_iter Required (not null) Returns: none	Gtk.TreeModelSort
	convert_path_to_child_path (TreePath *sorted_path) : Gtk.TreePath Converts sorted_path* to a path on the child model of tree_model_sort. Converts sorted_path to a path on the child model of tree_model_sort. That is, sorted_path points to a location in tree_model_sort. The returned path will point to the same location in the model not being sorted. If sorted_path does not point to a location in the child model, NULL is returned. Parameters: Gtk.TreePath sorted_path Required (not null) Returns: Gtk.TreePath	Gtk.TreeModelSort
	drag_data_delete (TreePath *path) : Boolean Asks the GtkTreeDragSource* to delete the row at path, because it was moved somewhere else via drag-and-drop. Asks the GtkTreeDragSource to delete the row at path, because it was moved somewhere else via drag-and-drop. Returns FALSE if the deletion fails because path no longer exists, or for some model-specific reason. Should robustly handle a path no longer found in the model! Parameters: Gtk.TreePath path Required (not null) Returns: Boolean	Gtk.TreeDragSource
	drag_data_get (TreePath *path, SelectionData selection_data) : Boolean Asks the GtkTreeDragSource* to fill in selection_data with a representation of the row at path. Asks the GtkTreeDragSource to fill in selection_data with a representation of the row at path. selection_data->target gives the required type of the data. Should robustly handle a path no longer found in the model! Parameters: Gtk.TreePath path Required (not null) Gtk.SelectionData selection_data Required (not null) Returns: Boolean	Gtk.TreeDragSource
	foreach (Function *func, void *user_data) : none Calls func on each node in model in a depth-first fashion. Calls func on each node in model in a depth-first fashion. If func* returns TRUE, then the tree ceases to be walked, and gtk_tree_model_foreach() returns. Parameters: Function (TreeModel *model, TreePath path, TreeIter iter, void *data) : none Required (not null) void user_data Required (not null) Returns: none	Gtk.TreeModel
	get_column_type (Number *index_) : Number Returns the type of the column. Returns the type of the column. Parameters: Number index_* Required (not null) Returns: Number	Gtk.TreeModel
	get_flags () : Gtk.TreeModelFlags Returns a set of flags supported by this interface. Returns a set of flags supported by this interface. The flags are a bitwise combination of GtkTreeModelFlags. The flags supported should not change during the lifecycle of the tree_model. Returns: Gtk.TreeModelFlags	Gtk.TreeModel
	get_iter (TreeIter *iter, TreePath path) : Boolean Sets iter* to a valid iterator pointing to path. Sets iter to a valid iterator pointing to path. Parameters: Gtk.TreeIter iter Required (not null) Gtk.TreePath path Required (not null) Returns: Boolean	Gtk.TreeModel
	get_iter_first (TreeIter *iter) : Boolean Initializes iter* with the first iterator in the tree (the one at the path "0") and returns TRUE. Initializes iter with the first iterator in the tree (the one at the path "0") and returns TRUE. Returns FALSE if the tree is empty. Parameters: Gtk.TreeIter iter Required (not null) Returns: Boolean	Gtk.TreeModel
	get_iter_from_string (TreeIter *iter, String path_string) : Boolean Sets iter* to a valid iterator pointing to path_string, if it exists. Sets iter to a valid iterator pointing to path_string, if it exists. Otherwise, iter is left invalid and FALSE is returned. Parameters: Gtk.TreeIter iter Required (not null) String path_string Required (not null) Returns: Boolean	Gtk.TreeModel
	get_model () : Gtk.TreeModel Returns the model the GtkTreeModelSort is sorting. Returns the model the GtkTreeModelSort is sorting. Returns: Gtk.TreeModel	Gtk.TreeModelSort
	get_n_columns () : Number Returns the number of columns supported by tree_model. Returns the number of columns supported by tree_model. Returns: Number	Gtk.TreeModel
	get_path (TreeIter *iter) : Gtk.TreePath Returns a newly-created GtkTreePath* referenced by iter. Returns a newly-created GtkTreePath referenced by iter. This path should be freed with gtk_tree_path_free(). Parameters: Gtk.TreeIter iter Required (not null) Returns: Gtk.TreePath	Gtk.TreeModel
	get_sort_column_id (Object *out_values, SortType order) : Boolean Fills in sort_column_id* and order with the current sort column and the order. Fills in sort_column_id and order with the current sort column and the order. It returns TRUE unless the sort_column_id is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID or GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID. column ids. Parameters: Object out_values Number sort_column_id Gtk.SortType order Required (not null) Returns: Boolean	Gtk.TreeSortable
	get_string_from_iter (TreeIter *iter) : String Generates a string representation of the iter. Generates a string representation of the iter. This string is a ':' separated list of numbers. For example, "4:10:0:3" would be an acceptable return value for this string. Parameters: Gtk.TreeIter iter* Required (not null) Returns: String	Gtk.TreeModel
	get_value (TreeIter *iter, Number column, Value value) : none Initializes and sets value* to that at column. Initializes and sets value to that at column. When done with value, g_value_unset() needs to be called to free any allocated memory. Parameters: Gtk.TreeIter iter Required (not null) Number column Required (not null) GObject.Value value Required (not null) An empty GValue to set. Returns: none	Gtk.TreeModel
	has_default_sort_func () : Boolean Returns TRUE if the model has a default sort function. Returns TRUE if the model has a default sort function. This is used primarily by GtkTreeViewColumns in order to determine if a model can go back to the default state, or not. Returns: Boolean	Gtk.TreeSortable
	iter_children (TreeIter *iter, TreeIter parent) : Boolean Sets iter* to point to the first child of parent. Sets iter to point to the first child of parent. If parent has no children, FALSE is returned and iter is set to be invalid. parent will remain a valid node after this function has been called. If parent is NULL returns the first node, equivalent to gtk_tree_model_get_iter_first (tree_model, iter); Parameters: Gtk.TreeIter iter Required (not null) Gtk.TreeIter parent The GtkTreeIter, or NULL Returns: Boolean	Gtk.TreeModel
	iter_has_child (TreeIter *iter) : Boolean Returns TRUE* if iter has children, FALSE otherwise. Returns TRUE if iter has children, FALSE otherwise. Parameters: Gtk.TreeIter iter Required (not null) Returns: Boolean	Gtk.TreeModel
	iter_is_valid (TreeIter *iter) : Boolean This function is slow. This function is slow. Only use it for debugging and/or testing purposes. Checks if the given iter is a valid iter for this GtkTreeModelSort. Parameters: Gtk.TreeIter iter* Required (not null) Returns: Boolean	Gtk.TreeModelSort
	iter_n_children (TreeIter *iter) : Number Returns the number of children that iter* has. Returns the number of children that iter has. As a special case, if iter is NULL, then the number of toplevel nodes is returned. Parameters: Gtk.TreeIter iter The GtkTreeIter, or NULL. Returns: Number	Gtk.TreeModel
	iter_next (TreeIter *iter) : Boolean Sets iter* to point to the node following it at the current level. Sets iter to point to the node following it at the current level. If there is no next iter, FALSE is returned and iter is set to be invalid. Parameters: Gtk.TreeIter iter Required (not null) Returns: Boolean	Gtk.TreeModel
	iter_nth_child (TreeIter *iter, TreeIter parent, Number n) : Boolean Sets iter* to be the child of parent, using the given index. Sets iter to be the child of parent, using the given index. The first index is 0. If n is too big, or parent has no children, iter is set to an invalid iterator and FALSE is returned. parent will remain a valid node after this function has been called. As a special case, if parent is NULL, then the nth root node is set. Parameters: Gtk.TreeIter iter Required (not null) Gtk.TreeIter parent The GtkTreeIter to get the child from, or NULL. Number n Required (not null) Returns: Boolean	Gtk.TreeModel
	iter_parent (TreeIter *iter, TreeIter child) : Boolean Sets iter* to be the parent of child. Sets iter to be the parent of child. If child is at the toplevel, and doesn't have a parent, then iter is set to an invalid iterator and FALSE is returned. child will remain a valid node after this function has been called. Parameters: Gtk.TreeIter iter Required (not null) Gtk.TreeIter child Required (not null) Returns: Boolean	Gtk.TreeModel
	ref_node (TreeIter *iter) : none Lets the tree ref the node. Lets the tree ref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. This function is primarily meant as a way for views to let caching model know when nodes are being displayed (and hence, whether or not to cache that node.) For example, a file-system based model would not want to keep the entire file-hierarchy in memory, just the sections that are currently being displayed by every current view. A model should be expected to be able to get an iter independent of its reffed state. Parameters: Gtk.TreeIter iter* Required (not null) Returns: none	Gtk.TreeModel
	reset_default_sort_func () : none This resets the default sort function to be in the 'unsorted' state. This resets the default sort function to be in the 'unsorted' state. That is, it is in the same order as the child model. It will re-sort the model to be in the same order as the child model only if the GtkTreeModelSort is in 'unsorted' state. Returns: none	Gtk.TreeModelSort
	row_changed (TreePath *path, TreeIter iter) : none Emits the "row-changed" signal on tree_model. Emits the "row-changed" signal on tree_model. Parameters: Gtk.TreePath path* Required (not null) Gtk.TreeIter iter Required (not null) Returns: none	Gtk.TreeModel
	row_deleted (TreePath *path) : none Emits the "row-deleted" signal on tree_model. Emits the "row-deleted" signal on tree_model. This should be called by models after a row has been removed. The location pointed to by path* should be the location that the row previously was at. It may not be a valid location anymore. Parameters: Gtk.TreePath path Required (not null) Returns: none	Gtk.TreeModel
	row_draggable (TreePath *path) : Boolean Asks the GtkTreeDragSource* whether a particular row can be used as the source of a DND operation. Asks the GtkTreeDragSource whether a particular row can be used as the source of a DND operation. If the source doesn't implement this interface, the row is assumed draggable. Parameters: Gtk.TreePath path Required (not null) Returns: Boolean	Gtk.TreeDragSource
	row_has_child_toggled (TreePath *path, TreeIter iter) : none Emits the "row-has-child-toggled" signal on tree_model. Emits the "row-has-child-toggled" signal on tree_model. This should be called by models after the child state of a node changes. Parameters: Gtk.TreePath path* Required (not null) Gtk.TreeIter iter Required (not null) Returns: none	Gtk.TreeModel
	row_inserted (TreePath *path, TreeIter iter) : none Emits the "row-inserted" signal on tree_model* Emits the "row-inserted" signal on tree_model Parameters: Gtk.TreePath path Required (not null) Gtk.TreeIter iter Required (not null) Returns: none	Gtk.TreeModel
	rows_reordered (TreePath *path, TreeIter iter) : Number Emits the "rows-reordered" signal on tree_model. Emits the "rows-reordered" signal on tree_model. This should be called by models when their rows have been reordered. Parameters: Gtk.TreePath path* Required (not null) reordered Gtk.TreeIter iter Required (not null) reordered, or NULL if the depth of path is 0. Returns: Number	Gtk.TreeModel
	set_default_sort_func (Function *sort_func, void *user_data, Function destroy) : none Sets the default comparison function used when sorting to be sort_func. Sets the default comparison function used when sorting to be sort_func. If the current sort column id of sortable* is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, then the model will sort using this function. If sort_func is NULL, then there will be no default comparison function. This means that once the model has been sorted, it can't go back to the default state. In this case, when the current sort column id of sortable is GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID, the model will be unsorted. Parameters: Function (TreeModel *model, TreeIter a, TreeIter b, void *user_data) : none Required (not null) void user_data User data to pass to sort_func, or NULL Function (void* *data) : none Destroy notifier of user_data, or NULL* Returns: none	Gtk.TreeSortable
	set_sort_column_id (Number *sort_column_id, SortType order) : none Sets the current sort column to be sort_column_id. Sets the current sort column to be sort_column_id. The sortable* will resort itself to reflect this change, after emitting a GtkTreeSortable::sort-column-changed signal. sortable may either be a regular column id, or one of the following special values: GTK_TREE_SORTABLE_DEFAULT_SORT_COLUMN_ID the default sort function will be used, if it is set GTK_TREE_SORTABLE_UNSORTED_SORT_COLUMN_ID no sorting will occur Parameters: Number sort_column_id Required (not null) Gtk.SortType order Required (not null) Returns: none	Gtk.TreeSortable
	set_sort_func (Number *sort_column_id, Function sort_func, void *user_data, Function destroy) : none Sets the comparison function used when sorting to be sort_func. Sets the comparison function used when sorting to be sort_func. If the current sort column id of sortable* is the same as sort_column_id, then the model will sort using this function. Parameters: Number sort_column_id Required (not null) Function (TreeModel *model, TreeIter a, TreeIter b, void *user_data) : none Required (not null) void user_data User data to pass to sort_func, or NULL Function (void* *data) : none Destroy notifier of user_data, or NULL* Returns: none	Gtk.TreeSortable
	sort_column_changed () : none Emits a GtkTreeSortable::sort-column-changed signal on sortable. Emits a GtkTreeSortable::sort-column-changed signal on sortable. Returns: none	Gtk.TreeSortable
	unref_node (TreeIter *iter) : none Lets the tree unref the node. Lets the tree unref the node. This is an optional method for models to implement. To be more specific, models may ignore this call as it exists primarily for performance reasons. For more information on what this means, see gtk_tree_model_ref_node(). Please note that nodes that are deleted are not unreffed. Parameters: Gtk.TreeIter iter* Required (not null) Returns: none	Gtk.TreeModel

Events - usage syntax: this.signals.EVENTNAME.connect( Function )
Event		Defined By
	row_changed (TreeModel *self, TreePath path, TreeIter iter) : none This signal is emitted when a row in the model has changed. This signal is emitted when a row in the model has changed. Parameters: Gtk.TreeModel self* Gtk.TreePath path Gtk.TreeIter iter Returns: {none}	Gtk.TreeModel
	row_deleted (TreeModel *self, TreePath path) : none This signal is emitted when a row has been deleted. This signal is emitted when a row has been deleted. Note that no iterator is passed to the signal handler, since the row is already deleted. Implementations of GtkTreeModel must emit row-deleted before removing the node from its internal data structures. This is because models and views which access and monitor this model might have references on the node which need to be released in the row-deleted handler. Parameters: Gtk.TreeModel self* Gtk.TreePath path Returns: {none}	Gtk.TreeModel
	row_has_child_toggled (TreeModel *self, TreePath path, TreeIter iter) : none This signal is emitted when a row has gotten the first child row or lost its last child row. This signal is emitted when a row has gotten the first child row or lost its last child row. Parameters: Gtk.TreeModel self* Gtk.TreePath path Gtk.TreeIter iter Returns: {none}	Gtk.TreeModel
	row_inserted (TreeModel *self, TreePath path, TreeIter iter) : none This signal is emitted when a new row has been inserted in the model. This signal is emitted when a new row has been inserted in the model. Note that the row may still be empty at this point, since it is a common pattern to first insert an empty row, and then fill it with the desired values. Parameters: Gtk.TreeModel self* Gtk.TreePath path Gtk.TreeIter iter Returns: {none}	Gtk.TreeModel
	rows_reordered (TreeModel *self, TreePath path, TreeIter iter, void *new_order) : none This signal is emitted when the children of a node in the GtkTreeModel* have been reordered. This signal is emitted when the children of a node in the GtkTreeModel have been reordered. Note that this signal is not emitted when rows are reordered by DND, since this is implemented by removing and then reinserting the row. Parameters: Gtk.TreeModel self Gtk.TreePath path Gtk.TreeIter iter void* new_order Returns: {none}	Gtk.TreeModel
	sort_column_changed (TreeSortable *self) : none The ::sort-column-changed signal is emitted when the sort column or sort order of sortable* is changed. The ::sort-column-changed signal is emitted when the sort column or sort order of sortable is changed. The signal is emitted before the contents of sortable are resorted. Parameters: Gtk.TreeSortable self Returns: {none}	Gtk.TreeSortable

Un-official Seed Documentation

Gtk

Classes

Interfaces

Structs

Unions

Enums

Class Gtk.TreeModelSort