GtkListStore              package:RGtk2              R Documentation

_G_t_k_L_i_s_t_S_t_o_r_e

_D_e_s_c_r_i_p_t_i_o_n:

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

_M_e_t_h_o_d_s _a_n_d _F_u_n_c_t_i_o_n_s:

     'gtkListStoreNew(...)'
      'gtkListStoreNewv(value)'
      'gtkListStoreSetColumnTypes(object, types)'
      'gtkListStoreSet(object, iter, ...)'
      'gtkListStoreSetValue(object, iter, column, value)'
      'gtkListStoreSetValuesv(object, iter, columns, values)'
      '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)'

_H_i_e_r_a_r_c_h_y:

     GObject
        +----GtkListStore 

_I_n_t_e_r_f_a_c_e_s:

     GtkListStore implements 'GtkBuildable',  'GtkTreeModel', 
     'GtkTreeDragSource',  'GtkTreeDragDest' and  'GtkTreeSortable'.

_D_e_t_a_i_l_e_d _D_e_s_c_r_i_p_t_i_o_n:

     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 'GObject's 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 'GdkPixbuf's stored.

     _Creating a simple list store._


     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)



_P_e_r_f_o_r_m_a_n_c_e _C_o_n_s_i_d_e_r_a_t_i_o_n_s:

     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
     'GtkTreeIter's 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 
     'gtkListStoreInsertWithValues' and 'gtkListStoreInsertWithValuesv'
      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 'GtkTreeModel' signaling. In contrast, using e.g.
     'gtkListStoreAppend' and then 'gtkListStoreSet'  will first create
     a row, which triggers the 'gtkTreeModelRowInserted' signal  on
     'GtkListStore'. The row, however, is still empty, and any signal
     handler  connecting to "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
     'GtkListStore' inside a 'GtkTreeModelFilter' and are using a
     'GtkTreeModelFilterVisibleFunc'. Using any of the non-atomic
     operations  to append rows to the 'GtkListStore' will cause the 
     'GtkTreeModelFilterVisibleFunc' to be visited with an empty row
     first; the  function must be prepared for that.

_G_t_k_L_i_s_t_S_t_o_r_e _a_s _G_t_k_B_u_i_l_d_a_b_l_e:

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

     _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>


_S_t_r_u_c_t_u_r_e_s:


     '_G_t_k_L_i_s_t_S_t_o_r_e' _undocumented _


_C_o_n_v_e_n_i_e_n_t _C_o_n_s_t_r_u_c_t_i_o_n:

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

_A_u_t_h_o_r(_s):

     Derived by RGtkGen from GTK+ documentation

_R_e_f_e_r_e_n_c_e_s:

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

_S_e_e _A_l_s_o:

     'GtkTreeModel' 'GtkTreeStore'

