gtk.ListStore a list model to use with a gtk.TreeView gtk.ListStore gobject.GObject gtk.TreeModel gtk.TreeDragSource gtk.TreeDragDest gtk.TreeSortable gtk.ListStore column_type ... set_column_types type ... set_value iter column value set iter column_num value ... remove iter insert position rowNone insert_before sibling rowNone insert_after sibling rowNone prepend rowNone append rowNone clear iter_is_valid iter reorder new_order swap a b move_after iter position move_before iter position +-- gobject.GObject +-- gtk.ListStore gtk.ListStore implements gtk.Buildable gtk.TreeModel gtk.TreeDragSource gtk.TreeDragDest gtk.TreeSortable gobject.GObject Signal Prototypes gtk.TreeModel Signal Prototypes gtk.TreeSortable Signal Prototypes The gtk.ListStore object is a list model for use with a gtk.TreeView widget. It implements the gtk.TreeModel interface, the gtk.TreeSortable and the tree drag and drop interfaces. The gtk.ListStore objects support the Python mapping and iterator protocols. See the gtk.TreeModel Description and the PyGTK tutorial for more information. gtk.ListStore column_type ... column_type : the column type of the first column ... : optional types for succeeding columns Returns : a new gtk.ListStore Creates a new list store as with one or more columns with the type specified by the arguments passed to the constructor. For example, gtk.ListStore(gobject.TYPE_INT, gobject.TYPE_STRING, gtk.gdk.Pixbuf); will create a new gtk.ListStore with three columns, of type int, string and gtk.gdk.Pixbuf respectively. The built-in GObject types are: gobject.TYPE_BOOLEAN gobject.TYPE_BOXED gobject.TYPE_CHAR gobject.TYPE_DOUBLE gobject.TYPE_ENUM gobject.TYPE_FLAGS gobject.TYPE_FLOAT gobject.TYPE_INT gobject.TYPE_INT64 gobject.TYPE_INTERFACE gobject.TYPE_INVALID gobject.TYPE_LONG gobject.TYPE_NONE gobject.TYPE_OBJECT gobject.TYPE_PARAM gobject.TYPE_POINTER gobject.TYPE_PYOBJECT gobject.TYPE_STRING gobject.TYPE_UCHAR gobject.TYPE_UINT gobject.TYPE_UINT64 gobject.TYPE_ULONG The column types can be any GObject type including those that are PyGTK objects or application defined objects that are subclassed from the GObject class. set_column_types type ... type : the type of the first column ... : zero or more type specifications This method is available in PyGTK 2.2 and above. The set_column_types() method sets the liststore columns to the types specified by type and any additional type parameters. This method is meant primarily for classes that inherit from gtk.ListStore, and should only be used when constructing a new gtk.ListStore. It will not function after a row has been added, or a method on the gtk.TreeModel interface is called. set_value iter column value iter : a valid gtk.TreeIter for the row being modified column : the column number to modify value : the new value for the cell The set_value() method sets the data in the cell specified by iter and column. The type of value must be convertible to the type of the column. set iter column_num value ... iter : A valid gtk.TreeIter for the row being modified column_num : the number of the column to modify value : the new cell value ... : additional optional sets of column number - value pairs The set() method sets the value of one or more cells in the row referenced by iter. The argument list should contain integer column numbers, each followed by the value to be set (the value must be convertible to the type of the cell column). For example, to set column 0 with type gobject.TYPE_STRING to "Foo", you would write: liststore.set(iter, 0, "Foo") remove iter iter : A valid gtk.TreeIter for the row Returns : True if iter is still valid. The remove() method removes the row specified by iter from the list store and returns True if iter is still valid. After being removed, iter is set to be the next valid row, or is invalidated if it pointed to the last row. Prior to PyGTK 2.4 this method returned a new gtk.TreeIter that is a copy of iter. insert position rowNone position : the integer position to insert the new row row : an optional list or tuple containing ordered column values to set on the row or None Returns : A gtk.TreeIter pointing at the new row The insert() method creates a new row at the location specified by position. 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 if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods. insert_before sibling rowNone sibling : A valid gtk.TreeIter or None row : an optional list or tuple containing ordered column values to set on the row or None Returns : A gtk.TreeIter pointing at the new row The insert_before() method inserts a new row before the row specified by the gtk.TreeIter sibling. The row will be empty if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods. In PyGTK 2.4, if sibling is None the row will be appended to the liststore. insert_after sibling rowNone sibling : A valid gtk.TreeIter or None row : an optional list or tuple containing ordered column values to set on the row or None Returns : A gtk.TreeIter pointing at the new row The insert_after() method inserts a new row after the row specified by the gtk.TreeIter sibling. The row will be empty if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods. In PyGTK 2.4, if sibling is None the row will be prepended to the liststore. prepend rowNone row : an optional list or tuple containing ordered column values to set on the row or None Returns : A gtk.TreeIter pointing at the new row The prepend() method prepends a new row to the liststore. The row will be empty if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods. append rowNone row : an optional list or tuple containing ordered column values to set on the row or None Returns : A gtk.TreeIter pointing at the new row The append() method appends a new row to the liststore. The row will be empty if row is not specified or is None. If row is specified it must contain a list or tuple of ordered column values (e.g. [gobject.TYPE_STRING, gobject.TYPE_INT]) that are used to set the values in the cells of the new row. Alternatively, the application can fill in row cell values using the set() or set_value() methods. clear The clear() method removes all rows from the liststore. iter_is_valid iter iter : A gtk.TreeIter. Returns : True if the iter is valid, False if the iter is invalid. This method is available in PyGTK 2.2 and above. This method is slow. Only use it for debugging and/or testing purposes. The iter_is_valid() method checks if the gtk.TreeIter specified by iter is a valid iter for this gtk.ListStore. reorder new_order new_order : a list of integers. The gtk.ListStore nodes will be rearranged so that the gtk.ListStore node that is at position index new_order[i] will be located at position index i. This method is available in PyGTK 2.2 and above. The reorder() method reorders the gtk.ListStore items to follow the order indicated by new_order. The gtk.ListStore nodes will be rearranged so that the gtk.ListStore node that is at position index new_order[i] will be located at position index i. Note that this method only works with unsorted stores. swap a b a : A gtk.TreeIter. b : Another gtk.TreeIter. This method is available in PyGTK 2.2 and above. The swap() method swaps the liststore rows specified by the gtk.TreeIters a and b. Note that this method only works with unsorted stores. move_after iter position iter : A gtk.TreeIter. position : A gtk.TreeIter or None. This method is available in PyGTK 2.2 and above. The move_after() method moves the liststore row referenced by iter to the position after the row referenced by position. Note that this method only works with unsorted stores. If position is None, the row referenced by iter will be moved to the start of the list. move_before iter position iter : A gtk.TreeIter. position : A gtk.TreeIter, or None. This method is available in PyGTK 2.2 and above. The move_before() method moves the liststore row referenced by iter to the position before the row referenced by position. Note that this method only works with unsorted stores. If position is None, the row referenced by iter will be moved to the end of the list.