awful.completion: doc fixes
[awesome.git] / widget.h
blobef834a07d3a8d715c07cc45e7c888e843a7a5c5a
1 /*
2 * widget.h - widget managing header
4 * Copyright © 2007-2008 Julien Danjou <julien@danjou.info>
6 * This program is free software; you can redistribute it and/or modify
7 * it under the terms of the GNU General Public License as published by
8 * the Free Software Foundation; either version 2 of the License, or
9 * (at your option) any later version.
11 * This program is distributed in the hope that it will be useful,
12 * but WITHOUT ANY WARRANTY; without even the implied warranty of
13 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
14 * GNU General Public License for more details.
16 * You should have received a copy of the GNU General Public License along
17 * with this program; if not, write to the Free Software Foundation, Inc.,
18 * 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
22 #ifndef AWESOME_WIDGET_H
23 #define AWESOME_WIDGET_H
25 #include "mouse.h"
27 #define WIDGET_CACHE_EMBEDDED (1<<3)
29 struct widget_node_t
31 /** The widget */
32 widget_t *widget;
33 /** The geometry where the widget was drawn */
34 area_t geometry;
37 void widget_delete(widget_t **);
39 DO_RCNT(widget_t, widget, widget_delete)
41 void widget_invalidate_cache(int, int);
42 int widget_calculate_offset(int, int, int, int);
43 void widget_common_new(widget_t *);
44 void widget_render(widget_node_array_t *, draw_context_t *, xcb_gcontext_t, xcb_drawable_t, int, orientation_t, int, int, wibox_t *);
46 int luaA_widget_userdata_new(lua_State *, widget_t *);
47 void luaA_table2widgets(lua_State *, widget_node_array_t *);
49 void widget_invalidate_bywidget(widget_t *);
51 widget_constructor_t textbox_new;
52 widget_constructor_t progressbar_new;
53 widget_constructor_t graph_new;
54 widget_constructor_t systray_new;
55 widget_constructor_t imagebox_new;
57 /** Delete a widget node structure.
58 * \param node The node to destroy.
60 static inline void
61 widget_node_delete(widget_node_t *node)
63 widget_unref(&node->widget);
66 ARRAY_FUNCS(widget_node_t, widget_node, widget_node_delete)
68 #endif
70 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80