← 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/xml/gtkcellrendererpixbuf.xml

  • Committer: Bazaar Package Importer
  • Author(s): Sebastien Bacher
  • Date: 2007-05-04 12:24:25 UTC
  • mfrom: (1.1.21 upstream)
  • Revision ID: james.westby@ubuntu.com-20070504122425-0m8midgzrp40y8w2
Tags: 2.10.12-1ubuntu1
* Sync with Debian
* New upstream version:
  Fixed bugs:
  - 379414 file chooser warnings when changing path in the entry
  - 418585 GtkFileChooserDefault sizing code is not DPI independent
  - 419568 Crash in search if start with special letter
  - 435062 build dies with icon cache validation
  - 379399 Segfault to call gtk_print_operation_run twice.
  - 387889 cups backend has problems when there are too many printers
  - 418531 invalid read to gtkicontheme.c gtk_icon_theme_lookup_icon...
  - 423916 crash in color scheme code
  - 424042 Segmentation fault while quickly pressing Alt+arrows
  - 415260 Protect against negative indices when setting values in G...
  - 419171 XGetVisualInfo() may not set nxvisuals
  - 128852 Gdk cursors don't look good on win32
  - 344657 Ctrl-H doesn't toggle "Show Hidden Files" setting
  - 345345 PrintOperation::paginate is not emitted for class handler
  - 347567 GtkPrintOperation::end-print is not emitted if it's cance...
  - 369112 gtk_ui_manager_add_ui should accept unnamed separator
  - 392015 Selected menu item invisible on Windows Vista
  - 399253 MS-Windows Theme Bottom Tab placement rendering glitches
  - 399425 gtk_input_dialog_fill_axes() adds child to gtkscrolledwin...
  - 403251 [patch] little memory leak in GtkPrintJob
  - 403267 [patch] memory leak in GtkPageSetupUnixDialog
  - 403470 MS-Windows Theme tab placement other than on top leaks a ...
  - 404506 Windows system fonts that have multi-byte font names cann...
  - 405089 Incorrect window placement for GtkEventBox private window
  - 405515 Minor leak in gtkfilesystemmodel.c
  - 405539 gdk_pixbuf_save() for PNG saver can return FALSE without ...
  - 415681 gdk_window_clear_area includes an extra line and column o...
  - 418219 GtkRecentChooser should apply filter before sorting and c...
  - 418403 Scroll to printer after selecting it from settings
  - 421985 _gtk_print_operation_platform_backend_launch_preview
  - 421990 gtk_print_job_get_surface
  - 421993 gtk_print_operation_init
  - 423064 Conditional jump or move depends on uninitialised value(s...
  - 423722 Fix printing header in gtk-demo
  - 424168 gtk_print_operation_run on async preview
  - 425655 Don't install gtk+-unix-print-2.0.pc on non-UNIX platforms
  - 425786 GDK segfaults if XineramaQueryScreens fails
  - 428665 Lpr Backend gets stuck in infinite loop during gtk_enumer...
  - 429902 GtkPrintOperation leaks cairo contextes
  - 431997 First delay of GdkPixbufAnimationIter is wrong
  - 433242 Inconsistent scroll arrow position calculations
  - 433972 Placing gtk.Expander inside a gtk.TextView() changes gtk....
  - 434261 _gtk_toolbar_elide_underscores incorrectly handles some s...
  - 383354 ctrl-L should make 'Location' entry disappear
  - 418673 gtk_recent_manager_add_item
  - 429732 gtk_accel_group_finalize accesses invalid memory
  - 435028 WM_CLIENT_LEADER is wrong on the leader_window
  - 431067 Background of the header window is not updated
  - 338843 add recent files support inside the ui manager
  - 148535 add drop shadow to menus, tooltips, etc. under Windows XP
* debian/control.in:
  - Conflicts on ubuntulooks (<= 0.9.11-1)
* debian/patches/15_default-fallback-icon-theme.patch:
  - patch from Debian, fallback on gnome icon theme

Show diffs side-by-side

added added

removed removed

Lines of Context:
docs/reference/gtk/xml/gtkcellrendererpixbuf.xml
 
1
<refentry id="GtkCellRendererPixbuf">
 
2
<refmeta>
 
3
<refentrytitle role="top_of_page">GtkCellRendererPixbuf</refentrytitle>
 
4
<manvolnum>3</manvolnum>
 
5
<refmiscinfo>GTK Library</refmiscinfo>
 
6
</refmeta>
 
7
 
 
8
<refnamediv>
 
9
<refname>GtkCellRendererPixbuf</refname>
 
10
<refpurpose>Renders a pixbuf in a cell</refpurpose>
 
11
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
 
12
</refnamediv>
 
13
 
 
14
<refsynopsisdiv role="synopsis">
 
15
<title role="synopsis.title">Synopsis</title>
 
16
 
 
17
<synopsis>
 
18
 
 
19
#include &lt;gtk/gtk.h&gt;
 
20
 
 
21
 
 
22
                    <link linkend="GtkCellRendererPixbuf-struct">GtkCellRendererPixbuf</link>;
 
23
<link linkend="GtkCellRenderer">GtkCellRenderer</link>*    <link linkend="gtk-cell-renderer-pixbuf-new">gtk_cell_renderer_pixbuf_new</link>        (void);
 
24
 
 
25
 
 
26
</synopsis>
 
27
</refsynopsisdiv>
 
28
 
 
29
<refsect1 role="object_hierarchy">
 
30
<title role="object_hierarchy.title">Object Hierarchy</title>
 
31
<synopsis>
 
32
 
 
33
  <link linkend="GObject">GObject</link>
 
34
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
 
35
         +----<link linkend="GtkObject">GtkObject</link>
 
36
               +----<link linkend="GtkCellRenderer">GtkCellRenderer</link>
 
37
                     +----GtkCellRendererPixbuf
 
38
</synopsis>
 
39
 
 
40
</refsect1>
 
41
 
 
42
 
 
43
 
 
44
 
 
45
 
 
46
<refsect1 role="properties">
 
47
<title role="properties.title">Properties</title>
 
48
<synopsis>
 
49
 
 
50
  &quot;<link linkend="GtkCellRendererPixbuf--follow-state">follow-state</link>&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write
 
51
  &quot;<link linkend="GtkCellRendererPixbuf--icon-name">icon-name</link>&quot;                <link linkend="gchararray">gchararray</link>            : Read / Write
 
52
  &quot;<link linkend="GtkCellRendererPixbuf--pixbuf">pixbuf</link>&quot;                   <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write
 
53
  &quot;<link linkend="GtkCellRendererPixbuf--pixbuf-expander-closed">pixbuf-expander-closed</link>&quot;   <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write
 
54
  &quot;<link linkend="GtkCellRendererPixbuf--pixbuf-expander-open">pixbuf-expander-open</link>&quot;     <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write
 
55
  &quot;<link linkend="GtkCellRendererPixbuf--stock-detail">stock-detail</link>&quot;             <link linkend="gchararray">gchararray</link>            : Read / Write
 
56
  &quot;<link linkend="GtkCellRendererPixbuf--stock-id">stock-id</link>&quot;                 <link linkend="gchararray">gchararray</link>            : Read / Write
 
57
  &quot;<link linkend="GtkCellRendererPixbuf--stock-size">stock-size</link>&quot;               <link linkend="guint">guint</link>                 : Read / Write
 
58
</synopsis>
 
59
</refsect1>
 
60
 
 
61
 
 
62
 
 
63
<refsect1 role="desc">
 
64
<title role="desc.title">Description</title>
 
65
<para>
 
66
A <link linkend="GtkCellRendererPixbuf"><type>GtkCellRendererPixbuf</type></link> can be used to render an image in a cell. It allows to render 
 
67
either a given <link linkend="GdkPixbuf"><type>GdkPixbuf</type></link> (set via the 
 
68
<link linkend="GtkCellRendererPixbuf--pixbuf">pixbuf</link> property) or a stock icon 
 
69
(set via the <link linkend="GtkCellRendererPixbuf--stock-id">stock-id</link> property).
 
70
</para>
 
71
 
 
72
<para>
 
73
To support the tree view, <link linkend="GtkCellRendererPixbuf"><type>GtkCellRendererPixbuf</type></link> also supports rendering two alternative 
 
74
pixbufs, when the <link linkend="GtkCellRenderer--is-expander">is-expander</link> property 
 
75
is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>. If the <link linkend="GtkCellRenderer--is-expanded">is-expanded</link> property 
 
76
is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> and the 
 
77
<link linkend="GtkCellRendererPixbuf--pixbuf-expander-open">pixbuf-expander-open</link> 
 
78
property is set to a pixbuf, it renders that pixbuf, if the 
 
79
<link linkend="GtkCellRenderer--is-expanded">is-expanded</link> property is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> and
 
80
the 
 
81
<link linkend="GtkCellRendererPixbuf--pixbuf-expander-closed">pixbuf-expander-closed</link> 
 
82
property is set to a pixbuf, it renders that one. 
 
83
</para>
 
84
</refsect1>
 
85
 
 
86
<refsect1 role="details">
 
87
<title role="details.title">Details</title>
 
88
<refsect2>
 
89
<title><anchor id="GtkCellRendererPixbuf-struct" role="struct"/>GtkCellRendererPixbuf</title>
 
90
<indexterm><primary>GtkCellRendererPixbuf</primary></indexterm><programlisting>typedef struct _GtkCellRendererPixbuf GtkCellRendererPixbuf;</programlisting>
 
91
<para>
 
92
 
 
93
</para></refsect2>
 
94
<refsect2>
 
95
<title><anchor id="gtk-cell-renderer-pixbuf-new" role="function"/>gtk_cell_renderer_pixbuf_new ()</title>
 
96
<indexterm><primary>gtk_cell_renderer_pixbuf_new</primary></indexterm><programlisting><link linkend="GtkCellRenderer">GtkCellRenderer</link>*    gtk_cell_renderer_pixbuf_new        (void);</programlisting>
 
97
<para>
 
98
Creates a new <link linkend="GtkCellRendererPixbuf"><type>GtkCellRendererPixbuf</type></link>. Adjust rendering
 
99
parameters using object properties. Object properties can be set
 
100
globally (with <link linkend="g-object-set"><function>g_object_set()</function></link>). Also, with <link linkend="GtkTreeViewColumn"><type>GtkTreeViewColumn</type></link>, you
 
101
can bind a property to a value in a <link linkend="GtkTreeModel"><type>GtkTreeModel</type></link>. For example, you
 
102
can bind the "pixbuf" property on the cell renderer to a pixbuf value
 
103
in the model, thus rendering a different image in each row of the
 
104
<link linkend="GtkTreeView"><type>GtkTreeView</type></link>.</para>
 
105
<para>
 
106
 
 
107
</para><variablelist role="params">
 
108
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> the new cell renderer
 
109
</simpara></listitem></varlistentry>
 
110
</variablelist></refsect2>
 
111
 
 
112
</refsect1>
 
113
<refsect1 role="property_details">
 
114
<title role="property_details.title">Property Details</title>
 
115
<refsect2><title><anchor id="GtkCellRendererPixbuf--follow-state"/>The &quot;<literal>follow-state</literal>&quot; property</title>
 
116
<indexterm role="2.8"><primary>GtkCellRendererPixbuf:follow-state</primary></indexterm><programlisting>  &quot;follow-state&quot;             <link linkend="gboolean">gboolean</link>              : Read / Write</programlisting>
 
117
<para>
 
118
Specifies whether the rendered pixbuf should be colorized
 
119
according to the <link linkend="GtkCellRendererState"><type>GtkCellRendererState</type></link>.</para>
 
120
<para>
 
121
 
 
122
</para><para>Default value: FALSE</para>
 
123
<para>Since  2.8
 
124
</para>
 
125
</refsect2>
 
126
<refsect2><title><anchor id="GtkCellRendererPixbuf--icon-name"/>The &quot;<literal>icon-name</literal>&quot; property</title>
 
127
<indexterm role="2.8"><primary>GtkCellRendererPixbuf:icon-name</primary></indexterm><programlisting>  &quot;icon-name&quot;                <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
 
128
<para>
 
129
The name of the themed icon to display.
 
130
This property only has an effect if not overridden by "stock_id" 
 
131
or "pixbuf" properties.</para>
 
132
<para>
 
133
 
 
134
</para><para>Default value: NULL</para>
 
135
<para>Since  2.8 
 
136
</para>
 
137
</refsect2>
 
138
<refsect2><title><anchor id="GtkCellRendererPixbuf--pixbuf"/>The &quot;<literal>pixbuf</literal>&quot; property</title>
 
139
<indexterm><primary>GtkCellRendererPixbuf:pixbuf</primary></indexterm><programlisting>  &quot;pixbuf&quot;                   <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write</programlisting>
 
140
<para>The pixbuf to render.</para></refsect2>
 
141
<refsect2><title><anchor id="GtkCellRendererPixbuf--pixbuf-expander-closed"/>The &quot;<literal>pixbuf-expander-closed</literal>&quot; property</title>
 
142
<indexterm><primary>GtkCellRendererPixbuf:pixbuf-expander-closed</primary></indexterm><programlisting>  &quot;pixbuf-expander-closed&quot;   <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write</programlisting>
 
143
<para>Pixbuf for closed expander.</para></refsect2>
 
144
<refsect2><title><anchor id="GtkCellRendererPixbuf--pixbuf-expander-open"/>The &quot;<literal>pixbuf-expander-open</literal>&quot; property</title>
 
145
<indexterm><primary>GtkCellRendererPixbuf:pixbuf-expander-open</primary></indexterm><programlisting>  &quot;pixbuf-expander-open&quot;     <link linkend="GdkPixbuf">GdkPixbuf</link>             : Read / Write</programlisting>
 
146
<para>Pixbuf for open expander.</para></refsect2>
 
147
<refsect2><title><anchor id="GtkCellRendererPixbuf--stock-detail"/>The &quot;<literal>stock-detail</literal>&quot; property</title>
 
148
<indexterm><primary>GtkCellRendererPixbuf:stock-detail</primary></indexterm><programlisting>  &quot;stock-detail&quot;             <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
 
149
<para>Render detail to pass to the theme engine.</para><para>Default value: NULL</para>
 
150
</refsect2>
 
151
<refsect2><title><anchor id="GtkCellRendererPixbuf--stock-id"/>The &quot;<literal>stock-id</literal>&quot; property</title>
 
152
<indexterm><primary>GtkCellRendererPixbuf:stock-id</primary></indexterm><programlisting>  &quot;stock-id&quot;                 <link linkend="gchararray">gchararray</link>            : Read / Write</programlisting>
 
153
<para>The stock ID of the stock icon to render.</para><para>Default value: NULL</para>
 
154
</refsect2>
 
155
<refsect2><title><anchor id="GtkCellRendererPixbuf--stock-size"/>The &quot;<literal>stock-size</literal>&quot; property</title>
 
156
<indexterm><primary>GtkCellRendererPixbuf:stock-size</primary></indexterm><programlisting>  &quot;stock-size&quot;               <link linkend="guint">guint</link>                 : Read / Write</programlisting>
 
157
<para>The GtkIconSize value that specifies the size of the rendered icon.</para><para>Default value: 1</para>
 
158
</refsect2>
 
159
 
 
160
</refsect1>
 
161
 
 
162
 
 
163
 
 
164
 
 
165
</refentry>