package Implements_Gtk_Tree_Drag_Source is new Glib.Types.Implements (Gtk.Tree_Drag_Source.Gtk_Tree_Drag_Source, Gtk_Tree_Model_Sort_Record, Gtk_Tree_Model_Sort);
package Implements_Gtk_Tree_Model is new Glib.Types.Implements (Gtk.Tree_Model.Gtk_Tree_Model, Gtk_Tree_Model_Sort_Record, Gtk_Tree_Model_Sort);
package Implements_Gtk_Tree_Sortable is new Glib.Types.Implements (Gtk.Tree_Sortable.Gtk_Tree_Sortable, Gtk_Tree_Model_Sort_Record, Gtk_Tree_Model_Sort);
type Gtk_Tree_Model_Sort_Record is new Gtk_Root_Tree_Model_Record with null record;
type Gtk_Tree_Model_Sort is access all Gtk_Tree_Model_Sort_Record'Class;
type Gtk_Tree_Model_Foreach_Func is access function (Model : Gtk.Tree_Model.Gtk_Tree_Model; Path : Gtk.Tree_Model.Gtk_Tree_Path; Iter : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean;
type Gtk_Tree_Iter_Compare_Func is access function (Model : Gtk.Tree_Model.Gtk_Tree_Model; A : Gtk.Tree_Model.Gtk_Tree_Iter; B : Gtk.Tree_Model.Gtk_Tree_Iter) return Gint;
Model_Property : constant Glib.Properties.Property_Interface;
procedure Gtk_New_With_Model
( | Self | : out Gtk_Tree_Model_Sort; |
Child_Model | : Gtk.Tree_Model.Gtk_Tree_Model); |
procedure Initialize_With_Model
( | Self | : not null access Gtk_Tree_Model_Sort_Record'Class; |
Child_Model | : Gtk.Tree_Model.Gtk_Tree_Model); |
function Gtk_Tree_Model_Sort_Sort_New_With_Model
( | Child_Model | : Gtk.Tree_Model.Gtk_Tree_Model) return Gtk_Tree_Model_Sort; |
function Get_Type return Glib.GType;
procedure Clear_Cache
( | Self | : not null access Gtk_Tree_Model_Sort_Record); |
function Convert_Child_Iter_To_Iter
( | Self | : not null access Gtk_Tree_Model_Sort_Record; |
Sort_Iter | : access Gtk.Tree_Model.Gtk_Tree_Iter; | |
Child_Iter | : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean; |
function Convert_Child_Path_To_Path
( | Self | : not null access Gtk_Tree_Model_Sort_Record; |
Child_Path | : Gtk.Tree_Model.Gtk_Tree_Path) return Gtk.Tree_Model.Gtk_Tree_Path; |
procedure Convert_Iter_To_Child_Iter
( | Self | : not null access Gtk_Tree_Model_Sort_Record; |
Child_Iter | : out Gtk.Tree_Model.Gtk_Tree_Iter; | |
Sorted_Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
function Convert_Path_To_Child_Path
( | Self | : not null access Gtk_Tree_Model_Sort_Record; |
Sorted_Path | : Gtk.Tree_Model.Gtk_Tree_Path) return Gtk.Tree_Model.Gtk_Tree_Path; |
function Get_Model
( | Self | : not null access Gtk_Tree_Model_Sort_Record) return Gtk.Tree_Model.Gtk_Tree_Model; |
function Iter_Is_Valid
( | Self | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean; |
procedure Reset_Default_Sort_Func
( | Self | : not null access Gtk_Tree_Model_Sort_Record); |
procedure Foreach
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Func | : Gtk_Tree_Model_Foreach_Func); |
procedure Set_Default_Sort_Func
( | Sortable | : not null access Gtk_Tree_Model_Sort_Record; |
Sort_Func | : Gtk_Tree_Iter_Compare_Func); |
procedure Set_Sort_Func
( | Sortable | : not null access Gtk_Tree_Model_Sort_Record; |
Sort_Column_Id | : Gint; | |
Sort_Func | : Gtk_Tree_Iter_Compare_Func); |
function Drag_Data_Delete
( | Self | : not null access Gtk_Tree_Model_Sort_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean; |
function Drag_Data_Get
( | Self | : not null access Gtk_Tree_Model_Sort_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Selection_Data | : Gtk.Selection_Data.Gtk_Selection_Data) return Boolean; |
function Row_Draggable
( | Self | : not null access Gtk_Tree_Model_Sort_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean; |
function Get_Column_Type
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Index | : Gint) return GType; |
function Get_Flags
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record) return Gtk.Tree_Model.Tree_Model_Flags; |
function Get_Iter
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path) return Gtk.Tree_Model.Gtk_Tree_Iter; |
function Get_Iter_First
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record) return Gtk.Tree_Model.Gtk_Tree_Iter; |
function Get_Iter_From_String
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Path_String | : UTF8_String) return Gtk.Tree_Model.Gtk_Tree_Iter; |
function Get_N_Columns
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record) return Gint; |
function Get_Path
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter) return Gtk.Tree_Model.Gtk_Tree_Path; |
function Get_String_From_Iter
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter) return UTF8_String; |
procedure Get_Value
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
Column | : Gint; | |
Value | : out Glib.Values.GValue); |
function Children
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Parent | : Gtk.Tree_Model.Gtk_Tree_Iter) return Gtk.Tree_Model.Gtk_Tree_Iter; |
function Has_Child
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean; |
function N_Children
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter := Gtk.Tree_Model.Null_Iter) return Gint; |
procedure Next
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : in out Gtk.Tree_Model.Gtk_Tree_Iter); |
function Nth_Child
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Parent | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
N | : Gint) return Gtk.Tree_Model.Gtk_Tree_Iter; |
function Parent
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Child | : Gtk.Tree_Model.Gtk_Tree_Iter) return Gtk.Tree_Model.Gtk_Tree_Iter; |
procedure Previous
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : in out Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Ref_Node
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Row_Changed
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Row_Deleted
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path); |
procedure Row_Has_Child_Toggled
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Row_Inserted
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Rows_Reordered
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
New_Order | : Gint_Array); |
procedure Unref_Node
( | Tree_Model | : not null access Gtk_Tree_Model_Sort_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Get_Sort_Column_Id
( | Sortable | : not null access Gtk_Tree_Model_Sort_Record; |
Sort_Column_Id | : out Gint; | |
Order | : out Gtk.Enums.Gtk_Sort_Type); |
procedure Set_Sort_Column_Id
( | Sortable | : not null access Gtk_Tree_Model_Sort_Record; |
Sort_Column_Id | : Gint; | |
Order | : Gtk.Enums.Gtk_Sort_Type); |
function Has_Default_Sort_Func
( | Sortable | : not null access Gtk_Tree_Model_Sort_Record) return Boolean; |
procedure Sort_Column_Changed
( | Sortable | : not null access Gtk_Tree_Model_Sort_Record); |
function "+"
( | Widget | : access Gtk_Tree_Model_Sort_Record'Class) return Gtk.Tree_Drag_Source.Gtk_Tree_Drag_Source renames Implements_Gtk_Tree_Drag_Source.To_Interface; |
function "-"
( | Interf | : Gtk.Tree_Drag_Source.Gtk_Tree_Drag_Source) return Gtk_Tree_Model_Sort renames Implements_Gtk_Tree_Drag_Source.To_Object; |
function "+"
( | Widget | : access Gtk_Tree_Model_Sort_Record'Class) return Gtk.Tree_Model.Gtk_Tree_Model renames Implements_Gtk_Tree_Model.To_Interface; |
function "-"
( | Interf | : Gtk.Tree_Model.Gtk_Tree_Model) return Gtk_Tree_Model_Sort renames Implements_Gtk_Tree_Model.To_Object; |
function "+"
( | Widget | : access Gtk_Tree_Model_Sort_Record'Class) return Gtk.Tree_Sortable.Gtk_Tree_Sortable renames Implements_Gtk_Tree_Sortable.To_Interface; |
function "-"
( | Interf | : Gtk.Tree_Sortable.Gtk_Tree_Sortable) return Gtk_Tree_Model_Sort renames Implements_Gtk_Tree_Sortable.To_Object; |
The Gtk.Tree_Model_Sort.Gtk_Tree_Model_Sort is a model which implements the Gtk.Tree_Sortable.Gtk_Tree_Sortable interface. It does not hold any data itself, but rather is created with a child model and proxies its data.
It has identical column types to this child model, and the changes in the child are propagated. The primary purpose of this model is to provide a way to sort a different model without modifying it. Note that the sort function used by Gtk.Tree_Model_Sort.Gtk_Tree_Model_Sort is not guaranteed to be stable.
The use of this is best demonstrated through an example. In the following sample code we create two Gtk.Tree_View.Gtk_Tree_View widgets each with a view of the same data. As the model is wrapped here by a Gtk.Tree_Model_Sort.Gtk_Tree_Model_Sort, the two Gtk.Tree_View.Gtk_Tree_View<!-- -->s can each sort their view of the data without affecting the other. By contrast, if we simply put the same model in each widget, then sorting the first would sort the second. == Using a <structname>GtkTreeModelSort</structname> == { GtkTreeView *tree_view1; GtkTreeView *tree_view2; GtkTreeModel *sort_model1; GtkTreeModel *sort_model2; GtkTreeModel *child_model; // get the child model child_model = get_my_model (); // Create the first tree sort_model1 = gtk_tree_model_sort_new_with_model (child_model); tree_view1 = gtk_tree_view_new_with_model (sort_model1); // Create the second tree sort_model2 = gtk_tree_model_sort_new_with_model (child_model); tree_view2 = gtk_tree_view_new_with_model (sort_model2); // Now we can sort the two models independently gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model1), COLUMN_1, GTK_SORT_ASCENDING); gtk_tree_sortable_set_sort_column_id (GTK_TREE_SORTABLE (sort_model2), COLUMN_1, GTK_SORT_DESCENDING); } To demonstrate how to access the underlying child model from the sort model, the next example will be a callback for the Gtk.Tree_Selection.Gtk_Tree_Selection Gtk.Tree_Selection.Gtk_Tree_Selection::changed signal. In this callback, we get a string from COLUMN_1 of the model. We then modify the string, find the same selected row on the child model, and change the row there. == Accessing the child model of in a selection changed callback == void selection_changed (GtkTreeSelection *selection, gpointer data) { GtkTreeModel *sort_model = NULL; GtkTreeModel *child_model; GtkTreeIter sort_iter; GtkTreeIter child_iter; char *some_data = NULL; char *modified_data; // Get the current selected row and the model. if (! gtk_tree_selection_get_selected (selection, &sort_model, &sort_iter)) return; /<!---->* Look up the current value on the selected row and get a new value * to change it to. *<!---->/ gtk_tree_model_get (GTK_TREE_MODEL (sort_model), &sort_iter, COLUMN_1, &some_data, -1); modified_data = change_the_data (some_data); g_free (some_data); // Get an iterator on the child model, instead of the sort model. gtk_tree_model_sort_convert_iter_to_child_iter (GTK_TREE_MODEL_SORT (sort_model), &child_iter, &sort_iter); /<!---->* Get the child model and change the value of the row. In this * example, the child model is a GtkListStore. It could be any other * type of model, though. *<!---->/ child_model = gtk_tree_model_sort_get_model (GTK_TREE_MODEL_SORT (sort_model)); gtk_list_store_set (GTK_LIST_STORE (child_model), &child_iter, COLUMN_1, &modified_data, -1); g_free (modified_data); }