1 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
4 <meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
5 <title>GtkCellRenderer</title>
6 <meta name="generator" content="DocBook XSL Stylesheets V1.76.1">
7 <link rel="home" href="index.html" title="GTK+ 3 Reference Manual">
8 <link rel="up" href="TreeWidgetObjects.html" title="Tree, List and Icon Grid Widgets">
9 <link rel="prev" href="GtkCellAreaContext.html" title="GtkCellAreaContext">
10 <link rel="next" href="GtkCellEditable.html" title="GtkCellEditable">
11 <meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12 <link rel="stylesheet" href="style.css" type="text/css">
14 <body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
15 <table class="navigation" id="top" width="100%" summary="Navigation header" cellpadding="2" cellspacing="2">
17 <td><a accesskey="p" href="GtkCellAreaContext.html"><img src="left.png" width="24" height="24" border="0" alt="Prev"></a></td>
18 <td><a accesskey="u" href="TreeWidgetObjects.html"><img src="up.png" width="24" height="24" border="0" alt="Up"></a></td>
19 <td><a accesskey="h" href="index.html"><img src="home.png" width="24" height="24" border="0" alt="Home"></a></td>
20 <th width="100%" align="center">GTK+ 3 Reference Manual</th>
21 <td><a accesskey="n" href="GtkCellEditable.html"><img src="right.png" width="24" height="24" border="0" alt="Next"></a></td>
23 <tr><td colspan="5" class="shortcuts">
24 <a href="#GtkCellRenderer.synopsis" class="shortcut">Top</a>
26 <a href="#GtkCellRenderer.description" class="shortcut">Description</a>
28 <a href="#GtkCellRenderer.object-hierarchy" class="shortcut">Object Hierarchy</a>
30 <a href="#GtkCellRenderer.properties" class="shortcut">Properties</a>
32 <a href="#GtkCellRenderer.signals" class="shortcut">Signals</a>
35 <div class="refentry">
36 <a name="GtkCellRenderer"></a><div class="titlepage"></div>
37 <div class="refnamediv"><table width="100%"><tr>
39 <h2><span class="refentrytitle"><a name="GtkCellRenderer.top_of_page"></a>GtkCellRenderer</span></h2>
40 <p>GtkCellRenderer — An object for rendering a single cell</p>
42 <td valign="top" align="right"></td>
44 <div class="refsynopsisdiv">
45 <a name="GtkCellRenderer.synopsis"></a><h2>Synopsis</h2>
46 <pre class="synopsis">
47 #include <gtk/gtk.h>
49 enum <a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState">GtkCellRendererState</a>;
50 enum <a class="link" href="GtkCellRenderer.html#GtkCellRendererMode" title="enum GtkCellRendererMode">GtkCellRendererMode</a>;
51 struct <a class="link" href="GtkCellRenderer.html#GtkCellRenderer-struct" title="struct GtkCellRenderer">GtkCellRenderer</a>;
52 struct <a class="link" href="GtkCellRenderer.html#GtkCellRendererClass" title="struct GtkCellRendererClass">GtkCellRendererClass</a>;
53 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-aligned-area" title="gtk_cell_renderer_get_aligned_area ()">gtk_cell_renderer_get_aligned_area</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
54 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
55 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> flags</code></em>,
56 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
57 <em class="parameter"><code><a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *aligned_area</code></em>);
58 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-size" title="gtk_cell_renderer_get_size ()">gtk_cell_renderer_get_size</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
59 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
60 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
61 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *x_offset</code></em>,
62 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *y_offset</code></em>,
63 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *width</code></em>,
64 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *height</code></em>);
65 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-render" title="gtk_cell_renderer_render ()">gtk_cell_renderer_render</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
66 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> *cr</code></em>,
67 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
68 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *background_area</code></em>,
69 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
70 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> flags</code></em>);
71 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-activate" title="gtk_cell_renderer_activate ()">gtk_cell_renderer_activate</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
72 <em class="parameter"><code><a href="http://developer.gnome.org/devel/gdk/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>,
73 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
74 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
75 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *background_area</code></em>,
76 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
77 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> flags</code></em>);
78 <a class="link" href="GtkCellEditable.html" title="GtkCellEditable"><span class="returnvalue">GtkCellEditable</span></a> * <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-start-editing" title="gtk_cell_renderer_start_editing ()">gtk_cell_renderer_start_editing</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
79 <em class="parameter"><code><a href="http://developer.gnome.org/devel/gdk/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>,
80 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
81 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
82 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *background_area</code></em>,
83 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
84 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> flags</code></em>);
85 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-stop-editing" title="gtk_cell_renderer_stop_editing ()">gtk_cell_renderer_stop_editing</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
86 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> canceled</code></em>);
87 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-fixed-size" title="gtk_cell_renderer_get_fixed_size ()">gtk_cell_renderer_get_fixed_size</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
88 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *width</code></em>,
89 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *height</code></em>);
90 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-set-fixed-size" title="gtk_cell_renderer_set_fixed_size ()">gtk_cell_renderer_set_fixed_size</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
91 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
92 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>);
93 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-visible" title="gtk_cell_renderer_get_visible ()">gtk_cell_renderer_get_visible</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>);
94 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-set-visible" title="gtk_cell_renderer_set_visible ()">gtk_cell_renderer_set_visible</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
95 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> visible</code></em>);
96 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-sensitive" title="gtk_cell_renderer_get_sensitive ()">gtk_cell_renderer_get_sensitive</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>);
97 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-set-sensitive" title="gtk_cell_renderer_set_sensitive ()">gtk_cell_renderer_set_sensitive</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
98 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sensitive</code></em>);
99 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-alignment" title="gtk_cell_renderer_get_alignment ()">gtk_cell_renderer_get_alignment</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
100 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> *xalign</code></em>,
101 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> *yalign</code></em>);
102 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-set-alignment" title="gtk_cell_renderer_set_alignment ()">gtk_cell_renderer_set_alignment</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
103 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> xalign</code></em>,
104 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> yalign</code></em>);
105 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-padding" title="gtk_cell_renderer_get_padding ()">gtk_cell_renderer_get_padding</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
106 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *xpad</code></em>,
107 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *ypad</code></em>);
108 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-set-padding" title="gtk_cell_renderer_set_padding ()">gtk_cell_renderer_set_padding</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
109 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> xpad</code></em>,
110 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ypad</code></em>);
111 <a class="link" href="gtk3-Standard-Enumerations.html#GtkStateFlags" title="enum GtkStateFlags"><span class="returnvalue">GtkStateFlags</span></a> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-state" title="gtk_cell_renderer_get_state ()">gtk_cell_renderer_get_state</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
112 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
113 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> cell_state</code></em>);
114 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-is-activatable" title="gtk_cell_renderer_is_activatable ()">gtk_cell_renderer_is_activatable</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>);
116 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-preferred-height" title="gtk_cell_renderer_get_preferred_height ()">gtk_cell_renderer_get_preferred_height</a>
117 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
118 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
119 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *minimum_size</code></em>,
120 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *natural_size</code></em>);
121 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-preferred-height-for-width" title="gtk_cell_renderer_get_preferred_height_for_width ()">gtk_cell_renderer_get_preferred_height_for_width</a>
122 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
123 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
124 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
125 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *minimum_height</code></em>,
126 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *natural_height</code></em>);
127 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-preferred-size" title="gtk_cell_renderer_get_preferred_size ()">gtk_cell_renderer_get_preferred_size</a>
128 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
129 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
130 <em class="parameter"><code><a class="link" href="GtkWidget.html#GtkRequisition"><span class="type">GtkRequisition</span></a> *minimum_size</code></em>,
131 <em class="parameter"><code><a class="link" href="GtkWidget.html#GtkRequisition"><span class="type">GtkRequisition</span></a> *natural_size</code></em>);
132 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-preferred-width" title="gtk_cell_renderer_get_preferred_width ()">gtk_cell_renderer_get_preferred_width</a>
133 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
134 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
135 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *minimum_size</code></em>,
136 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *natural_size</code></em>);
137 <span class="returnvalue">void</span> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-preferred-width-for-height" title="gtk_cell_renderer_get_preferred_width_for_height ()">gtk_cell_renderer_get_preferred_width_for_height</a>
138 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
139 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
140 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
141 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *minimum_width</code></em>,
142 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *natural_width</code></em>);
143 <a class="link" href="GtkWidget.html#GtkSizeRequestMode" title="enum GtkSizeRequestMode"><span class="returnvalue">GtkSizeRequestMode</span></a> <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-request-mode" title="gtk_cell_renderer_get_request_mode ()">gtk_cell_renderer_get_request_mode</a> (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>);
146 <div class="refsect1">
147 <a name="GtkCellRenderer.object-hierarchy"></a><h2>Object Hierarchy</h2>
148 <pre class="synopsis">
149 <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
150 +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
152 +----<a class="link" href="GtkCellRendererText.html" title="GtkCellRendererText">GtkCellRendererText</a>
153 +----<a class="link" href="GtkCellRendererPixbuf.html" title="GtkCellRendererPixbuf">GtkCellRendererPixbuf</a>
154 +----<a class="link" href="GtkCellRendererProgress.html" title="GtkCellRendererProgress">GtkCellRendererProgress</a>
155 +----<a class="link" href="GtkCellRendererSpinner.html" title="GtkCellRendererSpinner">GtkCellRendererSpinner</a>
156 +----<a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle">GtkCellRendererToggle</a>
159 <div class="refsect1">
160 <a name="GtkCellRenderer.properties"></a><h2>Properties</h2>
161 <pre class="synopsis">
162 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--cell-background" title='The "cell-background" property'>cell-background</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write
163 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--cell-background-gdk" title='The "cell-background-gdk" property'>cell-background-gdk</a>" <a href="http://developer.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a>* : Read / Write
164 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--cell-background-rgba" title='The "cell-background-rgba" property'>cell-background-rgba</a>" <a href="http://developer.gnome.org/devel/gdk/gdk3-RGBA-Colors.html#GdkRGBA"><span class="type">GdkRGBA</span></a>* : Read / Write
165 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--cell-background-set" title='The "cell-background-set" property'>cell-background-set</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
166 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--editing" title='The "editing" property'>editing</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read
167 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--height" title='The "height" property'>height</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
168 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--is-expanded" title='The "is-expanded" property'>is-expanded</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
169 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--is-expander" title='The "is-expander" property'>is-expander</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
170 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--mode" title='The "mode" property'>mode</a>" <a class="link" href="GtkCellRenderer.html#GtkCellRendererMode" title="enum GtkCellRendererMode"><span class="type">GtkCellRendererMode</span></a> : Read / Write
171 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--sensitive" title='The "sensitive" property'>sensitive</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
172 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--visible" title='The "visible" property'>visible</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write
173 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--width" title='The "width" property'>width</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write
174 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--xalign" title='The "xalign" property'>xalign</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
175 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--xpad" title='The "xpad" property'>xpad</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
176 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--yalign" title='The "yalign" property'>yalign</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write
177 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--ypad" title='The "ypad" property'>ypad</a>" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write
180 <div class="refsect1">
181 <a name="GtkCellRenderer.signals"></a><h2>Signals</h2>
182 <pre class="synopsis">
183 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer-editing-canceled" title='The "editing-canceled" signal'>editing-canceled</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
184 "<a class="link" href="GtkCellRenderer.html#GtkCellRenderer-editing-started" title='The "editing-started" signal'>editing-started</a>" : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a>
187 <div class="refsect1">
188 <a name="GtkCellRenderer.description"></a><h2>Description</h2>
190 The <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> is a base class of a set of objects used for
191 rendering a cell to a <a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a>. These objects are used primarily by
192 the <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a> widget, though they aren't tied to them in any
193 specific way. It is worth noting that <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> is not a
194 <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> and cannot be treated as such.
197 The primary use of a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> is for drawing a certain graphical
198 elements on a <a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a>. Typically, one cell renderer is used to
199 draw many cells on the screen. To this extent, it isn't expected that a
200 CellRenderer keep any permanent state around. Instead, any state is set
201 just prior to use using <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject"><span class="type">GObject</span></a>s property system. Then, the
202 cell is measured using <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-size" title="gtk_cell_renderer_get_size ()"><code class="function">gtk_cell_renderer_get_size()</code></a>. Finally, the cell
203 is rendered in the correct location using <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-render" title="gtk_cell_renderer_render ()"><code class="function">gtk_cell_renderer_render()</code></a>.
206 There are a number of rules that must be followed when writing a new
207 <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>. First and formost, its important that a certain set
208 of properties will always yield a cell renderer of the same size,
209 barring a <a class="link" href="GtkStyle.html" title="GtkStyle"><span class="type">GtkStyle</span></a> change. The <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> also has a number of
210 generic properties that are expected to be honored by all children.
213 Beyond merely rendering a cell, cell renderers can optionally
214 provide active user interface elements. A cell renderer can be
215 <em class="firstterm">activatable</em> like <a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>,
216 which toggles when it gets activated by a mouse click, or it can be
217 <em class="firstterm">editable</em> like <a class="link" href="GtkCellRendererText.html" title="GtkCellRendererText"><span class="type">GtkCellRendererText</span></a>, which
218 allows the user to edit the text using a <a class="link" href="GtkEntry.html" title="GtkEntry"><span class="type">GtkEntry</span></a>.
219 To make a cell renderer activatable or editable, you have to
220 implement the <span class="type">GtkCellRendererClass.activate</span> or
221 <span class="type">GtkCellRendererClass.start_editing</span> virtual functions, respectively.
224 <div class="refsect1">
225 <a name="GtkCellRenderer.details"></a><h2>Details</h2>
226 <div class="refsect2">
227 <a name="GtkCellRendererState"></a><h3>enum GtkCellRendererState</h3>
228 <pre class="programlisting">typedef enum {
229 GTK_CELL_RENDERER_SELECTED = 1 << 0,
230 GTK_CELL_RENDERER_PRELIT = 1 << 1,
231 GTK_CELL_RENDERER_INSENSITIVE = 1 << 2,
232 /* this flag means the cell is in the sort column/row */
233 GTK_CELL_RENDERER_SORTED = 1 << 3,
234 GTK_CELL_RENDERER_FOCUSED = 1 << 4,
235 GTK_CELL_RENDERER_EXPANDABLE = 1 << 5,
236 GTK_CELL_RENDERER_EXPANDED = 1 << 6
237 } GtkCellRendererState;
240 Tells how a cell is to be rendererd.
242 <div class="variablelist"><table border="0">
243 <col align="left" valign="top">
246 <td><p><a name="GTK-CELL-RENDERER-SELECTED:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_SELECTED</code></span></p></td>
247 <td>The cell is currently selected, and
248 probably has a selection colored background to render to.
252 <td><p><a name="GTK-CELL-RENDERER-PRELIT:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_PRELIT</code></span></p></td>
253 <td>The mouse is hovering over the cell.
257 <td><p><a name="GTK-CELL-RENDERER-INSENSITIVE:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_INSENSITIVE</code></span></p></td>
258 <td>The cell is drawn in an insensitive manner
262 <td><p><a name="GTK-CELL-RENDERER-SORTED:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_SORTED</code></span></p></td>
263 <td>The cell is in a sorted row
267 <td><p><a name="GTK-CELL-RENDERER-FOCUSED:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_FOCUSED</code></span></p></td>
268 <td>The cell is in the focus row.
272 <td><p><a name="GTK-CELL-RENDERER-EXPANDABLE:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_EXPANDABLE</code></span></p></td>
273 <td>The cell is in a row that can be expanded. Since 3.4
277 <td><p><a name="GTK-CELL-RENDERER-EXPANDED:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_EXPANDED</code></span></p></td>
278 <td>The cell is in a row that is expanded. Since 3.4
285 <div class="refsect2">
286 <a name="GtkCellRendererMode"></a><h3>enum GtkCellRendererMode</h3>
287 <pre class="programlisting">typedef enum {
288 GTK_CELL_RENDERER_MODE_INERT,
289 GTK_CELL_RENDERER_MODE_ACTIVATABLE,
290 GTK_CELL_RENDERER_MODE_EDITABLE
291 } GtkCellRendererMode;
294 Identifies how the user can interact with a particular cell.
296 <div class="variablelist"><table border="0">
297 <col align="left" valign="top">
300 <td><p><a name="GTK-CELL-RENDERER-MODE-INERT:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_MODE_INERT</code></span></p></td>
301 <td>The cell is just for display
302 and cannot be interacted with. Note that this doesn't mean that eg. the
303 row being drawn can't be selected -- just that a particular element of
304 it cannot be individually modified.
308 <td><p><a name="GTK-CELL-RENDERER-MODE-ACTIVATABLE:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_MODE_ACTIVATABLE</code></span></p></td>
309 <td>The cell can be clicked.
313 <td><p><a name="GTK-CELL-RENDERER-MODE-EDITABLE:CAPS"></a><span class="term"><code class="literal">GTK_CELL_RENDERER_MODE_EDITABLE</code></span></p></td>
314 <td>The cell can be edited or otherwise modified.
321 <div class="refsect2">
322 <a name="GtkCellRenderer-struct"></a><h3>struct GtkCellRenderer</h3>
323 <pre class="programlisting">struct GtkCellRenderer;</pre>
326 <div class="refsect2">
327 <a name="GtkCellRendererClass"></a><h3>struct GtkCellRendererClass</h3>
328 <pre class="programlisting">struct GtkCellRendererClass {
329 GInitiallyUnownedClass parent_class;
331 /* vtable - not signals */
332 GtkSizeRequestMode (* get_request_mode) (GtkCellRenderer *cell);
333 void (* get_preferred_width) (GtkCellRenderer *cell,
337 void (* get_preferred_height_for_width) (GtkCellRenderer *cell,
340 gint *minimum_height,
341 gint *natural_height);
342 void (* get_preferred_height) (GtkCellRenderer *cell,
346 void (* get_preferred_width_for_height) (GtkCellRenderer *cell,
350 gint *natural_width);
351 void (* get_aligned_area) (GtkCellRenderer *cell,
353 GtkCellRendererState flags,
354 const GdkRectangle *cell_area,
355 GdkRectangle *aligned_area);
356 void (* get_size) (GtkCellRenderer *cell,
358 const GdkRectangle *cell_area,
363 void (* render) (GtkCellRenderer *cell,
366 const GdkRectangle *background_area,
367 const GdkRectangle *cell_area,
368 GtkCellRendererState flags);
369 gboolean (* activate) (GtkCellRenderer *cell,
373 const GdkRectangle *background_area,
374 const GdkRectangle *cell_area,
375 GtkCellRendererState flags);
376 GtkCellEditable * (* start_editing) (GtkCellRenderer *cell,
380 const GdkRectangle *background_area,
381 const GdkRectangle *cell_area,
382 GtkCellRendererState flags);
385 void (* editing_canceled) (GtkCellRenderer *cell);
386 void (* editing_started) (GtkCellRenderer *cell,
387 GtkCellEditable *editable,
390 GtkCellRendererClassPrivate *priv;
392 /* Padding for future expansion */
393 void (*_gtk_reserved2) (void);
394 void (*_gtk_reserved3) (void);
395 void (*_gtk_reserved4) (void);
400 <div class="refsect2">
401 <a name="gtk-cell-renderer-get-aligned-area"></a><h3>gtk_cell_renderer_get_aligned_area ()</h3>
402 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_aligned_area (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
403 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
404 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> flags</code></em>,
405 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
406 <em class="parameter"><code><a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *aligned_area</code></em>);</pre>
408 Gets the aligned area used by <em class="parameter"><code>cell</code></em> inside <em class="parameter"><code>cell_area</code></em>. Used for finding
409 the appropriate edit and focus rectangle.
411 <div class="variablelist"><table border="0">
412 <col align="left" valign="top">
415 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
416 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> instance</td>
419 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
420 <td>the <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> this cell will be rendering to</td>
423 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
424 <td>render flags</td>
427 <td><p><span class="term"><em class="parameter"><code>cell_area</code></em> :</span></p></td>
428 <td>cell area which would be passed to <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-render" title="gtk_cell_renderer_render ()"><code class="function">gtk_cell_renderer_render()</code></a>
432 <td><p><span class="term"><em class="parameter"><code>aligned_area</code></em> :</span></p></td>
433 <td>the return location for the space inside <em class="parameter"><code>cell_area</code></em>
434 that would acually be used to render. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>]</span>
439 <p class="since">Since 3.0</p>
442 <div class="refsect2">
443 <a name="gtk-cell-renderer-get-size"></a><h3>gtk_cell_renderer_get_size ()</h3>
444 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_size (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
445 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
446 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
447 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *x_offset</code></em>,
448 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *y_offset</code></em>,
449 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *width</code></em>,
450 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *height</code></em>);</pre>
451 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
452 <h3 class="title">Warning</h3>
453 <p><code class="literal">gtk_cell_renderer_get_size</code> has been deprecated since version 3.0 and should not be used in newly-written code. Use <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-get-preferred-size" title="gtk_cell_renderer_get_preferred_size ()"><code class="function">gtk_cell_renderer_get_preferred_size()</code></a> instead.</p>
456 Obtains the width and height needed to render the cell. Used by view
457 widgets to determine the appropriate size for the cell_area passed to
458 <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-render" title="gtk_cell_renderer_render ()"><code class="function">gtk_cell_renderer_render()</code></a>. If <em class="parameter"><code>cell_area</code></em> is not <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>, fills in the
459 x and y offsets (if set) of the cell relative to this location.
462 Please note that the values set in <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em>, as well as those
463 in <em class="parameter"><code>x_offset</code></em> and <em class="parameter"><code>y_offset</code></em> are inclusive of the xpad and ypad properties.
465 <div class="variablelist"><table border="0">
466 <col align="left" valign="top">
469 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
470 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
474 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
475 <td>the widget the renderer is rendering to</td>
478 <td><p><span class="term"><em class="parameter"><code>cell_area</code></em> :</span></p></td>
479 <td>The area a cell will be allocated, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
483 <td><p><span class="term"><em class="parameter"><code>x_offset</code></em> :</span></p></td>
484 <td>location to return x offset of cell relative to <em class="parameter"><code>cell_area</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
488 <td><p><span class="term"><em class="parameter"><code>y_offset</code></em> :</span></p></td>
489 <td>location to return y offset of cell relative to <em class="parameter"><code>cell_area</code></em>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
493 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
494 <td>location to return width needed to render a cell, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
498 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
499 <td>location to return height needed to render a cell, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
506 <div class="refsect2">
507 <a name="gtk-cell-renderer-render"></a><h3>gtk_cell_renderer_render ()</h3>
508 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_render (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
509 <em class="parameter"><code><a href="/usr/share/gtk-doc/html/cairo/cairo-cairo-t.html#cairo-t"><span class="type">cairo_t</span></a> *cr</code></em>,
510 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
511 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *background_area</code></em>,
512 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
513 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> flags</code></em>);</pre>
515 Invokes the virtual render function of the <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>. The three
516 passed-in rectangles are areas in <em class="parameter"><code>cr</code></em>. Most renderers will draw within
517 <em class="parameter"><code>cell_area</code></em>; the xalign, yalign, xpad, and ypad fields of the <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
518 should be honored with respect to <em class="parameter"><code>cell_area</code></em>. <em class="parameter"><code>background_area</code></em> includes the
519 blank space around the cell, and also the area containing the tree expander;
520 so the <em class="parameter"><code>background_area</code></em> rectangles for all cells tile to cover the entire
521 <em class="parameter"><code>window</code></em>.
523 <div class="variablelist"><table border="0">
524 <col align="left" valign="top">
527 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
528 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
532 <td><p><span class="term"><em class="parameter"><code>cr</code></em> :</span></p></td>
533 <td>a cairo context to draw to</td>
536 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
537 <td>the widget owning <em class="parameter"><code>window</code></em>
541 <td><p><span class="term"><em class="parameter"><code>background_area</code></em> :</span></p></td>
542 <td>entire cell area (including tree expanders and maybe
543 padding on the sides)</td>
546 <td><p><span class="term"><em class="parameter"><code>cell_area</code></em> :</span></p></td>
547 <td>area normally rendered by a cell renderer</td>
550 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
551 <td>flags that affect rendering</td>
557 <div class="refsect2">
558 <a name="gtk-cell-renderer-activate"></a><h3>gtk_cell_renderer_activate ()</h3>
559 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_activate (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
560 <em class="parameter"><code><a href="http://developer.gnome.org/devel/gdk/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>,
561 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
562 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
563 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *background_area</code></em>,
564 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
565 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> flags</code></em>);</pre>
567 Passes an activate event to the cell renderer for possible processing.
568 Some cell renderers may use events; for example, <a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>
569 toggles when it gets a mouse click.
571 <div class="variablelist"><table border="0">
572 <col align="left" valign="top">
575 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
576 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
580 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
581 <td>a <a href="http://developer.gnome.org/devel/gdk/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a>
585 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
586 <td>widget that received the event</td>
589 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
590 <td>widget-dependent string representation of the event location;
591 e.g. for <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>, a string representation of <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a>
595 <td><p><span class="term"><em class="parameter"><code>background_area</code></em> :</span></p></td>
596 <td>background area as passed to <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-render" title="gtk_cell_renderer_render ()"><code class="function">gtk_cell_renderer_render()</code></a>
600 <td><p><span class="term"><em class="parameter"><code>cell_area</code></em> :</span></p></td>
601 <td>cell area as passed to <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-render" title="gtk_cell_renderer_render ()"><code class="function">gtk_cell_renderer_render()</code></a>
605 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
606 <td>render flags</td>
609 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
611 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the event was consumed/handled</td>
617 <div class="refsect2">
618 <a name="gtk-cell-renderer-start-editing"></a><h3>gtk_cell_renderer_start_editing ()</h3>
619 <pre class="programlisting"><a class="link" href="GtkCellEditable.html" title="GtkCellEditable"><span class="returnvalue">GtkCellEditable</span></a> * gtk_cell_renderer_start_editing (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
620 <em class="parameter"><code><a href="http://developer.gnome.org/devel/gdk/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a> *event</code></em>,
621 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
622 <em class="parameter"><code>const <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path</code></em>,
623 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *background_area</code></em>,
624 <em class="parameter"><code>const <a href="http://developer.gnome.org/devel/gdk/gdk3-Points-Rectangles-and-Regions.html#GdkRectangle"><span class="type">GdkRectangle</span></a> *cell_area</code></em>,
625 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> flags</code></em>);</pre>
627 Passes an activate event to the cell renderer for possible processing.
629 <div class="variablelist"><table border="0">
630 <col align="left" valign="top">
633 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
634 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
638 <td><p><span class="term"><em class="parameter"><code>event</code></em> :</span></p></td>
639 <td>a <a href="http://developer.gnome.org/devel/gdk/gdk3-Event-Structures.html#GdkEvent"><span class="type">GdkEvent</span></a>
643 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
644 <td>widget that received the event</td>
647 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
648 <td>widget-dependent string representation of the event location;
649 e.g. for <a class="link" href="GtkTreeView.html" title="GtkTreeView"><span class="type">GtkTreeView</span></a>, a string representation of <a class="link" href="GtkTreeModel.html#GtkTreePath"><span class="type">GtkTreePath</span></a>
653 <td><p><span class="term"><em class="parameter"><code>background_area</code></em> :</span></p></td>
654 <td>background area as passed to <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-render" title="gtk_cell_renderer_render ()"><code class="function">gtk_cell_renderer_render()</code></a>
658 <td><p><span class="term"><em class="parameter"><code>cell_area</code></em> :</span></p></td>
659 <td>cell area as passed to <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-render" title="gtk_cell_renderer_render ()"><code class="function">gtk_cell_renderer_render()</code></a>
663 <td><p><span class="term"><em class="parameter"><code>flags</code></em> :</span></p></td>
664 <td>render flags</td>
667 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
668 <td>A new <a class="link" href="GtkCellEditable.html" title="GtkCellEditable"><span class="type">GtkCellEditable</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Don't free data after the code is done."><span class="acronym">transfer none</span></acronym>]</span>
675 <div class="refsect2">
676 <a name="gtk-cell-renderer-stop-editing"></a><h3>gtk_cell_renderer_stop_editing ()</h3>
677 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_stop_editing (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
678 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> canceled</code></em>);</pre>
680 Informs the cell renderer that the editing is stopped.
681 If <em class="parameter"><code>canceled</code></em> is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>, the cell renderer will emit the
682 <a class="link" href="GtkCellRenderer.html#GtkCellRenderer-editing-canceled" title='The "editing-canceled" signal'><span class="type">"editing-canceled"</span></a> signal.
685 This function should be called by cell renderer implementations
686 in response to the <a class="link" href="GtkCellEditable.html#GtkCellEditable-editing-done" title='The "editing-done" signal'><span class="type">"editing-done"</span></a> signal of
687 <a class="link" href="GtkCellEditable.html" title="GtkCellEditable"><span class="type">GtkCellEditable</span></a>.
689 <div class="variablelist"><table border="0">
690 <col align="left" valign="top">
693 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
694 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
698 <td><p><span class="term"><em class="parameter"><code>canceled</code></em> :</span></p></td>
700 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the editing has been canceled</td>
704 <p class="since">Since 2.6</p>
707 <div class="refsect2">
708 <a name="gtk-cell-renderer-get-fixed-size"></a><h3>gtk_cell_renderer_get_fixed_size ()</h3>
709 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_fixed_size (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
710 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *width</code></em>,
711 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *height</code></em>);</pre>
713 Fills in <em class="parameter"><code>width</code></em> and <em class="parameter"><code>height</code></em> with the appropriate size of <em class="parameter"><code>cell</code></em>.
715 <div class="variablelist"><table border="0">
716 <col align="left" valign="top">
719 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
720 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
724 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
725 <td>location to fill in with the fixed width of the cell, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
729 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
730 <td>location to fill in with the fixed height of the cell, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
737 <div class="refsect2">
738 <a name="gtk-cell-renderer-set-fixed-size"></a><h3>gtk_cell_renderer_set_fixed_size ()</h3>
739 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_set_fixed_size (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
740 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
741 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>);</pre>
743 Sets the renderer size to be explicit, independent of the properties set.
745 <div class="variablelist"><table border="0">
746 <col align="left" valign="top">
749 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
750 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
754 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
755 <td>the width of the cell renderer, or -1</td>
758 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
759 <td>the height of the cell renderer, or -1</td>
765 <div class="refsect2">
766 <a name="gtk-cell-renderer-get-visible"></a><h3>gtk_cell_renderer_get_visible ()</h3>
767 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_get_visible (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>);</pre>
769 Returns the cell renderer's visibility.
771 <div class="variablelist"><table border="0">
772 <col align="left" valign="top">
775 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
776 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
780 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
782 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the cell renderer is visible</td>
786 <p class="since">Since 2.18</p>
789 <div class="refsect2">
790 <a name="gtk-cell-renderer-set-visible"></a><h3>gtk_cell_renderer_set_visible ()</h3>
791 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_set_visible (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
792 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> visible</code></em>);</pre>
794 Sets the cell renderer's visibility.
796 <div class="variablelist"><table border="0">
797 <col align="left" valign="top">
800 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
801 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
805 <td><p><span class="term"><em class="parameter"><code>visible</code></em> :</span></p></td>
806 <td>the visibility of the cell</td>
810 <p class="since">Since 2.18</p>
813 <div class="refsect2">
814 <a name="gtk-cell-renderer-get-sensitive"></a><h3>gtk_cell_renderer_get_sensitive ()</h3>
815 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_get_sensitive (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>);</pre>
817 Returns the cell renderer's sensitivity.
819 <div class="variablelist"><table border="0">
820 <col align="left" valign="top">
823 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
824 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
828 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
830 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the cell renderer is sensitive</td>
834 <p class="since">Since 2.18</p>
837 <div class="refsect2">
838 <a name="gtk-cell-renderer-set-sensitive"></a><h3>gtk_cell_renderer_set_sensitive ()</h3>
839 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_set_sensitive (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
840 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> sensitive</code></em>);</pre>
842 Sets the cell renderer's sensitivity.
844 <div class="variablelist"><table border="0">
845 <col align="left" valign="top">
848 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
849 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
853 <td><p><span class="term"><em class="parameter"><code>sensitive</code></em> :</span></p></td>
854 <td>the sensitivity of the cell</td>
858 <p class="since">Since 2.18</p>
861 <div class="refsect2">
862 <a name="gtk-cell-renderer-get-alignment"></a><h3>gtk_cell_renderer_get_alignment ()</h3>
863 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_alignment (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
864 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> *xalign</code></em>,
865 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> *yalign</code></em>);</pre>
867 Fills in <em class="parameter"><code>xalign</code></em> and <em class="parameter"><code>yalign</code></em> with the appropriate values of <em class="parameter"><code>cell</code></em>.
869 <div class="variablelist"><table border="0">
870 <col align="left" valign="top">
873 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
874 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
878 <td><p><span class="term"><em class="parameter"><code>xalign</code></em> :</span></p></td>
879 <td>location to fill in with the x alignment of the cell, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
883 <td><p><span class="term"><em class="parameter"><code>yalign</code></em> :</span></p></td>
884 <td>location to fill in with the y alignment of the cell, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
889 <p class="since">Since 2.18</p>
892 <div class="refsect2">
893 <a name="gtk-cell-renderer-set-alignment"></a><h3>gtk_cell_renderer_set_alignment ()</h3>
894 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_set_alignment (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
895 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> xalign</code></em>,
896 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> yalign</code></em>);</pre>
898 Sets the renderer's alignment within its available space.
900 <div class="variablelist"><table border="0">
901 <col align="left" valign="top">
904 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
905 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
909 <td><p><span class="term"><em class="parameter"><code>xalign</code></em> :</span></p></td>
910 <td>the x alignment of the cell renderer</td>
913 <td><p><span class="term"><em class="parameter"><code>yalign</code></em> :</span></p></td>
914 <td>the y alignment of the cell renderer</td>
918 <p class="since">Since 2.18</p>
921 <div class="refsect2">
922 <a name="gtk-cell-renderer-get-padding"></a><h3>gtk_cell_renderer_get_padding ()</h3>
923 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_padding (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
924 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *xpad</code></em>,
925 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *ypad</code></em>);</pre>
927 Fills in <em class="parameter"><code>xpad</code></em> and <em class="parameter"><code>ypad</code></em> with the appropriate values of <em class="parameter"><code>cell</code></em>.
929 <div class="variablelist"><table border="0">
930 <col align="left" valign="top">
933 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
934 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
938 <td><p><span class="term"><em class="parameter"><code>xpad</code></em> :</span></p></td>
939 <td>location to fill in with the x padding of the cell, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
943 <td><p><span class="term"><em class="parameter"><code>ypad</code></em> :</span></p></td>
944 <td>location to fill in with the y padding of the cell, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
949 <p class="since">Since 2.18</p>
952 <div class="refsect2">
953 <a name="gtk-cell-renderer-set-padding"></a><h3>gtk_cell_renderer_set_padding ()</h3>
954 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_set_padding (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
955 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> xpad</code></em>,
956 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> ypad</code></em>);</pre>
958 Sets the renderer's padding.
960 <div class="variablelist"><table border="0">
961 <col align="left" valign="top">
964 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
965 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
969 <td><p><span class="term"><em class="parameter"><code>xpad</code></em> :</span></p></td>
970 <td>the x padding of the cell renderer</td>
973 <td><p><span class="term"><em class="parameter"><code>ypad</code></em> :</span></p></td>
974 <td>the y padding of the cell renderer</td>
978 <p class="since">Since 2.18</p>
981 <div class="refsect2">
982 <a name="gtk-cell-renderer-get-state"></a><h3>gtk_cell_renderer_get_state ()</h3>
983 <pre class="programlisting"><a class="link" href="gtk3-Standard-Enumerations.html#GtkStateFlags" title="enum GtkStateFlags"><span class="returnvalue">GtkStateFlags</span></a> gtk_cell_renderer_get_state (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
984 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
985 <em class="parameter"><code><a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a> cell_state</code></em>);</pre>
987 Translates the cell renderer state to <a class="link" href="gtk3-Standard-Enumerations.html#GtkStateFlags" title="enum GtkStateFlags"><span class="type">GtkStateFlags</span></a>,
988 based on the cell renderer and widget sensitivity, and
989 the given <a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a>.
991 <div class="variablelist"><table border="0">
992 <col align="left" valign="top">
995 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
996 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
1000 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1001 <td>a <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a>, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>
1005 <td><p><span class="term"><em class="parameter"><code>cell_state</code></em> :</span></p></td>
1006 <td>cell renderer state</td>
1009 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1010 <td>the widget state flags applying to <em class="parameter"><code>cell</code></em>
1015 <p class="since">Since 3.0</p>
1018 <div class="refsect2">
1019 <a name="gtk-cell-renderer-is-activatable"></a><h3>gtk_cell_renderer_is_activatable ()</h3>
1020 <pre class="programlisting"><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="returnvalue">gboolean</span></a> gtk_cell_renderer_is_activatable (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>);</pre>
1022 Checks whether the cell renderer can do something when activated.
1024 <div class="variablelist"><table border="0">
1025 <col align="left" valign="top">
1028 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
1029 <td>A <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a>
1033 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1035 <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if the cell renderer can do anything when activated</td>
1039 <p class="since">Since 3.0</p>
1042 <div class="refsect2">
1043 <a name="gtk-cell-renderer-get-preferred-height"></a><h3>gtk_cell_renderer_get_preferred_height ()</h3>
1044 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_preferred_height
1045 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
1046 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
1047 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *minimum_size</code></em>,
1048 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *natural_size</code></em>);</pre>
1050 Retreives a renderer's natural size when rendered to <em class="parameter"><code>widget</code></em>.
1052 <div class="variablelist"><table border="0">
1053 <col align="left" valign="top">
1056 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
1057 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> instance</td>
1060 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1061 <td>the <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> this cell will be rendering to</td>
1064 <td><p><span class="term"><em class="parameter"><code>minimum_size</code></em> :</span></p></td>
1065 <td>location to store the minimum size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1069 <td><p><span class="term"><em class="parameter"><code>natural_size</code></em> :</span></p></td>
1070 <td>location to store the natural size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1075 <p class="since">Since 3.0</p>
1078 <div class="refsect2">
1079 <a name="gtk-cell-renderer-get-preferred-height-for-width"></a><h3>gtk_cell_renderer_get_preferred_height_for_width ()</h3>
1080 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_preferred_height_for_width
1081 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
1082 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
1083 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> width</code></em>,
1084 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *minimum_height</code></em>,
1085 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *natural_height</code></em>);</pre>
1087 Retreives a cell renderers's minimum and natural height if it were rendered to
1088 <em class="parameter"><code>widget</code></em> with the specified <em class="parameter"><code>width</code></em>.
1090 <div class="variablelist"><table border="0">
1091 <col align="left" valign="top">
1094 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
1095 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> instance</td>
1098 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1099 <td>the <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> this cell will be rendering to</td>
1102 <td><p><span class="term"><em class="parameter"><code>width</code></em> :</span></p></td>
1103 <td>the size which is available for allocation</td>
1106 <td><p><span class="term"><em class="parameter"><code>minimum_height</code></em> :</span></p></td>
1107 <td>location for storing the minimum size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1111 <td><p><span class="term"><em class="parameter"><code>natural_height</code></em> :</span></p></td>
1112 <td>location for storing the preferred size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1117 <p class="since">Since 3.0</p>
1120 <div class="refsect2">
1121 <a name="gtk-cell-renderer-get-preferred-size"></a><h3>gtk_cell_renderer_get_preferred_size ()</h3>
1122 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_preferred_size
1123 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
1124 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
1125 <em class="parameter"><code><a class="link" href="GtkWidget.html#GtkRequisition"><span class="type">GtkRequisition</span></a> *minimum_size</code></em>,
1126 <em class="parameter"><code><a class="link" href="GtkWidget.html#GtkRequisition"><span class="type">GtkRequisition</span></a> *natural_size</code></em>);</pre>
1128 Retrieves the minimum and natural size of a cell taking
1129 into account the widget's preference for height-for-width management.
1131 <div class="variablelist"><table border="0">
1132 <col align="left" valign="top">
1135 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
1136 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> instance</td>
1139 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1140 <td>the <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> this cell will be rendering to</td>
1143 <td><p><span class="term"><em class="parameter"><code>minimum_size</code></em> :</span></p></td>
1144 <td>location for storing the minimum size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1148 <td><p><span class="term"><em class="parameter"><code>natural_size</code></em> :</span></p></td>
1149 <td>location for storing the natural size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1154 <p class="since">Since 3.0</p>
1157 <div class="refsect2">
1158 <a name="gtk-cell-renderer-get-preferred-width"></a><h3>gtk_cell_renderer_get_preferred_width ()</h3>
1159 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_preferred_width
1160 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
1161 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
1162 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *minimum_size</code></em>,
1163 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *natural_size</code></em>);</pre>
1165 Retreives a renderer's natural size when rendered to <em class="parameter"><code>widget</code></em>.
1167 <div class="variablelist"><table border="0">
1168 <col align="left" valign="top">
1171 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
1172 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> instance</td>
1175 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1176 <td>the <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> this cell will be rendering to</td>
1179 <td><p><span class="term"><em class="parameter"><code>minimum_size</code></em> :</span></p></td>
1180 <td>location to store the minimum size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1184 <td><p><span class="term"><em class="parameter"><code>natural_size</code></em> :</span></p></td>
1185 <td>location to store the natural size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1190 <p class="since">Since 3.0</p>
1193 <div class="refsect2">
1194 <a name="gtk-cell-renderer-get-preferred-width-for-height"></a><h3>gtk_cell_renderer_get_preferred_width_for_height ()</h3>
1195 <pre class="programlisting"><span class="returnvalue">void</span> gtk_cell_renderer_get_preferred_width_for_height
1196 (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>,
1197 <em class="parameter"><code><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> *widget</code></em>,
1198 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> height</code></em>,
1199 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *minimum_width</code></em>,
1200 <em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> *natural_width</code></em>);</pre>
1202 Retreives a cell renderers's minimum and natural width if it were rendered to
1203 <em class="parameter"><code>widget</code></em> with the specified <em class="parameter"><code>height</code></em>.
1205 <div class="variablelist"><table border="0">
1206 <col align="left" valign="top">
1209 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
1210 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> instance</td>
1213 <td><p><span class="term"><em class="parameter"><code>widget</code></em> :</span></p></td>
1214 <td>the <a class="link" href="GtkWidget.html" title="GtkWidget"><span class="type">GtkWidget</span></a> this cell will be rendering to</td>
1217 <td><p><span class="term"><em class="parameter"><code>height</code></em> :</span></p></td>
1218 <td>the size which is available for allocation</td>
1221 <td><p><span class="term"><em class="parameter"><code>minimum_width</code></em> :</span></p></td>
1222 <td>location for storing the minimum size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1226 <td><p><span class="term"><em class="parameter"><code>natural_width</code></em> :</span></p></td>
1227 <td>location for storing the preferred size, or <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#NULL:CAPS"><code class="literal">NULL</code></a>. <span class="annotation">[<acronym title="Parameter for returning results. Default is transfer full."><span class="acronym">out</span></acronym>][<acronym title="NULL is ok, both for passing and for returning."><span class="acronym">allow-none</span></acronym>]</span>
1232 <p class="since">Since 3.0</p>
1235 <div class="refsect2">
1236 <a name="gtk-cell-renderer-get-request-mode"></a><h3>gtk_cell_renderer_get_request_mode ()</h3>
1237 <pre class="programlisting"><a class="link" href="GtkWidget.html#GtkSizeRequestMode" title="enum GtkSizeRequestMode"><span class="returnvalue">GtkSizeRequestMode</span></a> gtk_cell_renderer_get_request_mode (<em class="parameter"><code><a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *cell</code></em>);</pre>
1239 Gets whether the cell renderer prefers a height-for-width layout
1240 or a width-for-height layout.
1242 <div class="variablelist"><table border="0">
1243 <col align="left" valign="top">
1246 <td><p><span class="term"><em class="parameter"><code>cell</code></em> :</span></p></td>
1247 <td>a <a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> instance</td>
1250 <td><p><span class="term"><span class="emphasis"><em>Returns</em></span> :</span></p></td>
1251 <td>The <a class="link" href="GtkWidget.html#GtkSizeRequestMode" title="enum GtkSizeRequestMode"><span class="type">GtkSizeRequestMode</span></a> preferred by this renderer.</td>
1255 <p class="since">Since 3.0</p>
1258 <div class="refsect1">
1259 <a name="GtkCellRenderer.property-details"></a><h2>Property Details</h2>
1260 <div class="refsect2">
1261 <a name="GtkCellRenderer--cell-background"></a><h3>The <code class="literal">"cell-background"</code> property</h3>
1262 <pre class="programlisting"> "cell-background" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>* : Write</pre>
1263 <p>Cell background color as a string.</p>
1264 <p>Default value: NULL</p>
1267 <div class="refsect2">
1268 <a name="GtkCellRenderer--cell-background-gdk"></a><h3>The <code class="literal">"cell-background-gdk"</code> property</h3>
1269 <pre class="programlisting"> "cell-background-gdk" <a href="http://developer.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a>* : Read / Write</pre>
1270 <div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
1271 <h3 class="title">Warning</h3>
1272 <p><code class="literal">GtkCellRenderer:cell-background-gdk</code> has been deprecated since version 3.4 and should not be used in newly-written code. Use <a class="link" href="GtkCellRenderer.html#GtkCellRenderer--cell-background-rgba" title='The "cell-background-rgba" property'><span class="type">"cell-background-rgba"</span></a> instead.</p>
1275 Cell background as a <a href="http://developer.gnome.org/devel/gdk/gdk3-Colors.html#GdkColor"><span class="type">GdkColor</span></a>
1279 <div class="refsect2">
1280 <a name="GtkCellRenderer--cell-background-rgba"></a><h3>The <code class="literal">"cell-background-rgba"</code> property</h3>
1281 <pre class="programlisting"> "cell-background-rgba" <a href="http://developer.gnome.org/devel/gdk/gdk3-RGBA-Colors.html#GdkRGBA"><span class="type">GdkRGBA</span></a>* : Read / Write</pre>
1283 Cell background as a <a href="http://developer.gnome.org/devel/gdk/gdk3-RGBA-Colors.html#GdkRGBA"><span class="type">GdkRGBA</span></a>
1285 <p class="since">Since 3.0</p>
1288 <div class="refsect2">
1289 <a name="GtkCellRenderer--cell-background-set"></a><h3>The <code class="literal">"cell-background-set"</code> property</h3>
1290 <pre class="programlisting"> "cell-background-set" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1291 <p>Whether this tag affects the cell background color.</p>
1292 <p>Default value: FALSE</p>
1295 <div class="refsect2">
1296 <a name="GtkCellRenderer--editing"></a><h3>The <code class="literal">"editing"</code> property</h3>
1297 <pre class="programlisting"> "editing" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read</pre>
1298 <p>Whether the cell renderer is currently in editing mode.</p>
1299 <p>Default value: FALSE</p>
1302 <div class="refsect2">
1303 <a name="GtkCellRenderer--height"></a><h3>The <code class="literal">"height"</code> property</h3>
1304 <pre class="programlisting"> "height" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
1305 <p>The fixed height.</p>
1306 <p>Allowed values: >= G_MAXULONG</p>
1307 <p>Default value: -1</p>
1310 <div class="refsect2">
1311 <a name="GtkCellRenderer--is-expanded"></a><h3>The <code class="literal">"is-expanded"</code> property</h3>
1312 <pre class="programlisting"> "is-expanded" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1313 <p>Row is an expander row, and is expanded.</p>
1314 <p>Default value: FALSE</p>
1317 <div class="refsect2">
1318 <a name="GtkCellRenderer--is-expander"></a><h3>The <code class="literal">"is-expander"</code> property</h3>
1319 <pre class="programlisting"> "is-expander" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1320 <p>Row has children.</p>
1321 <p>Default value: FALSE</p>
1324 <div class="refsect2">
1325 <a name="GtkCellRenderer--mode"></a><h3>The <code class="literal">"mode"</code> property</h3>
1326 <pre class="programlisting"> "mode" <a class="link" href="GtkCellRenderer.html#GtkCellRendererMode" title="enum GtkCellRendererMode"><span class="type">GtkCellRendererMode</span></a> : Read / Write</pre>
1327 <p>Editable mode of the CellRenderer.</p>
1328 <p>Default value: GTK_CELL_RENDERER_MODE_INERT</p>
1331 <div class="refsect2">
1332 <a name="GtkCellRenderer--sensitive"></a><h3>The <code class="literal">"sensitive"</code> property</h3>
1333 <pre class="programlisting"> "sensitive" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1334 <p>Display the cell sensitive.</p>
1335 <p>Default value: TRUE</p>
1338 <div class="refsect2">
1339 <a name="GtkCellRenderer--visible"></a><h3>The <code class="literal">"visible"</code> property</h3>
1340 <pre class="programlisting"> "visible" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> : Read / Write</pre>
1341 <p>Display the cell.</p>
1342 <p>Default value: TRUE</p>
1345 <div class="refsect2">
1346 <a name="GtkCellRenderer--width"></a><h3>The <code class="literal">"width"</code> property</h3>
1347 <pre class="programlisting"> "width" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gint"><span class="type">gint</span></a> : Read / Write</pre>
1348 <p>The fixed width.</p>
1349 <p>Allowed values: >= G_MAXULONG</p>
1350 <p>Default value: -1</p>
1353 <div class="refsect2">
1354 <a name="GtkCellRenderer--xalign"></a><h3>The <code class="literal">"xalign"</code> property</h3>
1355 <pre class="programlisting"> "xalign" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
1357 <p>Allowed values: [0,1]</p>
1358 <p>Default value: 0.5</p>
1361 <div class="refsect2">
1362 <a name="GtkCellRenderer--xpad"></a><h3>The <code class="literal">"xpad"</code> property</h3>
1363 <pre class="programlisting"> "xpad" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
1365 <p>Default value: 0</p>
1368 <div class="refsect2">
1369 <a name="GtkCellRenderer--yalign"></a><h3>The <code class="literal">"yalign"</code> property</h3>
1370 <pre class="programlisting"> "yalign" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gfloat"><span class="type">gfloat</span></a> : Read / Write</pre>
1372 <p>Allowed values: [0,1]</p>
1373 <p>Default value: 0.5</p>
1376 <div class="refsect2">
1377 <a name="GtkCellRenderer--ypad"></a><h3>The <code class="literal">"ypad"</code> property</h3>
1378 <pre class="programlisting"> "ypad" <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a> : Read / Write</pre>
1380 <p>Default value: 0</p>
1383 <div class="refsect1">
1384 <a name="GtkCellRenderer.signal-details"></a><h2>Signal Details</h2>
1385 <div class="refsect2">
1386 <a name="GtkCellRenderer-editing-canceled"></a><h3>The <code class="literal">"editing-canceled"</code> signal</h3>
1387 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *renderer,
1388 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
1390 This signal gets emitted when the user cancels the process of editing a
1391 cell. For example, an editable cell renderer could be written to cancel
1392 editing when the user presses Escape.
1395 See also: <a class="link" href="GtkCellRenderer.html#gtk-cell-renderer-stop-editing" title="gtk_cell_renderer_stop_editing ()"><code class="function">gtk_cell_renderer_stop_editing()</code></a>.
1397 <div class="variablelist"><table border="0">
1398 <col align="left" valign="top">
1401 <td><p><span class="term"><em class="parameter"><code>renderer</code></em> :</span></p></td>
1402 <td>the object which received the signal</td>
1405 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1406 <td>user data set when the signal handler was connected.</td>
1410 <p class="since">Since 2.4</p>
1413 <div class="refsect2">
1414 <a name="GtkCellRenderer-editing-started"></a><h3>The <code class="literal">"editing-started"</code> signal</h3>
1415 <pre class="programlisting"><span class="returnvalue">void</span> user_function (<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer"><span class="type">GtkCellRenderer</span></a> *renderer,
1416 <a class="link" href="GtkCellEditable.html" title="GtkCellEditable"><span class="type">GtkCellEditable</span></a> *editable,
1417 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a> *path,
1418 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gpointer"><span class="type">gpointer</span></a> user_data) : <a href="http://library.gnome.org/devel/gobject/unstable/gobject-Signals.html#G-SIGNAL-RUN-FIRST:CAPS"><code class="literal">Run First</code></a></pre>
1420 This signal gets emitted when a cell starts to be edited.
1421 The intended use of this signal is to do special setup
1422 on <em class="parameter"><code>editable</code></em>, e.g. adding a <a class="link" href="GtkEntryCompletion.html" title="GtkEntryCompletion"><span class="type">GtkEntryCompletion</span></a> or setting
1423 up additional columns in a <a class="link" href="GtkComboBox.html" title="GtkComboBox"><span class="type">GtkComboBox</span></a>.
1426 Note that GTK+ doesn't guarantee that cell renderers will
1427 continue to use the same kind of widget for editing in future
1428 releases, therefore you should check the type of <em class="parameter"><code>editable</code></em>
1429 before doing any specific setup, as in the following example:
1431 <div class="informalexample">
1432 <table class="listing_frame" border="0" cellpadding="0" cellspacing="0">
1435 <td class="listing_lines" align="right"><pre>1
1450 <td class="listing_code"><pre class="programlisting"><span class="keyword">static</span><span class="normal"> </span><span class="type">void</span>
1451 <span class="function">text_editing_started</span><span class="normal"> </span><span class="symbol">(</span><span class="usertype">GtkCellRenderer</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">cell</span><span class="symbol">,</span>
1452 <span class="normal"> </span><span class="usertype">GtkCellEditable</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">editable</span><span class="symbol">,</span>
1453 <span class="normal"> </span><span class="keyword">const</span><span class="normal"> </span><span class="usertype">gchar</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">path</span><span class="symbol">,</span>
1454 <span class="normal"> </span><span class="usertype">gpointer</span><span class="normal"> data</span><span class="symbol">)</span>
1455 <span class="cbracket">{</span>
1456 <span class="normal"> </span><span class="keyword">if</span><span class="normal"> </span><span class="symbol">(</span><span class="function">GTK_IS_ENTRY</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">editable</span><span class="symbol">))</span><span class="normal"> </span>
1457 <span class="normal"> </span><span class="cbracket">{</span>
1458 <span class="normal"> </span><span class="usertype">GtkEntry</span><span class="normal"> </span><span class="symbol">*</span><span class="normal">entry </span><span class="symbol">=</span><span class="normal"> </span><span class="function">GTK_ENTRY</span><span class="normal"> </span><span class="symbol">(</span><span class="normal">editable</span><span class="symbol">);</span>
1459 <span class="normal"> </span>
1460 <span class="normal"> </span><span class="comment">/* ... create a GtkEntryCompletion */</span>
1461 <span class="normal"> </span>
1462 <span class="normal"> </span><span class="function"><a href="GtkEntry.html#gtk-entry-set-completion">gtk_entry_set_completion</a></span><span class="normal"> </span><span class="symbol">(</span><span class="normal">entry</span><span class="symbol">,</span><span class="normal"> completion</span><span class="symbol">);</span>
1463 <span class="normal"> </span><span class="cbracket">}</span>
1464 <span class="cbracket">}</span></pre></td>
1472 <div class="variablelist"><table border="0">
1473 <col align="left" valign="top">
1476 <td><p><span class="term"><em class="parameter"><code>renderer</code></em> :</span></p></td>
1477 <td>the object which received the signal</td>
1480 <td><p><span class="term"><em class="parameter"><code>editable</code></em> :</span></p></td>
1481 <td>the <a class="link" href="GtkCellEditable.html" title="GtkCellEditable"><span class="type">GtkCellEditable</span></a>
1485 <td><p><span class="term"><em class="parameter"><code>path</code></em> :</span></p></td>
1486 <td>the path identifying the edited cell</td>
1489 <td><p><span class="term"><em class="parameter"><code>user_data</code></em> :</span></p></td>
1490 <td>user data set when the signal handler was connected.</td>
1494 <p class="since">Since 2.6</p>
1497 <div class="refsect1">
1498 <a name="GtkCellRenderer.see-also"></a><h2>See Also</h2>
1499 <a class="link" href="GtkCellRendererText.html" title="GtkCellRendererText"><span class="type">GtkCellRendererText</span></a>, <a class="link" href="GtkCellRendererPixbuf.html" title="GtkCellRendererPixbuf"><span class="type">GtkCellRendererPixbuf</span></a>, <a class="link" href="GtkCellRendererToggle.html" title="GtkCellRendererToggle"><span class="type">GtkCellRendererToggle</span></a>
1502 <div class="footer">
1504 Generated by GTK-Doc V1.18</div>