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
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
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
|
<refentry id="GnomePixmapEntry">
<refmeta>
<refentrytitle role="top_of_page">GnomePixmapEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomePixmapEntry</refname>
<refpurpose></refpurpose>
<!--[<xref linkend="desc" endterm="desc.title"/>]-->
</refnamediv>
<refsynopsisdiv role="synopsis">
<title role="synopsis.title">Synopsis</title>
<synopsis>
#include <libgnomeui/libgnomeui.h>
<link linkend="GnomePixmapEntry-struct">GnomePixmapEntry</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-pixmap-entry-new">gnome_pixmap_entry_new</link> (const <link linkend="gchar">gchar</link> *history_id,
const <link linkend="gchar">gchar</link> *browse_dialog_title,
<link linkend="gboolean">gboolean</link> do_preview);
<link linkend="void">void</link> <link linkend="gnome-pixmap-entry-construct">gnome_pixmap_entry_construct</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
const <link linkend="gchar">gchar</link> *history_id,
const <link linkend="gchar">gchar</link> *browse_dialog_title,
<link linkend="gboolean">gboolean</link> do_preview);
<link linkend="void">void</link> <link linkend="gnome-pixmap-entry-set-pixmap-subdir">gnome_pixmap_entry_set_pixmap_subdir</link>
(<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
const <link linkend="gchar">gchar</link> *subdir);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-pixmap-entry-gnome-file-entry">gnome_pixmap_entry_gnome_file_entry</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-pixmap-entry-gnome-entry">gnome_pixmap_entry_gnome_entry</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-pixmap-entry-gtk-entry">gnome_pixmap_entry_gtk_entry</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-pixmap-entry-scrolled-window">gnome_pixmap_entry_scrolled_window</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-pixmap-entry-preview-widget">gnome_pixmap_entry_preview_widget</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
<link linkend="void">void</link> <link linkend="gnome-pixmap-entry-set-preview">gnome_pixmap_entry_set_preview</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
<link linkend="gboolean">gboolean</link> do_preview);
<link linkend="void">void</link> <link linkend="gnome-pixmap-entry-set-preview-size">gnome_pixmap_entry_set_preview_size</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
<link linkend="gint">gint</link> preview_w,
<link linkend="gint">gint</link> preview_h);
<link linkend="gchar">gchar</link>* <link linkend="gnome-pixmap-entry-get-filename">gnome_pixmap_entry_get_filename</link> (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);
</synopsis>
</refsynopsisdiv>
<refsect1 role="object_hierarchy">
<title role="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="GtkContainer">GtkContainer</link>
+----<link linkend="GtkBox">GtkBox</link>
+----<link linkend="GtkVBox">GtkVBox</link>
+----<link linkend="GnomeFileEntry">GnomeFileEntry</link>
+----GnomePixmapEntry
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GnomePixmapEntry implements
<link linkend="AtkImplementorIface">AtkImplementorIface</link>, <link linkend="GtkBuildable">GtkBuildable</link> and <link linkend="GtkEditable">GtkEditable</link>.</para>
</refsect1>
<refsect1 role="properties">
<title role="properties.title">Properties</title>
<synopsis>
"<link linkend="GnomePixmapEntry--do-preview">do-preview</link>" <link linkend="gboolean">gboolean</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="desc">
<title role="desc.title">Description</title>
<para>
</para>
</refsect1>
<refsect1 role="details">
<title role="details.title">Details</title>
<refsect2>
<title><anchor id="GnomePixmapEntry-struct" role="struct"/>GnomePixmapEntry</title>
<indexterm role="deprecated"><primary>GnomePixmapEntry</primary></indexterm><programlisting>typedef struct _GnomePixmapEntry GnomePixmapEntry;</programlisting>
<warning><para><literal>GnomePixmapEntry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-new" role="function" condition="deprecated:"/>gnome_pixmap_entry_new ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_pixmap_entry_new (const <link linkend="gchar">gchar</link> *history_id,
const <link linkend="gchar">gchar</link> *browse_dialog_title,
<link linkend="gboolean">gboolean</link> do_preview);</programlisting>
<warning><para><literal>gnome_pixmap_entry_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new pixmap entry widget, if do_preview is false,
there is no preview, the files are not loaded and thus are not
checked to be real image files.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>history_id</parameter> :</term>
<listitem><simpara> The id given to <link linkend="gnome-entry-new"><type>gnome_entry_new</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>browse_dialog_title</parameter> :</term>
<listitem><simpara> Title of the browse dialog
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>do_preview</parameter> :</term>
<listitem><simpara> boolean
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> New GnomePixmapEntry object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-construct" role="function" condition="deprecated:"/>gnome_pixmap_entry_construct ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_construct</primary></indexterm><programlisting><link linkend="void">void</link> gnome_pixmap_entry_construct (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
const <link linkend="gchar">gchar</link> *history_id,
const <link linkend="gchar">gchar</link> *browse_dialog_title,
<link linkend="gboolean">gboolean</link> do_preview);</programlisting>
<warning><para><literal>gnome_pixmap_entry_construct</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Constructs the <parameter>pentry</parameter> object. If do_preview is <link linkend="FALSE:CAPS"><literal>FALSE</literal></link>,
there is no preview, the files are not loaded and thus are not
checked to be real image files.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> A <link linkend="GnomePixmapEntry"><type>GnomePixmapEntry</type></link> object to construct
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>history_id</parameter> :</term>
<listitem><simpara> The id given to <link linkend="gnome-entry-new"><type>gnome_entry_new</type></link>
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>browse_dialog_title</parameter> :</term>
<listitem><simpara> Title of the browse dialog
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>do_preview</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> if preview is desired, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> if not.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-set-pixmap-subdir" role="function" condition="deprecated:"/>gnome_pixmap_entry_set_pixmap_subdir ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_set_pixmap_subdir</primary></indexterm><programlisting><link linkend="void">void</link> gnome_pixmap_entry_set_pixmap_subdir
(<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
const <link linkend="gchar">gchar</link> *subdir);</programlisting>
<warning><para><literal>gnome_pixmap_entry_set_pixmap_subdir</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the default path for the file entry. The new
subdirectory should be specified relative to the default GNOME
pixmap directory.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>subdir</parameter> :</term>
<listitem><simpara> Subdirectory
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-gnome-file-entry" role="function" condition="deprecated:"/>gnome_pixmap_entry_gnome_file_entry ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_gnome_file_entry</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_pixmap_entry_gnome_file_entry (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_gnome_file_entry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the <link linkend="GnomeFileEntry"><type>GnomeFileEntry</type></link> component of the
GnomePixmapEntry widget for lower-level manipulation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="GnomeFileEntry"><type>GnomeFileEntry</type></link> widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-gnome-entry" role="function" condition="deprecated:"/>gnome_pixmap_entry_gnome_entry ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_gnome_entry</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_pixmap_entry_gnome_entry (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_gnome_entry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the <link linkend="GnomeEntry"><type>GnomeEntry</type></link> component of the
GnomePixmapEntry widget for lower-level manipulation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="GnomeEntry"><type>GnomeEntry</type></link> widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-gtk-entry" role="function" condition="deprecated:"/>gnome_pixmap_entry_gtk_entry ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_gtk_entry</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_pixmap_entry_gtk_entry (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_gtk_entry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the <link linkend="GtkEntry"><type>GtkEntry</type></link> component of the
GnomePixmapEntry for Gtk+-level manipulation.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="GtkEntry"><type>GtkEntry</type></link> widget
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-scrolled-window" role="function" condition="deprecated:"/>gnome_pixmap_entry_scrolled_window ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_scrolled_window</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_pixmap_entry_scrolled_window (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_scrolled_window</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the <link linkend="GtkScrolledWindow"><type>GtkScrolledWindow</type></link> widget that the preview
is contained in. Could be <link linkend="NULL:CAPS"><literal>NULL</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> <link linkend="GtkScrolledWindow"><type>GtkScrolledWindow</type></link> widget or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-preview-widget" role="function" condition="deprecated:"/>gnome_pixmap_entry_preview_widget ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_preview_widget</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_pixmap_entry_preview_widget (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_preview_widget</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get the widget that is the preview. Don't assume any
type of widget. Currently either <link linkend="GnomePixmap"><type>GnomePixmap</type></link> or <link linkend="GtkLabel"><type>GtkLabel</type></link>, but it
could change in the future. Could be <link linkend="NULL:CAPS"><literal>NULL</literal></link></para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> the preview widget pointer or <link linkend="NULL:CAPS"><literal>NULL</literal></link>
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-set-preview" role="function" condition="deprecated:"/>gnome_pixmap_entry_set_preview ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_set_preview</primary></indexterm><programlisting><link linkend="void">void</link> gnome_pixmap_entry_set_preview (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
<link linkend="gboolean">gboolean</link> do_preview);</programlisting>
<warning><para><literal>gnome_pixmap_entry_set_preview</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets whether or not the preview box is shown above
the entry. If the preview is on, we also load the files and check
for them being real images. If it is off, we don't check files
to be real image files.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>do_preview</parameter> :</term>
<listitem><simpara> <link linkend="TRUE:CAPS"><literal>TRUE</literal></link> to show previews, <link linkend="FALSE:CAPS"><literal>FALSE</literal></link> to not show them.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-set-preview-size" role="function" condition="deprecated:"/>gnome_pixmap_entry_set_preview_size ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_set_preview_size</primary></indexterm><programlisting><link linkend="void">void</link> gnome_pixmap_entry_set_preview_size (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry,
<link linkend="gint">gint</link> preview_w,
<link linkend="gint">gint</link> preview_h);</programlisting>
<warning><para><literal>gnome_pixmap_entry_set_preview_size</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Sets the minimum size of the preview frame in pixels.
This works only if the preview is enabled.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>preview_w</parameter> :</term>
<listitem><simpara> Preview width in pixels
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>preview_h</parameter> :</term>
<listitem><simpara> Preview height in pixels
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-pixmap-entry-get-filename" role="function" condition="deprecated:"/>gnome_pixmap_entry_get_filename ()</title>
<indexterm role="deprecated"><primary>gnome_pixmap_entry_get_filename</primary></indexterm><programlisting><link linkend="gchar">gchar</link>* gnome_pixmap_entry_get_filename (<link linkend="GnomePixmapEntry">GnomePixmapEntry</link> *pentry);</programlisting>
<warning><para><literal>gnome_pixmap_entry_get_filename</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Gets the filename of the image if the preview
successfully loaded if preview is disabled. If the preview is
disabled, the file is only checked if it exists or not.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>pentry</parameter> :</term>
<listitem><simpara> Pointer to GnomePixmapEntry widget
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Newly allocated string containing path, or <link linkend="NULL:CAPS"><literal>NULL</literal></link> on error.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GnomePixmapEntry--do-preview"/>The <literal>"do-preview"</literal> property</title>
<indexterm><primary>GnomePixmapEntry:do-preview</primary></indexterm><programlisting> "do-preview" <link linkend="gboolean">gboolean</link> : Read / Write</programlisting>
<para>Whether the pixmap entry should have a preview.</para><para>Default value: FALSE</para>
</refsect2>
</refsect1>
</refentry>
|
