gntwidget.h
Go to the documentation of this file.
/*
* GNT - The GLib Ncurses Toolkit
*
* GNT is the legal property of its developers, whose names are too numerous
* to list here. Please refer to the COPYRIGHT file distributed with this
* source distribution.
*
* This library is free software; you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation; either version 2 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program; if not, write to the Free Software
* Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02111-1301 USA
*/
#ifndef GNT_WIDGET_H
#define GNT_WIDGET_H
#include <stdio.h>
#include <glib.h>
#include <ncurses.h>
#include "gntbindable.h"
#define GNT_TYPE_WIDGET (gnt_widget_get_gtype())
#define GNT_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_CAST((obj), GNT_TYPE_WIDGET, GntWidget))
#define GNT_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_CAST((klass), GNT_TYPE_WIDGET, GntWidgetClass))
#define GNT_IS_WIDGET(obj) (G_TYPE_CHECK_INSTANCE_TYPE((obj), GNT_TYPE_WIDGET))
#define GNT_IS_WIDGET_CLASS(klass) (G_TYPE_CHECK_CLASS_TYPE((klass), GNT_TYPE_WIDGET))
#define GNT_WIDGET_GET_CLASS(obj) (G_TYPE_INSTANCE_GET_CLASS((obj), GNT_TYPE_WIDGET, GntWidgetClass))
#define GNT_WIDGET_FLAGS(obj) (GNT_WIDGET(obj)->priv.flags)
#define GNT_WIDGET_SET_FLAGS(obj, flags) (GNT_WIDGET_FLAGS(obj) |= flags)
#define GNT_WIDGET_UNSET_FLAGS(obj, flags) (GNT_WIDGET_FLAGS(obj) &= ~(flags))
#define GNT_WIDGET_IS_FLAG_SET(obj, flags) (GNT_WIDGET_FLAGS(obj) & (flags))
typedef struct _GntWidget GntWidget;
typedef struct _GntWidgetPriv GntWidgetPriv;
typedef struct _GntWidgetClass GntWidgetClass;
typedef enum _GntWidgetFlags
{
GNT_WIDGET_DESTROYING = 1 << 0,
GNT_WIDGET_CAN_TAKE_FOCUS = 1 << 1,
GNT_WIDGET_MAPPED = 1 << 2,
/* XXX: Need to set the following two as properties, and setup a callback whenever these
* get chnaged. */
GNT_WIDGET_NO_BORDER = 1 << 3,
GNT_WIDGET_NO_SHADOW = 1 << 4,
GNT_WIDGET_HAS_FOCUS = 1 << 5,
GNT_WIDGET_DRAWING = 1 << 6,
GNT_WIDGET_URGENT = 1 << 7,
GNT_WIDGET_GROW_X = 1 << 8,
GNT_WIDGET_GROW_Y = 1 << 9,
GNT_WIDGET_INVISIBLE = 1 << 10,
GNT_WIDGET_TRANSIENT = 1 << 11,
GNT_WIDGET_DISABLE_ACTIONS = 1 << 12,
} GntWidgetFlags;
/* XXX: This will probably move elsewhere */
typedef enum _GntMouseEvent
{
GNT_LEFT_MOUSE_DOWN = 1,
GNT_RIGHT_MOUSE_DOWN,
GNT_MIDDLE_MOUSE_DOWN,
GNT_MOUSE_UP,
GNT_MOUSE_SCROLL_UP,
GNT_MOUSE_SCROLL_DOWN
} GntMouseEvent;
/* XXX: I'll have to ask grim what he's using this for in guifications. */
typedef enum _GntParamFlags
{
GNT_PARAM_SERIALIZABLE = 1 << G_PARAM_USER_SHIFT
} GntParamFlags;
struct _GntWidgetPriv
{
int x, y;
int width, height;
GntWidgetFlags flags;
char *name;
int minw, minh; /* Minimum size for the widget */
};
struct _GntWidget
{
GntBindable inherit;
GntWidget *parent;
GntWidgetPriv priv;
WINDOW *window;
void (*gnt_reserved1)(void);
void (*gnt_reserved2)(void);
void (*gnt_reserved3)(void);
void (*gnt_reserved4)(void);
};
struct _GntWidgetClass
{
GntBindableClass parent;
void (*map)(GntWidget *obj);
void (*show)(GntWidget *obj); /* This will call draw() and take focus (if it can take focus) */
void (*destroy)(GntWidget *obj);
void (*draw)(GntWidget *obj); /* This will draw the widget */
void (*hide)(GntWidget *obj);
void (*expose)(GntWidget *widget, int x, int y, int width, int height);
void (*gained_focus)(GntWidget *widget);
void (*lost_focus)(GntWidget *widget);
void (*size_request)(GntWidget *widget);
gboolean (*confirm_size)(GntWidget *widget, int x, int y);
void (*size_changed)(GntWidget *widget, int w, int h);
void (*set_position)(GntWidget *widget, int x, int y);
gboolean (*key_pressed)(GntWidget *widget, const char *key);
void (*activate)(GntWidget *widget);
gboolean (*clicked)(GntWidget *widget, GntMouseEvent event, int x, int y);
void (*gnt_reserved1)(void);
void (*gnt_reserved2)(void);
void (*gnt_reserved3)(void);
void (*gnt_reserved4)(void);
};
G_BEGIN_DECLS
GType gnt_widget_get_gtype(void);
void gnt_widget_destroy(GntWidget *widget);
void gnt_widget_show(GntWidget *widget);
void gnt_widget_draw(GntWidget *widget);
void gnt_widget_expose(GntWidget *widget, int x, int y, int width, int height);
void gnt_widget_hide(GntWidget *widget);
void gnt_widget_get_position(GntWidget *widget, int *x, int *y);
void gnt_widget_set_position(GntWidget *widget, int x, int y);
void gnt_widget_size_request(GntWidget *widget);
void gnt_widget_get_size(GntWidget *widget, int *width, int *height);
gboolean gnt_widget_set_size(GntWidget *widget, int width, int height);
gboolean gnt_widget_confirm_size(GntWidget *widget, int width, int height);
gboolean gnt_widget_key_pressed(GntWidget *widget, const char *keys);
gboolean gnt_widget_clicked(GntWidget *widget, GntMouseEvent event, int x, int y);
gboolean gnt_widget_set_focus(GntWidget *widget, gboolean set);
void gnt_widget_activate(GntWidget *widget);
void gnt_widget_set_name(GntWidget *widget, const char *name);
const char *gnt_widget_get_name(GntWidget *widget);
void gnt_widget_queue_update(GntWidget *widget);
void gnt_widget_set_take_focus(GntWidget *widget, gboolean set);
void gnt_widget_set_visible(GntWidget *widget, gboolean set);
gboolean gnt_widget_has_shadow(GntWidget *widget);
G_END_DECLS
#endif /* GNT_WIDGET_H */
gnt_widget_destroy
void gnt_widget_destroy(GntWidget *widget)
Destroy a widget.
gnt_widget_set_size
gboolean gnt_widget_set_size(GntWidget *widget, int width, int height)
Set the size of a widget.
gnt_widget_get_gtype
G_BEGIN_DECLS GType gnt_widget_get_gtype(void)
_GntWidget
Definition: gntwidget.h:98
gnt_widget_get_name
const char * gnt_widget_get_name(GntWidget *widget)
Get the name of a widget.
gnt_widget_get_position
void gnt_widget_get_position(GntWidget *widget, int *x, int *y)
Get the position of a widget.
gnt_widget_draw
void gnt_widget_draw(GntWidget *widget)
Draw a widget.
gnt_widget_size_request
void gnt_widget_size_request(GntWidget *widget)
Request a widget to calculate its desired size.
_GntWidgetPriv
Definition: gntwidget.h:88
gnt_widget_set_name
void gnt_widget_set_name(GntWidget *widget, const char *name)
Set the name of a widget.
gnt_widget_set_take_focus
void gnt_widget_set_take_focus(GntWidget *widget, gboolean set)
Set whether a widget can take focus or not.
gnt_widget_set_focus
gboolean gnt_widget_set_focus(GntWidget *widget, gboolean set)
Give or remove focus to a widget.
gnt_widget_get_size
void gnt_widget_get_size(GntWidget *widget, int *width, int *height)
Get the size of a widget.
gnt_widget_set_visible
void gnt_widget_set_visible(GntWidget *widget, gboolean set)
Set the visibility of a widget.
_GntWidgetClass
Definition: gntwidget.h:113
_GntBindableClass
Definition: gntbindable.h:52
gntbindable.h
gnt_widget_activate
void gnt_widget_activate(GntWidget *widget)
Activate a widget.
gnt_widget_confirm_size
gboolean gnt_widget_confirm_size(GntWidget *widget, int width, int height)
Confirm a requested a size for a widget.
gnt_widget_set_position
void gnt_widget_set_position(GntWidget *widget, int x, int y)
Set the position of a widget.
gnt_widget_key_pressed
gboolean gnt_widget_key_pressed(GntWidget *widget, const char *keys)
Trigger the key-press callbacks for a widget.
_GntBindable
Definition: gntbindable.h:47
gnt_widget_has_shadow
gboolean gnt_widget_has_shadow(GntWidget *widget)
Check whether the widget has shadows.
gnt_widget_show
void gnt_widget_show(GntWidget *widget)
Show a widget.
gnt_widget_hide
void gnt_widget_hide(GntWidget *widget)
Hide a widget.
gnt_widget_clicked
gboolean gnt_widget_clicked(GntWidget *widget, GntMouseEvent event, int x, int y)
Trigger the 'click' callback of a widget.