Class (GI Class)

Gtk-4.0 ▶ Gtk ▶ ListStoreDeprecated 4.10

A list-like data structure that can be used with the Gtk.TreeView.

The Gtk.ListStore object is a list model for use with a Gtk.TreeView widget. It implements the Gtk.TreeModel interface, and consequentialy, can use all of the methods available there. It also implements the Gtk.TreeSortable interface so it can be sorted by the view. Finally, it also implements the tree drag and drop interfaces.

The Gtk.ListStore can accept most GObject.GTypes 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 GObject.Objects are handled a little differently. The Gtk.ListStore 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.TreeModel.row_changed to emit the Gtk.TreeModel::row_changed signal. This most commonly affects lists with Gdk.Textures stored.

An example for creating a simple list store:

enum {
  COLUMN_STRING,
  COLUMN_INT,
  COLUMN_BOOLEAN,
  N_COLUMNS
};

{
  GtkListStore *list_store;
  GtkTreePath *path;
  GtkTreeIter iter;
  int i;

  list_store = gtk_list_store_new (N_COLUMNS,
                                   G_TYPE_STRING,
                                   G_TYPE_INT,
                                   G_TYPE_BOOLEAN);

  for (i = 0; i < 10; i++)
    {
      char *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);
}

Gtk.ListStore is deprecated since GTK 4.10, and should not be used in newly written code. You should use Gio.ListStore instead, and the various list models provided by GTK.

Internally, the Gtk.ListStore was originally implemented with a linked list with a tail pointer. As a result, it was fast at data insertion and deletion, and not fast at random data access. The Gtk.ListStore sets the GTK_TREE_MODEL_ITERS_PERSIST flag, which means that Gtk.TreeIters 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.

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.TreeModel 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.TreeModel::row-inserted signal on Gtk.ListStore. The row, however, is still empty, and any signal handler connecting to Gtk.TreeModel::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.ListStore inside a Gtk.TreeModelFilter and are using a Gtk.TreeModelFilterVisibleFunc. Using any of the non-atomic operations to append rows to the Gtk.ListStore will cause the Gtk.TreeModelFilterVisibleFunc to be visited with an empty row first; the function must be prepared for that.

The GtkListStore implementation of the Gtk.Buildable 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.

An example of a UI Definition fragment for a list store:

<object class="GtkListStore">
  <columns>
    <column type="gchararray"/>
    <column type="gchararray"/>
    <column type="gint"/>
  </columns>
  <data>
    <row>
      <col id="0">John</col>
      <col id="1">Doe</col>
      <col id="2">25</col>
    </row>
    <row>
      <col id="0">Johan</col>
      <col id="1">Dahlin</col>
      <col id="2">50</col>
    </row>
  </data>
</object>

since 4.10: Use Gio.ListStore instead

Hierarchy (View Summary)

Implements

Index

Constructors

constructor

Properties

$signals $gtype

Methods

_init append bind_property bind_property_full block_signal_handler clear connect connect_after disconnect drag_data_delete drag_data_get drag_data_received emit filter_new force_floating foreach freeze_notify get_buildable_id get_column_type get_data get_flags get_iter get_iter_first get_iter_from_string get_n_columns get_path get_property get_qdata get_sort_column_id get_string_from_iter get_value getv has_default_sort_func insert insert_after insert_before insert_with_values is_floating iter_children iter_has_child iter_is_valid iter_n_children iter_next iter_nth_child iter_parent iter_previous move_after move_before notify notify_by_pspec prepend ref ref_node ref_sink remove reorder row_changed row_deleted row_draggable row_drop_possible row_has_child_toggled row_inserted rows_reordered run_dispose set set_column_types set_data set_default_sort_func set_property set_sort_column_id set_sort_func set_value sort_column_changed steal_data steal_qdata stop_emission_by_name swap thaw_notify unblock_signal_handler unref unref_node vfunc_add_child vfunc_constructed vfunc_custom_finished vfunc_custom_tag_end vfunc_custom_tag_start vfunc_dispatch_properties_changed vfunc_dispose vfunc_drag_data_delete vfunc_drag_data_get vfunc_drag_data_received vfunc_finalize vfunc_get_column_type vfunc_get_flags vfunc_get_id vfunc_get_internal_child vfunc_get_iter vfunc_get_n_columns vfunc_get_path vfunc_get_property vfunc_get_sort_column_id vfunc_get_value vfunc_has_default_sort_func vfunc_iter_children vfunc_iter_has_child vfunc_iter_n_children vfunc_iter_next vfunc_iter_nth_child vfunc_iter_parent vfunc_iter_previous vfunc_notify vfunc_parser_finished vfunc_ref_node vfunc_row_changed vfunc_row_deleted vfunc_row_draggable vfunc_row_drop_possible vfunc_row_has_child_toggled vfunc_row_inserted vfunc_set_buildable_property vfunc_set_default_sort_func vfunc_set_id vfunc_set_property vfunc_set_sort_column_id vfunc_set_sort_func vfunc_sort_column_changed vfunc_unref_node watch_closure new

Methods - Inherited from GObject

_classInit compat_control find_property install_properties install_property interface_find_property interface_install_property interface_list_properties list_properties newv override_property

Constructors

Properties

$signals: Gtk.ListStore.SignalSignatures

Compile-time signal type information.

This instance property is generated only for TypeScript type checking. It is not defined at runtime and should not be accessed in JS code.

$gtype: GType<Gtk.ListStore>

Methods

Deprecated_init

  • 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

  • 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.Object instance to be updated with the same value of the "active" property of the action GObject.Object instance.

    If flags contains GObject.BindingFlags.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 GObject.Binding 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.Object can have multiple bindings.

    Parameters

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Complete version of g_object_bind_property().

    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.

    If flags contains GObject.BindingFlags.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 transform_from function is only used in case of bidirectional bindings, otherwise it will be ignored

    The binding will automatically be removed when either the source or the target instances are finalized. This will release the reference that is being held on the GObject.Binding instance; if you want to hold on to the GObject.Binding instance, you will need to hold a reference to it.

    To remove the binding, call g_binding_unbind().

    A GObject.Object can have multiple bindings.

    The same user_data parameter will be used for both transform_to and transform_from transformation functions; the notify function will be called once, when the binding is removed. If you need different data for each transformation function, please use g_object_bind_property_with_closures() instead.

    Parameters

    • Deprecatedsource_property: string

      the property on source to bind

    • Deprecatedtarget: GObject.Object

      the target GObject.Object

    • Deprecatedtarget_property: string

      the property on target to bind

    • Deprecatedflags: GObject.BindingFlags

      flags to pass to GObject.Binding

    • OptionalDeprecatedtransform_to: BindingTransformFunc

      the transformation function from the source to the target, or null to use the default

    • OptionalDeprecatedtransform_from: BindingTransformFunc

      the transformation function from the target to the source, or null to use the default

    • OptionalDeprecatednotify: DestroyNotify

      a function to call when disposing the binding, to free resources used by the transformation functions, or null if not required

    Returns GObject.Binding

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • 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

    • Deprecated...args: never[]

      the property on source to bind

    Returns any

    the GObject.Binding instance representing the binding between the two GObject.Object instances. The binding is released whenever the GObject.Binding reference count reaches zero.

  • Disconnects a handler from an instance so it will not be called during any future or currently ongoing emissions of the signal it has been connected to.

    Parameters

    • Deprecatedid: number

      Handler ID of the handler to be disconnected

    Returns void

  • Asks the Gtk.TreeDragSource 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

    • Deprecatedpath: Gtk.TreePath

      row that was being dragged

    Returns boolean

    true if the row was successfully deleted

  • Asks the Gtk.TreeDragDest 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

    • Deprecateddest: Gtk.TreePath

      row to drop in front of

    • Deprecatedvalue: any

      data to drop

    Returns boolean

    whether a new row was created before position dest

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

  • Gets a named field from the objects table of associations (see g_object_set_data()).

    Parameters

    • Deprecatedkey: string

      name of the key for that association

    Returns any

    the data if found, or null if no such data exists.

  • Gets a property of an object.

    The value can be:

    • an empty GObject.Value initialized by G_VALUE_INIT, which will be automatically initialized with the expected type of the property (since GLib 2.60)
    • a GObject.Value initialized with the expected type of the property
    • a GObject.Value 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 GObject.Value.unset.

    Note that GObject.Object.get_property is really intended for language bindings, GObject.Object.get is much more convenient for C programming.

    Parameters

    • Deprecatedproperty_name: string

      The name of the property to get

    • Deprecatedvalue: any

      Return location for the property value. Can be an empty GObject.Value initialized by G_VALUE_INIT (auto-initialized with expected type since GLib 2.60), a GObject.Value initialized with the expected property type, or a GObject.Value initialized with a transformable type

    Returns any

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

    Returns [boolean, number, Gtk.SortType]

    true if the sort column is not one of the special sort column ids.

  • 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

    • Deprecatednames: string[]

      the names of each property to get

    • Deprecatedvalues: any[]

      the values of each property to get

    Returns void

  • 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

    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 -1 or 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

    • Deprecatedposition: 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 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

    Returns Gtk.TreeIter

  • 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

    Returns Gtk.TreeIter

  • 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

    • Deprecatedposition: number

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

    • Deprecatedcolumns: number[]

      an array of column numbers

    • Deprecatedvalues: any[]

      an array of GValues

    Returns Gtk.TreeIter

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

    true, if iter has been set to the first child

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

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

    Parameters

    Returns boolean

    true if the iter is valid, false if the iter is invalid.

  • 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

    • Deprecatedparent: Gtk.TreeIter

      the Gtk.TreeIter to get the child from

    • Deprecatedn: number

      the index of the desired child

    Returns [boolean, Gtk.TreeIter]

    true, if parent has an n-th 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.

    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]

    true, if iter is set to the parent of child

  • 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

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

      typedef enum
      {
        PROP_FOO = 1,
        PROP_LAST
      } MyObjectProperty;

      static GParamSpec *properties[PROP_LAST];

      static void
      my_object_class_init (MyObjectClass *klass)
      {
        properties[PROP_FOO] = g_param_spec_int ("foo", NULL, NULL,
                                                 0, 100,
                                                 50,
                                                 G_PARAM_READWRITE | G_PARAM_STATIC_STRINGS);
        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

    Returns void

  • 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

  • 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

    the same 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 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

    object

  • Removes the given row from the list store. After being removed, iter is set to be the next valid row, or invalidated if it pointed to the last row in list_store.

    Parameters

    Returns boolean

    true if iter is valid, false if not.

  • Reorders store to follow the order indicated by new_order. Note that this function only works with unsorted stores.

    Parameters

    • Deprecatednew_order: number[]

      an array of integers mapping the new position of each child to its old position before the re-ordering, i.e. new_order``[newpos] = oldpos. It must have exactly as many items as the list store’s length.

    Returns void

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

    See Gtk.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

    Returns void

  • 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

    • Deprecateddest_path: Gtk.TreePath

      destination row

    • Deprecatedvalue: any

      the data being dropped

    Returns boolean

    true if a drop is possible before dest_path

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

    See Gtk.TreeModel::rows-reordered.

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

    Parameters

    • Deprecatedpath: Gtk.TreePath

      a Gtk.TreePath pointing to the tree node whose children have been reordered

    • Deprecatediter: Gtk.TreeIter

      a valid Gtk.TreeIter pointing to the node whose children have been reordered, or null if the depth of path is 0

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

  • A variant of gtk_list_store_set_valist() which takes the columns and values as two arrays, instead of varargs. This function is mainly intended for language-bindings and in case the number of columns to change is not known until run-time.

    Parameters

    • Deprecatediter: Gtk.TreeIter

      A valid Gtk.TreeIter for the row being modified

    • Deprecatedcolumns: number[]

      an array of column numbers

    • Deprecatedvalues: any[]

      an array of GValues

    Returns void

  • Parameters

    • Deprecated...args: never[]

    Returns any

  • Sets the types of the columns of a list store.

    This function is meant primarily for objects that inherit from Gtk.ListStore, and should only be used when constructing a new instance.

    This function cannot be called after a row has been added, or a method on the Gtk.TreeModel interface is called.

    Parameters

    Returns 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 GLib.Quark 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 GLib.Quark storage growing unbounded.

    Parameters

    • Deprecatedkey: string

      name of the key

    • OptionalDeprecateddata: any

      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

  • Sets the current sort column to be sort_column_id. The sortable will resort itself to reflect this change, after emitting a Gtk.TreeSortable::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

    • Deprecatedsort_column_id: number

      the sort column id to set

    • Deprecatedorder: 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

    • Deprecatedsort_column_id: number

      the sort column id to set the function for

    • Deprecatedsort_func: Gtk.TreeIterCompareFunc

      The comparison function

    • OptionalDeprecateddestroy: DestroyNotify

      Destroy notifier of user_data

    Returns 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

    • Deprecatediter: Gtk.TreeIter

      A valid Gtk.TreeIter for the row being modified

    • Deprecatedcolumn: number

      column number to modify

    • Deprecatedvalue: any

      new value for the cell

    Returns void

  • Remove a specified datum from the object's data associations, without invoking the association's destroy handler.

    Parameters

    • Deprecatedkey: string

      name of the key

    Returns any

    the data if found, or null if no such data exists.

  • 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

    • Deprecatedquark: number

      A GLib.Quark, naming the user data pointer

    Returns any

    The user data pointer set, or null

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

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

  • the constructed function is called by g_object_new() as the final step of the object creation process. At the point of the call, all construction properties have been set on the object. The purpose of this call is to allow for object initialisation steps that can only be performed after construction properties have been set. constructed implementors should chain up to the constructed call of their parent class to allow it to complete its initialisation.

    Returns void

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

    Parameters

    • Deprecatedbuilder: Gtk.Builder

      a Gtk.Builder

    • Deprecatedchild: GObject.Object

      child object or null for non-child tags

    • Deprecatedtagname: string

      the name of the tag

    • OptionalDeprecateddata: any

      user data created in custom_tag_start

    Returns void

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

    Parameters

    • Deprecatedbuilder: Gtk.Builder

      Gtk.Builder used to construct this object

    • Deprecatedchild: GObject.Object

      child object or null for non-child tags

    • Deprecatedtagname: string

      name of tag

    • OptionalDeprecateddata: any

      user data that will be passed in to parser functions

    Returns void

  • the dispose function is supposed to drop all references to other objects, but keep the instance otherwise intact, so that client method invocations still work. It may be run multiple times (due to reference loops). Before returning, dispose should chain up to the dispose method of the parent class.

    Returns void

  • Asks the Gtk.TreeDragDest 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

    • Deprecateddest: Gtk.TreePath

      row to drop in front of

    • Deprecatedvalue: any

      data to drop

    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

    • Deprecatedparent: Gtk.TreeIter

      the Gtk.TreeIter to get the child from

    • Deprecatedn: 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]

  • 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

    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.

    Parameters

    Returns void

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

    See Gtk.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

    Returns void

  • 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

    • Deprecateddest_path: Gtk.TreePath

      destination row

    • Deprecatedvalue: any

      the data being dropped

    Returns boolean

  • Sets a property of a buildable object. It is normally not necessary to implement this, g_object_set_property() is used by default. Gtk.Window implements this to delay showing itself (i.e. setting the Gtk.Widget.visible property) until the whole interface is created.

    Parameters

    • Deprecatedbuilder: Gtk.Builder
    • Deprecatedname: string
    • Deprecatedvalue: any

    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

  • Stores the id attribute given in the Gtk.Builder UI definition. Gtk.Widget stores the name as object data. Implement this method if your object has some notion of “ID” and it makes sense to map the XML id attribute to it.

    Parameters

    • Deprecatedid: string

    Returns void

  • the generic setter for all properties of this type. Should be overridden for every type with properties. If implementations of set_property don't emit property change notification explicitly, this will be done implicitly by the type system. However, if the notify signal is emitted explicitly, the type system will not emit it a second time.

    Parameters

    • Deprecatedproperty_id: number
    • Deprecatedvalue: any
    • Deprecatedpspec: GObject.ParamSpec

    Returns void

  • Sets the current sort column to be sort_column_id. The sortable will resort itself to reflect this change, after emitting a Gtk.TreeSortable::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

    • Deprecatedsort_column_id: number

      the sort column id to set

    • Deprecatedorder: Gtk.SortType

      The sort order of the column

    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

  • 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

    Returns void

Methods - Inherited from GObject

StaticDeprecated_classInit

  • 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 GObject.ParamSpec, 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 GObject.TypeInfo.) 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

    Returns void

  • Parameters

    • Deprecatedproperty_id: number

      the new property ID

    • Deprecatedname: string

      the name of a property registered in a parent class or in an interface of this class.

    Returns void

Interfaces

ConstructorProps
SignalSignatures