gtk.ListStore — a list model to use with a gtk.TreeView
| class gtk.ListStore( | 
			gtk.ListStore
			implements 
			gtk.Buildable
            gtk.TreeModel
            gtk.TreeDragSource
            gtk.TreeDragDest
            gtk.TreeSortable
		
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, ...)| 
 | 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
gobject.TYPE_BOOLEANgobject.TYPE_BOXEDgobject.TYPE_CHARgobject.TYPE_DOUBLEgobject.TYPE_ENUMgobject.TYPE_FLAGSgobject.TYPE_FLOATgobject.TYPE_INTgobject.TYPE_INT64gobject.TYPE_INTERFACEgobject.TYPE_INVALIDgobject.TYPE_LONGgobject.TYPE_NONEgobject.TYPE_OBJECTgobject.TYPE_PARAMgobject.TYPE_POINTERgobject.TYPE_PYOBJECTgobject.TYPE_STRINGgobject.TYPE_UCHARgobject.TYPE_UINTgobject.TYPE_UINT64gobject.TYPE_ULONGThe column types can be any GObjectGObject
    def set_column_types(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.
    def set_value(iter, column, value)| 
 | a valid gtk.TreeIterfor
the row being modified | 
| 
 | the column number to modify | 
| 
 | 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.
    def set(iter, column_num, value, ...)| 
 | A valid gtk.TreeIterfor
the row being modified | 
| 
 | the number of the column to modify | 
| 
 | 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")
    def remove(iter)| 
 | A valid gtk.TreeIterfor
the row | 
| Returns : | Trueifiteris 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.
    def insert(position, row=None)| 
 | the integer position to insert the new row | 
| 
 | an optional list or tuple containing ordered
column values to set on the row or None | 
| Returns : | A gtk.TreeIterpointing 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.
    def insert_before(sibling, row=None)| 
 | A valid gtk.TreeIterorNone | 
| 
 | an optional list or tuple containing ordered
column values to set on the row or None | 
| Returns : | A gtk.TreeIterpointing 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.
    def insert_after(sibling, row=None)| 
 | A valid gtk.TreeIterorNone | 
| 
 | an optional list or tuple containing ordered
column values to set on the row or None | 
| Returns : | A gtk.TreeIterpointing 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.
    def prepend(row=None)| 
 | an optional list or tuple containing ordered
column values to set on the row or None | 
| Returns : | A gtk.TreeIterpointing 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.
    def append(row=None)| 
 | an optional list or tuple containing ordered
column values to set on the row or None | 
| Returns : | A gtk.TreeIterpointing 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.
    def iter_is_valid(iter)| 
 | A gtk.TreeIter. | 
| Returns : | Trueif the iter is valid,Falseif 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.
    def reorder(new_order)| 
 | a list of integers. The gtk.ListStorenodes will be rearranged so that thegtk.ListStorenode that is at position indexnew_order[i]will be
	  located at position indexi. | 
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.
    def swap(a, b)| 
 | A gtk.TreeIter. | 
| 
 | 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.
    def move_after(iter, position)| 
 | A gtk.TreeIter. | 
| 
 | A gtk.TreeIterorNone. | 
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.
    def move_before(iter, position)| 
 | A gtk.TreeIter. | 
| 
 | A gtk.TreeIter,
	  orNone. | 
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.