Gjsify LogoGjsify Logo

A tree-like data structure that can be used with the GtkTreeView

The GtkTreeStore object is a list model for use with a GtkTreeView widget. It implements the GtkTreeModel interface, and consequently, can use all of the methods available there. It also implements the GtkTreeSortable interface so it can be sorted by the view. Finally, it also implements the tree [drag and drop][gtk3-GtkTreeView-drag-and-drop] interfaces.

GtkTreeStore as GtkBuildable

The GtkTreeStore implementation of the GtkBuildable interface allows to specify the model columns with a element that may contain multiple elements, each specifying one model column. The “type” attribute specifies the data type for the column.

An example of a UI Definition fragment for a tree store: |[


@class

Hierarchy

Index

Constructors

Properties

Methods

Constructors

Properties

g_type_instance: TypeInstance
parent: GObject.Object
name: string

Methods

  • Appends a new row to tree_store. If parent is non-%NULL, 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().

    Parameters

    Returns Gtk.TreeIter

  • Creates a binding between source_property on source and target_property on target.

    Whenever the source_property is changed the target_property is updated using the same value. For instance:

      g_object_bind_property (action, "active", widget, "sensitive", 0);
    

    Will result in the "sensitive" property of the widget #GObject instance to be updated with the same value of the "active" property of the action #GObject instance.

    If flags contains %G_BINDING_BIDIRECTIONAL then the binding will be mutual: if target_property on target changes then the source_property on source will be updated as well.

    The binding will automatically be removed when either the source or the target instances are finalized. To remove the binding without affecting the source and the target you can just call g_object_unref() on the returned #GBinding instance.

    Removing the binding by calling g_object_unref() on it must only be done if the binding, source and target are only used from a single thread and it is clear that both source and target outlive the binding. Especially it is not safe to rely on this if the binding, source or target can be finalized from different threads. Keep another reference to the binding and use g_binding_unbind() instead to be on the safe side.

    A #GObject can have multiple bindings.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    Returns Binding

  • Creates a binding between source_property on source and target_property on target, allowing you to set the transformation functions to be used by the binding.

    This function is the language bindings friendly version of g_object_bind_property_full(), using #GClosures instead of function pointers.

    Parameters

    • source_property: string

      the property on source to bind

    • target: GObject.Object

      the target #GObject

    • target_property: string

      the property on target to bind

    • flags: BindingFlags

      flags to pass to #GBinding

    • transform_to: TClosure<any, any>

      a #GClosure wrapping the transformation function from the source to the target, or %NULL to use the default

    • transform_from: TClosure<any, any>

      a #GClosure wrapping the transformation function from the target to the source, or %NULL to use the default

    Returns Binding

  • clear(): void
  • connect(sigName: string, callback: ((...args: any[]) => void)): number
  • connect_after(sigName: string, callback: ((...args: any[]) => void)): number
  • disconnect(id: number): void
  • 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

    Returns boolean

  • drag_data_received(dest: Gtk.TreePath, value: any): boolean
  • Asks the GtkTreeDragDest to insert a row before the path dest, deriving the contents of the row from value. 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

    • dest: Gtk.TreePath

      row to drop in front of

    • value: any

      data to drop

    Returns boolean

  • emit(sigName: string, ...args: any[]): void
  • force_floating(): void
  • This function is intended for #GObject implementations to re-enforce a [floating][floating-ref] object reference. Doing this is seldom required: all #GInitiallyUnowneds are created with a floating reference which usually just needs to be sunken by calling g_object_ref_sink().

    Returns void

  • freeze_notify(): void
  • Increases the freeze count on object. If the freeze count is non-zero, the emission of "notify" signals on object is stopped. The signals are queued until the freeze count is decreased to zero. Duplicate notifications are squashed so that at most one #GObject::notify signal is emitted for each property modified while the object is frozen.

    This is necessary for accessors that modify multiple properties to prevent premature notification while the object is still being modified.

    Returns void

  • get_buildable_id(): string
  • Gets the ID of the buildable object.

    GtkBuilder sets the name based on the ID attribute of the tag used to construct the buildable.

    Returns string

    • get_column_type(index_: number): GType<unknown>
    • get_data(key?: string): object
    • Gets a named field from the objects table of associations (see g_object_set_data()).

      Parameters

      • Optional key: string

        name of the key for that association

      Returns object

    • get_iter_from_string(path_string: string): [boolean, Gtk.TreeIter]
    • get_n_columns(): number
    • get_property(property_name?: string, value?: any): void
    • Gets a property of an object.

      The value can be:

      • an empty #GValue initialized by %G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
      • a #GValue initialized with the expected type of the property
      • a #GValue initialized with a type to which the expected type of the property can be transformed

      In general, a copy is made of the property contents and the caller is responsible for freeing the memory by calling g_value_unset().

      Note that g_object_get_property() is really intended for language bindings, g_object_get() is much more convenient for C programming.

      Parameters

      • Optional property_name: string

        the name of the property to get

      • Optional value: any

        return location for the property value

      Returns void

    • get_qdata(quark: number): object
    • 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

      • iter: Gtk.TreeIter

        the GtkTreeIter

      • column: number

        the column to lookup the value at

      Returns any

    • getv(names: string[], values: any[]): void
    • Gets n_properties properties for an object. Obtained properties will be set to values. All properties must be valid. Warnings will be emitted and undefined behaviour may result if invalid properties are passed in.

      Parameters

      • names: string[]

        the names of each property to get

      • values: any[]

        the values of each property to get

      Returns void

    • has_default_sort_func(): boolean
    • Creates a new row at position. If parent is non-%NULL, 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().

      Parameters

      • parent: Gtk.TreeIter

        A valid GtkTreeIter

      • position: number

        position to insert the new row, or -1 for last

      Returns Gtk.TreeIter

    • Inserts a new row after sibling. If sibling is %NULL, then the row will be prepended to parent ’s children. If parent and sibling are %NULL, 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().

      Parameters

      Returns Gtk.TreeIter

    • Inserts a new row before sibling. If sibling is %NULL, then the row will be appended to parent ’s children. If parent and sibling are %NULL, 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().

      Parameters

      Returns Gtk.TreeIter

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

      Parameters

      • parent: Gtk.TreeIter

        A valid GtkTreeIter

      • position: number

        position to insert the new row, or -1 for last

      • columns: number[]

        an array of column numbers

      • values: any[]

        an array of GValues

      Returns Gtk.TreeIter

    • Returns %TRUE if iter is an ancestor of descendant. That is, iter is the parent (or grandparent or great-grandparent) of descendant.

      Parameters

      Returns boolean

    • is_floating(): boolean
    • 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

      Returns [boolean, Gtk.TreeIter]

    • Returns the depth of iter. This will be 0 for anything on the root level, 1 for anything down a level, etc.

      Parameters

      Returns number

    • Checks if the given iter is a valid iter for this GtkTreeStore.

      This function is slow. Only use it for debugging and/or testing purposes.

      Parameters

      Returns boolean

    • 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 n-th root node is set.

      Parameters

      • parent: Gtk.TreeIter

        the GtkTreeIter to get the child from

      • n: number

        the index of the desired child

      Returns [boolean, Gtk.TreeIter]

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

      iter will be initialized before the lookup is performed, so child and iter cannot point to the same memory location.

      Parameters

      Returns [boolean, Gtk.TreeIter]

    • 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 %NULL, iter will be moved to the start of the level.

      Parameters

      Returns void

    • 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 %NULL, iter will be moved to the end of the level.

      Parameters

      Returns void

    • notify(property_name: string): void
    • Emits a "notify" signal for the property property_name on object.

      When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

      Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

      Parameters

      • property_name: string

        the name of a property installed on the class of object.

      Returns void

    • Emits a "notify" signal for the property specified by pspec on object.

      This function omits the property name lookup, hence it is faster than g_object_notify().

      One way to avoid using g_object_notify() from within the class that registered the properties, and using g_object_notify_by_pspec() instead, is to store the GParamSpec used with g_object_class_install_property() inside a static array, e.g.:

        enum
      {
      PROP_0,
      PROP_FOO,
      PROP_LAST
      };

      static GParamSpec *properties[PROP_LAST];

      static void
      my_object_class_init (MyObjectClass *klass)
      {
      properties[PROP_FOO] = g_param_spec_int ("foo", "Foo", "The foo",
      0, 100,
      50,
      G_PARAM_READWRITE);
      g_object_class_install_property (gobject_class,
      PROP_FOO,
      properties[PROP_FOO]);
      }

      and then notify a change on the "foo" property with:

        g_object_notify_by_pspec (self, properties[PROP_FOO]);
      

      Parameters

      • pspec: ParamSpec

        the #GParamSpec of a property installed on the class of object.

      Returns void

    • Prepends a new row to tree_store. If parent is non-%NULL, 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().

      Parameters

      Returns Gtk.TreeIter

    • Increases the reference count of object.

      Since GLib 2.56, if GLIB_VERSION_MAX_ALLOWED is 2.56 or greater, the type of object will be propagated to the return type (using the GCC typeof() extension), so any casting the caller needs to do on the return type must be explicit.

      Returns GObject.Object

    • 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). Being displayed means a node is in an expanded branch, regardless of whether the node is currently visible in the viewport. 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

      Returns void

    • Increase the reference count of object, and possibly remove the [floating][floating-ref] reference, if object has a floating reference.

      In other words, if the object is floating, then this call "assumes ownership" of the floating reference, converting it to a normal reference by clearing the floating flag while leaving the reference count unchanged. If the object is not floating, then this call adds a new normal reference increasing the reference count by one.

      Since GLib 2.56, the type of object will be propagated to the return type under the same conditions as for g_object_ref().

      Returns GObject.Object

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

      Parameters

      Returns boolean

    • Emits the ::row-deleted signal on tree_model.

      See [signalGtk.TreeModel::row-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.

      Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released.

      Parameters

      • path: Gtk.TreePath

        a GtkTreePath pointing to the previous location of the deleted row

      Returns void

    • 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

      • path: Gtk.TreePath

        row on which user is initiating a drag

      Returns boolean

    • row_drop_possible(dest_path: Gtk.TreePath, value: any): boolean
    • 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 value at that location. dest_path does not have to exist; the return value will almost certainly be %FALSE if the parent of dest_path doesn’t exist, though.

      Parameters

      • dest_path: Gtk.TreePath

        destination row

      • value: any

        the data being dropped

      Returns boolean

    • Emits the ::row-has-child-toggled signal on tree_model.

      See [signalGtk.TreeModel::row-has-child-toggled].

      This should be called by models after the child state of a node changes.

      Parameters

      • path: Gtk.TreePath

        a GtkTreePath pointing to the changed row

      • iter: Gtk.TreeIter

        a valid GtkTreeIter pointing to the changed row

      Returns void

    • Emits the ::rows-reordered signal on tree_model.

      See [signalGtk.TreeModel::rows-reordered].

      This should be called by models when their rows have been reordered.

      Parameters

      • path: Gtk.TreePath

        a GtkTreePath pointing to the tree node whose children have been reordered

      • iter: Gtk.TreeIter

        a valid GtkTreeIter pointing to the node whose children have been reordered, or %NULL if the depth of path is 0

      • new_order: number[]

        an array of integers mapping the current position of each child to its old position before the re-ordering, i.e. new_order``[newpos] = oldpos

      Returns void

    • run_dispose(): void
    • Releases all references to other objects. This can be used to break reference cycles.

      This function should only be called from object system implementations.

      Returns void

    • set(iter: Gtk.TreeIter, columns: number[], values: any[]): void
    • 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.

      Parameters

      • iter: Gtk.TreeIter

        A valid GtkTreeIter for the row being modified

      • columns: number[]

        an array of column numbers

      • values: any[]

        an array of GValues

      Returns void

    • set_column_types(types: GType<unknown>[]): void
    • This function is meant primarily for GObjects that inherit from GtkTreeStore, and should only be used when constructing a new GtkTreeStore. It will not function after a row has been added, or a method on the GtkTreeModel interface is called.

      Parameters

      • types: GType<unknown>[]

        An array of GType types, one for each column

      Returns void

    • set_data(key: string, data?: object): void
    • Each object carries around a table of associations from strings to pointers. This function lets you set an association.

      If the object already had an association with that name, the old association will be destroyed.

      Internally, the key is converted to a #GQuark using g_quark_from_string(). This means a copy of key is kept permanently (even after object has been finalized) — so it is recommended to only use a small, bounded set of values for key in your program, to avoid the #GQuark storage growing unbounded.

      Parameters

      • key: string

        name of the key

      • Optional data: object

        data to associate with that key

      Returns void

    • 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

      Returns void

    • set_property(property_name: string, value?: any): void
    • set_sort_column_id(sort_column_id: number, order: Gtk.SortType): void
    • 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

      • sort_column_id: number

        the sort column id to set

      • order: Gtk.SortType

        The sort order of the column

      Returns void

    • 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

      • sort_column_id: number

        the sort column id to set the function for

      • sort_func: Gtk.TreeIterCompareFunc

        The comparison function

      Returns void

    • set_value(iter: Gtk.TreeIter, column: number, value: any): void
    • 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

      • iter: Gtk.TreeIter

        A valid GtkTreeIter for the row being modified

      • column: number

        column number to modify

      • value: any

        new value for the cell

      Returns void

    • sort_column_changed(): void
    • steal_data(key?: string): object
    • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

      Parameters

      • Optional key: string

        name of the key

      Returns object

    • steal_qdata(quark: number): object
    • This function gets back user data pointers stored via g_object_set_qdata() and removes the data from object without invoking its destroy() function (if any was set). Usually, calling this function is only required to update user data pointers with a destroy notifier, for example:

      void
      object_add_to_user_list (GObject *object,
      const gchar *new_string)
      {
      // the quark, naming the object data
      GQuark quark_string_list = g_quark_from_static_string ("my-string-list");
      // retrieve the old string list
      GList *list = g_object_steal_qdata (object, quark_string_list);

      // prepend new string
      list = g_list_prepend (list, g_strdup (new_string));
      // this changed 'list', so we need to set it again
      g_object_set_qdata_full (object, quark_string_list, list, free_string_list);
      }
      static void
      free_string_list (gpointer data)
      {
      GList *node, *list = data;

      for (node = list; node; node = node->next)
      g_free (node->data);
      g_list_free (list);
      }

      Using g_object_get_qdata() in the above example, instead of g_object_steal_qdata() would have left the destroy function set, and thus the partial string list would have been freed upon g_object_set_qdata_full().

      Parameters

      • quark: number

        A #GQuark, naming the user data pointer

      Returns object

    • thaw_notify(): void
    • Reverts the effect of a previous call to g_object_freeze_notify(). The freeze count is decreased on object and when it reaches zero, queued "notify" signals are emitted.

      Duplicate notifications for each property are squashed so that at most one #GObject::notify signal is emitted for each property, in the reverse order in which they have been queued.

      It is an error to call this function when the freeze count is zero.

      Returns void

    • unref(): void
    • Decreases the reference count of object. When its reference count drops to 0, the object is finalized (i.e. its memory is freed).

      If the pointer to the #GObject may be reused in future (for example, if it is an instance variable of another object), it is recommended to clear the pointer to %NULL rather than retain a dangling pointer to a potentially invalid #GObject instance. Use g_clear_object() for this.

      Returns void

    • 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

      Returns void

    • vfunc_constructed(): void
    • Similar to gtk_buildable_parser_finished() but is called once for each custom tag handled by the buildable.

      virtual

      Parameters

      • builder: Gtk.Builder

        a GtkBuilder

      • child: GObject.Object

        child object or %NULL for non-child tags

      • tagname: string

        the name of the tag

      • data: object

        user data created in custom_tag_start

      Returns void

    • Called at the end of each custom element handled by the buildable.

      virtual

      Parameters

      • builder: Gtk.Builder

        GtkBuilder used to construct this object

      • child: GObject.Object

        child object or %NULL for non-child tags

      • tagname: string

        name of tag

      • data: object

        user data that will be passed in to parser functions

      Returns void

    • vfunc_dispatch_properties_changed(n_pspecs: number, pspecs: ParamSpec): void
    • vfunc_dispose(): void
    • 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!

      virtual

      Parameters

      Returns boolean

    • vfunc_drag_data_received(dest: Gtk.TreePath, value: any): boolean
    • Asks the GtkTreeDragDest to insert a row before the path dest, deriving the contents of the row from value. 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!

      virtual

      Parameters

      • dest: Gtk.TreePath

        row to drop in front of

      • value: any

        data to drop

      Returns boolean

    • vfunc_finalize(): void
    • vfunc_get_column_type(index_: number): GType<unknown>
    • vfunc_get_id(): string
    • vfunc_get_n_columns(): number
    • vfunc_get_property(property_id: number, value?: any, pspec?: ParamSpec): void
    • vfunc_get_sort_column_id(): [boolean, number, Gtk.SortType]
    • vfunc_get_value(iter: Gtk.TreeIter, column: number): any
    • vfunc_has_default_sort_func(): boolean
    • 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);

      virtual

      Parameters

      Returns [boolean, Gtk.TreeIter]

    • 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 n-th root node is set.

      virtual

      Parameters

      • parent: Gtk.TreeIter

        the GtkTreeIter to get the child from

      • n: number

        the index of the desired child

      Returns [boolean, Gtk.TreeIter]

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

      iter will be initialized before the lookup is performed, so child and iter cannot point to the same memory location.

      virtual

      Parameters

      Returns [boolean, Gtk.TreeIter]

    • Emits a "notify" signal for the property property_name on object.

      When possible, eg. when signaling a property change from within the class that registered the property, you should use g_object_notify_by_pspec() instead.

      Note that emission of the notify signal may be blocked with g_object_freeze_notify(). In this case, the signal emissions are queued and will be emitted (in reverse order) when g_object_thaw_notify() is called.

      virtual

      Parameters

      Returns void

    • 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). Being displayed means a node is in an expanded branch, regardless of whether the node is currently visible in the viewport. 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.

      virtual

      Parameters

      Returns void

    • Emits the ::row-deleted signal on tree_model.

      See [signalGtk.TreeModel::row-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.

      Nodes that are deleted are not unreffed, this means that any outstanding references on the deleted node should not be released.

      virtual

      Parameters

      • path: Gtk.TreePath

        a GtkTreePath pointing to the previous location of the deleted row

      Returns void

    • vfunc_row_drop_possible(dest_path: Gtk.TreePath, value: any): boolean
    • 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 value at that location. dest_path does not have to exist; the return value will almost certainly be %FALSE if the parent of dest_path doesn’t exist, though.

      virtual

      Parameters

      • dest_path: Gtk.TreePath

        destination row

      • value: any

        the data being dropped

      Returns boolean

    • vfunc_set_buildable_property(builder: Gtk.Builder, name: string, value: any): void
    • 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.

      virtual

      Parameters

      Returns void

    • vfunc_set_id(id: string): void
    • vfunc_set_property(property_id: number, value?: any, pspec?: ParamSpec): void
    • vfunc_set_sort_column_id(sort_column_id: number, order: Gtk.SortType): void
    • 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

      virtual

      Parameters

      • sort_column_id: number

        the sort column id to set

      • order: Gtk.SortType

        The sort order of the column

      Returns void

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

      virtual

      Parameters

      • sort_column_id: number

        the sort column id to set the function for

      • sort_func: Gtk.TreeIterCompareFunc

        The comparison function

      Returns void

    • vfunc_sort_column_changed(): void
    • 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.

      virtual

      Parameters

      Returns void

    • watch_closure(closure: TClosure<any, any>): void
    • This function essentially limits the life time of the closure to the life time of the object. That is, when the object is finalized, the closure is invalidated by calling g_closure_invalidate() on it, in order to prevent invocations of the closure with a finalized (nonexisting) object. Also, g_object_ref() and g_object_unref() are added as marshal guards to the closure, to ensure that an extra reference count is held on object during invocation of the closure. Usually, this function will be called on closures that use this object as closure data.

      Parameters

      • closure: TClosure<any, any>

        #GClosure to watch

      Returns void

    • compat_control(what: number, data: object): number
    • Find the #GParamSpec with the given name for an interface. Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

      Parameters

      • g_iface: TypeInterface

        any interface vtable for the interface, or the default vtable for the interface

      • property_name: string

        name of a property to look up.

      Returns ParamSpec

    • Add a property to an interface; this is only useful for interfaces that are added to GObject-derived types. Adding a property to an interface forces all objects classes with that interface to have a compatible property. The compatible property could be a newly created #GParamSpec, but normally g_object_class_override_property() will be used so that the object class only needs to provide an implementation and inherits the property description, default value, bounds, and so forth from the interface property.

      This function is meant to be called from the interface's default vtable initialization function (the class_init member of #GTypeInfo.) It must not be called after after class_init has been called for any object types implementing this interface.

      If pspec is a floating reference, it will be consumed.

      Parameters

      • g_iface: TypeInterface

        any interface vtable for the interface, or the default vtable for the interface.

      • pspec: ParamSpec

        the #GParamSpec for the new property

      Returns void

    • Lists the properties of an interface.Generally, the interface vtable passed in as g_iface will be the default vtable from g_type_default_interface_ref(), or, if you know the interface has already been loaded, g_type_default_interface_peek().

      Parameters

      • g_iface: TypeInterface

        any interface vtable for the interface, or the default vtable for the interface

      Returns ParamSpec[]

    • Creates a new instance of a #GObject subtype and sets its properties.

      Construction parameters (see %G_PARAM_CONSTRUCT, %G_PARAM_CONSTRUCT_ONLY) which are not explicitly specified are set to their default values.

      Parameters

      • object_type: GType<unknown>

        the type id of the #GObject subtype to instantiate

      • parameters: GObject.Parameter[]

        an array of #GParameter

      Returns GObject.Object

    Legend

    • Module
    • Object literal
    • Variable
    • Function
    • Function with type parameter
    • Index signature
    • Type alias
    • Type alias with type parameter
    • Enumeration
    • Enumeration member
    • Property
    • Method
    • Interface
    • Interface with type parameter
    • Constructor
    • Property
    • Method
    • Index signature
    • Class
    • Class with type parameter
    • Constructor
    • Property
    • Method
    • Accessor
    • Index signature
    • Inherited constructor
    • Inherited property
    • Inherited method
    • Inherited accessor
    • Protected property
    • Protected method
    • Protected accessor
    • Private property
    • Private method
    • Private accessor
    • Static property
    • Static method