Guile-GNOME: Gdk version 2.16.2, updated 9 December 2011 Damon Chaplin many others This manual is for (gnome gdk) (version 2.16.2, updated 9 December 2011) GDK documentation Copyright 1997-2007 Damon Chaplin and others This work may be reproduced and distributed in whole or in part, in any medium, physical or electronic, so as long as this copyright notice remains intact and unchanged on all copies. Commercial redistribution is permitted and encouraged, but you may not redistribute, in whole or in part, under terms more restrictive than those under which you received it. If you redistribute a modified or translated version of this work, you must also make the source code to the modified or translated version available in electronic form without charge. However, mere aggregation as part of a larger work shall not count as a modification for this purpose. All code examples in this work are placed into the public domain, and may be used, modified and redistributed without restriction. BECAUSE THIS WORK IS LICENSED FREE OF CHARGE, THERE IS NO WARRANTY FOR THE WORK, TO THE EXTENT PERMITTED BY APPLICABLE LAW. EXCEPT WHEN OTHERWISE STATED IN WRIT- ING THE COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE WORK "AS IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE. SHOULD THE WORK PROVE DEFECTIVE, YOU ASSUME THE COST OF ALL NECESSARY REPAIR OR CORREC- TION. IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY MODIFY AND/OR REDISTRIBUTE THE WORK AS PERMITTED ABOVE, BE LIABLE TO YOU FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR CONSEQUENTIAL DAM- AGES ARISING OUT OF THE USE OR INABILITY TO USE THE WORK, EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED OF THE POSSIBILITY OF SUCH DAMAGES. GDK-Pixbuf documentation Copyright 2000 Free Software Foundation. Permission is granted to copy, distribute and/or modify this document under the terms of the GNU Free Documentation License, Version 1.1 or any later version published by the Free Software Foundation with no Invariant Sections, no Front-Cover Texts, and no Back-Cover Texts. You may obtain a copy of the GNU Free Documentation License from the Free Software Foundation by visiting their Web site or by writing to: The Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA Many of the names used by companies to distinguish their products and ser- vices are claimed as trademarks. Where those names appear in any GNOME documentation, and those trademarks are made aware to the members of the GNOME Documentation Project, the names have been printed in caps or initial caps. i Short Contents 1 Overview :::::::::::::::::::::::::::::::::::::::::::: 1 2 General ::::::::::::::::::::::::::::::::::::::::::::: 2 3 GdkDisplay :::::::::::::::::::::::::::::::::::::::::: 7 4 GdkDisplayManager :::::::::::::::::::::::::::::::::: 14 5 GdkScreen :::::::::::::::::::::::::::::::::::::::::: 15 6 Points, Rectangles and Regions ::::::::::::::::::::::::: 24 7 Graphics Contexts ::::::::::::::::::::::::::::::::::: 27 8 Drawing Primitives ::::::::::::::::::::::::::::::::::: 32 9 Bitmaps and Pixmaps :::::::::::::::::::::::::::::::: 42 10 GdkRGB ::::::::::::::::::::::::::::::::::::::::::: 44 11 Images ::::::::::::::::::::::::::::::::::::::::::::: 48 12 Pixbufs :::::::::::::::::::::::::::::::::::::::::::: 50 13 Colormaps and Colors :::::::::::::::::::::::::::::::: 54 14 Visuals ::::::::::::::::::::::::::::::::::::::::::::: 56 15 Fonts :::::::::::::::::::::::::::::::::::::::::::::: 59 16 Cursors :::::::::::::::::::::::::::::::::::::::::::: 65 17 Windows ::::::::::::::::::::::::::::::::::::::::::: 69 18 Events ::::::::::::::::::::::::::::::::::::::::::::: 93 19 Event Structures ::::::::::::::::::::::::::::::::::::: 96 20 Key Values ::::::::::::::::::::::::::::::::::::::::: 98 21 Selections:::::::::::::::::::::::::::::::::::::::::: 102 22 Drag and Drop ::::::::::::::::::::::::::::::::::::: 105 23 Properties and Atoms :::::::::::::::::::::::::::::::: 108 24 Threads ::::::::::::::::::::::::::::::::::::::::::: 110 25 Input Devices :::::::::::::::::::::::::::::::::::::: 115 26 Pango Interaction ::::::::::::::::::::::::::::::::::: 118 27 Cairo Interaction :::::::::::::::::::::::::::::::::::: 123 28 X Window System Interaction ::::::::::::::::::::::::: 125 29 The GdkPixbuf Structure::::::::::::::::::::::::::::: 127 30 File Loading ::::::::::::::::::::::::::::::::::::::: 130 31 Image Data in Memory::::::::::::::::::::::::::::::: 132 32 Scaling :::::::::::::::::::::::::::::::::::::::::::: 134 33 Utilities ::::::::::::::::::::::::::::::::::::::::::: 139 34 Animations :::::::::::::::::::::::::::::::::::::::: 141 35 GdkPixbufLoader ::::::::::::::::::::::::::::::::::: 143 ii 36 Module Interface :::::::::::::::::::::::::::::::::::: 147 37 Undocumented ::::::::::::::::::::::::::::::::::::: 148 Type Index :::::::::::::::::::::::::::::::::::::::::::: 149 Function Index ::::::::::::::::::::::::::::::::::::::::: 150 Chapter 1: Overview 1 1 Overview (gnome gdk) wraps the platform-specific layer of +GTK for Guile. It is a part of Guile- GNOME. See the documentation for (gnome gobject) for more information on Guile-GNOME. Chapter 2: General 2 2 General Library initialization and miscellaneous functions 2.1 Overview This section describes the GDK initialization functions and miscellaneous utility functions. 2.2 Usage gdk-get-display-arg-name ) (ret mchars) [Function] Gets the display name specified in the command line arguments passed to gdk-init or gdk-parse-args, if any. ret the display name, if specified explicitely, otherwise#f ` ' this string is owned by GTK+ and must not be modified or freed. Since 2.2 gdk-set-locale ) (ret mchars) [Function] Initializes the support for internationalization by calling the setlocale system call. This function is called by gtk-set-locale and so GTK+ applications should use that instead. The locale to use is determined by the LANG environment variable, so to run an application in a certain locale you can do something like this: export LANG="fr" ... run application ... If the locale is not supported by X then it is reset to the standard "C" locale. ret the resulting locale. gdk-set-sm-client-id (sm client id mchars) [Function] Sets the `SM_CLIENT_ID' property on the application's leader window so that the window manager can save the application's state using the X11R6 ICCCM session management protocol. See the X Session Management Library documentation for more information on ses- sion management and the Inter-Client Communication Conventions Manual (ICCCM) for information on the `WM_CLIENT_LEADER' property. (Both documents are part of the X Window System distribution.) sm-client-id the client id assigned by the session manager when the connection was opened, or `#f' to remove the property. gdk-notify-startup-complete [Function] Indicates to the GUI environment that the application has finished loading. If the applications opens windows, this function is normally called after opening the appli- cation's initial set of windows. Chapter 2: General 3 GTK+ will call this function automatically after opening the first <gtk-window> un- less gtk-window-set-auto-startup-notification is called to disable that feature. Since 2.2 gdk-get-program-class ) (ret mchars) [Function] Gets the program class. Unless the program class has explicitly been set with gdk- set-program-class or with the option, the default value is the program name (de- termined with g-get-prgname) with the first character converted to uppercase. ret the program class. gdk-set-program-class (program class mchars) [Function] Sets the program class. The X11 backend uses the program class to set the class name part of the `WM_CLASS' property on toplevel windows; see the ICCCM. program-class a string. gdk-get-display ) (ret mchars) [Function] Gets the name of the display, which usually comes from the DISPLAY environment variable or the ret the name of the display. gdk-flush [Function] Flushes the X output buffer and waits until all requests have been processed bythe server. This is rarely needed by applications. It's main use is for trapping X errors with gdk-error-trap-push and gdk-error-trap-pop. gdk-screen-width ) (ret int) [Function] Returns the width of the default screen in pixels. ret the width of the default screen in pixels. gdk-screen-height ) (ret int) [Function] Returns the height of the default screen in pixels. ret the height of the default screen in pixels. gdk-screen-width-mm ) (ret int) [Function] Returns the width of the default screen in millimeters. Note that on many X servers this value will not be correct. ret the width of the default screen in millimeters, though it is not always correct. gdk-screen-height-mm ) (ret int) [Function] Returns the height of the default screen in millimeters. Note that on many X servers this value will not be correct. ret the height of the default screen in millimeters, though it is not always correct. Chapter 2: General 4 gdk-pointer-grab (window <gdk-window>)(owner events bool) [Function] (event mask <gdk-event-mask>)(confine to <gdk-window>) (cursor <gdk-cursor>)(time unsigned-int32) ) (ret <gdk-grab-status>) Grabs the pointer (usually a mouse) so that all events are passed to this applica- tion until the pointer is ungrabbed with gdk-pointer-ungrab, or the grab window becomes unviewable. This overrides any previous pointer grab by this client. Pointer grabs are