GtkCellRenderer            package:RGtk2            R Documentation

_G_t_k_C_e_l_l_R_e_n_d_e_r_e_r

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

     An object for rendering a single cell on a GdkDrawable

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

     'gtkCellRendererGetSize(object, widget, cell.area = NULL)'
      'gtkCellRendererRender(object, window, widget, background.area,
     cell.area, expose.area, flags)'
      'gtkCellRendererActivate(object, event, widget, path,
     background.area, cell.area, flags)'
      'gtkCellRendererStartEditing(object, event, widget, path,
     background.area, cell.area, flags)'
      'gtkCellRendererEditingCanceled(object)'
      'gtkCellRendererEditingCanceled(object)'
      'gtkCellRendererStopEditing(object, canceled)'
      'gtkCellRendererGetFixedSize(object)'
      'gtkCellRendererSetFixedSize(object, width, height)'

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

     GObject
        +----GInitiallyUnowned
              +----GtkObject
                    +----GtkCellRenderer
                          +----GtkCellRendererText
                          +----GtkCellRendererPixbuf
                          +----GtkCellRendererProgress
                          +----GtkCellRendererToggle 

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

     The 'GtkCellRenderer' is a base class of a set of objects used for
     rendering a cell to a 'GdkDrawable'.  These objects are used
     primarily by the 'GtkTreeView' widget, though they aren't tied to
     them in any specific way.  It is worth noting that
     'GtkCellRenderer' is not a 'GtkWidget' and cannot be treated as
     such.

     The primary use of a 'GtkCellRenderer' is for drawing a certain
     graphical elements on a 'GdkDrawable'.  Typically, one cell
     renderer is used to draw many cells on the screen.  To this
     extent, it isn't expected that a CellRenderer keep any permanent
     state around.  Instead, any state is set just prior to use using
     'GObject's property system.  Then, the cell is measured using
     'gtkCellRendererGetSize'.  Finally, the cell is rendered in the
     correct location using 'gtkCellRendererRender'.

     There are a number of rules that must be followed when writing a
     new 'GtkCellRenderer'.  First and formost, it's important that a
     certain set of properties will always yield a cell renderer of the
     same size, barring a 'GtkStyle' change.  The 'GtkCellRenderer'
     also has a number of generic properties that are expected to be
     honored by all children.

     Beyond merely rendering a cell, cell renderers can optionally 
     provide active user interface elements. A cell renderer can be 
     activatable like 'GtkCellRendererToggle',  which toggles when it
     gets activated by a mouse click, or it can be  editable like
     'GtkCellRendererText', which  allows the user to edit the text
     using a 'GtkEntry'. To make a cell renderer activatable or
     editable, you have to  implement the 'activate' or 'start.editing'
     virtual functions,  respectively.

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


     '_G_t_k_C_e_l_l_R_e_n_d_e_r_e_r' _undocumented _


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


     '_G_t_k_C_e_l_l_R_e_n_d_e_r_e_r_S_t_a_t_e' Tells how a cell is to be rendererd.

          '_s_e_l_e_c_t_e_d' The cell is currently selected, and probably has a
               selection colored background to render to.

          '_p_r_e_l_i_t' The mouse is hovering over the cell.

          '_i_n_s_e_n_s_i_t_i_v_e' The cell is drawn in an insensitive manner

          '_s_o_r_t_e_d' The cell is in a sorted row

          '_f_o_c_u_s_e_d' The cell is in the focus row.


     '_G_t_k_C_e_l_l_R_e_n_d_e_r_e_r_M_o_d_e' Identifies how the user can interact with a
          particular cell.

          '_i_n_e_r_t' The cell is just for display and cannot be interacted
               with.  Note that this doesn't mean that eg. the row
               being drawn can't be selected - just that a particular
               element of it cannot be individually modified.

          '_a_c_t_i_v_a_t_a_b_l_e' The cell can be clicked.

          '_e_d_i_t_a_b_l_e' The cell can be edited or otherwise modified.


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


     '_e_d_i_t_i_n_g-_c_a_n_c_e_l_e_d(_r_e_n_d_e_r_e_r, _u_s_e_r._d_a_t_a)' This signal gets emitted
          when the user cancels the process of editing a cell.  For
          example, an editable cell renderer could be written to cancel
          editing when the user presses Escape. 

          See also: 'gtkCellRendererStopEditing'.  

          Since  2.4

          '_r_e_n_d_e_r_e_r' ['GtkCellRenderer']  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_d_i_t_i_n_g-_s_t_a_r_t_e_d(_r_e_n_d_e_r_e_r, _e_d_i_t_a_b_l_e, _p_a_t_h, _u_s_e_r._d_a_t_a)' This signal
          gets emitted when a cell starts to be edited. The indended
          use of this signal is to do special setup on 'editable', e.g.
          adding a 'GtkEntryCompletion' or setting up additional
          columns in a 'GtkComboBox'.

          Note that GTK+ doesn't guarantee that cell renderers will
          continue to use the same kind of widget for editing in future
          releases, therefore you should check the type of 'editable'
          before doing any specific setup, as in the following example:


          text_editing_started <- function(cell, editable, path, data)
          {
            checkPtrType(editable, "GtkEntry")
            ## ... create a GtkEntryCompletion
            editable$setCompletion(completion)
          }



          Since  2.6

          '_r_e_n_d_e_r_e_r' ['GtkCellRenderer']  the object which received the
               signal

          '_e_d_i_t_a_b_l_e' ['GtkCellEditable']  the 'GtkCellEditable'

          '_p_a_t_h' [character]  the path identifying the edited cell

          '_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:


     '_c_e_l_l-_b_a_c_k_g_r_o_u_n_d' [_c_h_a_r_a_c_t_e_r : _W_r_i_t_e] Cell background color as a
          string.  Default value: NULL


     '_c_e_l_l-_b_a_c_k_g_r_o_u_n_d-_g_d_k' ['_G_d_k_C_o_l_o_r' : _R_e_a_d / _W_r_i_t_e] Cell background
          color as a GdkColor.


     '_c_e_l_l-_b_a_c_k_g_r_o_u_n_d-_s_e_t' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Whether this tag
          affects the cell background color.  Default value: FALSE


     '_h_e_i_g_h_t' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The fixed height.  Allowed
          values: >= -1  Default value: -1


     '_i_s-_e_x_p_a_n_d_e_d' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Row is an expander row, and
          is expanded.  Default value: FALSE


     '_i_s-_e_x_p_a_n_d_e_r' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Row has children.  Default
          value: FALSE


     '_m_o_d_e' ['_G_t_k_C_e_l_l_R_e_n_d_e_r_e_r_M_o_d_e' : _R_e_a_d / _W_r_i_t_e] Editable mode of the
          CellRenderer.  Default value: GTK_CELL_RENDERER_MODE_INERT


     '_s_e_n_s_i_t_i_v_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Display the cell sensitive. 
          Default value: TRUE


     '_v_i_s_i_b_l_e' [_l_o_g_i_c_a_l : _R_e_a_d / _W_r_i_t_e] Display the cell.  Default
          value: TRUE


     '_w_i_d_t_h' [_i_n_t_e_g_e_r : _R_e_a_d / _W_r_i_t_e] The fixed width.  Allowed values:
          >= -1  Default value: -1


     '_x_a_l_i_g_n' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The x-align.  Allowed values:
          [0,1]  Default value: 0.5


     '_x_p_a_d' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The xpad.  Default value: 0


     '_y_a_l_i_g_n' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The y-align.  Allowed values:
          [0,1]  Default value: 0.5


     '_y_p_a_d' [_n_u_m_e_r_i_c : _R_e_a_d / _W_r_i_t_e] The ypad.  Default value: 0


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

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

     'GtkCellRendererText' 'GtkCellRendererPixbuf'
     'GtkCellRendererToggle'

