package Implements_Gtk_Buildable is new Glib.Types.Implements (Gtk.Buildable.Gtk_Buildable, Gtk_List_Store_Record, Gtk_List_Store);
package Implements_Gtk_Tree_Drag_Dest is new Glib.Types.Implements (Gtk.Tree_Drag_Dest.Gtk_Tree_Drag_Dest, Gtk_List_Store_Record, Gtk_List_Store);
package Implements_Gtk_Tree_Drag_Source is new Glib.Types.Implements (Gtk.Tree_Drag_Source.Gtk_Tree_Drag_Source, Gtk_List_Store_Record, Gtk_List_Store);
package Implements_Gtk_Tree_Model is new Glib.Types.Implements (Gtk.Tree_Model.Gtk_Tree_Model, Gtk_List_Store_Record, Gtk_List_Store);
package Implements_Gtk_Tree_Sortable is new Glib.Types.Implements (Gtk.Tree_Sortable.Gtk_Tree_Sortable, Gtk_List_Store_Record, Gtk_List_Store);
type Gtk_List_Store_Record is new Gtk_Root_Tree_Model_Record with null record;
type Gtk_List_Store is access all Gtk_List_Store_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;
procedure Gtk_New
( | List_Store | : out Gtk_List_Store; |
Types | : GType_Array); |
procedure Initialize
( | List_Store | : not null access Gtk_List_Store_Record'Class; |
Types | : GType_Array); |
function Gtk_List_Store_Newv
( | Types | : GType_Array) return Gtk_List_Store; |
function Get_Type return Glib.GType;
procedure Append
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : out Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Clear
( | List_Store | : not null access Gtk_List_Store_Record); |
procedure Insert
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : out Gtk.Tree_Model.Gtk_Tree_Iter; | |
Position | : Gint); |
procedure Insert_After
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : out Gtk.Tree_Model.Gtk_Tree_Iter; | |
Sibling | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Insert_Before
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : out Gtk.Tree_Model.Gtk_Tree_Iter; | |
Sibling | : Gtk.Tree_Model.Gtk_Tree_Iter); |
function Iter_Is_Valid
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean; |
procedure Move_After
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
Position | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Move_Before
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
Position | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Prepend
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : out Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Remove
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : in out Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Reorder
( | List_Store | : not null access Gtk_List_Store_Record; |
New_Order | : Gint_Array); |
procedure Set_Column_Types
( | List_Store | : not null access Gtk_List_Store_Record; |
Types | : GType_Array); |
procedure Set_Value
( | List_Store | : not null access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
Column | : Gint; | |
Value | : Glib.Values.GValue); |
procedure Swap
( | List_Store | : not null access Gtk_List_Store_Record; |
A | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
B | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Foreach
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Func | : Gtk_Tree_Model_Foreach_Func); |
procedure Set_Default_Sort_Func
( | Sortable | : not null access Gtk_List_Store_Record; |
Sort_Func | : Gtk_Tree_Iter_Compare_Func); |
procedure Set_Sort_Func
( | Sortable | : not null access Gtk_List_Store_Record; |
Sort_Column_Id | : Gint; | |
Sort_Func | : Gtk_Tree_Iter_Compare_Func); |
procedure Set
( | Tree_Store | : access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
Column | : Gint; | |
Value | : UTF8_String); |
procedure Set
( | Tree_Store | : access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
Column | : Gint; | |
Value | : Boolean); |
procedure Set
( | Tree_Store | : access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
Column | : Gint; | |
Value | : Gint); |
procedure Set
( | Tree_Store | : access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
Column | : Gint; | |
Value | : Gdk.Pixbuf.Gdk_Pixbuf); |
function Drag_Data_Received
( | Self | : not null access Gtk_List_Store_Record; |
Dest | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Selection_Data | : Gtk.Selection_Data.Gtk_Selection_Data) return Boolean; |
function Row_Drop_Possible
( | Self | : not null access Gtk_List_Store_Record; |
Dest_Path | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Selection_Data | : Gtk.Selection_Data.Gtk_Selection_Data) return Boolean; |
function Drag_Data_Delete
( | Self | : not null access Gtk_List_Store_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean; |
function Drag_Data_Get
( | Self | : not null access Gtk_List_Store_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_List_Store_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path) return Boolean; |
function Get_Column_Type
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Index | : Gint) return GType; |
function Get_Flags
( | Tree_Model | : not null access Gtk_List_Store_Record) return Gtk.Tree_Model.Tree_Model_Flags; |
function Get_Iter
( | Tree_Model | : not null access Gtk_List_Store_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_List_Store_Record) return Gtk.Tree_Model.Gtk_Tree_Iter; |
function Get_Iter_From_String
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Path_String | : UTF8_String) return Gtk.Tree_Model.Gtk_Tree_Iter; |
function Get_N_Columns
( | Tree_Model | : not null access Gtk_List_Store_Record) return Gint; |
function Get_Path
( | Tree_Model | : not null access Gtk_List_Store_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_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter) return UTF8_String; |
procedure Get_Value
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter; | |
Column | : Gint; | |
Value | : out Glib.Values.GValue); |
function Children
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Parent | : Gtk.Tree_Model.Gtk_Tree_Iter) return Gtk.Tree_Model.Gtk_Tree_Iter; |
function Has_Child
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter) return Boolean; |
function N_Children
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter := Gtk.Tree_Model.Null_Iter) return Gint; |
procedure Next
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Iter | : in out Gtk.Tree_Model.Gtk_Tree_Iter); |
function Nth_Child
( | Tree_Model | : not null access Gtk_List_Store_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_List_Store_Record; |
Child | : Gtk.Tree_Model.Gtk_Tree_Iter) return Gtk.Tree_Model.Gtk_Tree_Iter; |
procedure Previous
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Iter | : in out Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Ref_Node
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Row_Changed
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Row_Deleted
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path); |
procedure Row_Has_Child_Toggled
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Row_Inserted
( | Tree_Model | : not null access Gtk_List_Store_Record; |
Path | : Gtk.Tree_Model.Gtk_Tree_Path; | |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Rows_Reordered
( | Tree_Model | : not null access Gtk_List_Store_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_List_Store_Record; |
Iter | : Gtk.Tree_Model.Gtk_Tree_Iter); |
procedure Get_Sort_Column_Id
( | Sortable | : not null access Gtk_List_Store_Record; |
Sort_Column_Id | : out Gint; | |
Order | : out Gtk.Enums.Gtk_Sort_Type); |
procedure Set_Sort_Column_Id
( | Sortable | : not null access Gtk_List_Store_Record; |
Sort_Column_Id | : Gint; | |
Order | : Gtk.Enums.Gtk_Sort_Type); |
function Has_Default_Sort_Func
( | Sortable | : not null access Gtk_List_Store_Record) return Boolean; |
procedure Sort_Column_Changed
( | Sortable | : not null access Gtk_List_Store_Record); |
function "+"
( | Widget | : access Gtk_List_Store_Record'Class) return Gtk.Buildable.Gtk_Buildable renames Implements_Gtk_Buildable.To_Interface; |
function "-"
( | Interf | : Gtk.Buildable.Gtk_Buildable) return Gtk_List_Store renames Implements_Gtk_Buildable.To_Object; |
function "+"
( | Widget | : access Gtk_List_Store_Record'Class) return Gtk.Tree_Drag_Dest.Gtk_Tree_Drag_Dest renames Implements_Gtk_Tree_Drag_Dest.To_Interface; |
function "-"
( | Interf | : Gtk.Tree_Drag_Dest.Gtk_Tree_Drag_Dest) return Gtk_List_Store renames Implements_Gtk_Tree_Drag_Dest.To_Object; |
function "+"
( | Widget | : access Gtk_List_Store_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_List_Store renames Implements_Gtk_Tree_Drag_Source.To_Object; |
function "+"
( | Widget | : access Gtk_List_Store_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_List_Store renames Implements_Gtk_Tree_Model.To_Object; |
function "+"
( | Widget | : access Gtk_List_Store_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_List_Store renames Implements_Gtk_Tree_Sortable.To_Object; |
The Gtk.List_Store.Gtk_List_Store object is a list model for use with a Gtk.Tree_View.Gtk_Tree_View widget. It implements the Gtk.Tree_Model.Gtk_Tree_Model interface, and consequentialy, can use all of the methods available there. It also implements the Gtk.Tree_Sortable.Gtk_Tree_Sortable interface so it can be sorted by the view. Finally, it also implements the tree <link linkend="gtktreednd">drag and drop</link> interfaces.
The Gtk.List_Store.Gtk_List_Store can accept most GObject types as a column type, though it can't accept all custom types. Internally, it will keep a copy of data passed in (such as a string or a boxed pointer).
Columns that accept Glib.Object.GObject<!-- -->s are handled a little differently. The Gtk.List_Store.Gtk_List_Store will keep a reference to the object instead of copying the value. As a result, if the object is modified, it is up to the application writer to call Gtk.Tree_Model.Row_Changed to emit the Gtk.Tree_Model.Gtk_Tree_Model::row_changed signal. This most commonly affects lists with Gdk.Pixbuf.Gdk_Pixbuf<!-- -->s stored. == Creating a simple list store. == enum { COLUMN_STRING, COLUMN_INT, COLUMN_BOOLEAN, N_COLUMNS }; { GtkListStore *list_store; GtkTreePath *path; GtkTreeIter iter; gint i; list_store = gtk_list_store_new (N_COLUMNS, G_TYPE_STRING, G_TYPE_INT, G_TYPE_BOOLEAN); for (i = 0; i < 10; i++) { gchar *some_data; some_data = get_some_data (i); // Add a new row to the model gtk_list_store_append (list_store, &iter); gtk_list_store_set (list_store, &iter, COLUMN_STRING, some_data, COLUMN_INT, i, COLUMN_BOOLEAN, FALSE, -1); /<!---->* As the store will keep a copy of the string internally, we * free some_data. *<!---->/ g_free (some_data); } // Modify a particular row path = gtk_tree_path_new_from_string ("4"); gtk_tree_model_get_iter (GTK_TREE_MODEL (list_store), &iter, path); gtk_tree_path_free (path); gtk_list_store_set (list_store, &iter, COLUMN_BOOLEAN, TRUE, -1); } == Performance Considerations == Internally, the Gtk.List_Store.Gtk_List_Store was implemented with a linked list with a tail pointer prior to GTK+ 2.6. As a result, it was fast at data insertion and deletion, and not fast at random data access. The Gtk.List_Store.Gtk_List_Store sets the GTK_TREE_MODEL_ITERS_PERSIST flag, which means that Gtk.Tree_Model.Gtk_Tree_Iter<!-- -->s can be cached while the row exists. Thus, if access to a particular row is needed often and your code is expected to run on older versions of GTK+, it is worth keeping the iter around. == Atomic Operations == It is important to note that only the methods gtk_list_store_insert_with_values and gtk_list_store_insert_with_valuesv are atomic, in the sense that the row is being appended to the store and the values filled in in a single operation with regard to Gtk.Tree_Model.Gtk_Tree_Model signaling. In contrast, using e.g.
Gtk.List_Store.Append and then gtk_list_store_set will first create a row, which triggers the Gtk.Tree_Model.Gtk_Tree_Model::row-inserted signal on Gtk.List_Store.Gtk_List_Store. The row, however, is still empty, and any signal handler connecting to Gtk.Tree_Model.Gtk_Tree_Model::row-inserted on this particular store should be prepared for the situation that the row might be empty. This is especially important if you are wrapping the Gtk.List_Store.Gtk_List_Store inside a Gtk.Tree_Model_Filter.Gtk_Tree_Model_Filter and are using a Gtk_Tree_Model_Filter_Visible_Func. Using any of the non-atomic operations to append rows to the Gtk.List_Store.Gtk_List_Store will cause the Gtk_Tree_Model_Filter_Visible_Func to be visited with an empty row first; the function must be prepared for that. == GtkListStore as GtkBuildable == The GtkListStore implementation of the GtkBuildable interface allows to specify the model columns with a <columns> element that may contain multiple <column> elements, each specifying one model column. The "type" attribute specifies the data type for the column.
Additionally, it is possible to specify content for the list store in the UI definition, with the <data> element. It can contain multiple <row> elements, each specifying to content for one row of the list model. Inside a <row>, the <col> elements specify the content for individual cells.
Note that it is probably more common to define your models in the code, and one might consider it a layering violation to specify the content of a list store in a UI definition, *data*, not *presentation*, and common wisdom is to separate the two, as far as possible. <!-- FIXME a bit inconclusive --> == A UI Definition fragment for a list store == <object class="GtkListStore"> <columns> <column type="gchararray"/> <column type="gchararray"/> <column type="gint"/> </columns> <data> <col id="0">John</col> <col id="1">Doe</col> <col id="2">25</col> <col id="0">Johan</col> <col id="1">Dahlin</col> <col id="2">50</col> </data> </object>