gtkimage.sgml 3.13 KB
Newer Older
Owen Taylor's avatar
Owen Taylor committed
1
2
3
4
<!-- ##### SECTION Title ##### -->
GtkImage

<!-- ##### SECTION Short_Description ##### -->
5
A widget displaying a graphical image
Owen Taylor's avatar
Owen Taylor committed
6
7
8

<!-- ##### SECTION Long_Description ##### -->
<para>
9
10
11
12
13
14
15
16
The #GtkImage widget displays a graphical image. The image is typically created
using gdk_image_new.
</para>
<para>
The pixels in a #GtkImage may be manipulated by the application after creation,
as #GtkImage store the pixel data on the client side. If you wish to store the
pixel data on the server side (thus not allowing manipulation of the data after
creation) you should use #GtkPixmap.
Owen Taylor's avatar
Owen Taylor committed
17
18
19
20
</para>

<!-- ##### SECTION See_Also ##### -->
<para>
21
#GtkPixmap, #GdkRgb
Owen Taylor's avatar
Owen Taylor committed
22
23
24
25
</para>

<!-- ##### STRUCT GtkImage ##### -->
<para>
26
27
This struct contain private data only and should be accessed by the functions
below.
Owen Taylor's avatar
Owen Taylor committed
28
29
30
</para>


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
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
<!-- ##### FUNCTION gtk_image_get_icon_set ##### -->
<para>

</para>

@image: 
@icon_set: 
@size: 


<!-- ##### FUNCTION gtk_image_get_image ##### -->
<para>

</para>

@image: 
@gdk_image: 
@mask: 


<!-- ##### FUNCTION gtk_image_get_pixbuf ##### -->
<para>

</para>

@image: 
@Returns: 


<!-- ##### FUNCTION gtk_image_get_pixmap ##### -->
<para>

</para>

@image: 
@pixmap: 
@mask: 


<!-- ##### FUNCTION gtk_image_get_stock ##### -->
<para>

</para>

@image: 
@stock_id: 
@size: 


<!-- ##### FUNCTION gtk_image_get_storage_type ##### -->
<para>

</para>

@image: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_file ##### -->
<para>

</para>

@filename: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_icon_set ##### -->
<para>

</para>

@icon_set: 
@size: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_image ##### -->
<para>

</para>

@image: 
@mask: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_pixbuf ##### -->
<para>

</para>

@pixbuf: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_pixmap ##### -->
<para>

</para>

@pixmap: 
@mask: 
@Returns: 


<!-- ##### FUNCTION gtk_image_new_from_stock ##### -->
<para>

</para>

@stock_id: 
@size: 
@Returns: 


<!-- ##### FUNCTION gtk_image_set_from_file ##### -->
<para>

</para>

@image: 
@filename: 


<!-- ##### FUNCTION gtk_image_set_from_icon_set ##### -->
<para>

</para>

@image: 
@icon_set: 
@size: 


<!-- ##### FUNCTION gtk_image_set_from_image ##### -->
<para>

</para>

@image: 
@gdk_image: 
@mask: 


<!-- ##### FUNCTION gtk_image_set_from_pixbuf ##### -->
<para>

</para>

@image: 
@pixbuf: 


<!-- ##### FUNCTION gtk_image_set_from_pixmap ##### -->
<para>

</para>

@image: 
@pixmap: 
@mask: 


<!-- ##### FUNCTION gtk_image_set_from_stock ##### -->
<para>

</para>

@image: 
@stock_id: 
@size: 


Owen Taylor's avatar
Owen Taylor committed
205
206
<!-- ##### FUNCTION gtk_image_new ##### -->
<para>
207
Creates the new GtkImage using the value and the mask.
Owen Taylor's avatar
Owen Taylor committed
208
209
210
</para>

@val: 
211
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
212
@Returns: the GtkImage
Owen Taylor's avatar
Owen Taylor committed
213
214
215
216


<!-- ##### FUNCTION gtk_image_set ##### -->
<para>
217
Sets the GtkImage
Owen Taylor's avatar
Owen Taylor committed
218
219
</para>

220
@image: a #GdkPixmap
Owen Taylor's avatar
Owen Taylor committed
221
@val: 
222
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
Owen Taylor's avatar
Owen Taylor committed
223
224
225
226


<!-- ##### FUNCTION gtk_image_get ##### -->
<para>
227
Gets the GtkImage
Owen Taylor's avatar
Owen Taylor committed
228
229
</para>

230
@image: a #GdkPixmap
Owen Taylor's avatar
Owen Taylor committed
231
@val: 
232
@mask: a GDKBitmap that indicates which parts of the image should be transparent.
Owen Taylor's avatar
Owen Taylor committed
233
234