Mercurial > pidgin.yaz
annotate finch/libgnt/gntentry.h @ 28518:8aa7df246e13
Eighth^WNinth time's the charm...
author | Paul Aurich <paul@darkrain42.org> |
---|---|
date | Mon, 31 Aug 2009 20:27:04 +0000 |
parents | 1f59065c606a |
children | 69decc147e5b |
rev | line source |
---|---|
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
1 /** |
18303
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17718
diff
changeset
|
2 * @file gntentry.h Entry API |
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17718
diff
changeset
|
3 * @ingroup gnt |
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17718
diff
changeset
|
4 */ |
5c6f019e48f8
Generate doxy-help files for libgnt. And make it actually work.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
17718
diff
changeset
|
5 /* |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
6 * GNT - The GLib Ncurses Toolkit |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
7 * |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
8 * GNT is the legal property of its developers, whose names are too numerous |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
9 * to list here. Please refer to the COPYRIGHT file distributed with this |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
10 * source distribution. |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
11 * |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
12 * This library is free software; you can redistribute it and/or modify |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
13 * it under the terms of the GNU General Public License as published by |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
14 * the Free Software Foundation; either version 2 of the License, or |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
15 * (at your option) any later version. |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
16 * |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
17 * This program is distributed in the hope that it will be useful, |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
18 * but WITHOUT ANY WARRANTY; without even the implied warranty of |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
19 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
20 * GNU General Public License for more details. |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
21 * |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
22 * You should have received a copy of the GNU General Public License |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
23 * along with this program; if not, write to the Free Software |
19680
44b4e8bd759b
The FSF changed its address a while ago; our files were out of date.
John Bailey <rekkanoryo@rekkanoryo.org>
parents:
18303
diff
changeset
|
24 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
25 */ |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
26 |
15818 | 27 #ifndef GNT_ENTRY_H |
28 #define GNT_ENTRY_H | |
29 | |
30 #include "gntwidget.h" | |
31 #include "gnt.h" | |
32 #include "gntcolors.h" | |
33 #include "gntkeys.h" | |
34 | |
35 #define GNT_TYPE_ENTRY (gnt_entry_get_gtype()) | |
36 #define GNT_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_ENTRY, GntEntry)) | |
37 #define GNT_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_ENTRY, GntEntryClass)) | |
38 #define GNT_IS_ENTRY(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_ENTRY)) | |
39 #define GNT_IS_ENTRY_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_ENTRY)) | |
40 #define GNT_ENTRY_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_ENTRY, GntEntryClass)) | |
41 | |
42 #define GNT_ENTRY_FLAGS(obj) (GNT_ENTRY(obj)->priv.flags) | |
43 #define GNT_ENTRY_SET_FLAGS(obj, flags) (GNT_ENTRY_FLAGS(obj) |= flags) | |
44 #define GNT_ENTRY_UNSET_FLAGS(obj, flags) (GNT_ENTRY_FLAGS(obj) &= ~(flags)) | |
45 | |
46 #define ENTRY_CHAR '_' /* The character to use to fill in the blank places */ | |
47 | |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
48 typedef struct _GntEntry GntEntry; |
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
49 typedef struct _GntEntryPriv GntEntryPriv; |
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
50 typedef struct _GntEntryClass GntEntryClass; |
21266
1f59065c606a
Add 'yank' action in the entry boxes.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20751
diff
changeset
|
51 typedef struct _GntEntryKillRing GntEntryKillRing; |
15818 | 52 |
53 typedef enum | |
54 { | |
55 GNT_ENTRY_FLAG_ALPHA = 1 << 0, /* Only alpha */ | |
56 GNT_ENTRY_FLAG_INT = 1 << 1, /* Only integer */ | |
57 GNT_ENTRY_FLAG_NO_SPACE = 1 << 2, /* No blank space is allowed */ | |
58 GNT_ENTRY_FLAG_NO_PUNCT = 1 << 3, /* No punctuations */ | |
59 GNT_ENTRY_FLAG_MASK = 1 << 4, /* Mask the inputs */ | |
60 } GntEntryFlag; | |
61 | |
62 #define GNT_ENTRY_FLAG_ALL (GNT_ENTRY_FLAG_ALPHA | GNT_ENTRY_FLAG_INT) | |
63 | |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
64 struct _GntEntry |
15818 | 65 { |
66 GntWidget parent; | |
67 | |
68 GntEntryFlag flag; | |
69 | |
70 char *start; | |
71 char *end; | |
72 char *scroll; /* Current scrolling position */ | |
73 char *cursor; /* Cursor location */ | |
74 /* 0 <= cursor - scroll < widget-width */ | |
21266
1f59065c606a
Add 'yank' action in the entry boxes.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20751
diff
changeset
|
75 |
15818 | 76 size_t buffer; /* Size of the buffer */ |
21266
1f59065c606a
Add 'yank' action in the entry boxes.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20751
diff
changeset
|
77 |
15818 | 78 int max; /* 0 means infinite */ |
79 gboolean masked; | |
80 | |
81 GList *history; /* History of the strings. User can use this by pressing ctrl+up/down */ | |
82 int histlength; /* How long can the history be? */ | |
83 | |
84 GList *suggests; /* List of suggestions */ | |
85 gboolean word; /* Are the suggestions for only a word, or for the whole thing? */ | |
86 gboolean always; /* Should the list of suggestions show at all times, or only on tab-press? */ | |
87 GntWidget *ddown; /* The dropdown with the suggested list */ | |
21266
1f59065c606a
Add 'yank' action in the entry boxes.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
20751
diff
changeset
|
88 GntEntryKillRing *killring; /**< @since 2.3.0 */ |
15818 | 89 }; |
90 | |
15931
f00f2e283ffb
Some define changes. This helps in generating the python bindings.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
15818
diff
changeset
|
91 struct _GntEntryClass |
15818 | 92 { |
93 GntWidgetClass parent; | |
94 | |
95 void (*text_changed)(GntEntry *entry); | |
96 void (*gnt_reserved1)(void); | |
97 void (*gnt_reserved2)(void); | |
98 void (*gnt_reserved3)(void); | |
99 void (*gnt_reserved4)(void); | |
100 }; | |
101 | |
102 G_BEGIN_DECLS | |
103 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
104 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
105 * @return GType for GntEntry. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
106 */ |
15818 | 107 GType gnt_entry_get_gtype(void); |
108 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
109 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
110 * Create a new GntEntry. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
111 * |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
112 * @param text The text in the new entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
113 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
114 * @return The newly created entry box. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
115 */ |
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
116 GntWidget * gnt_entry_new(const char *text); |
15818 | 117 |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
118 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
119 * Set the maximum length of the text in the entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
120 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
121 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
122 * @param max The maximum length for text. A value of 0 means infinite length. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
123 */ |
15818 | 124 void gnt_entry_set_max(GntEntry *entry, int max); |
125 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
126 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
127 * Set the text in an entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
128 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
129 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
130 * @param text The text to set in the box. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
131 */ |
15818 | 132 void gnt_entry_set_text(GntEntry *entry, const char *text); |
133 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
134 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
135 * Set flags an entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
136 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
137 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
138 * @param flag The flags to set for the entry box. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
139 */ |
15818 | 140 void gnt_entry_set_flag(GntEntry *entry, GntEntryFlag flag); |
141 | |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
142 /** |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
143 * Get the text in an entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
144 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
145 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
146 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
147 * @return The current text in the entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
148 */ |
15818 | 149 const char *gnt_entry_get_text(GntEntry *entry); |
150 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
151 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
152 * Clear the text in the entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
153 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
154 * @param entry The entry box. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
155 */ |
15818 | 156 void gnt_entry_clear(GntEntry *entry); |
157 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
158 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
159 * Set whether the text in the entry box should be masked for display. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
160 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
161 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
162 * @param set @c TRUE if the text should be masked, @c FALSE otherwise. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
163 */ |
15818 | 164 void gnt_entry_set_masked(GntEntry *entry, gboolean set); |
165 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
166 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
167 * Add a text to the history list for the text. The history length for the |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
168 * entry box needs to be set first by gnt_entry_set_history_length. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
169 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
170 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
171 * @param text A new entry for the history list. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
172 */ |
15818 | 173 void gnt_entry_add_to_history(GntEntry *entry, const char *text); |
174 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
175 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
176 * Set the length of history for the entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
177 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
178 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
179 * @param num The maximum length of the history. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
180 */ |
15818 | 181 void gnt_entry_set_history_length(GntEntry *entry, int num); |
182 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
183 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
184 * Set whether the suggestions are for the entire entry box, or for each |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
185 * individual word in the entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
186 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
187 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
188 * @param word @c TRUE if the suggestions are for individual words, @c FALSE otherwise. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
189 */ |
15818 | 190 void gnt_entry_set_word_suggest(GntEntry *entry, gboolean word); |
191 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
192 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
193 * Set whether to always display the suggestions list, or only when the |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
194 * tab-completion key is pressed (the TAB key, by default). |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
195 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
196 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
197 * @param always @c TRUE if the suggestion list should always be displayed. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
198 */ |
15818 | 199 void gnt_entry_set_always_suggest(GntEntry *entry, gboolean always); |
200 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
201 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
202 * Add an item to the suggestion list. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
203 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
204 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
205 * @param text An item to add to the suggestion list. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
206 */ |
15818 | 207 void gnt_entry_add_suggest(GntEntry *entry, const char *text); |
208 | |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
209 /** |
20751
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
210 * Remove an entry from the suggestion list. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
211 * |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
212 * @param entry The entry box. |
fe77cc691f78
Some doxygen stuff.
Sadrul Habib Chowdhury <imadil@gmail.com>
parents:
19680
diff
changeset
|
213 * @param text The item to remove from the suggestion list. |
17718
8410511f4dbb
applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3
Eric Polino <aluink@pidgin.im>
parents:
15931
diff
changeset
|
214 */ |
15818 | 215 void gnt_entry_remove_suggest(GntEntry *entry, const char *text); |
216 | |
217 G_END_DECLS | |
218 | |
219 #endif /* GNT_ENTRY_H */ |