]> Pileus Git - ~andy/gtk/blobdiff - docs/reference/gtk/tmpl/gtkcellrenderer.sgml
Make 3.0 parallel-installable to 2.x
[~andy/gtk] / docs / reference / gtk / tmpl / gtkcellrenderer.sgml
index f9daddfc632045339c2c15a8e16b9cca76c918b1..4a0e088d414663d90b06e8cbe87a07fc4175902e 100644 (file)
@@ -2,7 +2,7 @@
 GtkCellRenderer
 
 <!-- ##### SECTION Short_Description ##### -->
-An object for rendering a single cell on a #GdkDrawable
+An object for rendering a single cell on a GdkDrawable
 
 <!-- ##### SECTION Long_Description ##### -->
 <para>
@@ -19,8 +19,8 @@ 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 @gtk_cell_renderer_get_size.  Finally, the cell
-is rendered in the correct location using @gtk_cell_renderer_render.
+cell is measured using gtk_cell_renderer_get_size().  Finally, the cell
+is rendered in the correct location using gtk_cell_renderer_render().
 </para>
 
 <para>
@@ -31,11 +31,29 @@ barring a #GtkStyle change.  The #GtkCellRenderer also has a number of
 generic properties that are expected to be honored by all children.
 </para>
 
+<para>
+Beyond merely rendering a cell, cell renderers can optionally 
+provide active user interface elements. A cell renderer can be 
+<firstterm>activatable</firstterm> like #GtkCellRendererToggle, 
+which toggles when it gets activated by a mouse click, or it can be 
+<firstterm>editable</firstterm> 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.
+</para>
+
 <!-- ##### SECTION See_Also ##### -->
 <para>
 #GtkCellRendererText,#GtkCellRendererPixbuf,#GtkCellRendererToggle
 </para>
 
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
 <!-- ##### ENUM GtkCellRendererState ##### -->
 <para>
 Tells how a cell is to be rendererd.
@@ -46,6 +64,7 @@ probably has a selection colored background to render to.
 @GTK_CELL_RENDERER_PRELIT: The mouse is hovering over the cell.
 @GTK_CELL_RENDERER_INSENSITIVE: The cell is drawn in an insensitive manner
 @GTK_CELL_RENDERER_SORTED: The cell is in a sorted row
+@GTK_CELL_RENDERER_FOCUSED: The cell is in the focus row.
 
 <!-- ##### ENUM GtkCellRendererMode ##### -->
 <para>
@@ -65,6 +84,112 @@ it cannot be individually modified.
 </para>
 
 
+<!-- ##### SIGNAL GtkCellRenderer::editing-canceled ##### -->
+<para>
+
+</para>
+
+@cellrenderer: the object which received the signal.
+
+<!-- ##### SIGNAL GtkCellRenderer::editing-started ##### -->
+<para>
+
+</para>
+
+@cellrenderer: the object which received the signal.
+@arg1: 
+@arg2: 
+
+<!-- ##### ARG GtkCellRenderer:cell-background ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:cell-background-gdk ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:cell-background-set ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:editing ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:height ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:is-expanded ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:is-expander ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:mode ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:sensitive ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:visible ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:width ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:xalign ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:xpad ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:yalign ##### -->
+<para>
+
+</para>
+
+<!-- ##### ARG GtkCellRenderer:ypad ##### -->
+<para>
+
+</para>
+
+<!-- ##### STRUCT GtkCellRendererClass ##### -->
+<para>
+
+</para>
+
+@parent_class: 
+@get_size: 
+@render: 
+@activate: 
+@start_editing: 
+@editing_canceled: 
+@editing_started: 
+@_gtk_reserved1: 
+@_gtk_reserved2: 
+
 <!-- ##### FUNCTION gtk_cell_renderer_get_size ##### -->
 <para>
 
@@ -123,6 +248,15 @@ it cannot be individually modified.
 @Returns: 
 
 
+<!-- ##### FUNCTION gtk_cell_renderer_stop_editing ##### -->
+<para>
+
+</para>
+
+@cell: 
+@canceled: 
+
+
 <!-- ##### FUNCTION gtk_cell_renderer_get_fixed_size ##### -->
 <para>
 
@@ -143,68 +277,79 @@ it cannot be individually modified.
 @height: 
 
 
-<!-- ##### ARG GtkCellRenderer:cell-background ##### -->
+<!-- ##### FUNCTION gtk_cell_renderer_get_visible ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkCellRenderer:cell-background-gdk ##### -->
-<para>
+@cell: 
+@Returns: 
 
-</para>
 
-<!-- ##### ARG GtkCellRenderer:cell-background-set ##### -->
+<!-- ##### FUNCTION gtk_cell_renderer_set_visible ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkCellRenderer:height ##### -->
-<para>
+@cell: 
+@visible: 
 
-</para>
 
-<!-- ##### ARG GtkCellRenderer:is-expanded ##### -->
+<!-- ##### FUNCTION gtk_cell_renderer_get_sensitive ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkCellRenderer:is-expander ##### -->
-<para>
+@cell: 
+@Returns: 
 
-</para>
 
-<!-- ##### ARG GtkCellRenderer:mode ##### -->
+<!-- ##### FUNCTION gtk_cell_renderer_set_sensitive ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkCellRenderer:visible ##### -->
-<para>
+@cell: 
+@sensitive: 
 
-</para>
 
-<!-- ##### ARG GtkCellRenderer:width ##### -->
+<!-- ##### FUNCTION gtk_cell_renderer_get_alignment ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkCellRenderer:xalign ##### -->
-<para>
+@cell: 
+@xalign: 
+@yalign: 
 
-</para>
 
-<!-- ##### ARG GtkCellRenderer:xpad ##### -->
+<!-- ##### FUNCTION gtk_cell_renderer_set_alignment ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkCellRenderer:yalign ##### -->
+@cell: 
+@xalign: 
+@yalign: 
+
+
+<!-- ##### FUNCTION gtk_cell_renderer_get_padding ##### -->
 <para>
 
 </para>
 
-<!-- ##### ARG GtkCellRenderer:ypad ##### -->
+@cell: 
+@xpad: 
+@ypad: 
+
+
+<!-- ##### FUNCTION gtk_cell_renderer_set_padding ##### -->
 <para>
 
 </para>
 
+@cell: 
+@xpad: 
+@ypad: 
+
+