Pileus Git - ~andy/gtk/blob - docs/reference/gtk/tmpl/gtkcellrenderer.sgml

   1 <!-- ##### SECTION Title ##### -->
   2 GtkCellRenderer
   3
   4 <!-- ##### SECTION Short_Description ##### -->
   5 An object for rendering a single cell on a #GdkDrawable
   6
   7 <!-- ##### SECTION Long_Description ##### -->
   8 <para>
   9 The #GtkCellRenderer is a base class of a set of objects used for
  10 rendering a cell to a #GdkDrawable.  These objects are used primarily by
  11 the #GtkTreeView widget, though they aren't tied to them in any
  12 specific way.  It is worth noting that #GtkCellRenderer is not a
  13 #GtkWidget and cannot be treated as such.
  14 </para>
  15
  16 <para>
  17 The primary use of a #GtkCellRenderer is for drawing a certain graphical
  18 elements on a #GdkDrawable.  Typically, one cell renderer is used to
  19 draw many cells on the screen.  To this extent, it isn't expected that a
  20 CellRenderer keep any permanent state around.  Instead, any state is set
  21 just prior to use using #GObject<!-- -->s property system.  Then, the
  22 cell is measured using @gtk_cell_renderer_get_size.  Finally, the cell
  23 is rendered in the correct location using @gtk_cell_renderer_render.
  24 </para>
  25
  26 <para>
  27 There are a number of rules that must be followed when writing a new
  28 #GtkCellRenderer.  First and formost, it's important that a certain set
  29 of properties will always yield a cell renderer of the same size,
  30 barring a #GtkStyle change.  The #GtkCellRenderer also has a number of
  31 generic properties that are expected to be honored by all children.
  32 </para>
  33
  34 <!-- ##### SECTION See_Also ##### -->
  35 <para>
  36 #GtkCellRendererText,#GtkCellRendererPixbuf,#GtkCellRendererToggle
  37 </para>
  38
  39 <!-- ##### ENUM GtkCellRendererState ##### -->
  40 <para>
  41 Tells how a cell is to be rendererd.
  42 </para>
  43
  44 @GTK_CELL_RENDERER_SELECTED: The cell is currently selected, and
  45 probably has a selection colored background to render to.
  46 @GTK_CELL_RENDERER_PRELIT: The mouse is hovering over the cell.
  47 @GTK_CELL_RENDERER_INSENSITIVE: The cell is drawn in an insensitive manner
  48 @GTK_CELL_RENDERER_SORTED: The cell is in a sorted row
  49 @GTK_CELL_RENDERER_FOCUSED:
  50
  51 <!-- ##### ENUM GtkCellRendererMode ##### -->
  52 <para>
  53 Identifies how the user can interact with a particular cell.
  54 </para>
  55
  56 @GTK_CELL_RENDERER_MODE_INERT: The cell is just for display
  57 and cannot be interacted with.  Note that this doesn't mean that eg. the
  58 row being drawn can't be selected -- just that a particular element of
  59 it cannot be individually modified.
  60 @GTK_CELL_RENDERER_MODE_ACTIVATABLE: The cell can be clicked.
  61 @GTK_CELL_RENDERER_MODE_EDITABLE: The cell can be edited or otherwise modified.
  62
  63 <!-- ##### STRUCT GtkCellRenderer ##### -->
  64 <para>
  65
  66 </para>
  67
  68
  69 <!-- ##### SIGNAL GtkCellRenderer::editing-canceled ##### -->
  70 <para>
  71
  72 </para>
  73
  74 @cellrenderer: the object which received the signal.
  75
  76 <!-- ##### ARG GtkCellRenderer:cell-background ##### -->
  77 <para>
  78
  79 </para>
  80
  81 <!-- ##### ARG GtkCellRenderer:cell-background-gdk ##### -->
  82 <para>
  83
  84 </para>
  85
  86 <!-- ##### ARG GtkCellRenderer:cell-background-set ##### -->
  87 <para>
  88
  89 </para>
  90
  91 <!-- ##### ARG GtkCellRenderer:height ##### -->
  92 <para>
  93
  94 </para>
  95
  96 <!-- ##### ARG GtkCellRenderer:is-expanded ##### -->
  97 <para>
  98
  99 </para>
 100
 101 <!-- ##### ARG GtkCellRenderer:is-expander ##### -->
 102 <para>
 103
 104 </para>
 105
 106 <!-- ##### ARG GtkCellRenderer:mode ##### -->
 107 <para>
 108
 109 </para>
 110
 111 <!-- ##### ARG GtkCellRenderer:sensitive ##### -->
 112 <para>
 113
 114 </para>
 115
 116 <!-- ##### ARG GtkCellRenderer:visible ##### -->
 117 <para>
 118
 119 </para>
 120
 121 <!-- ##### ARG GtkCellRenderer:width ##### -->
 122 <para>
 123
 124 </para>
 125
 126 <!-- ##### ARG GtkCellRenderer:xalign ##### -->
 127 <para>
 128
 129 </para>
 130
 131 <!-- ##### ARG GtkCellRenderer:xpad ##### -->
 132 <para>
 133
 134 </para>
 135
 136 <!-- ##### ARG GtkCellRenderer:yalign ##### -->
 137 <para>
 138
 139 </para>
 140
 141 <!-- ##### ARG GtkCellRenderer:ypad ##### -->
 142 <para>
 143
 144 </para>
 145
 146 <!-- ##### FUNCTION gtk_cell_renderer_get_size ##### -->
 147 <para>
 148
 149 </para>
 150
 151 @cell:
 152 @widget:
 153 @cell_area:
 154 @x_offset:
 155 @y_offset:
 156 @width:
 157 @height:
 158
 159
 160 <!-- ##### FUNCTION gtk_cell_renderer_render ##### -->
 161 <para>
 162
 163 </para>
 164
 165 @cell:
 166 @window:
 167 @widget:
 168 @background_area:
 169 @cell_area:
 170 @expose_area:
 171 @flags:
 172
 173
 174 <!-- ##### FUNCTION gtk_cell_renderer_activate ##### -->
 175 <para>
 176
 177 </para>
 178
 179 @cell:
 180 @event:
 181 @widget:
 182 @path:
 183 @background_area:
 184 @cell_area:
 185 @flags:
 186 @Returns:
 187
 188
 189 <!-- ##### FUNCTION gtk_cell_renderer_start_editing ##### -->
 190 <para>
 191
 192 </para>
 193
 194 @cell:
 195 @event:
 196 @widget:
 197 @path:
 198 @background_area:
 199 @cell_area:
 200 @flags:
 201 @Returns:
 202
 203
 204 <!-- ##### FUNCTION gtk_cell_renderer_editing_canceled ##### -->
 205 <para>
 206
 207 </para>
 208
 209 @cell:
 210
 211
 212 <!-- ##### FUNCTION gtk_cell_renderer_get_fixed_size ##### -->
 213 <para>
 214
 215 </para>
 216
 217 @cell:
 218 @width:
 219 @height:
 220
 221
 222 <!-- ##### FUNCTION gtk_cell_renderer_set_fixed_size ##### -->
 223 <para>
 224
 225 </para>
 226
 227 @cell:
 228 @width:
 229 @height:
 230
 231