* Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
*
* This library is free software; you can redistribute it and/or
- * modify it under the terms of the GNU Library General Public
+ * modify it under the terms of the GNU Lesser General Public
* License as published by the Free Software Foundation; either
* version 2 of the License, or (at your option) any later version.
*
* This library 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
- * Library General Public License for more details.
+ * Lesser General Public License for more details.
*
- * You should have received a copy of the GNU Library General Public
+ * You should have received a copy of the GNU Lesser General Public
* License along with this library; if not, write to the
* Free Software Foundation, Inc., 59 Temple Place - Suite 330,
* Boston, MA 02111-1307, USA.
*/
+
+/*
+ * Modified by the GTK+ Team and others 1997-2000. See the AUTHORS
+ * file for a list of people on the GTK+ Team. See the ChangeLog
+ * files for a list of changes. These files are distributed with
+ * GTK+ at ftp://ftp.gtk.org/pub/gtk/.
+ */
+
#ifndef __GTK_WIDGET_H__
#define __GTK_WIDGET_H__
-
#include <gdk/gdk.h>
#include <gtk/gtkaccelgroup.h>
#include <gtk/gtkobject.h>
+#include <gtk/gtkadjustment.h>
#include <gtk/gtkstyle.h>
#ifdef __cplusplus
extern "C" {
-#pragma }
#endif /* __cplusplus */
GTK_PARENT_SENSITIVE = 1 << 10,
GTK_CAN_FOCUS = 1 << 11,
GTK_HAS_FOCUS = 1 << 12,
+
+ /* widget is allowed to receive the default via gtk_widget_grab_default
+ * and will reserve space to draw the default if possible */
GTK_CAN_DEFAULT = 1 << 13,
+
+ /* the widget currently is receiving the default action and should be drawn
+ * appropriately if possible */
GTK_HAS_DEFAULT = 1 << 14,
+
GTK_HAS_GRAB = 1 << 15,
GTK_RC_STYLE = 1 << 16,
- GTK_BASIC = 1 << 17
+ GTK_COMPOSITE_CHILD = 1 << 17,
+ GTK_NO_REPARENT = 1 << 18,
+ GTK_APP_PAINTABLE = 1 << 19,
+
+ /* the widget when focused will receive the default action and have
+ * HAS_DEFAULT set even if there is a different widget set as default */
+ GTK_RECEIVES_DEFAULT = 1 << 20,
+
+ GTK_DOUBLE_BUFFERED = 1 << 21
} GtkWidgetFlags;
/* Macro for casting a pointer to a GtkWidget or GtkWidgetClass pointer.
#define GTK_WIDGET_CLASS(klass) (GTK_CHECK_CLASS_CAST ((klass), GTK_TYPE_WIDGET, GtkWidgetClass))
#define GTK_IS_WIDGET(widget) (GTK_CHECK_TYPE ((widget), GTK_TYPE_WIDGET))
#define GTK_IS_WIDGET_CLASS(klass) (GTK_CHECK_CLASS_TYPE ((klass), GTK_TYPE_WIDGET))
+#define GTK_WIDGET_GET_CLASS(obj) (GTK_CHECK_GET_CLASS ((obj), GTK_TYPE_WIDGET, GtkWidgetClass))
/* Macros for extracting various fields from GtkWidget and GtkWidgetClass.
*/
#define GTK_WIDGET_REALIZED(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_REALIZED) != 0)
#define GTK_WIDGET_MAPPED(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_MAPPED) != 0)
#define GTK_WIDGET_VISIBLE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_VISIBLE) != 0)
-#define GTK_WIDGET_DRAWABLE(wid) ((GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid)) != 0)
+#define GTK_WIDGET_DRAWABLE(wid) (GTK_WIDGET_VISIBLE (wid) && GTK_WIDGET_MAPPED (wid))
#define GTK_WIDGET_SENSITIVE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_SENSITIVE) != 0)
#define GTK_WIDGET_PARENT_SENSITIVE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_PARENT_SENSITIVE) != 0)
-#define GTK_WIDGET_IS_SENSITIVE(wid) (((GTK_WIDGET_SENSITIVE (wid) && \
- GTK_WIDGET_PARENT_SENSITIVE (wid)) != 0) != 0)
+#define GTK_WIDGET_IS_SENSITIVE(wid) (GTK_WIDGET_SENSITIVE (wid) && \
+ GTK_WIDGET_PARENT_SENSITIVE (wid))
#define GTK_WIDGET_CAN_FOCUS(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_FOCUS) != 0)
#define GTK_WIDGET_HAS_FOCUS(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_FOCUS) != 0)
#define GTK_WIDGET_CAN_DEFAULT(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_CAN_DEFAULT) != 0)
#define GTK_WIDGET_HAS_DEFAULT(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_DEFAULT) != 0)
#define GTK_WIDGET_HAS_GRAB(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_HAS_GRAB) != 0)
-#define GTK_WIDGET_BASIC(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_BASIC) != 0)
#define GTK_WIDGET_RC_STYLE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_RC_STYLE) != 0)
+#define GTK_WIDGET_COMPOSITE_CHILD(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_COMPOSITE_CHILD) != 0)
+#define GTK_WIDGET_APP_PAINTABLE(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_APP_PAINTABLE) != 0)
+#define GTK_WIDGET_RECEIVES_DEFAULT(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_RECEIVES_DEFAULT) != 0)
+#define GTK_WIDGET_DOUBLE_BUFFERED(wid) ((GTK_WIDGET_FLAGS (wid) & GTK_DOUBLE_BUFFERED) != 0)
/* Macros for setting and clearing widget flags.
*/
typedef struct _GtkRequisition GtkRequisition;
-typedef struct _GtkAllocation GtkAllocation;
+typedef struct _GdkRectangle GtkAllocation;
typedef struct _GtkSelectionData GtkSelectionData;
-typedef struct _GtkWidget GtkWidget;
typedef struct _GtkWidgetClass GtkWidgetClass;
typedef struct _GtkWidgetAuxInfo GtkWidgetAuxInfo;
typedef struct _GtkWidgetShapeInfo GtkWidgetShapeInfo;
*/
struct _GtkRequisition
{
- guint16 width;
- guint16 height;
-};
-
-/* An allocation is a size and position. Where a widget
- * can ask for a desired size, it is actually given
- * this amount of space at the specified position.
- */
-struct _GtkAllocation
-{
- gint16 x;
- gint16 y;
- guint16 width;
- guint16 height;
+ gint width;
+ gint height;
};
/* The contents of a selection are returned in a GtkSelectionData
no fields should be modified directly, they should not be created
directly, and pointers to them should not be stored beyond the duration of
a callback. (If the last is changed, we'll need to add reference
- counting) */
+ counting.) The time field gives the timestamp at which the data was sent. */
struct _GtkSelectionData
{
*/
GtkObjectClass parent_class;
- /* The signal to emit when an object of this class is activated.
- * This is used when activating the current focus widget and
- * the default widget.
+ /* The signal to emit when a widget of this class is activated,
+ * gtk_widget_activate() handles the emission.
+ * Implementation of this signal is optional.
*/
guint activate_signal;
+
+ /* This signal is emitted when a widget of this class is added
+ * to a scrolling aware parent, gtk_widget_set_scroll_adjustments()
+ * handles the emission.
+ * Implementation of this signal is optional.
+ */
+ guint set_scroll_adjustments_signal;
/* basics */
- void (* show) (GtkWidget *widget);
- void (* hide) (GtkWidget *widget);
- void (* show_all) (GtkWidget *widget);
- void (* hide_all) (GtkWidget *widget);
- void (* map) (GtkWidget *widget);
- void (* unmap) (GtkWidget *widget);
- void (* realize) (GtkWidget *widget);
- void (* unrealize) (GtkWidget *widget);
- void (* draw) (GtkWidget *widget,
- GdkRectangle *area);
- void (* draw_focus) (GtkWidget *widget);
- void (* draw_default) (GtkWidget *widget);
- void (* size_request) (GtkWidget *widget,
- GtkRequisition *requisition);
- void (* size_allocate) (GtkWidget *widget,
- GtkAllocation *allocation);
- void (* state_changed) (GtkWidget *widget,
- GtkStateType previous_state);
- void (* parent_set) (GtkWidget *widget,
- GtkWidget *previous_parent);
- void (* style_set) (GtkWidget *widget,
- GtkStyle *previous_style);
+ void (* show) (GtkWidget *widget);
+ void (* show_all) (GtkWidget *widget);
+ void (* hide) (GtkWidget *widget);
+ void (* hide_all) (GtkWidget *widget);
+ void (* map) (GtkWidget *widget);
+ void (* unmap) (GtkWidget *widget);
+ void (* realize) (GtkWidget *widget);
+ void (* unrealize) (GtkWidget *widget);
+ void (* draw) (GtkWidget *widget,
+ GdkRectangle *area);
+ void (* draw_focus) (GtkWidget *widget);
+ void (* draw_default) (GtkWidget *widget);
+ void (* size_request) (GtkWidget *widget,
+ GtkRequisition *requisition);
+ void (* size_allocate) (GtkWidget *widget,
+ GtkAllocation *allocation);
+ void (* state_changed) (GtkWidget *widget,
+ GtkStateType previous_state);
+ void (* parent_set) (GtkWidget *widget,
+ GtkWidget *previous_parent);
+ void (* style_set) (GtkWidget *widget,
+ GtkStyle *previous_style);
+ void (* direction_changed) (GtkWidget *widget,
+ GtkTextDirection previous_direction);
/* accelerators */
gint (* add_accelerator) (GtkWidget *widget,
GtkAccelGroup *accel_group,
guint accel_key,
GdkModifierType accel_mods);
+
+ /* explicit focus */
+ void (* grab_focus) (GtkWidget *widget);
/* events */
gint (* event) (GtkWidget *widget,
GdkEventButton *event);
gint (* button_release_event) (GtkWidget *widget,
GdkEventButton *event);
+ gint (* scroll_event) (GtkWidget *widget,
+ GdkEventScroll *event);
gint (* motion_notify_event) (GtkWidget *widget,
GdkEventMotion *event);
gint (* delete_event) (GtkWidget *widget,
GdkEventProximity *event);
gint (* proximity_out_event) (GtkWidget *widget,
GdkEventProximity *event);
- gint (* drag_begin_event) (GtkWidget *widget,
- GdkEventDragBegin *event);
- gint (* drag_request_event) (GtkWidget *widget,
- GdkEventDragRequest *event);
- gint (* drag_end_event) (GtkWidget *widget,
- GdkEvent *event);
- gint (* drop_enter_event) (GtkWidget *widget,
- GdkEventDropEnter *event);
- gint (* drop_leave_event) (GtkWidget *widget,
- GdkEventDropLeave *event);
- gint (* drop_data_available_event)(GtkWidget *widget,
- GdkEventDropDataAvailable *event);
gint (* visibility_notify_event) (GtkWidget *widget,
GdkEventVisibility *event);
gint (* client_event) (GtkWidget *widget,
GdkEventClient *event);
gint (* no_expose_event) (GtkWidget *widget,
GdkEventAny *event);
- gint (* other_event) (GtkWidget *widget,
- GdkEventOther *event);
-
+
/* selection */
+ void (* selection_get) (GtkWidget *widget,
+ GtkSelectionData *selection_data,
+ guint info,
+ guint time);
void (* selection_received) (GtkWidget *widget,
- GtkSelectionData *selection_data);
+ GtkSelectionData *selection_data,
+ guint time);
+
+ /* Source side drag signals */
+ void (* drag_begin) (GtkWidget *widget,
+ GdkDragContext *context);
+ void (* drag_end) (GtkWidget *widget,
+ GdkDragContext *context);
+ void (* drag_data_get) (GtkWidget *widget,
+ GdkDragContext *context,
+ GtkSelectionData *selection_data,
+ guint info,
+ guint time);
+ void (* drag_data_delete) (GtkWidget *widget,
+ GdkDragContext *context);
+
+ /* Target side drag signals */
+ void (* drag_leave) (GtkWidget *widget,
+ GdkDragContext *context,
+ guint time);
+ gboolean (* drag_motion) (GtkWidget *widget,
+ GdkDragContext *context,
+ gint x,
+ gint y,
+ guint time);
+ gboolean (* drag_drop) (GtkWidget *widget,
+ GdkDragContext *context,
+ gint x,
+ gint y,
+ guint time);
+ void (* drag_data_received) (GtkWidget *widget,
+ GdkDragContext *context,
+ gint x,
+ gint y,
+ GtkSelectionData *selection_data,
+ guint info,
+ guint time);
+
+ /* action signals */
+ void (* debug_msg) (GtkWidget *widget,
+ const gchar *string);
+
+ /* Padding for future expandsion */
+ GtkFunction pad1;
+ GtkFunction pad2;
+ GtkFunction pad3;
+ GtkFunction pad4;
};
struct _GtkWidgetAuxInfo
{
gint16 x;
gint16 y;
- guint16 width;
- guint16 height;
+ gint16 width;
+ gint16 height;
};
struct _GtkWidgetShapeInfo
GdkBitmap *shape_mask;
};
-
-GtkType gtk_widget_get_type (void);
-GtkWidget* gtk_widget_new (guint type,
+GtkType gtk_widget_get_type (void) G_GNUC_CONST;
+GtkWidget* gtk_widget_new (GtkType type,
+ const gchar *first_arg_name,
...);
-GtkWidget* gtk_widget_newv (guint type,
+GtkWidget* gtk_widget_newv (GtkType type,
guint nargs,
GtkArg *args);
-void gtk_widget_ref (GtkWidget *widget);
+GtkWidget* gtk_widget_ref (GtkWidget *widget);
void gtk_widget_unref (GtkWidget *widget);
void gtk_widget_destroy (GtkWidget *widget);
void gtk_widget_destroyed (GtkWidget *widget,
guint nargs,
GtkArg *args);
void gtk_widget_set (GtkWidget *widget,
+ const gchar *first_arg_name,
...);
void gtk_widget_setv (GtkWidget *widget,
guint nargs,
void gtk_widget_unmap (GtkWidget *widget);
void gtk_widget_realize (GtkWidget *widget);
void gtk_widget_unrealize (GtkWidget *widget);
+
+/* Queuing draws */
void gtk_widget_queue_draw (GtkWidget *widget);
+void gtk_widget_queue_draw_area (GtkWidget *widget,
+ gint x,
+ gint y,
+ gint width,
+ gint height);
+void gtk_widget_queue_clear (GtkWidget *widget);
+void gtk_widget_queue_clear_area (GtkWidget *widget,
+ gint x,
+ gint y,
+ gint width,
+ gint height);
+
+
void gtk_widget_queue_resize (GtkWidget *widget);
void gtk_widget_draw (GtkWidget *widget,
GdkRectangle *area);
void gtk_widget_draw_focus (GtkWidget *widget);
void gtk_widget_draw_default (GtkWidget *widget);
-void gtk_widget_draw_children (GtkWidget *widget);
void gtk_widget_size_request (GtkWidget *widget,
GtkRequisition *requisition);
void gtk_widget_size_allocate (GtkWidget *widget,
GtkAllocation *allocation);
+void gtk_widget_get_child_requisition (GtkWidget *widget,
+ GtkRequisition *requisition);
void gtk_widget_add_accelerator (GtkWidget *widget,
const gchar *accel_signal,
GtkAccelGroup *accel_group,
guint accel_key,
guint accel_mods,
GtkAccelFlags accel_flags);
-void gtk_widget_stop_accelerator (GtkWidget *widget);
void gtk_widget_remove_accelerator (GtkWidget *widget,
GtkAccelGroup *accel_group,
guint accel_key,
GtkAccelGroup *accel_group,
guint accel_key,
guint accel_mods);
+void gtk_widget_lock_accelerators (GtkWidget *widget);
+void gtk_widget_unlock_accelerators (GtkWidget *widget);
+gboolean gtk_widget_accelerators_locked (GtkWidget *widget);
gint gtk_widget_event (GtkWidget *widget,
GdkEvent *event);
-void gtk_widget_activate (GtkWidget *widget);
+gboolean gtk_widget_activate (GtkWidget *widget);
+gboolean gtk_widget_set_scroll_adjustments (GtkWidget *widget,
+ GtkAdjustment *hadjustment,
+ GtkAdjustment *vadjustment);
+
void gtk_widget_reparent (GtkWidget *widget,
GtkWidget *new_parent);
void gtk_widget_popup (GtkWidget *widget,
gint gtk_widget_intersect (GtkWidget *widget,
GdkRectangle *area,
GdkRectangle *intersection);
-gint gtk_widget_basic (GtkWidget *widget);
void gtk_widget_grab_focus (GtkWidget *widget);
void gtk_widget_grab_default (GtkWidget *widget);
void gtk_widget_set_state (GtkWidget *widget,
GtkStateType state);
void gtk_widget_set_sensitive (GtkWidget *widget,
- gint sensitive);
+ gboolean sensitive);
+void gtk_widget_set_app_paintable (GtkWidget *widget,
+ gboolean app_paintable);
+void gtk_widget_set_double_buffered (GtkWidget *widget,
+ gboolean double_buffered);
void gtk_widget_set_parent (GtkWidget *widget,
GtkWidget *parent);
void gtk_widget_set_parent_window (GtkWidget *widget,
gint height);
void gtk_widget_set_events (GtkWidget *widget,
gint events);
+void gtk_widget_add_events (GtkWidget *widget,
+ gint events);
void gtk_widget_set_extension_events (GtkWidget *widget,
GdkExtensionMode mode);
GtkType widget_type);
GdkColormap* gtk_widget_get_colormap (GtkWidget *widget);
GdkVisual* gtk_widget_get_visual (GtkWidget *widget);
+
+/* The following functions must not be called on an already
+ * realized widget. Because it is possible that somebody
+ * can call get_colormap() or get_visual() and save the
+ * result, these functions are probably only safe to
+ * call in a widget's init() function.
+ */
+void gtk_widget_set_colormap (GtkWidget *widget,
+ GdkColormap *colormap);
+
gint gtk_widget_get_events (GtkWidget *widget);
void gtk_widget_get_pointer (GtkWidget *widget,
gint *x,
gint gtk_widget_is_ancestor (GtkWidget *widget,
GtkWidget *ancestor);
-gint gtk_widget_is_child (GtkWidget *widget,
- GtkWidget *child);
/* Hide widget and return TRUE.
*/
GtkStyle* gtk_widget_get_style (GtkWidget *widget);
void gtk_widget_restore_default_style (GtkWidget *widget);
+void gtk_widget_modify_style (GtkWidget *widget,
+ GtkRcStyle *style);
+GtkRcStyle *gtk_widget_get_modifier_style (GtkWidget *widget);
+void gtk_widget_modify_fg (GtkWidget *widget,
+ GtkStateType state,
+ GdkColor *color);
+void gtk_widget_modify_bg (GtkWidget *widget,
+ GtkStateType state,
+ GdkColor *color);
+void gtk_widget_modify_text (GtkWidget *widget,
+ GtkStateType state,
+ GdkColor *color);
+void gtk_widget_modify_base (GtkWidget *widget,
+ GtkStateType state,
+ GdkColor *color);
+void gtk_widget_modify_font (GtkWidget *widget,
+ PangoFontDescription *font_desc);
+
+PangoContext *gtk_widget_create_pango_context (GtkWidget *widget);
+PangoContext *gtk_widget_get_pango_context (GtkWidget *widget);
+PangoLayout *gtk_widget_create_pango_layout (GtkWidget *widget,
+ const gchar *text);
+
+GdkPixbuf* gtk_widget_render_stock_icon (GtkWidget *widget,
+ const gchar *stock_id,
+ const gchar *size,
+ const gchar *detail);
+
+/* handle composite names for GTK_COMPOSITE_CHILD widgets,
+ * the returned name is newly allocated.
+ */
+void gtk_widget_set_composite_name (GtkWidget *widget,
+ const gchar *name);
+gchar* gtk_widget_get_composite_name (GtkWidget *widget);
+
/* Descend recursively and set rc-style on all widgets without user styles */
void gtk_widget_reset_rc_styles (GtkWidget *widget);
* This will override the values that got set by the
* gtk_widget_set_default_* () functions.
*/
-void gtk_widget_push_style (GtkStyle *style);
-void gtk_widget_push_colormap (GdkColormap *cmap);
-void gtk_widget_push_visual (GdkVisual *visual);
-void gtk_widget_pop_style (void);
-void gtk_widget_pop_colormap (void);
-void gtk_widget_pop_visual (void);
+void gtk_widget_push_style (GtkStyle *style);
+void gtk_widget_push_colormap (GdkColormap *cmap);
+void gtk_widget_push_composite_child (void);
+void gtk_widget_pop_composite_child (void);
+void gtk_widget_pop_style (void);
+void gtk_widget_pop_colormap (void);
/* Set certain default values to be used at widget creation time.
*/
void gtk_widget_set_default_style (GtkStyle *style);
void gtk_widget_set_default_colormap (GdkColormap *colormap);
-void gtk_widget_set_default_visual (GdkVisual *visual);
GtkStyle* gtk_widget_get_default_style (void);
GdkColormap* gtk_widget_get_default_colormap (void);
GdkVisual* gtk_widget_get_default_visual (void);
+/* Functions for setting directionality for widgets
+ */
+
+void gtk_widget_set_direction (GtkWidget *widget,
+ GtkTextDirection dir);
+GtkTextDirection gtk_widget_get_direction (GtkWidget *widget);
+
+void gtk_widget_set_default_direction (GtkTextDirection dir);
+GtkTextDirection gtk_widget_get_default_direction (void);
+
/* Counterpart to gdk_window_shape_combine_mask.
*/
void gtk_widget_shape_combine_mask (GtkWidget *widget,
gint offset_x,
gint offset_y);
+/* internal function */
+void gtk_widget_reset_shapes (GtkWidget *widget);
+
/* Compute a widget's path in the form "GtkWindow.MyLabel", and
* return newly alocated strings.
*/
gchar **path,
gchar **path_reversed);
-/* When you get a drag_enter event, you can use this to tell Gtk of other
- * items that are to be dragged as well...
- */
-void gtk_widget_dnd_drag_add (GtkWidget *widget);
-
-/* These two functions enable drag and/or drop on a widget,
- * and also let Gtk know what data types will be accepted (use MIME
- * type naming, plus tacking "URL:" on the front for link dragging)
- */
-void gtk_widget_dnd_drag_set (GtkWidget *widget,
- guint8 drag_enable,
- gchar **type_accept_list,
- guint numtypes);
-void gtk_widget_dnd_drop_set (GtkWidget *widget,
- guint8 drop_enable,
- gchar **type_accept_list,
- guint numtypes,
- guint8 is_destructive_operation);
-
-/* Used to reply to a DRAG_REQUEST event - if you don't want to
- * give the data then pass in NULL for it
- */
-void gtk_widget_dnd_data_set (GtkWidget *widget,
- GdkEvent *event,
- gpointer data,
- gulong data_numbytes);
-
#if defined (GTK_TRACE_OBJECTS) && defined (__GNUC__)
# define gtk_widget_ref gtk_object_ref
# define gtk_widget_unref gtk_object_unref
#endif /* GTK_TRACE_OBJECTS && __GNUC__ */
+
#ifdef __cplusplus
}
#endif /* __cplusplus */
projects / ~andy / gtk / blobdiff