General
<!-- ##### SECTION Short_Description ##### -->
-library initialization and miscellaneous functions.
+Library initialization and miscellaneous functions
<!-- ##### SECTION Long_Description ##### -->
<para>
</para>
+<!-- ##### SECTION Stability_Level ##### -->
+
+
+<!-- ##### SECTION Image ##### -->
+
+
<!-- ##### FUNCTION gdk_init ##### -->
<para>
Initializes the GDK library and connects to the X server.
@Returns: %TRUE if initialization succeeded.
+<!-- ##### FUNCTION gdk_parse_args ##### -->
+<para>
+
+</para>
+
+@argc:
+@argv:
+
+
+<!-- ##### FUNCTION gdk_get_display_arg_name ##### -->
+<para>
+
+</para>
+
+@void:
+@Returns:
+
+
<!-- ##### FUNCTION gdk_set_locale ##### -->
<para>
Initializes the support for internationalization by calling the <function>setlocale()</function>
locale.
</para>
+@void:
@Returns: the resulting locale.
<!-- ##### FUNCTION gdk_set_sm_client_id ##### -->
<para>
-Sets the <literal>SM_CLIENT_ID</literal> 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.
-</para>
-<para>
-The leader window is automatically created by GDK and never shown. It's only
-use is for session management. The <literal>WM_CLIENT_LEADER</literal> property is automatically
-set on all X windows created by the application to point to the leader window.
-</para>
-<para>
-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 <literal>WM_CLIENT_LEADER</literal> property.
-(Both documents are part of the X Window System distribution.)
</para>
-@sm_client_id: the client id assigned by the session manager when the
-connection was opened, or %NULL to remove the property.
+@sm_client_id:
<!-- ##### FUNCTION gdk_exit ##### -->
@error_code: the error code to pass to the <function>exit()</function> call.
+<!-- ##### FUNCTION gdk_notify_startup_complete ##### -->
+<para>
+
+</para>
+
+@void:
+
+
+<!-- ##### FUNCTION gdk_notify_startup_complete_with_id ##### -->
+<para>
+
+</para>
+
+@startup_id:
+
+
<!-- ##### FUNCTION gdk_get_program_class ##### -->
<para>
Gets the program class. Unless the program class has explicitly
with g_get_prgname()) with the first character converted to uppercase.
</para>
+@void:
@Returns: the program class.
environment variable or the <option>--display</option> command line option.
</para>
+@void:
@Returns: the name of the display.
trapping X errors with gdk_error_trap_push() and gdk_error_trap_pop().
</para>
+@void:
<!-- ##### FUNCTION gdk_screen_width ##### -->
<para>
-Returns the width of the screen in pixels.
</para>
-@Returns: the width of the screen in pixels.
+@void:
+@Returns:
<!-- ##### FUNCTION gdk_screen_height ##### -->
<para>
-Returns the height of the screen in pixels.
</para>
-@Returns: the height of the screen in pixels.
+@void:
+@Returns:
<!-- ##### FUNCTION gdk_screen_width_mm ##### -->
<para>
-Returns the width of the screen in millimeters.
-Note that on many X servers this value will not be correct.
</para>
-@Returns: the width of the screen in millimeters, though it is not always
-correct.
+@void:
+@Returns:
<!-- ##### FUNCTION gdk_screen_height_mm ##### -->
<para>
-Returns the height of the screen in millimeters.
-Note that on many X servers this value will not be correct.
</para>
-@Returns: the height of the screen in millimeters, though it is not always
-correct.
+@void:
+@Returns:
<!-- ##### FUNCTION gdk_pointer_grab ##### -->
It is equivalent to a pointer grab on the window with @owner_events set to
%TRUE.
</para>
+<para>
+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.
+</para>
@window: the #GdkWindow which will own the grab (the grab window).
@owner_events: if %FALSE then all pointer events are reported with respect to
this application are reported with respect to @window and only if selected by
@event_mask. In either mode, unreported events are discarded.
@event_mask: specifies the event mask, which is used in accordance with
-@owner_events.
+@owner_events. Note that only pointer events (i.e. button and motion events)
+ may be selected.
@confine_to: If non-%NULL, the pointer will be confined to this
window during the grab. If the pointer is outside @confine_to, it will
automatically be moved to the closest edge of @confine_to and enter
@cursor: the cursor to display while the grab is active. If this is %NULL then
the normal cursors are used for @window and its descendants, and the cursor
for @window is used for all other windows.
-@time: the timestamp of the event which led to this pointer grab. This usually
+@time_: the timestamp of the event which led to this pointer grab. This usually
comes from a #GdkEventButton struct, though %GDK_CURRENT_TIME can be used if
the time isn't known.
@Returns: %GDK_GRAB_SUCCESS if the grab was successful.
<!-- ##### FUNCTION gdk_pointer_ungrab ##### -->
<para>
-Ungrabs the pointer, if it is grabbed by this application.
+
</para>
-@time: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is
-available.
+@time_:
<!-- ##### FUNCTION gdk_pointer_is_grabbed ##### -->
<para>
-Returns %TRUE if the pointer is currently grabbed by this application.
</para>
<para>
-Note that the return value is not completely reliable since the X server may
-automatically ungrab the pointer, without informing the application, if the
-grab window becomes unviewable. It also does not take passive pointer grabs
-into account.
</para>
-@Returns: %TRUE if the pointer is currently grabbed by this application.
-Though this value is not always correct.
+@void:
+@Returns:
<!-- ##### FUNCTION gdk_set_double_click_time ##### -->
application until the keyboard is ungrabbed with gdk_keyboard_ungrab().
This overrides any previous keyboard grab by this client.
</para>
+<para>
+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.
+</para>
@window: the #GdkWindow which will own the grab (the grab window).
@owner_events: if %FALSE then all keyboard events are reported with respect to
normal, but keyboard events outside this application are reported with respect
to @window. Both key press and key release events are always reported,
independant of the event mask set by the application.
-@time: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is
+@time_: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is
available.
@Returns: %GDK_GRAB_SUCCESS if the grab was successful.
<!-- ##### FUNCTION gdk_keyboard_ungrab ##### -->
<para>
-Ungrabs the keyboard, if it is grabbed by this application.
</para>
-@time: a timestamp from a #GdkEvent, or %GDK_CURRENT_TIME if no timestamp is
-available.
+@time_:
<!-- ##### FUNCTION gdk_beep ##### -->
<para>
-Emits a short beep.
</para>
+@void:
<!-- ##### FUNCTION gdk_get_use_xshm ##### -->
server are on the same machine and the server supports it.
</para>
+@void:
@Returns: %TRUE if use of the MIT shared memory extension will be attempted.
avoid the X error in any other way.
</para>
<example>
-<title>Trapping an X error.</title>
+<title>Trapping an X error</title>
<programlisting>
- gdk_error_trap_push (<!>);
+ gdk_error_trap_push (<!-- -->);
/* ... Call the X function which may cause an error here ... */
/* Flush the X queue to catch errors now. */
- gdk_flush (<!>);
+ gdk_flush (<!-- -->);
- if (gdk_error_trap_pop (<!>))
+ if (gdk_error_trap_pop (<!-- -->))
{
/* ... Handle the error here ... */
}
</programlisting>
</example>
+@void:
<!-- ##### FUNCTION gdk_error_trap_pop ##### -->
Removes the X error trap installed with gdk_error_trap_push().
</para>
+@void:
@Returns: the X error code, or 0 if no error occurred.
-<!-- ##### MACRO GDK_WINDOWING_FB ##### -->
-<para>
-This macro is defined if GDK is configured to use the Linux framebuffer backend.
-</para>
-
-
-
projects / ~andy / gtk / blobdiff