Adds a child to buildable. type is an optional string
describing how the child should be added.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

GObject.Object child Required (not null)

child to add

String type

kind of child or NULL

Returns:

none

Appends a new row to list_store. 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_list_store_set() or gtk_list_store_set_value().

Returns:

Gtk.TreeIter

Removes all rows from the list store.

Returns:

none

Constructs a child of buildable with the name name.
GtkBuilder calls this function if a "constructor" has been
specified in the UI definition.

Parameters:

Gtk.Builder builder Required (not null)

GtkBuilder used to construct this object

String name Required (not null)

name of child to construct

Returns:

GObject.Object the constructed child

This is similar to gtk_buildable_parser_finished() but is
called once for each custom tag handled by the buildable.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

GObject.Object child

child object or NULL for non-child tags

String tagname Required (not null)

the name of the tag

void* data Required (not null)

user data created in custom_tag_start

Returns:

none

This is called at the end of each custom element handled by
the buildable.

Parameters:

Gtk.Builder builder Required (not null)

GtkBuilder used to construct this object

GObject.Object child

child object or NULL for non-child tags

String tagname Required (not null)

name of tag

void* data Required (not null)

user data that will be passed in to parser functions

Returns:

none

This is called for each unknown element under <child>.
if it doesn't.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder used to construct this object

GObject.Object child

child object or NULL for non-child tags

String tagname Required (not null)

name of tag

Object out_values

GLib.MarkupParser parser

void* data

Returns:

gboolean TRUE if a object has a custom implementation, FALSE

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)

row that was being dragged

Returns:

gboolean TRUE if the row was successfully deleted

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)

row that was dragged

Object out_values

Gtk.SelectionData selection_data

Returns:

gboolean TRUE if data of the required type was provided

Asks the GtkTreeDragDest to insert a row before the path dest,
deriving the contents of the row from selection_data. If dest is
outside the tree so that inserting before it is impossible, FALSE
will be returned. Also, FALSE may be returned if the new row is
not created for some model-specific reason. Should robustly handle
a dest no longer found in the model!

Parameters:

Gtk.TreePath dest Required (not null)

row to drop in front of

Gtk.SelectionData selection_data Required (not null)

data to drop

Returns:

gboolean whether a new row was created before position dest

Creates a new GtkTreeModel, with child_model as the child_model
and root as the virtual root.

Parameters:

Gtk.TreePath root

A GtkTreePath or NULL.

Returns:

Gtk.TreeModel A new GtkTreeModel.

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)

a function to be called on each row

void* user_data Required (not null)

user data to passed to func

Returns:

none

Returns the type of the column.

Parameters:

gint32 index_ Required (not null)

the column index

Returns:

Number the type of the column

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 lifetime
of the tree_model.

Returns:

Gtk.TreeModelFlags the flags supported by this interface

Get the internal child called childname of the buildable object.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

String childname Required (not null)

name of child

Returns:

GObject.Object the internal child of the buildable object

Sets iter to a valid iterator pointing to path.

Parameters:

Object out_values

Gtk.TreeIter iter

Gtk.TreePath path Required (not null)

the GtkTreePath

Returns:

gboolean TRUE, if iter was set

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:

Object out_values

Gtk.TreeIter iter

Returns:

gboolean TRUE, if iter was set

Sets iter to a valid iterator pointing to path_string, if it
exists. Otherwise, iter is left invalid and FALSE is returned.

Parameters:

Object out_values

Gtk.TreeIter iter

String path_string Required (not null)

a string representation of a GtkTreePath

Returns:

gboolean TRUE, if iter was set

Returns the number of columns supported by tree_model.

Returns:

gint32 the number of columns

Gets the name of the buildable object.
GtkBuilder sets the name based on the the
GtkBuilder UI definition
used to construct the buildable.

Returns:

String the name set with gtk_buildable_set_name()

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)

the GtkTreeIter

Returns:

Gtk.TreePath a newly-created GtkTreePath

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

gint32 sort_column_id

Gtk.SortType order

Returns:

gboolean TRUE if the sort column is not one of the special sort

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.
Must be freed with g_free().

Parameters:

Gtk.TreeIter iter Required (not null)

a GtkTreeIter

Returns:

String a newly-allocated string.

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)

the GtkTreeIter

gint32 column Required (not null)

the column to lookup the value at

Returns:

GObject.Value

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:

gboolean TRUE, if the model has a default sort function

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 empty after this
function is called. To fill in values, you need to call
gtk_list_store_set() or gtk_list_store_set_value().

Parameters:

Gtk.TreeIter iter Required (not null)

An unset GtkTreeIter to set to the new row

gint32 position Required (not null)

position to insert the new row

Returns:

Gtk.TreeIter An unset GtkTreeIter to set to the new row

Inserts a new row after sibling. If sibling is NULL, then the row will be
prepended to the beginning 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_list_store_set() or gtk_list_store_set_value().

Parameters:

Gtk.TreeIter iter Required (not null)

An unset GtkTreeIter to set to the new row

Gtk.TreeIter sibling

A valid GtkTreeIter, or NULL

Returns:

Gtk.TreeIter An unset GtkTreeIter to set to the new row

Inserts a new row before sibling. If sibling is NULL, then the row will
be appended 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_list_store_set() or gtk_list_store_set_value().

Parameters:

Gtk.TreeIter iter Required (not null)

An unset GtkTreeIter to set to the new row

Gtk.TreeIter sibling

A valid GtkTreeIter, or NULL

Returns:

Gtk.TreeIter An unset GtkTreeIter to set to the new row

A variant of gtk_list_store_insert_with_values() which
takes the columns and values as two arrays, instead of
varargs. This function is mainly intended for
language-bindings.

Parameters:

Gtk.TreeIter iter

An unset GtkTreeIter to set to the new row, or NULL.

gint32 position Required (not null)

position to insert the new row

Array columns Required (not null)

an array of column numbers

Array values Required (not null)

an array of GValues

gint32 n_values Required (not null)

the length of the columns and values arrays

Returns:

Gtk.TreeIter An unset GtkTreeIter to set to the new row, or NULL.

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:

Object out_values

Gtk.TreeIter iter

Gtk.TreeIter parent

the GtkTreeIter, or NULL

Returns:

gboolean TRUE, if child has been set to the first child

Returns TRUE if iter has children, FALSE otherwise.

Parameters:

Gtk.TreeIter iter Required (not null)

the GtkTreeIter to test for children

Returns:

gboolean TRUE if iter has children

This function is slow. Only use it for debugging and/or testing
purposes.
Checks if the given iter is a valid iter for this GtkListStore.

Parameters:

Gtk.TreeIter iter Required (not null)

A GtkTreeIter.

Returns:

gboolean TRUE if the iter is valid, FALSE if the iter is invalid.

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:

gint32 the number of children of iter

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)

the GtkTreeIter

Returns:

gboolean TRUE if iter has been changed to the next node

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,
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:

Object out_values

Gtk.TreeIter iter

Gtk.TreeIter parent

the GtkTreeIter to get the child from, or NULL.

gint32 n Required (not null)

the index of the desired child

Returns:

gboolean TRUE, if parent has an nth child

Sets iter to be the parent of child.
If child is at the toplevel, and doesn't have a parent, then
called.

Parameters:

Object out_values

Gtk.TreeIter iter

Gtk.TreeIter child Required (not null)

the GtkTreeIter

Returns:

gboolean TRUE, if iter is set to the parent of child

Sets iter to point to the previous node at the current level.
If there is no previous iter, FALSE is returned and iter is
set to be invalid.

Parameters:

Gtk.TreeIter iter Required (not null)

the GtkTreeIter

Returns:

gboolean TRUE if iter has been changed to the previous node

Moves iter in store to the position after position. Note that this
function only works with unsorted stores. If position is NULL, iter
will be moved to the start of the list.

Parameters:

Gtk.TreeIter iter Required (not null)

A GtkTreeIter.

Gtk.TreeIter position

A GtkTreeIter or NULL.

Returns:

none

Moves iter in store to the position before position. Note that this
function only works with unsorted stores. If position is NULL, iter
will be moved to the end of the list.

Parameters:

Gtk.TreeIter iter Required (not null)

A GtkTreeIter.

Gtk.TreeIter position

A GtkTreeIter, or NULL.

Returns:

none

Called when the builder finishes the parsing of a
GtkBuilder UI definition.
Note that this will be called once for each time
gtk_builder_add_from_file() or gtk_builder_add_from_string()
is called on a builder.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

Returns:

none

Prepends a new row to list_store. 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_list_store_set() or gtk_list_store_set_value().

Returns:

Gtk.TreeIter

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 models 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)

the GtkTreeIter

Returns:

none

Removes the given row from the list store. After being removed,
to the last row in list_store.

Parameters:

Gtk.TreeIter iter Required (not null)

A valid GtkTreeIter

Returns:

gboolean TRUE if iter is valid, FALSE if not.

Emits the GtkTreeModel::row-changed signal on tree_model.

Parameters:

Gtk.TreePath path Required (not null)

a GtkTreePath pointing to the changed row

Gtk.TreeIter iter Required (not null)

a valid GtkTreeIter pointing to the changed row

Returns:

none

Emits the GtkTreeModel::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)

a GtkTreePath pointing to the previous location of the deleted row

Returns:

none

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)

row on which user is initiating a drag

Returns:

gboolean TRUE if the row can be dragged

Determines whether a drop is possible before the given dest_path,
at the same depth as dest_path. i.e., can we drop the data in
exist; the return value will almost certainly be FALSE if the
parent of dest_path doesn't exist, though.

Parameters:

Gtk.TreePath dest_path Required (not null)

destination row

Gtk.SelectionData selection_data Required (not null)

the data being dragged

Returns:

gboolean TRUE if a drop is possible before dest_path

Emits the GtkTreeModel::row-has-child-toggled signal on
state of a node changes.

Parameters:

Gtk.TreePath path Required (not null)

a GtkTreePath pointing to the changed row

Gtk.TreeIter iter Required (not null)

a valid GtkTreeIter pointing to the changed row

Returns:

none

Emits the GtkTreeModel::row-inserted signal on tree_model.

Parameters:

Gtk.TreePath path Required (not null)

a GtkTreePath pointing to the inserted row

Gtk.TreeIter iter Required (not null)

a valid GtkTreeIter pointing to the inserted row

Returns:

none

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_list_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.

Parameters:

Gtk.TreeIter iter Required (not null)

row iterator

Array columns Required (not null)

Array values Required (not null)

gint32 n_values Required (not null)

Returns:

none

Sets the property name name to value on the buildable object.

Parameters:

Gtk.Builder builder Required (not null)

a GtkBuilder

String name Required (not null)

name of property

GObject.Value value Required (not null)

value of property

Returns:

none

This function is meant primarily for GObjects that inherit from GtkListStore,
and should only be used when constructing a new GtkListStore. It will not
function after a row has been added, or a method on the GtkTreeModel
interface is called.

Parameters:

gint32 n_columns Required (not null)

Number of columns for the list store

Array types Required (not null)

An array length n of GTypes

Returns:

none

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)

The comparison function

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

Sets the name of the buildable object.

Parameters:

String name Required (not null)

name to set

Returns:

none

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. sort_column_id 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:

gint32 sort_column_id Required (not null)

the sort column id to set

Gtk.SortType order Required (not null)

The sort order of the column

Returns:

none

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:

gint32 sort_column_id Required (not null)

the sort column id to set the function for

Function (TreeModel model, TreeIter a, TreeIter b, void* user_data) : none Required (not null)

The comparison function

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

Sets the data in the cell specified by iter and column.
The type of value must be convertible to the type of the
column.

Parameters:

Gtk.TreeIter iter Required (not null)

A valid GtkTreeIter for the row being modified

gint32 column Required (not null)

column number to modify

GObject.Value value Required (not null)

new value for the cell

Returns:

none

Emits a GtkTreeSortable::sort-column-changed signal on sortable.

Returns:

none

Creates a new GtkTreeModel, with child_model as the child model.

Returns:

Gtk.TreeModel A new GtkTreeModel.

Swaps a and b in store. Note that this function only works with
unsorted stores.

Parameters:

Gtk.TreeIter a Required (not null)

A GtkTreeIter.

Gtk.TreeIter b Required (not null)

Another GtkTreeIter.

Returns:

none

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)

the GtkTreeIter

Returns:

none

This signal is emitted when a row in the model has changed.

Parameters:

Gtk.TreeModel self

Gtk.TreePath path

Gtk.TreeIter iter

Returns:

{none}

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.
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.TreeModel self

Gtk.TreePath path

Returns:

{none}

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}

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}

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}