widget.h

   1 /*
   2  * widget.h - widget managing header
   3  *
   4  * Copyright © 2007-2009 Julien Danjou <julien@danjou.info>
   5  *
   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.
  10  *
  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.
  15  *
  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.
  19  *
  20  */
  21
  22 #ifndef AWESOME_WIDGET_H
  23 #define AWESOME_WIDGET_H
  24
  25 #include "button.h"
  26 #include "common/tokenize.h"
  27
  28 typedef widget_t *(widget_constructor_t)(widget_t *);
  29 typedef void (widget_destructor_t)(widget_t *);
  30
  31 /** Widget */
  32 struct widget_t
  33 {
  34     /** Lua references */
  35     luaA_ref_array_t refs;
  36     /** Widget type is constructor */
  37     widget_constructor_t *type;
  38     /** Widget destructor */
  39     widget_destructor_t *destructor;
  40     /** Geometry function */
  41     area_t (*geometry)(widget_t *, screen_t *, int, int);
  42     /** Draw function */
  43     void (*draw)(widget_t *, draw_context_t *, area_t, wibox_t *);
  44     /** Index function */
  45     int (*index)(lua_State *, awesome_token_t);
  46     /** Newindex function */
  47     int (*newindex)(lua_State *, awesome_token_t);
  48     /** Mouse over event handler */
  49     luaA_ref mouse_enter, mouse_leave;
  50     /** Alignement */
  51     alignment_t align;
  52     /** Supported alignment */
  53     alignment_t align_supported;
  54     /** Misc private data */
  55     void *data;
  56     /** Button bindings */
  57     button_array_t buttons;
  58     /** True if the widget is visible */
  59     bool isvisible;
  60 };
  61
  62 LUA_OBJECT_FUNCS(widget_t, widget, "widget");
  63
  64 struct widget_node_t
  65 {
  66     /** The widget object */
  67     widget_t *widget;
  68     /** The geometry where the widget was drawn */
  69     area_t geometry;
  70 };
  71
  72 widget_t *widget_getbycoords(position_t, widget_node_array_t *, int, int, int16_t *, int16_t *);
  73 void widget_render(wibox_t *);
  74
  75 void luaA_table2widgets(lua_State *, widget_node_array_t *);
  76
  77 void widget_invalidate_bywidget(widget_t *);
  78 void widget_invalidate_bytype(screen_t *, widget_constructor_t *);
  79
  80 widget_constructor_t widget_textbox;
  81 widget_constructor_t widget_progressbar;
  82 widget_constructor_t widget_graph;
  83 widget_constructor_t widget_systray;
  84 widget_constructor_t widget_imagebox;
  85
  86 void widget_node_delete(widget_node_t *);
  87 ARRAY_FUNCS(widget_node_t, widget_node, widget_node_delete)
  88
  89 #endif
  90
  91 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80