1
<refentry id="GtkCellView">
3
<refentrytitle role="top_of_page">GtkCellView</refentrytitle>
4
<manvolnum>3</manvolnum>
5
<refmiscinfo>GTK Library</refmiscinfo>
9
<refname>GtkCellView</refname>
10
<refpurpose>A widget displaying a single row of a GtkTreeModel</refpurpose>
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
14
<refsynopsisdiv role="synopsis">
15
<title role="synopsis.title">Synopsis</title>
19
#include <gtk/gtk.h>
22
<link linkend="GtkCellView-struct">GtkCellView</link>;
23
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-cell-view-new">gtk_cell_view_new</link> (void);
24
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-cell-view-new-with-text">gtk_cell_view_new_with_text</link> (const <link linkend="gchar">gchar</link> *text);
25
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-cell-view-new-with-markup">gtk_cell_view_new_with_markup</link> (const <link linkend="gchar">gchar</link> *markup);
26
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gtk-cell-view-new-with-pixbuf">gtk_cell_view_new_with_pixbuf</link> (<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);
27
<link linkend="void">void</link> <link linkend="gtk-cell-view-set-model">gtk_cell_view_set_model</link> (<link linkend="GtkCellView">GtkCellView</link> *cell_view,
28
<link linkend="GtkTreeModel">GtkTreeModel</link> *model);
29
<link linkend="void">void</link> <link linkend="gtk-cell-view-set-displayed-row">gtk_cell_view_set_displayed_row</link> (<link linkend="GtkCellView">GtkCellView</link> *cell_view,
30
<link linkend="GtkTreePath">GtkTreePath</link> *path);
31
<link linkend="GtkTreePath">GtkTreePath</link>* <link linkend="gtk-cell-view-get-displayed-row">gtk_cell_view_get_displayed_row</link> (<link linkend="GtkCellView">GtkCellView</link> *cell_view);
32
<link linkend="gboolean">gboolean</link> <link linkend="gtk-cell-view-get-size-of-row">gtk_cell_view_get_size_of_row</link> (<link linkend="GtkCellView">GtkCellView</link> *cell_view,
33
<link linkend="GtkTreePath">GtkTreePath</link> *path,
34
<link linkend="GtkRequisition">GtkRequisition</link> *requisition);
35
<link linkend="void">void</link> <link linkend="gtk-cell-view-set-background-color">gtk_cell_view_set_background_color</link> (<link linkend="GtkCellView">GtkCellView</link> *cell_view,
36
const <link linkend="GdkColor">GdkColor</link> *color);
37
<link linkend="GList">GList</link>* <link linkend="gtk-cell-view-get-cell-renderers">gtk_cell_view_get_cell_renderers</link> (<link linkend="GtkCellView">GtkCellView</link> *cell_view);
43
<refsect1 role="object_hierarchy">
44
<title role="object_hierarchy.title">Object Hierarchy</title>
47
<link linkend="GObject">GObject</link>
48
+----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
49
+----<link linkend="GtkObject">GtkObject</link>
50
+----<link linkend="GtkWidget">GtkWidget</link>
58
<refsect1 role="impl_interfaces">
59
<title role="impl_interfaces.title">Implemented Interfaces</title>
61
GtkCellView implements
62
<link linkend="AtkImplementorIface">AtkImplementorIface</link> and <link linkend="GtkCellLayout">GtkCellLayout</link>.</para>
67
<refsect1 role="properties">
68
<title role="properties.title">Properties</title>
71
"<link linkend="GtkCellView--background">background</link>" <link linkend="gchararray">gchararray</link> : Write
72
"<link linkend="GtkCellView--background-gdk">background-gdk</link>" <link linkend="GdkColor">GdkColor</link> : Read / Write
73
"<link linkend="GtkCellView--background-set">background-set</link>" <link linkend="gboolean">gboolean</link> : Read / Write
74
"<link linkend="GtkCellView--model">model</link>" <link linkend="GtkTreeModel">GtkTreeModel</link> : Read / Write
80
<refsect1 role="desc">
81
<title role="desc.title">Description</title>
83
A <link linkend="GtkCellView"><type>GtkCellView</type></link> displays a single row of a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link>, using
84
cell renderers just like <link linkend="GtkTreeView"><type>GtkTreeView</type></link>. <link linkend="GtkCellView"><type>GtkCellView</type></link> doesn't support
85
some of the more complex features of <link linkend="GtkTreeView"><type>GtkTreeView</type></link>, like cell editing
90
<refsect1 role="details">
91
<title role="details.title">Details</title>
93
<title><anchor id="GtkCellView-struct" role="struct"/>GtkCellView</title>
94
<indexterm><primary>GtkCellView</primary></indexterm><programlisting>typedef struct _GtkCellView GtkCellView;</programlisting>
99
<title><anchor id="gtk-cell-view-new" role="function" condition="since:2.6"/>gtk_cell_view_new ()</title>
100
<indexterm role="2.6"><primary>gtk_cell_view_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_cell_view_new (void);</programlisting>
102
Creates a new <link linkend="GtkCellView"><type>GtkCellView</type></link> widget.</para>
105
</para><variablelist role="params">
106
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly created <link linkend="GtkCellView"><type>GtkCellView</type></link> widget.
108
</simpara></listitem></varlistentry>
109
</variablelist><para role="since">Since 2.6
112
<title><anchor id="gtk-cell-view-new-with-text" role="function" condition="since:2.6"/>gtk_cell_view_new_with_text ()</title>
113
<indexterm role="2.6"><primary>gtk_cell_view_new_with_text</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_cell_view_new_with_text (const <link linkend="gchar">gchar</link> *text);</programlisting>
115
Creates a new <link linkend="GtkCellView"><type>GtkCellView</type></link> widget, adds a <link linkend="GtkCellRendererText"><type>GtkCellRendererText</type></link>
116
to it, and makes its show <parameter>text</parameter>.</para>
119
</para><variablelist role="params">
120
<varlistentry><term><parameter>text</parameter> :</term>
121
<listitem><simpara> the text to display in the cell view
122
</simpara></listitem></varlistentry>
123
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly created <link linkend="GtkCellView"><type>GtkCellView</type></link> widget.
125
</simpara></listitem></varlistentry>
126
</variablelist><para role="since">Since 2.6
129
<title><anchor id="gtk-cell-view-new-with-markup" role="function" condition="since:2.6"/>gtk_cell_view_new_with_markup ()</title>
130
<indexterm role="2.6"><primary>gtk_cell_view_new_with_markup</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_cell_view_new_with_markup (const <link linkend="gchar">gchar</link> *markup);</programlisting>
132
Creates a new <link linkend="GtkCellView"><type>GtkCellView</type></link> widget, adds a <link linkend="GtkCellRendererText"><type>GtkCellRendererText</type></link>
133
to it, and makes its show <parameter>markup</parameter>. The text can text can be
134
marked up with the <link linkend="PangoMarkupFormat">Pango text
135
markup language</link>.</para>
138
</para><variablelist role="params">
139
<varlistentry><term><parameter>markup</parameter> :</term>
140
<listitem><simpara> the text to display in the cell view
141
</simpara></listitem></varlistentry>
142
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly created <link linkend="GtkCellView"><type>GtkCellView</type></link> widget.
144
</simpara></listitem></varlistentry>
145
</variablelist><para role="since">Since 2.6
148
<title><anchor id="gtk-cell-view-new-with-pixbuf" role="function" condition="since:2.6"/>gtk_cell_view_new_with_pixbuf ()</title>
149
<indexterm role="2.6"><primary>gtk_cell_view_new_with_pixbuf</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gtk_cell_view_new_with_pixbuf (<link linkend="GdkPixbuf">GdkPixbuf</link> *pixbuf);</programlisting>
151
Creates a new <link linkend="GtkCellView"><type>GtkCellView</type></link> widget, adds a <link linkend="GtkCellRendererPixbuf"><type>GtkCellRendererPixbuf</type></link>
152
to it, and makes its show <parameter>pixbuf</parameter>.</para>
155
</para><variablelist role="params">
156
<varlistentry><term><parameter>pixbuf</parameter> :</term>
157
<listitem><simpara> the image to display in the cell view
158
</simpara></listitem></varlistentry>
159
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> A newly created <link linkend="GtkCellView"><type>GtkCellView</type></link> widget.
161
</simpara></listitem></varlistentry>
162
</variablelist><para role="since">Since 2.6
165
<title><anchor id="gtk-cell-view-set-model" role="function" condition="since:2.6"/>gtk_cell_view_set_model ()</title>
166
<indexterm role="2.6"><primary>gtk_cell_view_set_model</primary></indexterm><programlisting><link linkend="void">void</link> gtk_cell_view_set_model (<link linkend="GtkCellView">GtkCellView</link> *cell_view,
167
<link linkend="GtkTreeModel">GtkTreeModel</link> *model);</programlisting>
169
Sets the model for <parameter>cell_view</parameter>. If <parameter>cell_view</parameter> already has a model
170
set, it will remove it before setting the new model. If <parameter>model</parameter> is
171
<link linkend="NULL:CAPS"><literal>NULL</literal></link>, then it will unset the old model.</para>
174
</para><variablelist role="params">
175
<varlistentry><term><parameter>cell_view</parameter> :</term>
176
<listitem><simpara> a <link linkend="GtkCellView"><type>GtkCellView</type></link>
177
</simpara></listitem></varlistentry>
178
<varlistentry><term><parameter>model</parameter> :</term>
179
<listitem><simpara> a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link>
180
</simpara></listitem></varlistentry>
181
</variablelist><para role="since">Since 2.6
184
<title><anchor id="gtk-cell-view-set-displayed-row" role="function" condition="since:2.6"/>gtk_cell_view_set_displayed_row ()</title>
185
<indexterm role="2.6"><primary>gtk_cell_view_set_displayed_row</primary></indexterm><programlisting><link linkend="void">void</link> gtk_cell_view_set_displayed_row (<link linkend="GtkCellView">GtkCellView</link> *cell_view,
186
<link linkend="GtkTreePath">GtkTreePath</link> *path);</programlisting>
188
Sets the row of the model that is currently displayed
189
by the <link linkend="GtkCellView"><type>GtkCellView</type></link>. If the path is unset, then the
190
contents of the cellview "stick" at their last value;
191
this is not normally a desired result, but may be
192
a needed intermediate state if say, the model for
193
the <link linkend="GtkCellView"><type>GtkCellView</type></link> becomes temporarily empty.</para>
196
</para><variablelist role="params">
197
<varlistentry><term><parameter>cell_view</parameter> :</term>
198
<listitem><simpara> a <link linkend="GtkCellView"><type>GtkCellView</type></link>
199
</simpara></listitem></varlistentry>
200
<varlistentry><term><parameter>path</parameter> :</term>
201
<listitem><simpara> a <link linkend="GtkTreePath"><type>GtkTreePath</type></link> or <link linkend="NULL:CAPS"><literal>NULL</literal></link> to unset.
202
</simpara></listitem></varlistentry>
203
</variablelist><para role="since">Since 2.6
206
<title><anchor id="gtk-cell-view-get-displayed-row" role="function" condition="since:2.6"/>gtk_cell_view_get_displayed_row ()</title>
207
<indexterm role="2.6"><primary>gtk_cell_view_get_displayed_row</primary></indexterm><programlisting><link linkend="GtkTreePath">GtkTreePath</link>* gtk_cell_view_get_displayed_row (<link linkend="GtkCellView">GtkCellView</link> *cell_view);</programlisting>
209
Returns a <link linkend="GtkTreePath"><type>GtkTreePath</type></link> referring to the currently
210
displayed row. If no row is currently displayed,
211
<link linkend="NULL:CAPS"><literal>NULL</literal></link> is returned.</para>
214
</para><variablelist role="params">
215
<varlistentry><term><parameter>cell_view</parameter> :</term>
216
<listitem><simpara> a <link linkend="GtkCellView"><type>GtkCellView</type></link>
217
</simpara></listitem></varlistentry>
218
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the currently displayed row or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
220
</simpara></listitem></varlistentry>
221
</variablelist><para role="since">Since 2.6
224
<title><anchor id="gtk-cell-view-get-size-of-row" role="function" condition="since:2.6"/>gtk_cell_view_get_size_of_row ()</title>
225
<indexterm role="2.6"><primary>gtk_cell_view_get_size_of_row</primary></indexterm><programlisting><link linkend="gboolean">gboolean</link> gtk_cell_view_get_size_of_row (<link linkend="GtkCellView">GtkCellView</link> *cell_view,
226
<link linkend="GtkTreePath">GtkTreePath</link> *path,
227
<link linkend="GtkRequisition">GtkRequisition</link> *requisition);</programlisting>
229
Sets <parameter>requisition</parameter> to the size needed by <parameter>cell_view</parameter> to display
230
the model row pointed to by <parameter>path</parameter>.</para>
233
</para><variablelist role="params">
234
<varlistentry><term><parameter>cell_view</parameter> :</term>
235
<listitem><simpara> a <link linkend="GtkCellView"><type>GtkCellView</type></link>
236
</simpara></listitem></varlistentry>
237
<varlistentry><term><parameter>path</parameter> :</term>
238
<listitem><simpara> a <link linkend="GtkTreePath"><type>GtkTreePath</type></link>
239
</simpara></listitem></varlistentry>
240
<varlistentry><term><parameter>requisition</parameter> :</term>
241
<listitem><simpara> return location for the size
242
</simpara></listitem></varlistentry>
243
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>
245
</simpara></listitem></varlistentry>
246
</variablelist><para role="since">Since 2.6
249
<title><anchor id="gtk-cell-view-set-background-color" role="function" condition="since:2.6"/>gtk_cell_view_set_background_color ()</title>
250
<indexterm role="2.6"><primary>gtk_cell_view_set_background_color</primary></indexterm><programlisting><link linkend="void">void</link> gtk_cell_view_set_background_color (<link linkend="GtkCellView">GtkCellView</link> *cell_view,
251
const <link linkend="GdkColor">GdkColor</link> *color);</programlisting>
253
Sets the background color of <parameter>view</parameter>.</para>
256
</para><variablelist role="params">
257
<varlistentry><term><parameter>cell_view</parameter> :</term>
258
<listitem><simpara> a <link linkend="GtkCellView"><type>GtkCellView</type></link>
259
</simpara></listitem></varlistentry>
260
<varlistentry><term><parameter>color</parameter> :</term>
261
<listitem><simpara> the new background color
262
</simpara></listitem></varlistentry>
263
</variablelist><para role="since">Since 2.6
266
<title><anchor id="gtk-cell-view-get-cell-renderers" role="function" condition="since:2.6"/>gtk_cell_view_get_cell_renderers ()</title>
267
<indexterm role="2.6"><primary>gtk_cell_view_get_cell_renderers</primary></indexterm><programlisting><link linkend="GList">GList</link>* gtk_cell_view_get_cell_renderers (<link linkend="GtkCellView">GtkCellView</link> *cell_view);</programlisting>
269
Returns the cell renderers which have been added to <parameter>cell_view</parameter>.</para>
272
</para><variablelist role="params">
273
<varlistentry><term><parameter>cell_view</parameter> :</term>
274
<listitem><simpara> a <link linkend="GtkCellView"><type>GtkCellView</type></link>
275
</simpara></listitem></varlistentry>
276
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> a list of cell renderers. The list, but not the
277
renderers has been newly allocated and should be freed with
278
<link linkend="g-list-free"><function>g_list_free()</function></link> when no longer needed.
280
</simpara></listitem></varlistentry>
281
</variablelist><para role="since">Since 2.6
285
<refsect1 role="property_details">
286
<title role="property_details.title">Property Details</title>
287
<refsect2><title><anchor id="GtkCellView--background"/>The "<literal>background</literal>" property</title>
288
<indexterm><primary>GtkCellView:background</primary></indexterm><programlisting> "background" <link linkend="gchararray">gchararray</link> : Write</programlisting>
289
<para>Background color as a string.</para><para>Default value: NULL</para>
291
<refsect2><title><anchor id="GtkCellView--background-gdk"/>The "<literal>background-gdk</literal>" property</title>
292
<indexterm><primary>GtkCellView:background-gdk</primary></indexterm><programlisting> "background-gdk" <link linkend="GdkColor">GdkColor</link> : Read / Write</programlisting>
293
<para>Background color as a GdkColor.</para></refsect2>
294
<refsect2><title><anchor id="GtkCellView--background-set"/>The "<literal>background-set</literal>" property</title>
295
<indexterm><primary>GtkCellView:background-set</primary></indexterm><programlisting> "background-set" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
296
<para>Whether this tag affects the background color.</para><para>Default value: FALSE</para>
298
<refsect2><title><anchor id="GtkCellView--model"/>The "<literal>model</literal>" property</title>
299
<indexterm><primary>GtkCellView:model</primary></indexterm><programlisting> "model" <link linkend="GtkTreeModel">GtkTreeModel</link> : Read / Write</programlisting>
301
The model for cell view