1 /* GDK - The GIMP Drawing Kit
2 * Copyright (C) 1995-1997 Peter Mattis, Spencer Kimball and Josh MacDonald
4 * This library is free software; you can redistribute it and/or
5 * modify it under the terms of the GNU Library General Public
6 * License as published by the Free Software Foundation; either
7 * version 2 of the License, or (at your option) any later version.
9 * This library is distributed in the hope that it will be useful,
10 * but WITHOUT ANY WARRANTY; without even the implied warranty of
11 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
12 * Library General Public License for more details.
14 * You should have received a copy of the GNU Library General Public
15 * License along with this library; if not, write to the
16 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
17 * Boston, MA 02111-1307, USA.
23 #include <gdk/gdktypes.h>
28 #endif /* __cplusplus */
31 /* Initialization, exit and events
33 void gdk_init (int *argc,
35 void gdk_exit (int error_code);
36 gchar* gdk_set_locale (void);
38 gint gdk_events_pending (void);
39 GdkEvent *gdk_event_get (void);
40 GdkEvent *gdk_event_get_graphics_expose (GdkWindow *window);
41 void gdk_event_put (GdkEvent *event);
43 GdkEvent *gdk_event_copy (GdkEvent *event);
44 void gdk_event_free (GdkEvent *event);
46 void gdk_set_show_events (gint show_events);
47 void gdk_set_use_xshm (gint use_xshm);
49 gint gdk_get_show_events (void);
50 gint gdk_get_use_xshm (void);
51 gchar *gdk_get_display (void);
53 guint32 gdk_time_get (void);
54 guint32 gdk_timer_get (void);
55 void gdk_timer_set (guint32 milliseconds);
56 void gdk_timer_enable (void);
57 void gdk_timer_disable (void);
59 gint gdk_input_add_full (gint source,
60 GdkInputCondition condition,
61 GdkInputFunction function,
63 GdkDestroyNotify destroy);
64 #define gdk_input_add_interp gdk_input_add_full
65 gint gdk_input_add (gint source,
66 GdkInputCondition condition,
67 GdkInputFunction function,
69 void gdk_input_remove (gint tag);
71 gint gdk_pointer_grab (GdkWindow * window,
73 GdkEventMask event_mask,
74 GdkWindow * confine_to,
77 void gdk_pointer_ungrab (guint32 time);
79 gint gdk_keyboard_grab (GdkWindow * window,
82 void gdk_keyboard_ungrab (guint32 time);
84 gint gdk_pointer_is_grabbed (void);
86 gint gdk_screen_width (void);
87 gint gdk_screen_height (void);
89 gint gdk_screen_width_mm (void);
90 gint gdk_screen_height_mm (void);
92 void gdk_flush (void);
95 void gdk_key_repeat_disable (void);
96 void gdk_key_repeat_restore (void);
101 gint gdk_visual_get_best_depth (void);
102 GdkVisualType gdk_visual_get_best_type (void);
103 GdkVisual* gdk_visual_get_system (void);
104 GdkVisual* gdk_visual_get_best (void);
105 GdkVisual* gdk_visual_get_best_with_depth (gint depth);
106 GdkVisual* gdk_visual_get_best_with_type (GdkVisualType visual_type);
107 GdkVisual* gdk_visual_get_best_with_both (gint depth,
108 GdkVisualType visual_type);
110 /* Actually, these are no-ops... */
111 GdkVisual* gdk_visual_ref (GdkVisual *visual);
112 void gdk_visual_unref (GdkVisual *visual);
114 void gdk_query_depths (gint **depths,
116 void gdk_query_visual_types (GdkVisualType **visual_types,
119 GList* gdk_list_visuals (void);
124 GdkWindow* gdk_window_new (GdkWindow *parent,
125 GdkWindowAttr *attributes,
126 gint attributes_mask);
128 GdkWindow* gdk_window_foreign_new (guint32 anid);
129 void gdk_window_destroy (GdkWindow *window);
130 GdkWindow* gdk_window_ref (GdkWindow *window);
131 void gdk_window_unref (GdkWindow *window);
133 GdkWindow* gdk_window_at_pointer (gint *win_x,
135 void gdk_window_show (GdkWindow *window);
136 void gdk_window_hide (GdkWindow *window);
137 void gdk_window_withdraw (GdkWindow *window);
138 void gdk_window_move (GdkWindow *window,
141 void gdk_window_resize (GdkWindow *window,
144 void gdk_window_move_resize (GdkWindow *window,
149 void gdk_window_reparent (GdkWindow *window,
150 GdkWindow *new_parent,
153 void gdk_window_clear (GdkWindow *window);
154 void gdk_window_clear_area (GdkWindow *window,
159 void gdk_window_clear_area_e(GdkWindow *window,
164 void gdk_window_copy_area (GdkWindow *window,
168 GdkWindow *source_window,
173 void gdk_window_raise (GdkWindow *window);
174 void gdk_window_lower (GdkWindow *window);
176 void gdk_window_set_user_data (GdkWindow *window,
178 void gdk_window_set_override_redirect(GdkWindow *window,
179 gboolean override_redirect);
181 void gdk_window_add_filter (GdkWindow *window,
182 GdkFilterFunc function,
184 void gdk_window_remove_filter (GdkWindow *window,
185 GdkFilterFunc function,
189 * This allows for making shaped (partially transparent) windows
190 * - cool feature, needed for Drag and Drag for example.
191 * The shape_mask can be the mask
192 * from gdk_pixmap_create_from_xpm. Stefan Wille
194 void gdk_window_shape_combine_mask (GdkWindow *window,
195 GdkBitmap *shape_mask,
201 * Algorithm (drop source):
202 * A window being dragged will be sent a GDK_DRAG_BEGIN message.
203 * It will then do gdk_dnd_drag_addwindow() for any other windows that are to be
205 * When we get a DROP_ENTER incoming, we send it on to the window in question.
206 * That window needs to use gdk_dnd_drop_enter_reply() to indicate the state of
207 * things (it must call that even if it's not going to accept the drop)
209 * These two turn on/off drag or drop, and if enabling it also
210 * sets the list of types supported. The list of types passed in
211 * should be in order of decreasing preference.
213 void gdk_window_dnd_drag_set (GdkWindow *window,
219 *XXX todo: add a GDK_DROP_ENTER which can look at actual data
221 void gdk_window_dnd_drop_set (GdkWindow *window,
225 guint8 destructive_op);
228 * This is used by the GDK_DRAG_BEGIN handler. An example of usage would be a
229 * file manager where multiple icons were selected and the drag began.
230 * The icon that the drag actually began on would gdk_dnd_drag_addwindow
231 * for all the other icons that were being dragged...
233 void gdk_dnd_drag_addwindow (GdkWindow *window);
234 void gdk_window_dnd_data_set (GdkWindow *window,
237 gulong data_numbytes);
238 void gdk_dnd_set_drag_cursors(GdkCursor *default_cursor,
239 GdkCursor *goahead_cursor);
240 void gdk_dnd_set_drag_shape(GdkWindow *default_pixmapwin,
241 GdkPoint *default_hotspot,
242 GdkWindow *goahead_pixmapwin,
243 GdkPoint *goahead_hotspot);
245 void gdk_window_set_hints (GdkWindow *window,
253 void gdk_window_set_title (GdkWindow *window,
255 void gdk_window_set_background (GdkWindow *window,
257 void gdk_window_set_back_pixmap (GdkWindow *window,
259 gint parent_relative);
260 void gdk_window_set_cursor (GdkWindow *window,
262 void gdk_window_set_colormap (GdkWindow *window,
263 GdkColormap *colormap);
264 void gdk_window_get_user_data (GdkWindow *window,
266 void gdk_window_get_geometry (GdkWindow *window,
272 void gdk_window_get_position (GdkWindow *window,
275 void gdk_window_get_size (GdkWindow *window,
278 GdkVisual* gdk_window_get_visual (GdkWindow *window);
279 GdkColormap* gdk_window_get_colormap (GdkWindow *window);
280 GdkWindowType gdk_window_get_type (GdkWindow *window);
281 gint gdk_window_get_origin (GdkWindow *window,
284 void gdk_window_get_root_origin (GdkWindow *window,
287 GdkWindow* gdk_window_get_pointer (GdkWindow *window,
290 GdkModifierType *mask);
291 GdkWindow* gdk_window_get_parent (GdkWindow *window);
292 GdkWindow* gdk_window_get_toplevel (GdkWindow *window);
293 GList* gdk_window_get_children (GdkWindow *window);
294 GdkEventMask gdk_window_get_events (GdkWindow *window);
295 void gdk_window_set_events (GdkWindow *window,
296 GdkEventMask event_mask);
298 void gdk_window_set_icon (GdkWindow *window,
299 GdkWindow *icon_window,
302 void gdk_window_set_icon_name (GdkWindow *window,
304 void gdk_window_set_group (GdkWindow *window,
306 void gdk_window_set_decorations (GdkWindow *window,
307 GdkWMDecoration decorations);
308 void gdk_window_set_functions (GdkWindow *window,
309 GdkWMFunction functions);
310 GList * gdk_window_get_toplevels (void);
312 void gdk_drawable_set_data (GdkDrawable *drawable,
315 GDestroyNotify destroy_func);
320 GdkCursor* gdk_cursor_new (GdkCursorType cursor_type);
321 GdkCursor* gdk_cursor_new_from_pixmap (GdkPixmap *source,
327 void gdk_cursor_destroy (GdkCursor *cursor);
332 GdkGC* gdk_gc_new (GdkWindow *window);
333 GdkGC* gdk_gc_new_with_values (GdkWindow *window,
335 GdkGCValuesMask values_mask);
336 GdkGC* gdk_gc_ref (GdkGC *gc);
337 void gdk_gc_unref (GdkGC *gc);
338 void gdk_gc_destroy (GdkGC *gc);
339 void gdk_gc_get_values (GdkGC *gc,
340 GdkGCValues *values);
341 void gdk_gc_set_foreground (GdkGC *gc,
343 void gdk_gc_set_background (GdkGC *gc,
345 void gdk_gc_set_font (GdkGC *gc,
347 void gdk_gc_set_function (GdkGC *gc,
348 GdkFunction function);
349 void gdk_gc_set_fill (GdkGC *gc,
351 void gdk_gc_set_tile (GdkGC *gc,
353 void gdk_gc_set_stipple (GdkGC *gc,
355 void gdk_gc_set_ts_origin (GdkGC *gc,
358 void gdk_gc_set_clip_origin (GdkGC *gc,
361 void gdk_gc_set_clip_mask (GdkGC *gc,
363 void gdk_gc_set_clip_rectangle (GdkGC *gc,
364 GdkRectangle *rectangle);
365 void gdk_gc_set_clip_region (GdkGC *gc,
367 void gdk_gc_set_subwindow (GdkGC *gc,
368 GdkSubwindowMode mode);
369 void gdk_gc_set_exposures (GdkGC *gc,
371 void gdk_gc_set_line_attributes (GdkGC *gc,
373 GdkLineStyle line_style,
374 GdkCapStyle cap_style,
375 GdkJoinStyle join_style);
376 void gdk_gc_set_dashes (GdkGC *gc,
380 void gdk_gc_copy (GdkGC *dst_gc,
386 GdkPixmap* gdk_pixmap_new (GdkWindow *window,
390 GdkBitmap* gdk_bitmap_create_from_data (GdkWindow *window,
394 GdkPixmap* gdk_pixmap_create_from_data (GdkWindow *window,
401 GdkPixmap* gdk_pixmap_create_from_xpm (GdkWindow *window,
403 GdkColor *transparent_color,
404 const gchar *filename);
405 GdkPixmap* gdk_pixmap_colormap_create_from_xpm
407 GdkColormap *colormap,
409 GdkColor *transparent_color,
410 const gchar *filename);
411 GdkPixmap* gdk_pixmap_create_from_xpm_d (GdkWindow *window,
413 GdkColor *transparent_color,
415 GdkPixmap* gdk_pixmap_colormap_create_from_xpm_d
417 GdkColormap *colormap,
419 GdkColor *transparent_color,
421 GdkPixmap *gdk_pixmap_ref (GdkPixmap *pixmap);
422 void gdk_pixmap_unref (GdkPixmap *pixmap);
424 GdkBitmap *gdk_bitmap_ref (GdkBitmap *pixmap);
425 void gdk_bitmap_unref (GdkBitmap *pixmap);
430 GdkImage* gdk_image_new_bitmap(GdkVisual *visual,
434 GdkImage* gdk_image_new (GdkImageType type,
438 GdkImage* gdk_image_get (GdkWindow *window,
443 void gdk_image_put_pixel (GdkImage *image,
447 guint32 gdk_image_get_pixel (GdkImage *image,
450 void gdk_image_destroy (GdkImage *image);
455 GdkColormap* gdk_colormap_new (GdkVisual *visual,
457 GdkColormap* gdk_colormap_ref (GdkColormap *cmap);
458 void gdk_colormap_unref (GdkColormap *cmap);
460 GdkColormap* gdk_colormap_get_system (void);
461 gint gdk_colormap_get_system_size (void);
463 void gdk_colormap_change (GdkColormap *colormap,
467 gint gdk_colormap_alloc_colors (GdkColormap *colormap,
473 gboolean gdk_colormap_alloc_color (GdkColormap *colormap,
476 gboolean best_match);
477 void gdk_colormap_free_colors (GdkColormap *colormap,
481 void gdk_colors_store (GdkColormap *colormap,
485 GdkColor *gdk_color_copy (GdkColor *color);
486 void gdk_color_free (GdkColor *color);
488 gint gdk_colors_alloc (GdkColormap *colormap,
494 void gdk_colors_free (GdkColormap *colormap,
498 gint gdk_color_white (GdkColormap *colormap,
500 gint gdk_color_black (GdkColormap *colormap,
502 gint gdk_color_parse (const gchar *spec,
504 gint gdk_color_alloc (GdkColormap *colormap,
506 gint gdk_color_change (GdkColormap *colormap,
508 guint gdk_color_hash (const GdkColor *colora,
509 const GdkColor *colorb);
510 gint gdk_color_equal (const GdkColor *colora,
511 const GdkColor *colorb);
516 GdkFont* gdk_font_load (const gchar *font_name);
517 GdkFont* gdk_fontset_load (gchar *fontset_name);
518 GdkFont* gdk_font_ref (GdkFont *font);
519 void gdk_font_unref (GdkFont *font);
520 gint gdk_font_id (const GdkFont *font);
521 gint gdk_font_equal (const GdkFont *fonta,
522 const GdkFont *fontb);
523 gint gdk_string_width (GdkFont *font,
524 const gchar *string);
525 gint gdk_text_width (GdkFont *font,
528 gint gdk_char_width (GdkFont *font,
530 gint gdk_string_measure (GdkFont *font,
531 const gchar *string);
532 gint gdk_text_measure (GdkFont *font,
535 gint gdk_char_measure (GdkFont *font,
537 gint gdk_string_height (GdkFont *font,
538 const gchar *string);
539 gint gdk_text_height (GdkFont *font,
542 gint gdk_char_height (GdkFont *font,
545 void gdk_text_extents (GdkFont *font,
553 void gdk_string_extents (GdkFont *font,
563 void gdk_draw_point (GdkDrawable *drawable,
567 void gdk_draw_line (GdkDrawable *drawable,
573 void gdk_draw_rectangle (GdkDrawable *drawable,
580 void gdk_draw_arc (GdkDrawable *drawable,
589 void gdk_draw_polygon (GdkDrawable *drawable,
594 void gdk_draw_string (GdkDrawable *drawable,
599 const gchar *string);
600 void gdk_draw_text (GdkDrawable *drawable,
607 void gdk_draw_pixmap (GdkDrawable *drawable,
616 void gdk_draw_bitmap (GdkDrawable *drawable,
625 void gdk_draw_image (GdkDrawable *drawable,
634 void gdk_draw_points (GdkDrawable *drawable,
638 void gdk_draw_segments (GdkDrawable *drawable,
642 void gdk_draw_lines (GdkDrawable *drawable,
652 gint gdk_selection_owner_set (GdkWindow *owner,
656 GdkWindow* gdk_selection_owner_get (GdkAtom selection);
657 void gdk_selection_convert (GdkWindow *requestor,
661 gint gdk_selection_property_get (GdkWindow *requestor,
665 void gdk_selection_send_notify (guint32 requestor,
671 gint gdk_text_property_to_text_list (GdkAtom encoding, gint format,
672 guchar *text, gint length,
674 void gdk_free_text_list (gchar **list);
675 gint gdk_string_to_compound_text (gchar *str,
676 GdkAtom *encoding, gint *format,
677 guchar **ctext, gint *length);
678 void gdk_free_compound_text (guchar *ctext);
682 GdkAtom gdk_atom_intern (const gchar *atom_name,
683 gint only_if_exists);
684 gchar* gdk_atom_name (GdkAtom atom);
685 gint gdk_property_get (GdkWindow *window,
691 GdkAtom *actual_property_type,
696 void gdk_property_change (GdkWindow *window,
703 void gdk_property_delete (GdkWindow *window,
707 /* Rectangle utilities
709 gint gdk_rectangle_intersect (GdkRectangle *src1,
716 void gdk_input_init (void);
717 void gdk_input_exit (void);
718 GList *gdk_input_list_devices (void);
719 void gdk_input_set_extension_events (GdkWindow *window,
721 GdkExtensionMode mode);
722 void gdk_input_set_source (guint32 deviceid,
723 GdkInputSource source);
724 gint gdk_input_set_mode (guint32 deviceid,
726 void gdk_input_set_axes (guint32 deviceid,
728 void gdk_input_set_key (guint32 deviceid,
731 GdkModifierType modifiers);
732 void gdk_input_window_get_pointer (GdkWindow *window,
739 GdkModifierType *mask);
741 GdkTimeCoord *gdk_input_motion_events (GdkWindow *window,
745 gint *nevents_return);
747 /* International Input Method Support Functions
750 gint gdk_im_ready (void);
752 void gdk_im_begin (GdkIC ic,
754 void gdk_im_end (void);
755 GdkIMStyle gdk_im_decide_style (GdkIMStyle supported_style);
756 GdkIMStyle gdk_im_set_best_style (GdkIMStyle best_allowed_style);
757 GdkIC gdk_ic_new (GdkWindow* client_window,
758 GdkWindow* focus_window,
759 GdkIMStyle style, ...);
760 void gdk_ic_destroy (GdkIC ic);
761 GdkIMStyle gdk_ic_get_style (GdkIC ic);
762 void gdk_ic_set_values (GdkIC ic,
764 void gdk_ic_get_values (GdkIC ic,
766 void gdk_ic_set_attr (GdkIC ic,
767 const char *target, ...);
768 void gdk_ic_get_attr (GdkIC ic,
769 const char *target, ...);
770 GdkEventMask gdk_ic_get_events (GdkIC ic);
774 GdkColorContext *gdk_color_context_new (GdkVisual *visual,
775 GdkColormap *colormap);
777 GdkColorContext *gdk_color_context_new_mono (GdkVisual *visual,
778 GdkColormap *colormap);
780 void gdk_color_context_free (GdkColorContext *cc);
782 gulong gdk_color_context_get_pixel (GdkColorContext *cc,
787 void gdk_color_context_get_pixels (GdkColorContext *cc,
794 void gdk_color_context_get_pixels_incremental (GdkColorContext *cc,
803 gint gdk_color_context_query_color (GdkColorContext *cc,
805 gint gdk_color_context_query_colors (GdkColorContext *cc,
809 gint gdk_color_context_add_palette (GdkColorContext *cc,
813 void gdk_color_context_init_dither (GdkColorContext *cc);
814 void gdk_color_context_free_dither (GdkColorContext *cc);
816 gulong gdk_color_context_get_pixel_from_palette (GdkColorContext *cc,
821 guchar gdk_color_context_get_index_from_palette (GdkColorContext *cc,
829 GdkRegion* gdk_region_new (void);
830 void gdk_region_destroy (GdkRegion *region);
832 void gdk_region_get_clipbox(GdkRegion *region,
833 GdkRectangle *rectangle);
835 gboolean gdk_region_empty (GdkRegion *region);
836 gboolean gdk_region_equal (GdkRegion *region1,
838 gboolean gdk_region_point_in (GdkRegion *region,
841 GdkOverlapType gdk_region_rect_in (GdkRegion *region,
844 GdkRegion* gdk_region_polygon (GdkPoint *points,
846 GdkFillRule fill_rule);
848 void gdk_region_offset (GdkRegion *region,
851 void gdk_region_shrink (GdkRegion *region,
855 GdkRegion* gdk_region_union_with_rect (GdkRegion *region,
857 GdkRegion* gdk_regions_intersect (GdkRegion *source1,
859 GdkRegion* gdk_regions_union (GdkRegion *source1,
861 GdkRegion* gdk_regions_subtract (GdkRegion *source1,
863 GdkRegion* gdk_regions_xor (GdkRegion *source1,
869 gboolean gdk_threads_init (void);
870 void gdk_threads_enter (void);
871 void gdk_threads_leave (void);
873 /* If the mainloop thread is in its select, wake it up.
874 * For GTK's idle handling
876 void gdk_threads_wake (void);
879 void gdk_event_send_clientmessage_toall (GdkEvent *event);
883 gchar* gdk_keyval_name (guint keyval);
884 guint gdk_keyval_from_name (const gchar *keyval_name);
885 guint gdk_keyval_to_upper (guint keyval);
886 guint gdk_keyval_to_lower (guint keyval);
887 gboolean gdk_keyval_is_upper (guint keyval);
888 gboolean gdk_keyval_is_lower (guint keyval);
891 #include <gdk/gdkrgb.h>
895 #endif /* __cplusplus */
898 #endif /* __GDK_H__ */