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_OBJECT_HEADER
  35     /** Widget type is constructor */
  36     widget_constructor_t *type;
  37     /** Widget destructor */
  38     widget_destructor_t *destructor;
  39     /** Geometry function for drawing */
  40     area_t (*geometry)(widget_t *, int);
  41     /** Extents function */
  42     area_t (*extents)(lua_State *, widget_t *);
  43     /** Draw function */
  44     void (*draw)(widget_t *, draw_context_t *, area_t, wibox_t *);
  45     /** Index function */
  46     int (*index)(lua_State *, awesome_token_t);
  47     /** Newindex function */
  48     int (*newindex)(lua_State *, awesome_token_t);
  49     /** Mouse over event handler */
  50     void *mouse_enter, *mouse_leave;
  51     /** Misc private data */
  52     void *data;
  53     /** Button bindings */
  54     void *buttons;
  55     /** True if the widget is visible */
  56     bool isvisible;
  57 };
  58
  59 lua_class_t widget_class;
  60 LUA_OBJECT_FUNCS(widget_class, widget_t, widget, "widget");
  61
  62 struct widget_node_t
  63 {
  64     /** The widget object */
  65     widget_t *widget;
  66     /** The geometry where the widget was drawn */
  67     area_t geometry;
  68 };
  69
  70 widget_t *widget_getbycoords(orientation_t, widget_node_array_t *, int, int, int16_t *, int16_t *);
  71 void widget_render(wibox_t *);
  72 bool widget_geometries(wibox_t *);
  73
  74 void widget_invalidate_bywidget(widget_t *);
  75 void widget_invalidate_bytype(widget_constructor_t *);
  76
  77 widget_constructor_t widget_textbox;
  78 widget_constructor_t widget_progressbar;
  79 widget_constructor_t widget_graph;
  80 widget_constructor_t widget_systray;
  81 widget_constructor_t widget_imagebox;
  82
  83 void widget_node_delete(widget_node_t *);
  84 ARRAY_FUNCS(widget_node_t, widget_node, widget_node_delete)
  85
  86 #endif
  87
  88 // vim: filetype=c:expandtab:shiftwidth=4:tabstop=8:softtabstop=4:encoding=utf-8:textwidth=80