gnt/gntwidget.h

   1 /**
   2  * @file gntwidget.h Widget API
   3  * @ingroup gnt
   4  */
   5 /*
   6  * GNT - The GLib Ncurses Toolkit
   7  *
   8  * GNT is the legal property of its developers, whose names are too numerous
   9  * to list here.  Please refer to the COPYRIGHT file distributed with this
  10  * source distribution.
  11  *
  12  * This library is free software; you can redistribute it and/or modify
  13  * it under the terms of the GNU General Public License as published by
  14  * the Free Software Foundation; either version 2 of the License, or
  15  * (at your option) any later version.
  16  *
  17  * This program is distributed in the hope that it will be useful,
  18  * but WITHOUT ANY WARRANTY; without even the implied warranty of
  19  * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
  20  * GNU General Public License for more details.
  21  *
  22  * You should have received a copy of the GNU General Public License
  23  * along with this program; if not, write to the Free Software
  24  * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02111-1301  USA
  25  */
  26
  27 #ifndef GNT_WIDGET_H
  28 #define GNT_WIDGET_H
  29
  30 #include <stdio.h>
  31 #include <glib.h>
  32 #include <ncurses.h>
  33
  34 #include "gntbindable.h"
  35
  36 #define GNT_TYPE_WIDGET                         (gnt_widget_get_gtype())
  37 #define GNT_WIDGET(obj)                         (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_WIDGET, GntWidget))
  38 #define GNT_WIDGET_CLASS(klass)         (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_WIDGET, GntWidgetClass))
  39 #define GNT_IS_WIDGET(obj)                      (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_WIDGET))
  40 #define GNT_IS_WIDGET_CLASS(klass)      (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_WIDGET))
  41 #define GNT_WIDGET_GET_CLASS(obj)       (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_WIDGET, GntWidgetClass))
  42
  43 #define GNT_WIDGET_FLAGS(obj)                           (GNT_WIDGET(obj)->priv.flags)
  44 #define GNT_WIDGET_SET_FLAGS(obj, flags)                (GNT_WIDGET_FLAGS(obj) |= flags)
  45 #define GNT_WIDGET_UNSET_FLAGS(obj, flags)      (GNT_WIDGET_FLAGS(obj) &= ~(flags))
  46 #define GNT_WIDGET_IS_FLAG_SET(obj, flags)      (GNT_WIDGET_FLAGS(obj) & (flags))
  47
  48 typedef struct _GntWidget                       GntWidget;
  49 typedef struct _GntWidgetPriv           GntWidgetPriv;
  50 typedef struct _GntWidgetClass          GntWidgetClass;
  51
  52 typedef enum _GntWidgetFlags
  53 {
  54         GNT_WIDGET_DESTROYING     = 1 << 0,
  55         GNT_WIDGET_CAN_TAKE_FOCUS = 1 << 1,
  56         GNT_WIDGET_MAPPED         = 1 << 2,
  57         /* XXX: Need to set the following two as properties, and setup a callback whenever these
  58          * get chnaged. */
  59         GNT_WIDGET_NO_BORDER      = 1 << 3,
  60         GNT_WIDGET_NO_SHADOW      = 1 << 4,
  61         GNT_WIDGET_HAS_FOCUS      = 1 << 5,
  62         GNT_WIDGET_DRAWING        = 1 << 6,
  63         GNT_WIDGET_URGENT         = 1 << 7,
  64         GNT_WIDGET_GROW_X         = 1 << 8,
  65         GNT_WIDGET_GROW_Y         = 1 << 9,
  66         GNT_WIDGET_INVISIBLE      = 1 << 10,
  67         GNT_WIDGET_TRANSIENT      = 1 << 11,
  68         GNT_WIDGET_DISABLE_ACTIONS = 1 << 12,
  69 } GntWidgetFlags;
  70
  71 /* XXX: This will probably move elsewhere */
  72 typedef enum _GntMouseEvent
  73 {
  74         GNT_LEFT_MOUSE_DOWN = 1,
  75         GNT_RIGHT_MOUSE_DOWN,
  76         GNT_MIDDLE_MOUSE_DOWN,
  77         GNT_MOUSE_UP,
  78         GNT_MOUSE_SCROLL_UP,
  79         GNT_MOUSE_SCROLL_DOWN
  80 } GntMouseEvent;
  81
  82 /* XXX: I'll have to ask grim what he's using this for in guifications. */
  83 typedef enum _GntParamFlags
  84 {
  85         GNT_PARAM_SERIALIZABLE  = 1 << G_PARAM_USER_SHIFT
  86 } GntParamFlags;
  87
  88 struct _GntWidgetPriv
  89 {
  90         int x, y;
  91         int width, height;
  92         GntWidgetFlags flags;
  93         char *name;
  94
  95         int minw, minh;    /* Minimum size for the widget */
  96 };
  97
  98 struct _GntWidget
  99 {
 100         GntBindable inherit;
 101
 102         GntWidget *parent;
 103
 104         GntWidgetPriv priv;
 105         WINDOW *window;
 106
 107     void (*gnt_reserved1)(void);
 108     void (*gnt_reserved2)(void);
 109     void (*gnt_reserved3)(void);
 110     void (*gnt_reserved4)(void);
 111 };
 112
 113 struct _GntWidgetClass
 114 {
 115         GntBindableClass parent;
 116
 117         void (*map)(GntWidget *obj);
 118         void (*show)(GntWidget *obj);           /* This will call draw() and take focus (if it can take focus) */
 119         void (*destroy)(GntWidget *obj);
 120         void (*draw)(GntWidget *obj);           /* This will draw the widget */
 121         void (*hide)(GntWidget *obj);
 122         void (*expose)(GntWidget *widget, int x, int y, int width, int height);
 123         void (*gained_focus)(GntWidget *widget);
 124         void (*lost_focus)(GntWidget *widget);
 125
 126         void (*size_request)(GntWidget *widget);
 127         gboolean (*confirm_size)(GntWidget *widget, int x, int y);
 128         void (*size_changed)(GntWidget *widget, int w, int h);
 129         void (*set_position)(GntWidget *widget, int x, int y);
 130         gboolean (*key_pressed)(GntWidget *widget, const char *key);
 131         void (*activate)(GntWidget *widget);
 132         gboolean (*clicked)(GntWidget *widget, GntMouseEvent event, int x, int y);
 133
 134         void (*gnt_reserved1)(void);
 135         void (*gnt_reserved2)(void);
 136         void (*gnt_reserved3)(void);
 137         void (*gnt_reserved4)(void);
 138 };
 139
 140 G_BEGIN_DECLS
 141
 142 /**
 143  *
 144  *
 145  * @return
 146  */
 147 GType gnt_widget_get_gtype(void);
 148
 149 /**
 150  *
 151  * @param widget
 152  */
 153 void gnt_widget_destroy(GntWidget *widget);
 154
 155 /**
 156  *
 157  * @param widget
 158  */
 159 void gnt_widget_show(GntWidget *widget);
 160
 161 /**
 162  *
 163  * @param widget
 164  */
 165 void gnt_widget_draw(GntWidget *widget);
 166
 167 /**
 168  *
 169  * @param widget
 170  * @param x
 171  * @param y
 172  * @param width
 173  * @param height
 174  */
 175 void gnt_widget_expose(GntWidget *widget, int x, int y, int width, int height);
 176
 177 /**
 178  *
 179  * @param widget
 180  */
 181 void gnt_widget_hide(GntWidget *widget);
 182
 183 /**
 184  *
 185  * @param widget
 186  * @param x
 187  * @param y
 188  */
 189 void gnt_widget_get_position(GntWidget *widget, int *x, int *y);
 190
 191 /**
 192  *
 193  * @param widget
 194  * @param x
 195  * @param y
 196  */
 197 void gnt_widget_set_position(GntWidget *widget, int x, int y);
 198
 199 /**
 200  *
 201  * @param widget
 202  */
 203 void gnt_widget_size_request(GntWidget *widget);
 204
 205 /**
 206  *
 207  * @param widget
 208  * @param width
 209  * @param height
 210  */
 211 void gnt_widget_get_size(GntWidget *widget, int *width, int *height);
 212
 213 /**
 214  *
 215  * @param widget
 216  * @param width
 217  * @param height
 218  *
 219  * @return
 220  */
 221 gboolean gnt_widget_set_size(GntWidget *widget, int width, int height);
 222
 223 /**
 224  *
 225  * @param widget
 226  * @param width
 227  * @param height
 228  *
 229  * @return
 230  */
 231 gboolean gnt_widget_confirm_size(GntWidget *widget, int width, int height);
 232
 233 /**
 234  *
 235  * @param widget
 236  * @param keys
 237  *
 238  * @return
 239  */
 240 gboolean gnt_widget_key_pressed(GntWidget *widget, const char *keys);
 241
 242 /**
 243  *
 244  * @param widget
 245  * @param event
 246  * @param x
 247  * @param y
 248  *
 249  * @return
 250  */
 251 gboolean gnt_widget_clicked(GntWidget *widget, GntMouseEvent event, int x, int y);
 252
 253 /**
 254  *
 255  * @param widget
 256  * @param set
 257  *
 258  * @return
 259  */
 260 gboolean gnt_widget_set_focus(GntWidget *widget, gboolean set);
 261
 262 /**
 263  *
 264  * @param widget
 265  */
 266 void gnt_widget_activate(GntWidget *widget);
 267
 268 /**
 269  *
 270  * @param widget
 271  * @param name
 272  */
 273 void gnt_widget_set_name(GntWidget *widget, const char *name);
 274
 275 const char *gnt_widget_get_name(GntWidget *widget);
 276
 277 /* Widget-subclasses should call this from the draw-callback.
 278  * Applications should just call gnt_widget_draw instead of this. */
 279 /**
 280  *
 281  * @param widget
 282  */
 283 void gnt_widget_queue_update(GntWidget *widget);
 284
 285 /**
 286  *
 287  * @param widget
 288  * @param set
 289  */
 290 void gnt_widget_set_take_focus(GntWidget *widget, gboolean set);
 291
 292 /**
 293  *
 294  * @param widget
 295  * @param set
 296  */
 297 void gnt_widget_set_visible(GntWidget *widget, gboolean set);
 298
 299 /**
 300  *
 301  * @param widget
 302  *
 303  * @return
 304  */
 305 gboolean gnt_widget_has_shadow(GntWidget *widget);
 306
 307 G_END_DECLS
 308
 309 #endif /* GNT_WIDGET_H */