← Back to branch summary

~canonical-dx-team/ubuntu/maverick/gtk+2.0/menuproxy

« back to all changes in this revision

Viewing changes to docs/reference/gtk/html/GtkCellRendererPixbuf.html

  • Committer: Bazaar Package Importer
  • Author(s): Sebastian Dröge
  • Date: 2010-06-11 12:19:30 UTC
  • mfrom: (1.11.6 upstream)
  • mto: This revision was merged to the branch mainline in revision 175.
  • Revision ID: james.westby@ubuntu.com-20100611121930-n4pklvkoqdsg12vm
Tags: 2.21.2-1
* New upstream development release:
  + debian/rules,
    debian/libgtk2.0-0.symbols:
    - Update for new API symbols.
  + debian/patches/070_mandatory-relibtoolize.patch:
    - Regenerated for the new version.
  + debian/control.in:
    - Update GLib (build-) dependency to >= 2.25.8.

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/html/GtkCellRendererPixbuf.html
51
51
<div class="refsect1" title="Object Hierarchy">
52
52
<a name="GtkCellRendererPixbuf.object-hierarchy"></a><h2>Object Hierarchy</h2>
53
53
<pre class="synopsis">
54
 
  <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GObject">GObject</a>
55
 
   +----<a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
 
54
  <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
 
55
   +----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
56
56
         +----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
57
57
               +----<a class="link" href="GtkCellRenderer.html" title="GtkCellRenderer">GtkCellRenderer</a>
58
58
                     +----GtkCellRendererPixbuf
61
61
<div class="refsect1" title="Properties">
62
62
<a name="GtkCellRendererPixbuf.properties"></a><h2>Properties</h2>
63
63
<pre class="synopsis">
64
 
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--follow-state" title='The "follow-state" property'>follow-state</a>"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
65
 
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--gicon" title='The "gicon" property'>gicon</a>"                    <a href="/usr/share/gtk-doc/html/gio/GIcon.html"><span class="type">GIcon</span></a>*                : Read / Write
66
 
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--icon-name" title='The "icon-name" property'>icon-name</a>"                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
67
 
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--pixbuf" title='The "pixbuf" property'>pixbuf</a>"                   <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write
68
 
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--pixbuf-expander-closed" title='The "pixbuf-expander-closed" property'>pixbuf-expander-closed</a>"   <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write
69
 
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--pixbuf-expander-open" title='The "pixbuf-expander-open" property'>pixbuf-expander-open</a>"     <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write
70
 
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--stock-detail" title='The "stock-detail" property'>stock-detail</a>"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
71
 
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--stock-id" title='The "stock-id" property'>stock-id</a>"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
72
 
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--stock-size" title='The "stock-size" property'>stock-size</a>"               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
 
64
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--follow-state" title='The "follow-state" property'>follow-state</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write
 
65
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--gicon" title='The "gicon" property'>gicon</a>"                    <a href="http://library.gnome.org/devel/gio/unstable/GIcon.html"><span class="type">GIcon</span></a>*                : Read / Write
 
66
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--icon-name" title='The "icon-name" property'>icon-name</a>"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
67
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--pixbuf" title='The "pixbuf" property'>pixbuf</a>"                   <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write
 
68
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--pixbuf-expander-closed" title='The "pixbuf-expander-closed" property'>pixbuf-expander-closed</a>"   <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write
 
69
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--pixbuf-expander-open" title='The "pixbuf-expander-open" property'>pixbuf-expander-open</a>"     <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write
 
70
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--stock-detail" title='The "stock-detail" property'>stock-detail</a>"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
71
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--stock-id" title='The "stock-id" property'>stock-id</a>"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write
 
72
  "<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--stock-size" title='The "stock-size" property'>stock-size</a>"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write
73
73
</pre>
74
74
</div>
75
75
<div class="refsect1" title="Description">
76
76
<a name="GtkCellRendererPixbuf.description"></a><h2>Description</h2>
77
77
<p>
78
78
A <a class="link" href="GtkCellRendererPixbuf.html" title="GtkCellRendererPixbuf"><span class="type">GtkCellRendererPixbuf</span></a> can be used to render an image in a cell. It allows to render
79
 
either a given <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> (set via the
 
79
either a given <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a> (set via the
80
80
<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--pixbuf" title='The "pixbuf" property'>pixbuf</a> property) or a stock icon
81
81
(set via the <a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--stock-id" title='The "stock-id" property'>stock-id</a> property).
82
82
</p>
83
83
<p>
84
84
To support the tree view, <a class="link" href="GtkCellRendererPixbuf.html" title="GtkCellRendererPixbuf"><span class="type">GtkCellRendererPixbuf</span></a> also supports rendering two alternative
85
85
pixbufs, when the <a class="link" href="GtkCellRenderer.html#GtkCellRenderer--is-expander" title='The "is-expander" property'>is-expander</a> property
86
 
is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. If the <a class="link" href="GtkCellRenderer.html#GtkCellRenderer--is-expanded" title='The "is-expanded" property'>is-expanded</a> property
87
 
is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> and the
 
86
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>. If the <a class="link" href="GtkCellRenderer.html#GtkCellRenderer--is-expanded" title='The "is-expanded" property'>is-expanded</a> property
 
87
is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> and the
88
88
<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--pixbuf-expander-open" title='The "pixbuf-expander-open" property'>pixbuf-expander-open</a>
89
89
property is set to a pixbuf, it renders that pixbuf, if the
90
 
<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--is-expanded" title='The "is-expanded" property'>is-expanded</a> property is <a href="/usr/share/gtk-doc/html/glib/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and
 
90
<a class="link" href="GtkCellRenderer.html#GtkCellRenderer--is-expanded" title='The "is-expanded" property'>is-expanded</a> property is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#FALSE:CAPS"><code class="literal">FALSE</code></a> and
91
91
the
92
92
<a class="link" href="GtkCellRendererPixbuf.html#GtkCellRendererPixbuf--pixbuf-expander-closed" title='The "pixbuf-expander-closed" property'>pixbuf-expander-closed</a>
93
93
property is set to a pixbuf, it renders that one.
108
108
<p>
109
109
Creates a new <a class="link" href="GtkCellRendererPixbuf.html" title="GtkCellRendererPixbuf"><span class="type">GtkCellRendererPixbuf</span></a>. Adjust rendering
110
110
parameters using object properties. Object properties can be set
111
 
globally (with <a href="/usr/share/gtk-doc/html/gobject/gobject-The-Base-Object-Type.html#g-object-set"><code class="function">g_object_set()</code></a>). Also, with <a class="link" href="GtkTreeViewColumn.html" title="GtkTreeViewColumn"><span class="type">GtkTreeViewColumn</span></a>, you
 
111
globally (with <a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#g-object-set"><code class="function">g_object_set()</code></a>). Also, with <a class="link" href="GtkTreeViewColumn.html" title="GtkTreeViewColumn"><span class="type">GtkTreeViewColumn</span></a>, you
112
112
can bind a property to a value in a <a class="link" href="GtkTreeModel.html" title="GtkTreeModel"><span class="type">GtkTreeModel</span></a>. For example, you
113
113
can bind the "pixbuf" property on the cell renderer to a pixbuf value
114
114
in the model, thus rendering a different image in each row of the
128
128
<a name="GtkCellRendererPixbuf.property-details"></a><h2>Property Details</h2>
129
129
<div class="refsect2" title='The "follow-state" property'>
130
130
<a name="GtkCellRendererPixbuf--follow-state"></a><h3>The <code class="literal">"follow-state"</code> property</h3>
131
 
<pre class="programlisting">  "follow-state"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
 
131
<pre class="programlisting">  "follow-state"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a>              : Read / Write</pre>
132
132
<p>
133
133
Specifies whether the rendered pixbuf should be colorized
134
134
according to the <a class="link" href="GtkCellRenderer.html#GtkCellRendererState" title="enum GtkCellRendererState"><span class="type">GtkCellRendererState</span></a>.
139
139
<hr>
140
140
<div class="refsect2" title='The "gicon" property'>
141
141
<a name="GtkCellRendererPixbuf--gicon"></a><h3>The <code class="literal">"gicon"</code> property</h3>
142
 
<pre class="programlisting">  "gicon"                    <a href="/usr/share/gtk-doc/html/gio/GIcon.html"><span class="type">GIcon</span></a>*                : Read / Write</pre>
 
142
<pre class="programlisting">  "gicon"                    <a href="http://library.gnome.org/devel/gio/unstable/GIcon.html"><span class="type">GIcon</span></a>*                : Read / Write</pre>
143
143
<p>
144
144
The GIcon representing the icon to display.
145
145
If the icon theme is changed, the image will be updated
150
150
<hr>
151
151
<div class="refsect2" title='The "icon-name" property'>
152
152
<a name="GtkCellRendererPixbuf--icon-name"></a><h3>The <code class="literal">"icon-name"</code> property</h3>
153
 
<pre class="programlisting">  "icon-name"                <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
153
<pre class="programlisting">  "icon-name"                <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
154
154
<p>
155
155
The name of the themed icon to display.
156
156
This property only has an effect if not overridden by "stock_id"
162
162
<hr>
163
163
<div class="refsect2" title='The "pixbuf" property'>
164
164
<a name="GtkCellRendererPixbuf--pixbuf"></a><h3>The <code class="literal">"pixbuf"</code> property</h3>
165
 
<pre class="programlisting">  "pixbuf"                   <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write</pre>
 
165
<pre class="programlisting">  "pixbuf"                   <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write</pre>
166
166
<p>The pixbuf to render.</p>
167
167
</div>
168
168
<hr>
169
169
<div class="refsect2" title='The "pixbuf-expander-closed" property'>
170
170
<a name="GtkCellRendererPixbuf--pixbuf-expander-closed"></a><h3>The <code class="literal">"pixbuf-expander-closed"</code> property</h3>
171
 
<pre class="programlisting">  "pixbuf-expander-closed"   <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write</pre>
 
171
<pre class="programlisting">  "pixbuf-expander-closed"   <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write</pre>
172
172
<p>Pixbuf for closed expander.</p>
173
173
</div>
174
174
<hr>
175
175
<div class="refsect2" title='The "pixbuf-expander-open" property'>
176
176
<a name="GtkCellRendererPixbuf--pixbuf-expander-open"></a><h3>The <code class="literal">"pixbuf-expander-open"</code> property</h3>
177
 
<pre class="programlisting">  "pixbuf-expander-open"     <a href="/usr/share/gtk-doc/html/gdk-pixbuf/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write</pre>
 
177
<pre class="programlisting">  "pixbuf-expander-open"     <a href="http://library.gnome.org/devel/gdk-pixbuf/unstable/gdk-pixbuf-gdk-pixbuf.html#GdkPixbuf"><span class="type">GdkPixbuf</span></a>*            : Read / Write</pre>
178
178
<p>Pixbuf for open expander.</p>
179
179
</div>
180
180
<hr>
181
181
<div class="refsect2" title='The "stock-detail" property'>
182
182
<a name="GtkCellRendererPixbuf--stock-detail"></a><h3>The <code class="literal">"stock-detail"</code> property</h3>
183
 
<pre class="programlisting">  "stock-detail"             <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
183
<pre class="programlisting">  "stock-detail"             <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
184
184
<p>Render detail to pass to the theme engine.</p>
185
185
<p>Default value: NULL</p>
186
186
</div>
187
187
<hr>
188
188
<div class="refsect2" title='The "stock-id" property'>
189
189
<a name="GtkCellRendererPixbuf--stock-id"></a><h3>The <code class="literal">"stock-id"</code> property</h3>
190
 
<pre class="programlisting">  "stock-id"                 <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
 
190
<pre class="programlisting">  "stock-id"                 <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gchar"><span class="type">gchar</span></a>*                : Read / Write</pre>
191
191
<p>The stock ID of the stock icon to render.</p>
192
192
<p>Default value: NULL</p>
193
193
</div>
194
194
<hr>
195
195
<div class="refsect2" title='The "stock-size" property'>
196
196
<a name="GtkCellRendererPixbuf--stock-size"></a><h3>The <code class="literal">"stock-size"</code> property</h3>
197
 
<pre class="programlisting">  "stock-size"               <a href="/usr/share/gtk-doc/html/glib/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
 
197
<pre class="programlisting">  "stock-size"               <a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#guint"><span class="type">guint</span></a>                 : Read / Write</pre>
198
198
<p>The GtkIconSize value that specifies the size of the rendered icon.</p>
199
199
<p>Default value: 1</p>
200
200
</div>