8
8
<link rel="up" href="DeprecatedObjects.html" title="Deprecated">
9
9
<link rel="prev" href="GtkOptionMenu.html" title="GtkOptionMenu">
10
10
<link rel="next" href="GtkPreview.html" title="GtkPreview">
11
<meta name="generator" content="GTK-Doc V1.18.1 (XML mode)">
11
<meta name="generator" content="GTK-Doc V1.18 (XML mode)">
12
12
<link rel="stylesheet" href="style.css" type="text/css">
14
14
<body bgcolor="white" text="black" link="#0000FF" vlink="#840084" alink="#0000FF">
45
45
#include <gtk/gtk.h>
47
47
struct <a class="link" href="GtkPixmap.html#GtkPixmap-struct" title="struct GtkPixmap">GtkPixmap</a>;
48
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkPixmap.html#gtk-pixmap-new" title="gtk_pixmap_new ()">gtk_pixmap_new</a> (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *pixmap</code></em>,
49
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);
48
<a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * <a class="link" href="GtkPixmap.html#gtk-pixmap-new" title="gtk_pixmap_new ()">gtk_pixmap_new</a> (<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *pixmap</code></em>,
49
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);
50
50
<span class="returnvalue">void</span> <a class="link" href="GtkPixmap.html#gtk-pixmap-set" title="gtk_pixmap_set ()">gtk_pixmap_set</a> (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
51
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *val</code></em>,
52
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);
51
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *val</code></em>,
52
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);
53
53
<span class="returnvalue">void</span> <a class="link" href="GtkPixmap.html#gtk-pixmap-get" title="gtk_pixmap_get ()">gtk_pixmap_get</a> (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
54
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> **val</code></em>,
55
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> **mask</code></em>);
54
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> **val</code></em>,
55
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> **mask</code></em>);
56
56
<span class="returnvalue">void</span> <a class="link" href="GtkPixmap.html#gtk-pixmap-set-build-insensitive" title="gtk_pixmap_set_build_insensitive ()">gtk_pixmap_set_build_insensitive</a> (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
57
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> build</code></em>);
57
<em class="parameter"><code><span class="type">gboolean</span> build</code></em>);
60
60
<div class="refsect1">
61
61
<a name="GtkPixmap.object-hierarchy"></a><h2>Object Hierarchy</h2>
62
62
<pre class="synopsis">
63
<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GObject">GObject</a>
64
+----<a href="http://library.gnome.org/devel/gobject/unstable/gobject-The-Base-Object-Type.html#GInitiallyUnowned">GInitiallyUnowned</a>
64
+----GInitiallyUnowned
65
65
+----<a class="link" href="GtkObject.html" title="GtkObject">GtkObject</a>
66
66
+----<a class="link" href="GtkWidget.html" title="GtkWidget">GtkWidget</a>
67
67
+----<a class="link" href="GtkMisc.html" title="GtkMisc">GtkMisc</a>
78
78
<a name="GtkPixmap.description"></a><h2>Description</h2>
80
80
The <a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> widget displays a graphical image or icon.
81
The icon is typically created using <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#gdk-pixmap-colormap-create-from-xpm"><code class="function">gdk_pixmap_colormap_create_from_xpm()</code></a>
82
or <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#gdk-pixmap-colormap-create-from-xpm-d"><code class="function">gdk_pixmap_colormap_create_from_xpm_d()</code></a>.
81
The icon is typically created using <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#gdk-pixmap-colormap-create-from-xpm"><code class="function">gdk_pixmap_colormap_create_from_xpm()</code></a>
82
or <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#gdk-pixmap-colormap-create-from-xpm-d"><code class="function">gdk_pixmap_colormap_create_from_xpm_d()</code></a>.
85
85
The pixels in a <a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> cannot be manipulated by the application after
111
111
<div class="refsect2">
112
112
<a name="gtk-pixmap-new"></a><h3>gtk_pixmap_new ()</h3>
113
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_pixmap_new (<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *pixmap</code></em>,
114
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);</pre>
113
<pre class="programlisting"><a class="link" href="GtkWidget.html" title="GtkWidget"><span class="returnvalue">GtkWidget</span></a> * gtk_pixmap_new (<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *pixmap</code></em>,
114
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);</pre>
115
115
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
116
116
<h3 class="title">Warning</h3>
117
117
<p><code class="literal">gtk_pixmap_new</code> is deprecated and should not be used in newly-written code.</p>
145
145
<div class="refsect2">
146
146
<a name="gtk-pixmap-set"></a><h3>gtk_pixmap_set ()</h3>
147
147
<pre class="programlisting"><span class="returnvalue">void</span> gtk_pixmap_set (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
148
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *val</code></em>,
149
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);</pre>
148
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> *val</code></em>,
149
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> *mask</code></em>);</pre>
150
150
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
151
151
<h3 class="title">Warning</h3>
152
152
<p><code class="literal">gtk_pixmap_set</code> is deprecated and should not be used in newly-written code.</p>
155
Sets the <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> and <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> mask.
155
Sets the <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> and <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> mask.
157
157
<div class="variablelist"><table border="0" class="variablelist">
168
168
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
169
<td>a <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a>.</td>
169
<td>a <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a>.</td>
172
172
<td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
173
<td>a <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a>, which indicates which parts of the <em class="parameter"><code>pixmap</code></em> should be
173
<td>a <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a>, which indicates which parts of the <em class="parameter"><code>pixmap</code></em> should be
174
174
transparent. This can be NULL, in which case none of the <em class="parameter"><code>pixmap</code></em> is
175
175
transparent.</td>
181
181
<div class="refsect2">
182
182
<a name="gtk-pixmap-get"></a><h3>gtk_pixmap_get ()</h3>
183
183
<pre class="programlisting"><span class="returnvalue">void</span> gtk_pixmap_get (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
184
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> **val</code></em>,
185
<em class="parameter"><code><a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> **mask</code></em>);</pre>
184
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> **val</code></em>,
185
<em class="parameter"><code><a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> **mask</code></em>);</pre>
186
186
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
187
187
<h3 class="title">Warning</h3>
188
188
<p><code class="literal">gtk_pixmap_get</code> is deprecated and should not be used in newly-written code.</p>
191
Gets the current <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> and <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> mask.
191
Gets the current <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a> and <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> mask.
193
193
<div class="variablelist"><table border="0" class="variablelist">
204
204
<td><p><span class="term"><em class="parameter"><code>val</code></em> :</span></p></td>
205
<td>returns the current <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a>.</td>
205
<td>returns the current <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkPixmap"><span class="type">GdkPixmap</span></a>.</td>
208
208
<td><p><span class="term"><em class="parameter"><code>mask</code></em> :</span></p></td>
209
<td>returns the current <a href="http://library.gnome.org/devel/gdk3/gdk-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> mask.</td>
209
<td>returns the current <a href="../gdk2/gdk2-Bitmaps-and-Pixmaps.html#GdkBitmap"><span class="type">GdkBitmap</span></a> mask.</td>
215
215
<div class="refsect2">
216
216
<a name="gtk-pixmap-set-build-insensitive"></a><h3>gtk_pixmap_set_build_insensitive ()</h3>
217
217
<pre class="programlisting"><span class="returnvalue">void</span> gtk_pixmap_set_build_insensitive (<em class="parameter"><code><a class="link" href="GtkPixmap.html" title="GtkPixmap"><span class="type">GtkPixmap</span></a> *pixmap</code></em>,
218
<em class="parameter"><code><a href="http://library.gnome.org/devel/glib/unstable/glib-Basic-Types.html#gboolean"><span class="type">gboolean</span></a> build</code></em>);</pre>
218
<em class="parameter"><code><span class="type">gboolean</span> build</code></em>);</pre>
219
219
<div class="warning" style="margin-left: 0.5in; margin-right: 0.5in;">
220
220
<h3 class="title">Warning</h3>
221
221
<p><code class="literal">gtk_pixmap_set_build_insensitive</code> is deprecated and should not be used in newly-written code.</p>
224
224
Sets wether an extra pixmap should be automatically created and used
225
when the pixmap is insensitive. The default value is <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a>.
225
when the pixmap is insensitive. The default value is <code class="literal">TRUE</code>.
227
227
<div class="variablelist"><table border="0" class="variablelist">
238
238
<td><p><span class="term"><em class="parameter"><code>build</code></em> :</span></p></td>
239
<td>set to <a href="http://library.gnome.org/devel/glib/unstable/glib-Standard-Macros.html#TRUE:CAPS"><code class="literal">TRUE</code></a> if an extra pixmap should be automatically created to use
239
<td>set to <code class="literal">TRUE</code> if an extra pixmap should be automatically created to use
240
240
when the pixmap is insensitive.</td>