gdk_init ()

void                gdk_init                            (gint *argc,
                                                         gchar ***argv);

Initializes the GDK library and connects to the X server. If initialization fails, a warning message is output and the application terminates with a call to exit(1).

Any arguments used by GDK are removed from the array and argc and argv are updated accordingly.

GTK+ initializes GDK in gtk_init() and so this function is not usually needed by GTK+ applications.

gdk_init_check ()

gboolean            gdk_init_check                      (gint *argc,
                                                         gchar ***argv);

Initialize the library for use.

Arguments: "argc" is the number of arguments. "argv" is an array of strings.

Results: "argc" and "argv" are modified to reflect any arguments which were not handled. (Such arguments should either be handled by the application or dismissed). If initialization fails, returns FALSE, otherwise TRUE.

Side effects: The library is initialized.

--------------------------------------------------------------

Initializes the GDK library and connects to the X server, returning TRUE on success.

Any arguments used by GDK are removed from the array and argc and argv are updated accordingly.

GTK+ initializes GDK in gtk_init() and so this function is not usually needed by GTK+ applications.

gdk_parse_args ()

void                gdk_parse_args                      (gint *argc,
                                                         gchar ***argv);

Parse command line arguments, and store for future use by calls to gdk_display_open().

Any arguments used by GDK are removed from the array and argc and argv are updated accordingly.

You shouldn't call this function explicitely if you are using gtk_init(), gtk_init_check(), gdk_init(), or gdk_init_check().

Since 2.2

gdk_get_display_arg_name ()

const gchar *       gdk_get_display_arg_name            (void);

Gets the display name specified in the command line arguments passed to gdk_init() or gdk_parse_args(), if any.

Since 2.2

gdk_set_locale ()

gchar *             gdk_set_locale                      (void);

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:

1
2

export LANG="fr"
... run application ...

If the locale is not supported by X then it is reset to the standard "C" locale.

gdk_set_sm_client_id ()

void                gdk_set_sm_client_id                (const gchar *sm_client_id);

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 session 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.)

gdk_exit ()

void                gdk_exit                            (gint error_code);

Exits the application using the exit() system call.

This routine is provided mainly for backwards compatibility, since it used to perform tasks necessary to exit the application cleanly. Those tasks are now performed in a function which is automatically called on exit (via the use of g_atexit()).

gdk_notify_startup_complete ()

void                gdk_notify_startup_complete         (void);

Indicates to the GUI environment that the application has finished loading. If the applications opens windows, this function is normally called after opening the application's initial set of windows.

GTK+ will call this function automatically after opening the first GtkWindow unless gtk_window_set_auto_startup_notification() is called to disable that feature.

Since 2.2

gdk_notify_startup_complete_with_id ()

void                gdk_notify_startup_complete_with_id (const gchar *startup_id);

Indicates to the GUI environment that the application has finished loading, using a given identifier.

GTK+ will call this function automatically for GtkWindow with custom startup-notification identifier unless gtk_window_set_auto_startup_notification() is called to disable that feature.

Since 2.12

gdk_get_program_class ()

const char *        gdk_get_program_class               (void);

Gets the program class. Unless the program class has explicitly been set with gdk_set_program_class() or with the --class commandline option, the default value is the program name (determined with g_get_prgname()) with the first character converted to uppercase.

gdk_set_program_class ()

void                gdk_set_program_class               (const char *program_class);

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.

gdk_get_display ()

gchar *             gdk_get_display                     (void);

Gets the name of the display, which usually comes from the DISPLAY environment variable or the --display command line option.

gdk_flush ()

void                gdk_flush                           (void);

Flushes the X output buffer and waits until all requests have been processed by the 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 ()

gint                gdk_screen_width                    (void);

Returns the width of the default screen in pixels.

gdk_screen_height ()

gint                gdk_screen_height                   (void);

Returns the height of the default screen in pixels.

gdk_screen_width_mm ()

gint                gdk_screen_width_mm                 (void);

Returns the width of the default screen in millimeters. Note that on many X servers this value will not be correct.

gdk_screen_height_mm ()

gint                gdk_screen_height_mm                (void);

Returns the height of the default screen in millimeters. Note that on many X servers this value will not be correct.

gdk_pointer_grab ()

GdkGrabStatus       gdk_pointer_grab                    (GdkWindow *window,
                                                         gboolean owner_events,
                                                         GdkEventMask event_mask,
                                                         GdkWindow *confine_to,
                                                         GdkCursor *cursor,
                                                         guint32 time_);

Grabs the pointer (usually a mouse) so that all events are passed to this application 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 used for operations which need complete control over mouse events, even if the mouse leaves the application. For example in GTK+ it is used for Drag and Drop, for dragging the handle in the GtkHPaned and GtkVPaned widgets, and for resizing columns in GtkCList widgets.

Note that if the event mask of an X window has selected both button press and button release events, then a button press event will cause an automatic pointer grab until the button is released. X does this automatically since most applications expect to receive button press and release events in pairs. It is equivalent to a pointer grab on the window with owner_events set to TRUE.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.

enum GdkGrabStatus

typedef enum
{
  GDK_GRAB_SUCCESS         = 0,
  GDK_GRAB_ALREADY_GRABBED = 1,
  GDK_GRAB_INVALID_TIME    = 2,
  GDK_GRAB_NOT_VIEWABLE    = 3,
  GDK_GRAB_FROZEN          = 4
} GdkGrabStatus;

Returned by gdk_pointer_grab() and gdk_keyboard_grab() to indicate success or the reason for the failure of the grab attempt.

gdk_pointer_ungrab ()

void                gdk_pointer_ungrab                  (guint32 time_);

Ungrabs the pointer on the default display, if it is grabbed by this application.

gdk_pointer_is_grabbed ()

gboolean            gdk_pointer_is_grabbed              (void);

Returns TRUE if the pointer on the default display is currently grabbed by this application.

Note that this does not take the inmplicit pointer grab on button presses into account.

gdk_set_double_click_time ()

void                gdk_set_double_click_time           (guint msec);

Set the double click time for the default display. See gdk_display_set_double_click_time(). See also gdk_display_set_double_click_distance(). Applications should not set this, it is a global user-configured setting.

gdk_keyboard_grab ()

GdkGrabStatus       gdk_keyboard_grab                   (GdkWindow *window,
                                                         gboolean owner_events,
                                                         guint32 time_);

Grabs the keyboard so that all events are passed to this application until the keyboard is ungrabbed with gdk_keyboard_ungrab(). This overrides any previous keyboard grab by this client.

If you set up anything at the time you take the grab that needs to be cleaned up when the grab ends, you should handle the GdkEventGrabBroken events that are emitted when the grab ends unvoluntarily.

gdk_keyboard_ungrab ()

void                gdk_keyboard_ungrab                 (guint32 time_);

Ungrabs the keyboard on the default display, if it is grabbed by this application.

gdk_beep ()

void                gdk_beep                            (void);

Emits a short beep on the default display.

gdk_get_use_xshm ()

gboolean            gdk_get_use_xshm                    (void);

Returns TRUE if GDK will attempt to use the MIT-SHM shared memory extension.

The shared memory extension is used for GdkImage, and consequently for GdkRGB. It enables much faster drawing by communicating with the X server through SYSV shared memory calls. However, it can only be used if the X client and server are on the same machine and the server supports it.

gdk_set_use_xshm ()

void                gdk_set_use_xshm                    (gboolean use_xshm);

Sets whether the use of the MIT shared memory extension should be attempted. This function is mainly for internal use. It is only safe for an application to set this to FALSE, since if it is set to TRUE and the server does not support the extension it may cause warning messages to be output.

gdk_error_trap_push ()

void                gdk_error_trap_push                 (void);

This function allows X errors to be trapped instead of the normal behavior of exiting the application. It should only be used if it is not possible to avoid the X error in any other way.

1
2
3
4
5
6
7
8

gdk_error_trap_push ();
/* ... Call the X function which may cause an error here ... */
/* Flush the X queue to catch errors now. */
gdk_flush ();
if (gdk_error_trap_pop ())
  {
    /* ... Handle the error here ... */
  }

gdk_error_trap_pop ()

gint                gdk_error_trap_pop                  (void);

Removes the X error trap installed with gdk_error_trap_push().

GDK_WINDOWING_X11

#define GDK_WINDOWING_X11

This macro is defined if GDK is configured to use the X11 backend.

GDK_WINDOWING_WIN32

#define GDK_WINDOWING_WIN32

This macro is defined if GDK is configured to use the Win32 backend.