gtk2/docs/reference/gtk/tmpl/gtkcellrenderer.sgml

232 lines
4.5 KiB
Plaintext
Raw Normal View History

<!-- ##### SECTION Title ##### -->
GtkCellRenderer
<!-- ##### SECTION Short_Description ##### -->
An object for rendering a single cell on a #GdkDrawable
<!-- ##### SECTION Long_Description ##### -->
<para>
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.
</para>
<para>
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 @gtk_cell_renderer_get_size. Finally, the cell
is rendered in the correct location using @gtk_cell_renderer_render.
</para>
<para>
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.
</para>
docs/reference/gdk/tmpl/dnd.sgml docs/reference/gdk/tmpl/drawing.sgml Fri Nov 8 20:14:52 2002 Soeren Sandmann <sandmann@daimi.au.dk> * docs/reference/gdk/tmpl/dnd.sgml docs/reference/gdk/tmpl/drawing.sgml docs/reference/gdk/tmpl/gdk-unused.sgml docs/reference/gdk/tmpl/gdkdisplay.sgml docs/reference/gdk/tmpl/general.sgml docs/reference/gdk/tmpl/input_devices.sgml docs/reference/gdk/tmpl/selections.sgml docs/reference/gtk/tmpl/gtkcellrenderer.sgml docs/reference/gtk/tmpl/gtkcurve.sgml docs/reference/gtk/tmpl/gtkdnd.sgml docs/reference/gtk/tmpl/gtkitemfactory.sgml docs/reference/gtk/tmpl/gtkmenu.sgml docs/reference/gtk/tmpl/gtkoldeditable.sgml docs/reference/gtk/tmpl/gtkoptionmenu.sgml docs/reference/gtk/tmpl/gtkpreview.sgml docs/reference/gtk/tmpl/gtkselection.sgml docs/reference/gtk/tmpl/gtksocket.sgml docs/reference/gtk/tmpl/gtkstyle.sgml docs/reference/gtk/tmpl/gtktextbuffer.sgml docs/reference/gtk/tmpl/gtktreemodel.sgml docs/reference/gtk/tmpl/gtkwidget.sgml gdk/gdk.h gdk/gdkdisplay.c gdk/gdkdisplay.h gdk/gdkdnd.h gdk/gdkdraw.c gdk/gdkdrawable.h gdk/gdkinput.h gdk/gdkselection.h gdk/x11/gdkdisplay-x11.c gdk/x11/gdkdnd-x11.c gdk/x11/gdkselection-x11.c gtk/gtkcurve.h gtk/gtkdnd.h gtk/gtkitemfactory.c gtk/gtkitemfactory.h gtk/gtkmenu.h gtk/gtkoldeditable.c gtk/gtkoldeditable.h gtk/gtkoptionmenu.h gtk/gtkplug.c gtk/gtkplug.h gtk/gtkpreview.h gtk/gtkrange.h gtk/gtkselection.c gtk/gtkselection.h gtk/gtksocket.c gtk/gtksocket.h gtk/gtkstyle.c gtk/gtkstyle.h gtk/gtktextlayout.c gtk/gtktextlayout.h gtk/gtktreemodel.c gtk/gtktreemodel.h gtk/gtkwidget.h Trivial s/foo/foo_/ fixes to make gtk.h includable with -Wshadow without warnings. (#91680)
2002-11-08 19:41:50 +00:00
<!-- ##### SECTION See_Also ##### -->
<para>
#GtkCellRendererText,#GtkCellRendererPixbuf,#GtkCellRendererToggle
</para>
<!-- ##### ENUM GtkCellRendererState ##### -->
<para>
Tells how a cell is to be rendererd.
</para>
@GTK_CELL_RENDERER_SELECTED: The cell is currently selected, and
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
2002-11-28 00:33:17 +00:00
@GTK_CELL_RENDERER_FOCUSED:
<!-- ##### ENUM GtkCellRendererMode ##### -->
<para>
Identifies how the user can interact with a particular cell.
</para>
@GTK_CELL_RENDERER_MODE_INERT: 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.
@GTK_CELL_RENDERER_MODE_ACTIVATABLE: The cell can be clicked.
@GTK_CELL_RENDERER_MODE_EDITABLE: The cell can be edited or otherwise modified.
<!-- ##### STRUCT GtkCellRenderer ##### -->
<para>
</para>
<!-- ##### FUNCTION gtk_cell_renderer_get_size ##### -->
<para>
</para>
@cell:
@widget:
@cell_area:
@x_offset:
@y_offset:
@width:
@height:
<!-- ##### FUNCTION gtk_cell_renderer_render ##### -->
<para>
</para>
@cell:
@window:
@widget:
@background_area:
@cell_area:
@expose_area:
@flags:
<!-- ##### FUNCTION gtk_cell_renderer_activate ##### -->
<para>
</para>
@cell:
@event:
@widget:
@path:
@background_area:
@cell_area:
@flags:
@Returns:
<!-- ##### FUNCTION gtk_cell_renderer_start_editing ##### -->
<para>
</para>
@cell:
@event:
@widget:
@path:
@background_area:
@cell_area:
@flags:
@Returns:
<!-- ##### FUNCTION gtk_cell_renderer_editing_canceled ##### -->
<para>
</para>
@cell:
<!-- ##### FUNCTION gtk_cell_renderer_get_fixed_size ##### -->
<para>
</para>
@cell:
@width:
@height:
<!-- ##### FUNCTION gtk_cell_renderer_set_fixed_size ##### -->
<para>
</para>
@cell:
@width:
@height:
<!-- ##### SIGNAL GtkCellRenderer::editing-canceled ##### -->
<para>
</para>
@cellrenderer: the object which received the signal.
<!-- ##### ARG GtkCellRenderer:cell-background ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRenderer:cell-background-gdk ##### -->
<para>
</para>
<!-- ##### ARG GtkCellRenderer:cell-background-set ##### -->
<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>