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
|
<refentry id="GnomeEntry">
<refmeta>
<refentrytitle role="top_of_page">GnomeEntry</refentrytitle>
<manvolnum>3</manvolnum>
<refmiscinfo>LIBGNOMEUI Library</refmiscinfo>
</refmeta>
<refnamediv>
<refname>GnomeEntry</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="GnomeEntryPrivate">GnomeEntryPrivate</link>;
<link linkend="GnomeEntry-struct">GnomeEntry</link>;
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-entry-new">gnome_entry_new</link> (const <link linkend="gchar">gchar</link> *history_id);
<link linkend="GtkWidget">GtkWidget</link>* <link linkend="gnome-entry-gtk-entry">gnome_entry_gtk_entry</link> (<link linkend="GnomeEntry">GnomeEntry</link> *gentry);
const <link linkend="gchar">gchar</link>* <link linkend="gnome-entry-get-history-id">gnome_entry_get_history_id</link> (<link linkend="GnomeEntry">GnomeEntry</link> *gentry);
<link linkend="void">void</link> <link linkend="gnome-entry-set-history-id">gnome_entry_set_history_id</link> (<link linkend="GnomeEntry">GnomeEntry</link> *gentry,
const <link linkend="gchar">gchar</link> *history_id);
<link linkend="void">void</link> <link linkend="gnome-entry-set-max-saved">gnome_entry_set_max_saved</link> (<link linkend="GnomeEntry">GnomeEntry</link> *gentry,
<link linkend="guint">guint</link> max_saved);
<link linkend="guint">guint</link> <link linkend="gnome-entry-get-max-saved">gnome_entry_get_max_saved</link> (<link linkend="GnomeEntry">GnomeEntry</link> *gentry);
<link linkend="void">void</link> <link linkend="gnome-entry-prepend-history">gnome_entry_prepend_history</link> (<link linkend="GnomeEntry">GnomeEntry</link> *gentry,
<link linkend="gboolean">gboolean</link> save,
const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link> <link linkend="gnome-entry-append-history">gnome_entry_append_history</link> (<link linkend="GnomeEntry">GnomeEntry</link> *gentry,
<link linkend="gboolean">gboolean</link> save,
const <link linkend="gchar">gchar</link> *text);
<link linkend="void">void</link> <link linkend="gnome-entry-clear-history">gnome_entry_clear_history</link> (<link linkend="GnomeEntry">GnomeEntry</link> *gentry);
</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="GtkHBox">GtkHBox</link>
+----<link linkend="GtkCombo">GtkCombo</link>
+----GnomeEntry
</synopsis>
</refsect1>
<refsect1 role="impl_interfaces">
<title role="impl_interfaces.title">Implemented Interfaces</title>
<para>
GnomeEntry 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="GnomeEntry--gtk-entry">gtk-entry</link>" <link linkend="GtkEntry">GtkEntry</link> : Read
"<link linkend="GnomeEntry--history-id">history-id</link>" <link linkend="gchararray">gchararray</link> : Read / Write
</synopsis>
</refsect1>
<refsect1 role="signal_proto">
<title role="signal_proto.title">Signals</title>
<synopsis>
"<link linkend="GnomeEntry-activate">activate</link>" : Run Last
</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="GnomeEntryPrivate" role="struct" condition="deprecated:"/>GnomeEntryPrivate</title>
<indexterm role="deprecated"><primary>GnomeEntryPrivate</primary></indexterm><programlisting>typedef struct _GnomeEntryPrivate GnomeEntryPrivate;</programlisting>
<warning><para><literal>GnomeEntryPrivate</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="GnomeEntry-struct" role="struct"/>GnomeEntry</title>
<indexterm role="deprecated"><primary>GnomeEntry</primary></indexterm><programlisting>typedef struct _GnomeEntry GnomeEntry;</programlisting>
<warning><para><literal>GnomeEntry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
</para></refsect2>
<refsect2>
<title><anchor id="gnome-entry-new" role="function" condition="deprecated:"/>gnome_entry_new ()</title>
<indexterm role="deprecated"><primary>gnome_entry_new</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_entry_new (const <link linkend="gchar">gchar</link> *history_id);</programlisting>
<warning><para><literal>gnome_entry_new</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Creates a new GnomeEntry widget. If <parameter>history_id</parameter> is
not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, then the history list will be saved and restored between
uses under the given id.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>history_id</parameter> :</term>
<listitem><simpara> If not <link linkend="NULL:CAPS"><literal>NULL</literal></link>, the text id under which history data is stored
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Newly-created GnomeEntry widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-entry-gtk-entry" role="function" condition="deprecated:"/>gnome_entry_gtk_entry ()</title>
<indexterm role="deprecated"><primary>gnome_entry_gtk_entry</primary></indexterm><programlisting><link linkend="GtkWidget">GtkWidget</link>* gnome_entry_gtk_entry (<link linkend="GnomeEntry">GnomeEntry</link> *gentry);</programlisting>
<warning><para><literal>gnome_entry_gtk_entry</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Obtain pointer to GnomeEntry's internal text entry</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gentry</parameter> :</term>
<listitem><simpara> Pointer to GnomeEntry object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> Pointer to GtkEntry widget.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-entry-get-history-id" role="function" condition="deprecated:"/>gnome_entry_get_history_id ()</title>
<indexterm role="deprecated"><primary>gnome_entry_get_history_id</primary></indexterm><programlisting>const <link linkend="gchar">gchar</link>* gnome_entry_get_history_id (<link linkend="GnomeEntry">GnomeEntry</link> *gentry);</programlisting>
<warning><para><literal>gnome_entry_get_history_id</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Returns the current history id of the GnomeEntry widget.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gentry</parameter> :</term>
<listitem><simpara> Pointer to GnomeEntry object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> The current history id.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-entry-set-history-id" role="function" condition="deprecated:"/>gnome_entry_set_history_id ()</title>
<indexterm role="deprecated"><primary>gnome_entry_set_history_id</primary></indexterm><programlisting><link linkend="void">void</link> gnome_entry_set_history_id (<link linkend="GnomeEntry">GnomeEntry</link> *gentry,
const <link linkend="gchar">gchar</link> *history_id);</programlisting>
<warning><para><literal>gnome_entry_set_history_id</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Set the id of the history list. This function cannot be
used to change and already existing id.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gentry</parameter> :</term>
<listitem><simpara> Pointer to GnomeEntry object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>history_id</parameter> :</term>
<listitem><simpara> the text id under which history data is stored
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-entry-set-max-saved" role="function" condition="deprecated:"/>gnome_entry_set_max_saved ()</title>
<indexterm role="deprecated"><primary>gnome_entry_set_max_saved</primary></indexterm><programlisting><link linkend="void">void</link> gnome_entry_set_max_saved (<link linkend="GnomeEntry">GnomeEntry</link> *gentry,
<link linkend="guint">guint</link> max_saved);</programlisting>
<warning><para><literal>gnome_entry_set_max_saved</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Set internal limit on number of history items saved
to the config file.
Zero is an acceptable value for <parameter>max_saved</parameter>, but the same thing is
accomplished by setting the history id of <parameter>gentry</parameter> to <link linkend="NULL:CAPS"><literal>NULL</literal></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gentry</parameter> :</term>
<listitem><simpara> Pointer to GnomeEntry object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>max_saved</parameter> :</term>
<listitem><simpara> Maximum number of history items to save
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-entry-get-max-saved" role="function" condition="deprecated:"/>gnome_entry_get_max_saved ()</title>
<indexterm role="deprecated"><primary>gnome_entry_get_max_saved</primary></indexterm><programlisting><link linkend="guint">guint</link> gnome_entry_get_max_saved (<link linkend="GnomeEntry">GnomeEntry</link> *gentry);</programlisting>
<warning><para><literal>gnome_entry_get_max_saved</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Get internal limit on number of history items saved
to the config file
See #<link linkend="gnome-entry-set-max-saved"><function>gnome_entry_set_max_saved()</function></link>.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gentry</parameter> :</term>
<listitem><simpara> Pointer to GnomeEntry object.
</simpara></listitem></varlistentry>
<varlistentry><term><emphasis>Returns</emphasis> :</term><listitem><simpara> An unsigned integer
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-entry-prepend-history" role="function" condition="deprecated:"/>gnome_entry_prepend_history ()</title>
<indexterm role="deprecated"><primary>gnome_entry_prepend_history</primary></indexterm><programlisting><link linkend="void">void</link> gnome_entry_prepend_history (<link linkend="GnomeEntry">GnomeEntry</link> *gentry,
<link linkend="gboolean">gboolean</link> save,
const <link linkend="gchar">gchar</link> *text);</programlisting>
<warning><para><literal>gnome_entry_prepend_history</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Adds a history item of the given <parameter>text</parameter> to the head of
the history list inside <parameter>gentry</parameter>. If <parameter>save</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the history
item will be saved in the config file (assuming that <parameter>gentry</parameter>'s
history id is not <link linkend="NULL:CAPS"><literal>NULL</literal></link>).
Duplicates are automatically removed from the history list.
The history list is automatically saved if needed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gentry</parameter> :</term>
<listitem><simpara> Pointer to GnomeEntry object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>save</parameter> :</term>
<listitem><simpara> If <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, history entry will be saved to config file
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> Text to add
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-entry-append-history" role="function" condition="deprecated:"/>gnome_entry_append_history ()</title>
<indexterm role="deprecated"><primary>gnome_entry_append_history</primary></indexterm><programlisting><link linkend="void">void</link> gnome_entry_append_history (<link linkend="GnomeEntry">GnomeEntry</link> *gentry,
<link linkend="gboolean">gboolean</link> save,
const <link linkend="gchar">gchar</link> *text);</programlisting>
<warning><para><literal>gnome_entry_append_history</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Adds a history item of the given <parameter>text</parameter> to the tail
of the history list inside <parameter>gentry</parameter>. If <parameter>save</parameter> is <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, the
history item will be saved in the config file (assuming that
<parameter>gentry</parameter>'s history id is not <link linkend="NULL:CAPS"><literal>NULL</literal></link>).
Duplicates are automatically removed from the history list.
The history list is automatically saved if needed.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gentry</parameter> :</term>
<listitem><simpara> Pointer to GnomeEntry object.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>save</parameter> :</term>
<listitem><simpara> If <link linkend="TRUE:CAPS"><literal>TRUE</literal></link>, history entry will be saved to config file
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>text</parameter> :</term>
<listitem><simpara> Text to add
</simpara></listitem></varlistentry>
</variablelist></refsect2>
<refsect2>
<title><anchor id="gnome-entry-clear-history" role="function" condition="deprecated:"/>gnome_entry_clear_history ()</title>
<indexterm role="deprecated"><primary>gnome_entry_clear_history</primary></indexterm><programlisting><link linkend="void">void</link> gnome_entry_clear_history (<link linkend="GnomeEntry">GnomeEntry</link> *gentry);</programlisting>
<warning><para><literal>gnome_entry_clear_history</literal> is deprecated and should not be used in newly-written code.</para></warning>
<para>
Clears the history.</para>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>gentry</parameter> :</term>
<listitem><simpara> Pointer to GnomeEntry object.
</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
<refsect1 role="property_details">
<title role="property_details.title">Property Details</title>
<refsect2><title><anchor id="GnomeEntry--gtk-entry"/>The <literal>"gtk-entry"</literal> property</title>
<indexterm><primary>GnomeEntry:gtk-entry</primary></indexterm><programlisting> "gtk-entry" <link linkend="GtkEntry">GtkEntry</link> : Read</programlisting>
<para>The GTK entry.</para></refsect2>
<refsect2><title><anchor id="GnomeEntry--history-id"/>The <literal>"history-id"</literal> property</title>
<indexterm><primary>GnomeEntry:history-id</primary></indexterm><programlisting> "history-id" <link linkend="gchararray">gchararray</link> : Read / Write</programlisting>
<para>History ID.</para><para>Default value: NULL</para>
</refsect2>
</refsect1>
<refsect1 role="signals">
<title role="signals.title">Signal Details</title>
<refsect2><title><anchor id="GnomeEntry-activate"/>The <literal>"activate"</literal> signal</title>
<indexterm><primary>GnomeEntry::activate</primary></indexterm><programlisting><link linkend="void">void</link> user_function (<link linkend="GnomeEntry">GnomeEntry</link> *entry,
<link linkend="gpointer">gpointer</link> user_data) : Run Last</programlisting>
<para>
</para><variablelist role="params">
<varlistentry><term><parameter>entry</parameter> :</term>
<listitem><simpara>the object which received the signal.
</simpara></listitem></varlistentry>
<varlistentry><term><parameter>user_data</parameter> :</term>
<listitem><simpara>user data set when the signal handler was connected.</simpara></listitem></varlistentry>
</variablelist></refsect2>
</refsect1>
</refentry>
|
