diff --git a/docs/reference/gdk/tmpl/.gitignore b/docs/reference/gdk/tmpl/.gitignore index a05bd1c699..3914941720 100644 --- a/docs/reference/gdk/tmpl/.gitignore +++ b/docs/reference/gdk/tmpl/.gitignore @@ -2,6 +2,7 @@ cairo_interaction.sgml colors.sgml dnd.sgml gdkapplaunchcontext.sgml +gdkdisplay.sgml pixbufs.sgml regions.sgml windows.sgml diff --git a/docs/reference/gdk/tmpl/gdkdisplay.sgml b/docs/reference/gdk/tmpl/gdkdisplay.sgml deleted file mode 100644 index 57ace8957e..0000000000 --- a/docs/reference/gdk/tmpl/gdkdisplay.sgml +++ /dev/null @@ -1,502 +0,0 @@ - -GdkDisplay - - -Controls the keyboard/mouse pointer grabs and a set of GdkScreens - - - -#GdkDisplay objects purpose are two fold: - -To grab/ungrab keyboard focus and mouse pointer -To manage and provide information about the #GdkScreen(s) - available for this #GdkDisplay - - - - - #GdkDisplay objects are the GDK representation of the X Display which can be - described as a workstation consisting of a keyboard a pointing - device (such as a mouse) and one or more screens. - It is used to open and keep track of various #GdkScreen objects currently - instanciated by the application. It is also used to grab and release the keyboard - and the mouse pointer. - - - - - - - - - - - - - - - -The GdkDisplay struct is the GDK representation -of an X display. All its fields are private and should not be accessed directly. - - -@Since: 2.2 - - - - - - -@gdkdisplay: the object which received the signal. -@arg1: - - - - - - -@gdkdisplay: the object which received the signal. - - - - - - -@display_name: -@Returns: - - - - - - - -@void: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@screen_num: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@time_: - - - - - - - -@display: -@time_: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@device: -@Returns: - - - - - - - -@display: - - - - - - - -@display: - - - - - - - -@display: - - - - - - - -@display: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@event: - - - - - - - -@display: -@message_type: -@func: -@data: - - - - - - - -@display: -@msec: - - - - - - - -@display: -@distance: - - - - - - - -@display: -@screen: -@x: -@y: -@mask: - - - - - - - -@display: -@device: -@screen: -@x: -@y: -@mask: - - - - - - - -@display: -@win_x: -@win_y: -@Returns: - - - - - - - -@display: -@device: -@win_x: -@win_y: -@Returns: - - - - -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(). - - -This is only useful for such low-level tools as an event recorder. -Applications should never have any reason to use this facility - - -@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). -@Since: 2.2 - - - - - - -@display: -@new_hooks: -@Returns: - - - - - - - -@get_device_state: -@window_get_device_position: -@window_at_device_position: - - - - - - -@display: -@new_hooks: -@Returns: - - - - - - - -@display: -@screen: -@x: -@y: - - - - - - - -@display: -@device: -@screen: -@x: -@y: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@width: -@height: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@selection: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@clipboard_window: -@time_: -@targets: -@n_targets: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - - - - - - -@display: -@Returns: - - diff --git a/gdk/gdkdisplay.c b/gdk/gdkdisplay.c index 2f3050965a..1dab470c5d 100644 --- a/gdk/gdkdisplay.c +++ b/gdk/gdkdisplay.c @@ -34,6 +34,32 @@ #include #include + +/** + * SECTION:gdkdisplay + * @Short_description: Controls the keyboard/mouse pointer grabs and a set of GdkScreens + * @Title: GdkDisplay + * + * #GdkDisplay objects purpose are two fold: + * + * + * To grab/ungrab keyboard focus and mouse pointer + * + * + * To manage and provide information about the #GdkScreen(s) + * available for this #GdkDisplay + * + * + * + * #GdkDisplay objects are the GDK representation of the X Display which can be + * described as a workstation consisting of a keyboard a pointing + * device (such as a mouse) and one or more screens. + * It is used to open and keep track of various #GdkScreen objects currently + * instanciated by the application. It is also used to grab and release the keyboard + * and the mouse pointer. + */ + + enum { OPENED, CLOSED, diff --git a/gdk/gdkdisplay.h b/gdk/gdkdisplay.h index 1b11b696c7..17afa4bfc7 100644 --- a/gdk/gdkdisplay.h +++ b/gdk/gdkdisplay.h @@ -132,6 +132,28 @@ struct _GdkDisplayClass gboolean is_error); }; +/** + * GdkDisplayPointerHooks: + * @get_pointer: Obtains the current pointer position and modifier state. + * The position is given in coordinates relative to the screen containing + * the pointer, which is returned in @screen. + * @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). + * + * 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(). + * + * This is only useful for such low-level tools as an event recorder. + * Applications should never have any reason to use this facility + * + * Since: 2.2 + */ struct _GdkDisplayPointerHooks { void (*get_pointer) (GdkDisplay *display,