GtkListStore

Description

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

Methods and Functions

gtkListStoreNew(...)
gtkListStoreNewv(value)
gtkListStoreSetColumnTypes(object, types)
gtkListStoreSet(object, iter, ...)
gtkListStoreSetValue(object, iter, column, value)
gtkListStoreRemove(object, iter)
gtkListStoreInsert(object, position)
gtkListStoreInsertBefore(object, sibling)
gtkListStoreInsertAfter(object, sibling)
gtkListStoreInsertWithValues(object, position, ...)
gtkListStoreInsertWithValuesv(object, position, columns, values)
gtkListStorePrepend(object, iter)
gtkListStoreAppend(object)
gtkListStoreClear(object)
gtkListStoreIterIsValid(object, iter)
gtkListStoreReorder(object, new.order)
gtkListStoreSwap(object, a, b)
gtkListStoreMoveBefore(object, iter, position = NULL)
gtkListStoreMoveAfter(object, iter, position = NULL)
gtkListStore(..., value)

Hierarchy

  GObject
   +----GtkListStore

Interfaces

GtkListStore implements GtkTreeModel, GtkTreeDragSource, GtkTreeDragDest and GtkTreeSortable.

Detailed Description

The GtkListStore object is a list model for use with a GtkTreeView widget. It implements the GtkTreeModel interface, and consequentialy, 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 interfaces.

The GtkListStore can accept most GObject types as a column type, though it can't accept all custom types. Internally, it will keep a copy of data passed in (such as a string or a boxed pointer). Columns that accept GObjects are handled a little differently. The GtkListStore will keep a reference to the object instead of copying the value. As a result, if the object is modified, it is up to the application writer to call gtk.tree.model.row.changed to emit the "row_changed" signal. This most commonly affects lists with GdkPixbufs stored.

  list_store <- gtk_list_store_new ("character", "integer", "logical")

  sapply(character_vector, function(string)
    {
      # Add a new row to the model
      iter <- list_store$append(iter)$iter
      list_store$set(iter, 0, string, 1, i, 2,  FALSE)
        })

  # Modify a particular row
  path <- gtkTreePathNewFromString("4")
  iter <- list_store$getIter(path)$iter
  list_store$set(iter, 2, TRUE)

Performance Considerations

Internally, the GtkListStore was implemented with a linked list with a tail pointer prior to GTK+ 2.6. As a result, it was fast at data insertion and deletion, and not fast at random data access. The GtkListStore sets the GTK_TREE_MODEL_ITERS_PERSIST flag, which means that GtkTreeIters 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.

Structures

GtkListStore

undocumented

Convenient Construction

gtkListStore is the result of collapsing the constructors of GtkListStore (gtkListStoreNew, gtkListStoreNewv) and accepts a subset of its arguments matching the required arguments of one of its delegate constructors.

Author(s)

Derived by RGtkGen from GTK+ documentation

References

http://developer.gnome.org/doc/API/2.0/gtk/GtkListStore.html

See Also

GtkTreeModel GtkTreeStore