~ubuntu-branches/ubuntu/edgy/gimp/edgy

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN" 
               "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd">

<refentry id="GimpPixmap">
<refmeta>
<refentrytitle id="top_of_page">GimpPixmap</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGIMPWIDGETS Library</refmiscinfo>
</refmeta>

<refnamediv>
<refname>GimpPixmap</refname>
<refpurpose>Widget which creates a <link linkend="GtkPixmap"><type>GtkPixmap</type></link> from XPM data.</refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>

<refsynopsisdiv id="synopsis">
<title id="synopsis.title">Synopsis</title>

<synopsis>



            <link linkend="GimpPixmap-struct">GimpPixmap</link>;
<link linkend="GtkWidget">GtkWidget</link>*  <link linkend="gimp-pixmap-new">gimp_pixmap_new</link>                 (<link linkend="gchar">gchar</link> **xpm_data);
<link linkend="void">void</link>        <link linkend="gimp-pixmap-set">gimp_pixmap_set</link>                 (<link linkend="GimpPixmap">GimpPixmap</link> *pixmap,
                                             <link linkend="gchar">gchar</link> **xpm_data);

</synopsis>
</refsynopsisdiv>

<refsect1 id="object_hierarchy">
<title id="object_hierarchy.title">Object Hierarchy</title>
<synopsis>

  <link linkend="GObject">GObject</link>
   +----<link linkend="GInitiallyUnowned">GInitiallyUnowned</link>
         +----<link linkend="GtkObject">GtkObject</link>
               +----<link linkend="GtkWidget">GtkWidget</link>
                     +----<link linkend="GtkMisc">GtkMisc</link>
                           +----<link linkend="GtkImage">GtkImage</link>
                                 +----GimpPixmap
</synopsis>

</refsect1>



<refsect1 id="impl_interfaces">
<title id="impl_interfaces.title">Implemented Interfaces</title>
<para>
GimpPixmap implements
 <link linkend="AtkImplementorIface">AtkImplementorIface</link>.</para>

</refsect1>





<refsect1 id="desc">
<title id="desc.title">Description</title>
<para>
Widget which creates a <link linkend="GtkPixmap"><type>GtkPixmap</type></link> from XPM data.
</para>
<para>
Use this widget instead of <link linkend="GtkPixmap"><type>GtkPixmap</type></link> if you don't want to worry about
the parent container's "realized" state.
</para>
<para>
Note that the drawback of the easy interface is that the actual <link linkend="GdkPixmap"><type>GdkPixmap</type></link>
and it's mask have to be constructed every time you call <link linkend="gimp-pixmap-new"><function>gimp_pixmap_new()</function></link>
and cannot be cached in memory without doing bad hacks.
</para>
</refsect1>

<refsect1 id="details">
<title id="details.title">Details</title>
<refsect2>
<title><anchor id="GimpPixmap-struct" role="struct"/>GimpPixmap</title>
<indexterm role="deprecated"><primary>GimpPixmap</primary></indexterm><programlisting>typedef struct _GimpPixmap GimpPixmap;</programlisting>
<warning><para><literal>GimpPixmap</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>

</para></refsect2>
<refsect2>
<title><anchor id="gimp-pixmap-new" role="function" condition="deprecated:"/>gimp_pixmap_new ()</title>
<indexterm role="deprecated"><primary>gimp_pixmap_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>*  gimp_pixmap_new                 (<link linkend="gchar">gchar</link> **xpm_data);</programlisting>
<warning><para><literal>gimp_pixmap_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new <link linkend="GimpPixmap"><type>GimpPixmap</type></link> widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>xpm_data</parameter>&nbsp;:</term>
<listitem><simpara> A pointer to a XPM data structure as found in XPM files.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis>&nbsp;:</term><listitem><simpara> A pointer to the new <link linkend="GimpPixmap"><type>GimpPixmap</type></link> widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gimp-pixmap-set" role="function" condition="deprecated:"/>gimp_pixmap_set ()</title>
<indexterm role="deprecated"><primary>gimp_pixmap_set</primary></indexterm><programlisting><link linkend="void">void</link>        gimp_pixmap_set                 (<link linkend="GimpPixmap">GimpPixmap</link> *pixmap,
                                             <link linkend="gchar">gchar</link> **xpm_data);</programlisting>
<warning><para><literal>gimp_pixmap_set</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets a new image for an existing <link linkend="GimpPixmap"><type>GimpPixmap</type></link> widget.</para>
<para>

</para><variablelist role="params">
<varlistentry><term><parameter>pixmap</parameter>&nbsp;:</term>
<listitem><simpara> The pixmap widget you want to set the new xpm_data for.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>xpm_data</parameter>&nbsp;:</term>
<listitem><simpara> A pointer to a XPM data structure as found in XPM files.
</simpara></listitem></varlistentry>
</variablelist></refsect2>

</refsect1>



<refsect1>
<title>See Also</title>
<para>
<link linkend="gimp-pixmap-button-new"><function>gimp_pixmap_button_new()</function></link>
</para>
<para>
<link linkend="GtkPixmap"><type>GtkPixmap</type></link>
</para>
</refsect1>

</refentry>