comparison finch/libgnt/gntwidget.h @ 17928:8410511f4dbb

applied changes from 016401bd409e6229fae0ab1e80d9fef9365511b3 through e82c41f34ce5f7439b2f2971139efaf6ef7a54ff
author Eric Polino <aluink@pidgin.im>
date Wed, 06 Jun 2007 15:50:21 +0000
parents f00f2e283ffb
children 5c6f019e48f8
comparison
equal deleted inserted replaced
17927:f189497429c5 17928:8410511f4dbb
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_WIDGET_H 23 #ifndef GNT_WIDGET_H
2 #define GNT_WIDGET_H 24 #define GNT_WIDGET_H
3 25
4 #include <stdio.h> 26 #include <stdio.h>
5 #include <glib.h> 27 #include <glib.h>
110 void (*gnt_reserved4)(void); 132 void (*gnt_reserved4)(void);
111 }; 133 };
112 134
113 G_BEGIN_DECLS 135 G_BEGIN_DECLS
114 136
137 /**
138 *
139 *
140 * @return
141 */
115 GType gnt_widget_get_gtype(void); 142 GType gnt_widget_get_gtype(void);
143
144 /**
145 *
146 * @param widget
147 */
116 void gnt_widget_destroy(GntWidget *widget); 148 void gnt_widget_destroy(GntWidget *widget);
149
150 /**
151 *
152 * @param widget
153 */
117 void gnt_widget_show(GntWidget *widget); 154 void gnt_widget_show(GntWidget *widget);
155
156 /**
157 *
158 * @param widget
159 */
118 void gnt_widget_draw(GntWidget *widget); 160 void gnt_widget_draw(GntWidget *widget);
161
162 /**
163 *
164 * @param widget
165 * @param x
166 * @param y
167 * @param width
168 * @param height
169 */
119 void gnt_widget_expose(GntWidget *widget, int x, int y, int width, int height); 170 void gnt_widget_expose(GntWidget *widget, int x, int y, int width, int height);
171
172 /**
173 *
174 * @param widget
175 */
120 void gnt_widget_hide(GntWidget *widget); 176 void gnt_widget_hide(GntWidget *widget);
121 177
178 /**
179 *
180 * @param widget
181 * @param x
182 * @param y
183 */
122 void gnt_widget_get_position(GntWidget *widget, int *x, int *y); 184 void gnt_widget_get_position(GntWidget *widget, int *x, int *y);
185
186 /**
187 *
188 * @param widget
189 * @param x
190 * @param y
191 */
123 void gnt_widget_set_position(GntWidget *widget, int x, int y); 192 void gnt_widget_set_position(GntWidget *widget, int x, int y);
193
194 /**
195 *
196 * @param widget
197 */
124 void gnt_widget_size_request(GntWidget *widget); 198 void gnt_widget_size_request(GntWidget *widget);
199
200 /**
201 *
202 * @param widget
203 * @param width
204 * @param height
205 */
125 void gnt_widget_get_size(GntWidget *widget, int *width, int *height); 206 void gnt_widget_get_size(GntWidget *widget, int *width, int *height);
207
208 /**
209 *
210 * @param widget
211 * @param width
212 * @param height
213 *
214 * @return
215 */
126 gboolean gnt_widget_set_size(GntWidget *widget, int width, int height); 216 gboolean gnt_widget_set_size(GntWidget *widget, int width, int height);
217
218 /**
219 *
220 * @param widget
221 * @param width
222 * @param height
223 *
224 * @return
225 */
127 gboolean gnt_widget_confirm_size(GntWidget *widget, int width, int height); 226 gboolean gnt_widget_confirm_size(GntWidget *widget, int width, int height);
128 227
228 /**
229 *
230 * @param widget
231 * @param keys
232 *
233 * @return
234 */
129 gboolean gnt_widget_key_pressed(GntWidget *widget, const char *keys); 235 gboolean gnt_widget_key_pressed(GntWidget *widget, const char *keys);
130 236
237 /**
238 *
239 * @param widget
240 * @param event
241 * @param x
242 * @param y
243 *
244 * @return
245 */
131 gboolean gnt_widget_clicked(GntWidget *widget, GntMouseEvent event, int x, int y); 246 gboolean gnt_widget_clicked(GntWidget *widget, GntMouseEvent event, int x, int y);
132 247
248 /**
249 *
250 * @param widget
251 * @param set
252 *
253 * @return
254 */
133 gboolean gnt_widget_set_focus(GntWidget *widget, gboolean set); 255 gboolean gnt_widget_set_focus(GntWidget *widget, gboolean set);
256
257 /**
258 *
259 * @param widget
260 */
134 void gnt_widget_activate(GntWidget *widget); 261 void gnt_widget_activate(GntWidget *widget);
135 262
263 /**
264 *
265 * @param widget
266 * @param name
267 */
136 void gnt_widget_set_name(GntWidget *widget, const char *name); 268 void gnt_widget_set_name(GntWidget *widget, const char *name);
137 269
138 const char *gnt_widget_get_name(GntWidget *widget); 270 const char *gnt_widget_get_name(GntWidget *widget);
139 271
140 /* Widget-subclasses should call this from the draw-callback. 272 /* Widget-subclasses should call this from the draw-callback.
141 * Applications should just call gnt_widget_draw instead of this. */ 273 * Applications should just call gnt_widget_draw instead of this. */
274 /**
275 *
276 * @param widget
277 */
142 void gnt_widget_queue_update(GntWidget *widget); 278 void gnt_widget_queue_update(GntWidget *widget);
143 279
280 /**
281 *
282 * @param widget
283 * @param set
284 */
144 void gnt_widget_set_take_focus(GntWidget *widget, gboolean set); 285 void gnt_widget_set_take_focus(GntWidget *widget, gboolean set);
145 286
287 /**
288 *
289 * @param widget
290 * @param set
291 */
146 void gnt_widget_set_visible(GntWidget *widget, gboolean set); 292 void gnt_widget_set_visible(GntWidget *widget, gboolean set);
147 293
294 /**
295 *
296 * @param widget
297 *
298 * @return
299 */
148 gboolean gnt_widget_has_shadow(GntWidget *widget); 300 gboolean gnt_widget_has_shadow(GntWidget *widget);
149 301
150 G_END_DECLS 302 G_END_DECLS
151 303
152 #endif /* GNT_WIDGET_H */ 304 #endif /* GNT_WIDGET_H */