2002-04-30 18:07:51 +00:00
|
|
|
<!-- ##### SECTION Title ##### -->
|
|
|
|
GdkDisplay
|
|
|
|
|
|
|
|
<!-- ##### SECTION Short_Description ##### -->
|
2002-05-01 21:29:49 +00:00
|
|
|
controls the keyboard/mouse pointer grabs and a set of <type>GdkScreen</type>s
|
2002-04-30 18:07:51 +00:00
|
|
|
|
|
|
|
<!-- ##### SECTION Long_Description ##### -->
|
|
|
|
<para>
|
2002-05-01 21:29:49 +00:00
|
|
|
#GdkDisplay objects purpose are two fold:
|
2002-04-30 18:07:51 +00:00
|
|
|
<itemizedlist>
|
|
|
|
<listitem><para>To grab/ungrab keyboard focus and mouse pointer</para></listitem>
|
|
|
|
<listitem><para>To manage and provide information about the #GdkScreen(s)
|
|
|
|
available for this #GdkDisplay
|
|
|
|
</para></listitem>
|
|
|
|
</itemizedlist>
|
|
|
|
</para>
|
|
|
|
<para>
|
2002-05-01 21:29:49 +00:00
|
|
|
#GdkDisplay objects are the GDK representation of the X Display which can be
|
|
|
|
described as <emphasis>a workstation consisting of a keyboard a pointing
|
|
|
|
device (such as a mouse) and one or more screens</emphasis>.
|
2002-04-30 18:07:51 +00:00
|
|
|
It is used to open and keep track of various #GdkScreen objects currently
|
2002-05-01 21:29:49 +00:00
|
|
|
instanciated by the application. It is also used to grab and release the keyboard
|
2002-04-30 18:07:51 +00:00
|
|
|
and the mouse pointer.
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### SECTION See_Also ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GdkDisplay ##### -->
|
|
|
|
<para>
|
2002-05-02 22:28:50 +00:00
|
|
|
The <structname>GdkDisplay</structname> struct is the GDK representation
|
|
|
|
of an X display. All its fields are private and should not be accessed directly.
|
2002-04-30 18:07:51 +00:00
|
|
|
</para>
|
|
|
|
|
|
|
|
|
2002-06-20 23:59:27 +00:00
|
|
|
<!-- ##### FUNCTION gdk_display_open ##### -->
|
2002-04-30 18:07:51 +00:00
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display_name:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-06-20 23:59:27 +00:00
|
|
|
<!-- ##### FUNCTION gdk_display_get_default ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
2002-04-30 18:07:51 +00:00
|
|
|
<!-- ##### FUNCTION gdk_display_get_name ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_get_n_screens ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_get_screen ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@screen_num:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_get_default_screen ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_pointer_ungrab ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@time:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_keyboard_ungrab ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@time:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_pointer_is_grabbed ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_beep ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_sync ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_close ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_list_devices ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_get_event ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_peek_event ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_put_event ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@event:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_add_client_message_filter ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@message_type:
|
|
|
|
@func:
|
|
|
|
@data:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_set_double_click_time ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@msec:
|
|
|
|
|
|
|
|
|
Documentation fixes.
Sun Oct 13 18:50:14 2002 Soeren Sandmann <sandmann@daimi.au.dk>
* gtkmenu.c, gtkmenu.sgml, gtkitemfactory.c, gdkwindow.c,
gtkwindow.c, gtkpaned.sgml, gtkdialog.c, gtkbox.h, gtkbutton.sgml,
gtktreemodel.sgml,gtktable.sgml, gtktable.c:
Documentation fixes.
#85719, #90759, #95169, Owen Taylor;
#89221, Yao Zhang, Matthias Clasen;
#95592, Joost Faassen;
#92637, Vitaly Tishkov;
#94616, Ben Martin;
#94772, sbaillie@bigpond.net.au;
2002-10-13 17:17:14 +00:00
|
|
|
<!-- ##### FUNCTION gdk_display_get_pointer ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@screen:
|
|
|
|
@x:
|
|
|
|
@y:
|
|
|
|
@mask:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_get_window_at_pointer ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@win_x:
|
|
|
|
@win_y:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
|
|
|
<!-- ##### STRUCT GdkDisplayPointerHooks ##### -->
|
|
|
|
<para>
|
2002-10-22 22:11:22 +00:00
|
|
|
A table of pointers to functions for getting quantities related to
|
|
|
|
the current pointer position. Each #GdkDisplay has a table of this type,
|
|
|
|
which can be set using gdk_display_set_pointer_hooks().
|
|
|
|
</para>
|
|
|
|
<para>
|
|
|
|
This is only useful for such low-level tools as an event recorder.
|
|
|
|
Applications should never have any reason to use this facility
|
Documentation fixes.
Sun Oct 13 18:50:14 2002 Soeren Sandmann <sandmann@daimi.au.dk>
* gtkmenu.c, gtkmenu.sgml, gtkitemfactory.c, gdkwindow.c,
gtkwindow.c, gtkpaned.sgml, gtkdialog.c, gtkbox.h, gtkbutton.sgml,
gtktreemodel.sgml,gtktable.sgml, gtktable.c:
Documentation fixes.
#85719, #90759, #95169, Owen Taylor;
#89221, Yao Zhang, Matthias Clasen;
#95592, Joost Faassen;
#92637, Vitaly Tishkov;
#94616, Ben Martin;
#94772, sbaillie@bigpond.net.au;
2002-10-13 17:17:14 +00:00
|
|
|
</para>
|
|
|
|
|
2002-10-22 22:11:22 +00:00
|
|
|
@get_pointer: Obtains the current pointer position and modifier state.
|
|
|
|
The position is given in coordinates relative to the window containing
|
|
|
|
the pointer, which is returned in @window.
|
|
|
|
@window_get_pointer: Obtains the window underneath the mouse pointer.
|
|
|
|
Current pointer position and modifier state are returned in @x, @y and
|
|
|
|
@mask. The position is given in coordinates relative to @window.
|
|
|
|
@window_at_pointer: Obtains the window underneath the mouse pointer,
|
|
|
|
returning the location of that window in @win_x, @win_y. Returns %NULL
|
|
|
|
if the window under the mouse pointer is not known to GDK (for example,
|
|
|
|
belongs to another application).
|
Documentation fixes.
Sun Oct 13 18:50:14 2002 Soeren Sandmann <sandmann@daimi.au.dk>
* gtkmenu.c, gtkmenu.sgml, gtkitemfactory.c, gdkwindow.c,
gtkwindow.c, gtkpaned.sgml, gtkdialog.c, gtkbox.h, gtkbutton.sgml,
gtktreemodel.sgml,gtktable.sgml, gtktable.c:
Documentation fixes.
#85719, #90759, #95169, Owen Taylor;
#89221, Yao Zhang, Matthias Clasen;
#95592, Joost Faassen;
#92637, Vitaly Tishkov;
#94616, Ben Martin;
#94772, sbaillie@bigpond.net.au;
2002-10-13 17:17:14 +00:00
|
|
|
|
|
|
|
<!-- ##### FUNCTION gdk_display_set_pointer_hooks ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@display:
|
|
|
|
@new_hooks:
|
|
|
|
@Returns:
|
|
|
|
|
|
|
|
|
Minor documentation fixes
2002-08-10 Soren Sandmann <sandmann@daimi.au.dk>
* docs/reference/gtk/tree_widget.sgml,
docs/reference/gtk/tmpl/gtkdialog.sgml,
docs/reference/gtk/tmpl/gtkentry.sgml,
docs/reference/gtk/tmpl/gtkfilesel.sgml,
docs/reference/gtk/tmpl/gtkfontsel.sgml,
docs/reference/gtk/tmpl/gtkfontseldlg.sgml,
docs/reference/gtk/tmpl/gtktreemodel.sgml,
docs/reference/gtk/tmpl/gtkwidget.sgml, gdk/x11/gdkdisplay-x11.c,
gtk/gtkbbox.c, gtk/gtkbox.c, gtk/gtkbutton.c, gtk/gtkcellrenderer.c,
gtk/gtkcellrendererpixbuf.c, gtk/gtkcellrenderertext.c,
gtk/gtkcheckmenuitem.c, gtk/gtkcontainer.c, gtk/gtkcurve.c,
gtk/gtkdialog.h, gtk/gtkentry.c, gtk/gtkfilesel.c, gtk/gtkfontsel.c,
gtk/gtkframe.c, gtk/gtkhandlebox.c, gtk/gtkiconfactory.c,
gtk/gtkimage.c, gtk/gtkinvisible.c, gtk/gtkitemfactory.c,
gtk/gtklabel.c, gtk/gtklayout.c, gtk/gtkmenu.c, gtk/gtkprogress.c,
gtk/gtkprogressbar.c, gtk/gtkscrolledwindow.c, gtk/gtksizegroup.c,
gtk/gtktable.c, gtk/gtktextiter.c, gtk/gtktexttag.c,
gtk/gtktexttag.h, gtk/gtktextview.c, gtk/gtktogglebutton.c,
gtk/gtktoolbar.c, gtk/gtktreemodel.c, gtk/gtktreeselection.c,
gtk/gtktreestore.c, gtk/gtktreeview.c, gtk/gtktreeviewcolumn.c,
gtk/gtkviewport.c, gtk/gtkwidget.c, gtk/gtkwidget.h,
gtk/gtkwindow.c:
Minor documentation fixes
(#89254, patch from Brett Nash;
#85809, patch from daten@dnetc.org;
#76391, patch from Ross Burton;
#74559, Manuel Clos;
#73569, #72005, Alexey A. Malyshev;
#70061, patch from Dennis Bj"orklund;
#64566, #63388, #58328, #57499, #81007, #77349, Vitaly Tishkov;
#78932, Vitaly Tishkov, patch from Ross Burton;
#73306)
2002-08-10 09:55:41 +00:00
|
|
|
<!-- ##### SIGNAL GdkDisplay::closed ##### -->
|
|
|
|
<para>
|
|
|
|
|
|
|
|
</para>
|
|
|
|
|
|
|
|
@gdkdisplay: the object which received the signal.
|
|
|
|
@arg1:
|
|
|
|
|