* 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 * 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 * @section_id: libgnt-gntwidget * @short_description: <filename>gntwidget.h</filename> #define GNT_TYPE_WIDGET (gnt_widget_get_type()) #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; 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 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, /* XXX: This will probably move elsewhere */ /* XXX: I'll have to ask grim what he's using this for in guifications. */ GNT_PARAM_SERIALIZABLE = 1 << G_PARAM_USER_SHIFT int minw, minh; /* Minimum size for the widget */ 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); * Returns: GType for GntWidget. GType gnt_widget_get_type(void); * @widget: The widget to destroy. * Emits the "destroy" signal notifying all reference holders that they * should release @widget. void gnt_widget_destroy(GntWidget *widget); * @widget: The widget to show. * Show a widget. This should only be used for toplevel widgets. For the rest * of the widgets, use #gnt_widget_draw instead. void gnt_widget_show(GntWidget *widget); * @widget: The widget to draw. void gnt_widget_draw(GntWidget *widget); * Expose part of a widget. * Internal function -- do not use. void gnt_widget_expose(GntWidget *widget, int x, int y, int width, int height); * @widget: The widget to hide. void gnt_widget_hide(GntWidget *widget); * gnt_widget_get_position: * @x: Location to store the x-coordinate of the widget. * @y: Location to store the y-coordinate of the widget. * Get the position of a widget. void gnt_widget_get_position(GntWidget *widget, int *x, int *y); * gnt_widget_set_position: * @widget: The widget to reposition. * @x: The x-coordinate of the widget. * @y: The x-coordinate of the widget. * Set the position of a widget. void gnt_widget_set_position(GntWidget *widget, int x, int y); * gnt_widget_size_request: * Request a widget to calculate its desired size. void gnt_widget_size_request(GntWidget *widget); * @width: Location to store the width of the widget. * @height: Location to store the height of the widget. * Get the size of a widget. void gnt_widget_get_size(GntWidget *widget, int *width, int *height); * @widget: The widget to resize. * @width: The width of the widget. * @height: The height of the widget. * Set the size of a widget. * Returns: If the widget was resized to the new size. gboolean gnt_widget_set_size(GntWidget *widget, int width, int height); * gnt_widget_confirm_size: * @width: The requested width. * @height: The requested height. * Confirm a requested a size for a widget. * Returns: %TRUE if the new size was confirmed, %FALSE otherwise. gboolean gnt_widget_confirm_size(GntWidget *widget, int width, int height); * gnt_widget_key_pressed: * @keys: The keypress on the widget. * Trigger the key-press callbacks for a widget. * Returns: %TRUE if the key-press was handled, %FALSE otherwise. gboolean gnt_widget_key_pressed(GntWidget *widget, const char *keys); * @event: The mouseevent. * @x: The x-coordinate of the mouse. * @y: The y-coordinate of the mouse. * Trigger the 'click' callback of a widget. * Returns: %TRUE if the event was handled, %FALSE otherwise. gboolean gnt_widget_clicked(GntWidget *widget, GntMouseEvent event, int x, int y); * @set: %TRUE of focus should be given to the widget, %FALSE if * focus should be removed. * Give or remove focus to a widget. * Returns: %TRUE if the focus has been changed, %FALSE otherwise. gboolean gnt_widget_set_focus(GntWidget *widget, gboolean set); * @widget: The widget to activate. * Activate a widget. This only applies to widgets that can be activated (eg. GntButton) void gnt_widget_activate(GntWidget *widget); * @name: A new name for the widget. * Set the name of a widget. void gnt_widget_set_name(GntWidget *widget, const char *name); * Get the name of a widget. * Returns: The name of the widget. const char *gnt_widget_get_name(GntWidget *widget); * gnt_widget_queue_update: * Internal function -- do not use. * Use gnt_widget_draw() instead. void gnt_widget_queue_update(GntWidget *widget); * gnt_widget_set_take_focus: * @set: %TRUE if the widget can take focus. * Set whether a widget can take focus or not. void gnt_widget_set_take_focus(GntWidget *widget, gboolean set); * gnt_widget_set_visible: * @set: Whether the widget is visible or not. * Set the visibility of a widget. void gnt_widget_set_visible(GntWidget *widget, gboolean set); * Check whether the widget has shadows. * Returns: %TRUE if the widget has shadows. This checks both the user-setting * and whether the widget can have shadows at all. gboolean gnt_widget_has_shadow(GntWidget *widget); #endif /* GNT_WIDGET_H */