GtkCList                package:RGtk2                R Documentation

_G_t_k_C_L_i_s_t

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

     A multi-columned scrolling list widget

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

     'gtkCListNew(columns = 1, show = TRUE)'
      'gtkCListNewWithTitles(columns = 1, titles, show = TRUE)'
      'gtkCListSetShadowType(object, type)'
      'gtkCListSetSelectionMode(object, mode)'
      'gtkCListFreeze(object)'
      'gtkCListThaw(object)'
      'gtkCListColumnTitlesShow(object)'
      'gtkCListColumnTitlesHide(object)'
      'gtkCListColumnTitleActive(object, column)'
      'gtkCListColumnTitlePassive(object, column)'
      'gtkCListColumnTitlesActive(object)'
      'gtkCListColumnTitlesPassive(object)'
      'gtkCListSetColumnTitle(object, column, title)'
      'gtkCListSetColumnWidget(object, column, widget)'
      'gtkCListSetColumnJustification(object, column, justification)'
      'gtkCListSetColumnVisibility(object, column, visible)'
      'gtkCListSetColumnResizeable(object, column, resizeable)'
      'gtkCListSetColumnAutoResize(object, column, auto.resize)'
      'gtkCListOptimalColumnWidth(object, column)'
      'gtkCListSetColumnWidth(object, column, width)'
      'gtkCListSetColumnMinWidth(object, column, min.width)'
      'gtkCListSetColumnMaxWidth(object, column, max.width)'
      'gtkCListSetRowHeight(object, height)'
      'gtkCListMoveto(object, row, column, row.align, col.align)'
      'gtkCListRowIsVisible(object, row)'
      'gtkCListGetCellType(object, row, column)'
      'gtkCListSetText(w, row, cols, values, zeroBased = TRUE)'
      'gtkCListGetText(w, row, cols, zeroBased = TRUE)'
      'gtkCListSetPixmap(object, row, column, pixmap, mask = NULL)'
      'gtkCListGetPixmap(object, row, column)'
      'gtkCListSetPixtext(object, row, column, text, spacing, pixmap,
     mask)'
      'gtkCListGetPixtext(object, row, column)'
      'gtkCListSetForeground(object, row, color)'
      'gtkCListSetBackground(object, row, color)'
      'gtkCListSetCellStyle(object, row, column, style)'
      'gtkCListGetCellStyle(object, row, column)'
      'gtkCListSetRowStyle(object, row, style)'
      'gtkCListGetRowStyle(object, row)'
      'gtkCListSetShift(object, row, column, vertical, horizontal)'
      'gtkCListSetSelectable(object, row, selectable)'
      'gtkCListGetSelectable(object, row)'
      'gtkCListPrepend(object, text)'
      'gtkCListAppend(object, text)'
      'gtkCListInsert(object, row, text)'
      'gtkCListRemove(object, row)'
      'gtkCListSetRowData(object, row, data = NULL)'
      'gtkCListSetRowDataFull(object, row, data = NULL)'
      'gtkCListGetRowData(object, row)'
      'gtkCListFindRowFromData(object, data)'
      'gtkCListSelectRow(object, row, column)'
      'gtkCListUnselectRow(object, row, column)'
      'gtkCListUndoSelection(object)'
      'gtkCListClear(object)'
      'gtkCListGetSelectionInfo(object, x, y)'
      'gtkCListSelectAll(object)'
      'gtkCListUnselectAll(object)'
      'gtkCListSwapRows(object, row1, row2)'
      'gtkCListSetCompareFunc(object, cmp.func)'
      'gtkCListSetSortColumn(object, column)'
      'gtkCListSetSortType(object, sort.type)'
      'gtkCListSort(object)'
      'gtkCListSetAutoSort(object, auto.sort)'
      'gtkCListColumnsAutosize(object)'
      'gtkCListGetColumnTitle(object, column)'
      'gtkCListGetColumnWidget(object, column)'
      'gtkCListGetHadjustment(object)'
      'gtkCListGetVadjustment(object)'
      'gtkCListRowMove(object, source.row, dest.row)'
      'gtkCListSetButtonActions(object, button, button.actions)'
      'gtkCListSetHadjustment(object, adjustment)'
      'gtkCListSetReorderable(object, reorderable)'
      'gtkCListSetUseDragIcons(object, use.icons)'
      'gtkCListSetVadjustment(object, adjustment)'
      'gtkCList(columns = 1, titles, show = TRUE)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkWidget
                          +----GtkContainer
                                +----GtkCList
                                      +----GtkCTree 

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

     GtkCList implements AtkImplementorIface and  'GtkBuildable'.

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

     The 'GtkCList' widget is a very useful multi-columned scrolling
     list.   It can display data in nicely aligned vertical columns,
     with titles  at the top of the list.

     GtkCList has been deprecated since GTK+ 2.0 and should not be used
     in newly written code. Use 'GtkTreeView' instead.

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


     '_G_t_k_C_L_i_s_t' *WARNING: 'GtkCList' is deprecated and should not be
          used in newly-written code.* This is the embodiment of the
          'GtkCList' widget.  This structure contains only private
          data, and should be accessed only via the CList API.


     '_G_t_k_C_L_i_s_t_R_o_w' *WARNING: 'GtkCListRow' is deprecated and should not
          be used in newly-written code.* A structure that the
          'GtkCList' widget uses to keep track of information about its
          rows.

          '_c_e_l_l' [GtkCell] 

          '_s_t_a_t_e' ['GtkStateType'] 

          '_f_o_r_e_g_r_o_u_n_d' ['GdkColor'] 

          '_b_a_c_k_g_r_o_u_n_d' ['GdkColor'] 

          '_s_t_y_l_e' ['GtkStyle'] 

          '_d_a_t_a' [Robject] 

          '_d_e_s_t_r_o_y' [GtkDestroyNotify] 

          '_f_g_S_e_t' [numeric] 

          '_b_g_S_e_t' [numeric] 

          '_s_e_l_e_c_t_a_b_l_e' [numeric] 


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

     'gtkCList' is the result of collapsing the constructors of
     'GtkCList' ('gtkCListNew', 'gtkCListNewWithTitles') and accepts a
     subset of its arguments matching the required arguments of one of
     its delegate constructors.

_E_n_u_m_s _a_n_d _F_l_a_g_s:


     '_G_t_k_C_e_l_l_T_y_p_e' *WARNING: 'GtkCellType' is deprecated and should not
          be used in newly-written code.* Identifies the type of
          element in the current cell of the CList.  Cells can contain
          text, pixmaps, or both. Unfortunately support for
          'GTK_CELL_WIDGET' was never completed.

          '_e_m_p_t_y' _undocumented _

          '_t_e_x_t' _undocumented _

          '_p_i_x_m_a_p' _undocumented _

          '_p_i_x_t_e_x_t' _undocumented _

          '_w_i_d_g_e_t' _undocumented _


     '_G_t_k_B_u_t_t_o_n_A_c_t_i_o_n' *WARNING: 'GtkButtonAction' is deprecated and
          should not be used in newly-written code.* Values for
          specifying what mouse button events a CList will react to.

          '_i_g_n_o_r_e_d' _undocumented _

          '_s_e_l_e_c_t_s' _undocumented _

          '_d_r_a_g_s' _undocumented _

          '_e_x_p_a_n_d_s' _undocumented _


     '_G_t_k_C_L_i_s_t_D_r_a_g_P_o_s' *WARNING: 'GtkCListDragPos' is deprecated and
          should not be used in newly-written code.* An enumeration for
          drag operations.

          '_n_o_n_e' _undocumented _

          '_b_e_f_o_r_e' _undocumented _

          '_i_n_t_o' _undocumented _

          '_a_f_t_e_r' _undocumented _


_U_s_e_r _F_u_n_c_t_i_o_n_s:


     '_G_t_k_C_L_i_s_t_C_o_m_p_a_r_e_F_u_n_c(_c_l_i_s_t, _p_t_r_1, _p_t_r_2)' Function prototype for
          the compare function callback.

          '_c_l_i_s_t' ['GtkCList'] The 'GtkCList' that is affected.

          '_p_t_r_1' [R object] A 'R object' to the first node to compare.

          '_p_t_r_2' [R object] A 'R object' to the second node to compare.

          _Returns:_ [integer] 0 if the nodes are equal, less than 0 if
          the first node should come before the second, and greater
          than 1 if the second come before the first.


_S_i_g_n_a_l_s:


     '_a_b_o_r_t-_c_o_l_u_m_n-_r_e_s_i_z_e(_c_l_i_s_t, _u_s_e_r._d_a_t_a)' This signal is emitted
          when a column resize is aborted.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_c_l_i_c_k-_c_o_l_u_m_n(_c_l_i_s_t, _c_o_l_u_m_n, _u_s_e_r._d_a_t_a)' This signal is emitted
          when a column title is clicked.

          '_c_l_i_s_t' ['GtkCList'] The object which received the signal.

          '_c_o_l_u_m_n' [integer] The number of the column.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_e_n_d-_s_e_l_e_c_t_i_o_n(_c_l_i_s_t, _u_s_e_r._d_a_t_a)' This signal is emitted when a
          selection ends in a  multiple selection CList.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_e_x_t_e_n_d-_s_e_l_e_c_t_i_o_n(_c_l_i_s_t, _s_c_r_o_l_l._t_y_p_e, _p_o_s_i_t_i_o_n, _a_u_t_o._s_t_a_r_t._s_e_l_e_c_t_i_o_n, _u_s_e_r._d_a_t_a)' 
          This signal is emitted when the selection is extended.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_s_c_r_o_l_l._t_y_p_e' ['GtkScrollType'] A 'GtkScrollType' value of
               any scrolling operation the occured during the
               selection.

          '_p_o_s_i_t_i_o_n' [numeric] A value between 0.0 and 1.0.

          '_a_u_t_o._s_t_a_r_t._s_e_l_e_c_t_i_o_n' [logical] 'TRUE' or 'FALSE'.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_r_e_s_i_z_e-_c_o_l_u_m_n(_c_l_i_s_t, _c_o_l_u_m_n, _w_i_d_t_h, _u_s_e_r._d_a_t_a)' This signal is
          emitted when a column is resized.

          '_c_l_i_s_t' ['GtkCList'] The object which received the signal.

          '_c_o_l_u_m_n' [integer] The number of the column

          '_w_i_d_t_h' [integer] The new width of the column.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_r_o_w-_m_o_v_e(_c_l_i_s_t, _a_r_g_1, _a_r_g_2, _u_s_e_r._d_a_t_a)' This signal is emitted
          when a row is moved.

          '_c_l_i_s_t' ['GtkCList'] The object which received the signal.

          '_a_r_g_1' [integer] The source position of the row.

          '_a_r_g_2' [integer] The destination position of the row.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_s_c_r_o_l_l-_h_o_r_i_z_o_n_t_a_l(_c_l_i_s_t, _s_c_r_o_l_l._t_y_p_e, _p_o_s_i_t_i_o_n, _u_s_e_r._d_a_t_a)' This
          signal is emitted when the CList is scrolled horizontally.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_s_c_r_o_l_l._t_y_p_e' ['GtkScrollType'] A 'GtkScrollType' value of
               how the scroll operation occured.

          '_p_o_s_i_t_i_o_n' [numeric] a value between 0.0 and 1.0.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_s_c_r_o_l_l-_v_e_r_t_i_c_a_l(_c_l_i_s_t, _s_c_r_o_l_l._t_y_p_e, _p_o_s_i_t_i_o_n, _u_s_e_r._d_a_t_a)' This
          signal is emitted when the CList is scrolled vertically.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_s_c_r_o_l_l._t_y_p_e' ['GtkScrollType'] A 'GtkScrollType' value of
               how the scroll operation occured.

          '_p_o_s_i_t_i_o_n' [numeric] A value between 0.0 and 1.0.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_s_e_l_e_c_t-_a_l_l(_c_l_i_s_t, _u_s_e_r._d_a_t_a)' This signal is emitted when all the
          rows are selected in a CList.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_s_e_l_e_c_t-_r_o_w(_c_l_i_s_t, _r_o_w, _c_o_l_u_m_n, _e_v_e_n_t, _u_s_e_r._d_a_t_a)' This signal is
          emitted when the user selects a row in the list.   It is
          emitted for every row that is selected in a multi-selection
          or by calling 'gtkCListSelectAll'.

          '_c_l_i_s_t' ['GtkCList'] The object which received the signal.

          '_r_o_w' [integer] The row selected.

          '_c_o_l_u_m_n' [integer] The column where the selection occured.

          '_e_v_e_n_t' ['GdkEventButton'] A 'GdkEvent' structure for the
               selection.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_s_e_t-_s_c_r_o_l_l-_a_d_j_u_s_t_m_e_n_t_s(_c_l_i_s_t, _a_r_g_1, _a_r_g_2, _u_s_e_r._d_a_t_a)' 
          _undocumented _

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_a_r_g_1' ['GtkAdjustment'] 

          '_a_r_g_2' ['GtkAdjustment'] 

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_s_t_a_r_t-_s_e_l_e_c_t_i_o_n(_c_l_i_s_t, _u_s_e_r._d_a_t_a)' This signal is emitted when a
          drag-selection is started in  a multiple-selection CList.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_t_o_g_g_l_e-_a_d_d-_m_o_d_e(_c_l_i_s_t, _u_s_e_r._d_a_t_a)' This signal is emitted when
          "add mode" is toggled.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_t_o_g_g_l_e-_f_o_c_u_s-_r_o_w(_c_l_i_s_t, _u_s_e_r._d_a_t_a)' _undocumented _

          '_c_l_i_s_t' ['GtkCList'] The object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_u_n_d_o-_s_e_l_e_c_t_i_o_n(_c_l_i_s_t, _u_s_e_r._d_a_t_a)' This signal is emitted when an
          undo selection occurs in the CList, probably via calling
          'gtkCListUndoSelection'.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_u_n_s_e_l_e_c_t-_a_l_l(_c_l_i_s_t, _u_s_e_r._d_a_t_a)' This signal is emitted when all
          rows are unselected in a CList.

          '_c_l_i_s_t' ['GtkCList'] the object which received the signal.

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


     '_u_n_s_e_l_e_c_t-_r_o_w(_c_l_i_s_t, _r_o_w, _c_o_l_u_m_n, _e_v_e_n_t, _u_s_e_r._d_a_t_a)' This signal
          is emitted when the user unselects a row in the list.   It is
          emitted for every row that is unselected in a multi-selection
          or by calling 'gtkCListUnselectAll'.  It is also emitted for
          the previously selected row in a "single" or "browse" mode
          CList.

          '_c_l_i_s_t' ['GtkCList'] The object which received the signal.

          '_r_o_w' [integer] The selected row

          '_c_o_l_u_m_n' [integer] The column where the selection occured.

          '_e_v_e_n_t' ['GdkEventButton'] 

          '_u_s_e_r._d_a_t_a' [R object] user data set when the signal handler
               was connected.


_P_r_o_p_e_r_t_i_e_s:


     '_n-_c_o_l_u_m_n_s' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e / _C_o_n_s_t_r_u_c_t _O_n_l_y] An integer
          value for a column. Default value: 0


     '_r_e_o_r_d_e_r_a_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] A boolean value for
          determining if the user can re-order the CList's columns.
          Default value: FALSE


     '_r_o_w-_h_e_i_g_h_t' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] An integer value
          representing the height of a row in pixels. Default value: 0


     '_s_e_l_e_c_t_i_o_n-_m_o_d_e' ['_G_t_k_S_e_l_e_c_t_i_o_n_M_o_d_e' : _R_e_a_d / _W_r_i_t_e] Sets the type
          of selection mode for the CList. Default value:
          GTK_SELECTION_NONE


     '_s_h_a_d_o_w-_t_y_p_e' ['_G_t_k_S_h_a_d_o_w_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] Sets the shadowing
          for the CList. Default value: GTK_SHADOW_NONE


     '_s_o_r_t-_t_y_p_e' ['_G_t_k_S_o_r_t_T_y_p_e' : _R_e_a_d / _W_r_i_t_e] Default value:
          GTK_SORT_ASCENDING


     '_t_i_t_l_e_s-_a_c_t_i_v_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] A boolean value for
          setting whether the column titles can be clicked. Default
          value: FALSE


     '_u_s_e-_d_r_a_g-_i_c_o_n_s' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] A boolean value for
          setting whether to use icons during drag operations. Default
          value: FALSE


_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/GtkCList.html>

