Mercurial > pidgin
comparison finch/libgnt/gntentry.h @ 18049:1cedd520cd18
Doxygen skeleton and license info for gnt files.
author | Sadrul Habib Chowdhury <imadil@gmail.com> |
---|---|
date | Wed, 06 Jun 2007 15:42:29 +0000 |
parents | f00f2e283ffb |
children | 5c6f019e48f8 |
comparison
equal
deleted
inserted
replaced
18048:9aa2c89c8b9e | 18049:1cedd520cd18 |
---|---|
1 /** | |
2 * GNT - The GLib Ncurses Toolkit | |
3 * | |
4 * GNT is the legal property of its developers, whose names are too numerous | |
5 * to list here. Please refer to the COPYRIGHT file distributed with this | |
6 * source distribution. | |
7 * | |
8 * This library is free software; you can redistribute it and/or modify | |
9 * it under the terms of the GNU General Public License as published by | |
10 * the Free Software Foundation; either version 2 of the License, or | |
11 * (at your option) any later version. | |
12 * | |
13 * This program is distributed in the hope that it will be useful, | |
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of | |
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the | |
16 * GNU General Public License for more details. | |
17 * | |
18 * You should have received a copy of the GNU General Public License | |
19 * along with this program; if not, write to the Free Software | |
20 * Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA | |
21 */ | |
22 | |
1 #ifndef GNT_ENTRY_H | 23 #ifndef GNT_ENTRY_H |
2 #define GNT_ENTRY_H | 24 #define GNT_ENTRY_H |
3 | 25 |
4 #include "gntwidget.h" | 26 #include "gntwidget.h" |
5 #include "gnt.h" | 27 #include "gnt.h" |
71 void (*gnt_reserved4)(void); | 93 void (*gnt_reserved4)(void); |
72 }; | 94 }; |
73 | 95 |
74 G_BEGIN_DECLS | 96 G_BEGIN_DECLS |
75 | 97 |
98 /** | |
99 * | |
100 * | |
101 * @return | |
102 */ | |
76 GType gnt_entry_get_gtype(void); | 103 GType gnt_entry_get_gtype(void); |
77 | 104 |
78 GntWidget *gnt_entry_new(const char *text); | 105 /** |
106 * | |
107 * @param text | |
108 * | |
109 * @return | |
110 */ | |
111 GntWidget * gnt_entry_new(const char *text); | |
79 | 112 |
113 /** | |
114 * | |
115 * @param entry | |
116 * @param max | |
117 */ | |
80 void gnt_entry_set_max(GntEntry *entry, int max); | 118 void gnt_entry_set_max(GntEntry *entry, int max); |
81 | 119 |
120 /** | |
121 * | |
122 * @param entry | |
123 * @param text | |
124 */ | |
82 void gnt_entry_set_text(GntEntry *entry, const char *text); | 125 void gnt_entry_set_text(GntEntry *entry, const char *text); |
83 | 126 |
127 /** | |
128 * | |
129 * @param entry | |
130 * @param flag | |
131 */ | |
84 void gnt_entry_set_flag(GntEntry *entry, GntEntryFlag flag); | 132 void gnt_entry_set_flag(GntEntry *entry, GntEntryFlag flag); |
85 | 133 |
86 const char *gnt_entry_get_text(GntEntry *entry); | 134 const char *gnt_entry_get_text(GntEntry *entry); |
87 | 135 |
136 /** | |
137 * | |
138 * @param entry | |
139 */ | |
88 void gnt_entry_clear(GntEntry *entry); | 140 void gnt_entry_clear(GntEntry *entry); |
89 | 141 |
142 /** | |
143 * | |
144 * @param entry | |
145 * @param set | |
146 */ | |
90 void gnt_entry_set_masked(GntEntry *entry, gboolean set); | 147 void gnt_entry_set_masked(GntEntry *entry, gboolean set); |
91 | 148 |
149 /** | |
150 * | |
151 * @param entry | |
152 * @param text | |
153 */ | |
92 void gnt_entry_add_to_history(GntEntry *entry, const char *text); | 154 void gnt_entry_add_to_history(GntEntry *entry, const char *text); |
93 | 155 |
156 /** | |
157 * | |
158 * @param entry | |
159 * @param num | |
160 */ | |
94 void gnt_entry_set_history_length(GntEntry *entry, int num); | 161 void gnt_entry_set_history_length(GntEntry *entry, int num); |
95 | 162 |
163 /** | |
164 * | |
165 * @param entry | |
166 * @param word | |
167 */ | |
96 void gnt_entry_set_word_suggest(GntEntry *entry, gboolean word); | 168 void gnt_entry_set_word_suggest(GntEntry *entry, gboolean word); |
97 | 169 |
170 /** | |
171 * | |
172 * @param entry | |
173 * @param always | |
174 */ | |
98 void gnt_entry_set_always_suggest(GntEntry *entry, gboolean always); | 175 void gnt_entry_set_always_suggest(GntEntry *entry, gboolean always); |
99 | 176 |
177 /** | |
178 * | |
179 * @param entry | |
180 * @param text | |
181 */ | |
100 void gnt_entry_add_suggest(GntEntry *entry, const char *text); | 182 void gnt_entry_add_suggest(GntEntry *entry, const char *text); |
101 | 183 |
184 /** | |
185 * | |
186 * @param entry | |
187 * @param text | |
188 */ | |
102 void gnt_entry_remove_suggest(GntEntry *entry, const char *text); | 189 void gnt_entry_remove_suggest(GntEntry *entry, const char *text); |
103 | 190 |
104 G_END_DECLS | 191 G_END_DECLS |
105 | 192 |
106 #endif /* GNT_ENTRY_H */ | 193 #endif /* GNT_ENTRY_H */ |