4 * Copyright 2001 Sun Microsystems Inc.
6 * Erwann Chenede <erwann.chenede@sun.com>
8 * This library is free software; you can redistribute it and/or
9 * modify it under the terms of the GNU Library General Public
10 * License as published by the Free Software Foundation; either
11 * version 2 of the License, or (at your option) any later version.
13 * This library is distributed in the hope that it will be useful,
14 * but WITHOUT ANY WARRANTY; without even the implied warranty of
15 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
16 * Library General Public License for more details.
18 * You should have received a copy of the GNU Library General Public
19 * License along with this library; if not, write to the
20 * Free Software Foundation, Inc., 59 Temple Place - Suite 330,
21 * Boston, MA 02111-1307, USA.
26 #include "gdkscreenprivate.h"
27 #include "gdkrectangle.h"
28 #include "gdkwindow.h"
34 * @Short_description: Object representing a physical screen
37 * #GdkScreen objects are the GDK representation of the screen on
38 * which windows can be displayed and on which the pointer moves.
39 * X originally identified screens with physical screens, but
40 * nowadays it is more common to have a single #GdkScreen which
41 * combines several physical monitors (see gdk_screen_get_n_monitors()).
43 * GdkScreen is used throughout GDK and GTK+ to specify which screen
44 * the top level windows are to be displayed on. it is also used to
45 * query the screen specification and default settings such as
46 * the default visual (gdk_screen_get_system_visual()), the dimensions
47 * of the physical monitors (gdk_screen_get_monitor_geometry()), etc.
51 static void gdk_screen_finalize (GObject *object);
52 static void gdk_screen_set_property (GObject *object,
56 static void gdk_screen_get_property (GObject *object,
76 static guint signals[LAST_SIGNAL] = { 0 };
78 G_DEFINE_TYPE (GdkScreen, gdk_screen, G_TYPE_OBJECT)
81 gdk_screen_class_init (GdkScreenClass *klass)
83 GObjectClass *object_class = G_OBJECT_CLASS (klass);
85 object_class->finalize = gdk_screen_finalize;
86 object_class->set_property = gdk_screen_set_property;
87 object_class->get_property = gdk_screen_get_property;
89 g_object_class_install_property (object_class,
91 g_param_spec_pointer ("font-options",
93 P_("The default font options for the screen"),
94 G_PARAM_READWRITE|G_PARAM_STATIC_NAME|
95 G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
97 g_object_class_install_property (object_class,
99 g_param_spec_double ("resolution",
100 P_("Font resolution"),
101 P_("The resolution for fonts on the screen"),
105 G_PARAM_READWRITE|G_PARAM_STATIC_NAME|
106 G_PARAM_STATIC_NICK|G_PARAM_STATIC_BLURB));
109 * GdkScreen::size-changed:
110 * @screen: the object on which the signal is emitted
112 * The ::size-changed signal is emitted when the pixel width or
113 * height of a screen changes.
117 signals[SIZE_CHANGED] =
118 g_signal_new (g_intern_static_string ("size-changed"),
119 G_OBJECT_CLASS_TYPE (klass),
121 G_STRUCT_OFFSET (GdkScreenClass, size_changed),
123 g_cclosure_marshal_VOID__VOID,
128 * GdkScreen::composited-changed:
129 * @screen: the object on which the signal is emitted
131 * The ::composited-changed signal is emitted when the composited
132 * status of the screen changes
136 signals[COMPOSITED_CHANGED] =
137 g_signal_new (g_intern_static_string ("composited-changed"),
138 G_OBJECT_CLASS_TYPE (klass),
140 G_STRUCT_OFFSET (GdkScreenClass, composited_changed),
142 g_cclosure_marshal_VOID__VOID,
147 * GdkScreen::monitors-changed:
148 * @screen: the object on which the signal is emitted
150 * The ::monitors-changed signal is emitted when the number, size
151 * or position of the monitors attached to the screen change.
153 * Only for X11 and OS X for now. A future implementation for Win32
154 * may be a possibility.
158 signals[MONITORS_CHANGED] =
159 g_signal_new (g_intern_static_string ("monitors-changed"),
160 G_OBJECT_CLASS_TYPE (klass),
162 G_STRUCT_OFFSET (GdkScreenClass, monitors_changed),
164 g_cclosure_marshal_VOID__VOID,
170 gdk_screen_init (GdkScreen *screen)
172 screen->resolution = -1.;
176 gdk_screen_finalize (GObject *object)
178 GdkScreen *screen = GDK_SCREEN (object);
180 if (screen->font_options)
181 cairo_font_options_destroy (screen->font_options);
183 G_OBJECT_CLASS (gdk_screen_parent_class)->finalize (object);
187 _gdk_screen_close (GdkScreen *screen)
189 g_return_if_fail (GDK_IS_SCREEN (screen));
193 screen->closed = TRUE;
194 g_object_run_dispose (G_OBJECT (screen));
198 /* Fallback used when the monitor "at" a point or window
202 get_nearest_monitor (GdkScreen *screen,
206 gint num_monitors, i;
207 gint nearest_dist = G_MAXINT;
208 gint nearest_monitor = 0;
210 g_return_val_if_fail (GDK_IS_SCREEN (screen), -1);
212 num_monitors = gdk_screen_get_n_monitors (screen);
214 for (i = 0; i < num_monitors; i++)
216 GdkRectangle monitor;
217 gint dist_x, dist_y, dist;
219 gdk_screen_get_monitor_geometry (screen, i, &monitor);
222 dist_x = monitor.x - x;
223 else if (x >= monitor.x + monitor.width)
224 dist_x = x - (monitor.x + monitor.width) + 1;
229 dist_y = monitor.y - y;
230 else if (y >= monitor.y + monitor.height)
231 dist_y = y - (monitor.y + monitor.height) + 1;
235 dist = dist_x + dist_y;
236 if (dist < nearest_dist)
243 return nearest_monitor;
247 * gdk_screen_get_monitor_at_point:
248 * @screen: a #GdkScreen.
249 * @x: the x coordinate in the virtual screen.
250 * @y: the y coordinate in the virtual screen.
252 * Returns the monitor number in which the point (@x,@y) is located.
254 * Returns: the monitor number in which the point (@x,@y) lies, or
255 * a monitor close to (@x,@y) if the point is not in any monitor.
260 gdk_screen_get_monitor_at_point (GdkScreen *screen,
264 gint num_monitors, i;
266 g_return_val_if_fail (GDK_IS_SCREEN (screen), -1);
268 num_monitors = gdk_screen_get_n_monitors (screen);
270 for (i=0;i<num_monitors;i++)
272 GdkRectangle monitor;
274 gdk_screen_get_monitor_geometry (screen, i, &monitor);
276 if (x >= monitor.x &&
277 x < monitor.x + monitor.width &&
279 y < (monitor.y + monitor.height))
283 return get_nearest_monitor (screen, x, y);
287 * gdk_screen_get_monitor_at_window:
288 * @screen: a #GdkScreen.
289 * @window: a #GdkWindow
290 * @returns: the monitor number in which most of @window is located,
291 * or if @window does not intersect any monitors, a monitor,
294 * Returns the number of the monitor in which the largest area of the
295 * bounding rectangle of @window resides.
300 gdk_screen_get_monitor_at_window (GdkScreen *screen,
303 gint num_monitors, i, area = 0, screen_num = -1;
304 GdkRectangle win_rect;
306 g_return_val_if_fail (GDK_IS_SCREEN (screen), -1);
308 gdk_window_get_geometry (window, &win_rect.x, &win_rect.y, &win_rect.width,
310 gdk_window_get_origin (window, &win_rect.x, &win_rect.y);
311 num_monitors = gdk_screen_get_n_monitors (screen);
313 for (i=0;i<num_monitors;i++)
315 GdkRectangle tmp_monitor, intersect;
317 gdk_screen_get_monitor_geometry (screen, i, &tmp_monitor);
318 gdk_rectangle_intersect (&win_rect, &tmp_monitor, &intersect);
320 if (intersect.width * intersect.height > area)
322 area = intersect.width * intersect.height;
329 return get_nearest_monitor (screen,
330 win_rect.x + win_rect.width / 2,
331 win_rect.y + win_rect.height / 2);
337 * Returns the width of the default screen in pixels.
339 * Return value: the width of the default screen in pixels.
342 gdk_screen_width (void)
344 return gdk_screen_get_width (gdk_screen_get_default ());
350 * Returns the height of the default screen in pixels.
352 * Return value: the height of the default screen in pixels.
355 gdk_screen_height (void)
357 return gdk_screen_get_height (gdk_screen_get_default ());
361 * gdk_screen_width_mm:
363 * Returns the width of the default screen in millimeters.
364 * Note that on many X servers this value will not be correct.
366 * Return value: the width of the default screen in millimeters,
367 * though it is not always correct.
370 gdk_screen_width_mm (void)
372 return gdk_screen_get_width_mm (gdk_screen_get_default ());
376 * gdk_screen_height_mm:
378 * Returns the height of the default screen in millimeters.
379 * Note that on many X servers this value will not be correct.
381 * Return value: the height of the default screen in millimeters,
382 * though it is not always correct.
385 gdk_screen_height_mm (void)
387 return gdk_screen_get_height_mm (gdk_screen_get_default ());
391 * gdk_screen_set_font_options:
392 * @screen: a #GdkScreen
393 * @options: (allow-none): a #cairo_font_options_t, or %NULL to unset any
394 * previously set default font options.
396 * Sets the default font options for the screen. These
397 * options will be set on any #PangoContext's newly created
398 * with gdk_pango_context_get_for_screen(). Changing the
399 * default set of font options does not affect contexts that
400 * have already been created.
405 gdk_screen_set_font_options (GdkScreen *screen,
406 const cairo_font_options_t *options)
408 g_return_if_fail (GDK_IS_SCREEN (screen));
410 if (screen->font_options != options)
412 if (screen->font_options)
413 cairo_font_options_destroy (screen->font_options);
416 screen->font_options = cairo_font_options_copy (options);
418 screen->font_options = NULL;
420 g_object_notify (G_OBJECT (screen), "font-options");
425 * gdk_screen_get_font_options:
426 * @screen: a #GdkScreen
428 * Gets any options previously set with gdk_screen_set_font_options().
430 * Return value: the current font options, or %NULL if no default
431 * font options have been set.
435 const cairo_font_options_t *
436 gdk_screen_get_font_options (GdkScreen *screen)
438 g_return_val_if_fail (GDK_IS_SCREEN (screen), NULL);
440 return screen->font_options;
444 * gdk_screen_set_resolution:
445 * @screen: a #GdkScreen
446 * @dpi: the resolution in "dots per inch". (Physical inches aren't actually
447 * involved; the terminology is conventional.)
449 * Sets the resolution for font handling on the screen. This is a
450 * scale factor between points specified in a #PangoFontDescription
451 * and cairo units. The default value is 96, meaning that a 10 point
452 * font will be 13 units high. (10 * 96. / 72. = 13.3).
457 gdk_screen_set_resolution (GdkScreen *screen,
460 g_return_if_fail (GDK_IS_SCREEN (screen));
465 if (screen->resolution != dpi)
467 screen->resolution = dpi;
469 g_object_notify (G_OBJECT (screen), "resolution");
474 * gdk_screen_get_resolution:
475 * @screen: a #GdkScreen
477 * Gets the resolution for font handling on the screen; see
478 * gdk_screen_set_resolution() for full details.
480 * Return value: the current resolution, or -1 if no resolution
486 gdk_screen_get_resolution (GdkScreen *screen)
488 g_return_val_if_fail (GDK_IS_SCREEN (screen), -1.0);
490 return screen->resolution;
494 gdk_screen_get_property (GObject *object,
499 GdkScreen *screen = GDK_SCREEN (object);
503 case PROP_FONT_OPTIONS:
504 g_value_set_pointer (value, (gpointer) gdk_screen_get_font_options (screen));
506 case PROP_RESOLUTION:
507 g_value_set_double (value, gdk_screen_get_resolution (screen));
510 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
516 gdk_screen_set_property (GObject *object,
521 GdkScreen *screen = GDK_SCREEN (object);
525 case PROP_FONT_OPTIONS:
526 gdk_screen_set_font_options (screen, g_value_get_pointer (value));
528 case PROP_RESOLUTION:
529 gdk_screen_set_resolution (screen, g_value_get_double (value));
532 G_OBJECT_WARN_INVALID_PROPERTY_ID (object, prop_id, pspec);
538 * gdk_screen_get_display:
539 * @screen: a #GdkScreen
541 * Gets the display to which the @screen belongs.
543 * Returns: (transfer none): the display to which @screen belongs
548 gdk_screen_get_display (GdkScreen *screen)
550 return GDK_SCREEN_GET_CLASS(screen)->get_display (screen);
555 * gdk_screen_get_width:
556 * @screen: a #GdkScreen
558 * Gets the width of @screen in pixels
560 * Returns: the width of @screen in pixels.
565 gdk_screen_get_width (GdkScreen *screen)
567 return GDK_SCREEN_GET_CLASS(screen)->get_width (screen);
571 * gdk_screen_get_height:
572 * @screen: a #GdkScreen
574 * Gets the height of @screen in pixels
576 * Returns: the height of @screen in pixels.
581 gdk_screen_get_height (GdkScreen *screen)
583 return GDK_SCREEN_GET_CLASS(screen)->get_height (screen);
587 * gdk_screen_get_width_mm:
588 * @screen: a #GdkScreen
590 * Gets the width of @screen in millimeters.
591 * Note that on some X servers this value will not be correct.
593 * Returns: the width of @screen in millimeters.
598 gdk_screen_get_width_mm (GdkScreen *screen)
600 return GDK_SCREEN_GET_CLASS(screen)->get_width_mm (screen);
604 * gdk_screen_get_height_mm:
605 * @screen: a #GdkScreen
607 * Returns the height of @screen in millimeters.
608 * Note that on some X servers this value will not be correct.
610 * Returns: the heigth of @screen in millimeters.
615 gdk_screen_get_height_mm (GdkScreen *screen)
617 return GDK_SCREEN_GET_CLASS(screen)->get_height_mm (screen);
621 * gdk_screen_get_number:
622 * @screen: a #GdkScreen
624 * Gets the index of @screen among the screens in the display
625 * to which it belongs. (See gdk_screen_get_display())
632 gdk_screen_get_number (GdkScreen *screen)
634 return GDK_SCREEN_GET_CLASS(screen)->get_number (screen);
638 * gdk_screen_get_root_window:
639 * @screen: a #GdkScreen
641 * Gets the root window of @screen.
643 * Returns: (transfer none): the root window
648 gdk_screen_get_root_window (GdkScreen *screen)
650 return GDK_SCREEN_GET_CLASS(screen)->get_root_window (screen);
654 * gdk_screen_get_n_monitors:
655 * @screen: a #GdkScreen
657 * Returns the number of monitors which @screen consists of.
659 * Returns: number of monitors which @screen consists of
664 gdk_screen_get_n_monitors (GdkScreen *screen)
666 return GDK_SCREEN_GET_CLASS(screen)->get_n_monitors (screen);
670 * gdk_screen_get_primary_monitor:
671 * @screen: a #GdkScreen.
673 * Gets the primary monitor for @screen. The primary monitor
674 * is considered the monitor where the 'main desktop' lives.
675 * While normal application windows typically allow the window
676 * manager to place the windows, specialized desktop applications
677 * such as panels should place themselves on the primary monitor.
679 * If no primary monitor is configured by the user, the return value
680 * will be 0, defaulting to the first monitor.
682 * Returns: An integer index for the primary monitor, or 0 if none is configured.
687 gdk_screen_get_primary_monitor (GdkScreen *screen)
689 return GDK_SCREEN_GET_CLASS(screen)->get_primary_monitor (screen);
693 * gdk_screen_get_monitor_width_mm:
694 * @screen: a #GdkScreen
695 * @monitor_num: number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
697 * Gets the width in millimeters of the specified monitor, if available.
699 * Returns: the width of the monitor, or -1 if not available
704 gdk_screen_get_monitor_width_mm (GdkScreen *screen,
707 return GDK_SCREEN_GET_CLASS(screen)->get_monitor_width_mm (screen, monitor_num);
711 * gdk_screen_get_monitor_height_mm:
712 * @screen: a #GdkScreen
713 * @monitor_num: number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
715 * Gets the height in millimeters of the specified monitor.
717 * Returns: the height of the monitor, or -1 if not available
722 gdk_screen_get_monitor_height_mm (GdkScreen *screen,
725 return GDK_SCREEN_GET_CLASS(screen)->get_monitor_height_mm (screen, monitor_num);
729 * gdk_screen_get_monitor_plug_name:
730 * @screen: a #GdkScreen
731 * @monitor_num: number of the monitor, between 0 and gdk_screen_get_n_monitors (screen)
733 * Returns the output name of the specified monitor.
734 * Usually something like VGA, DVI, or TV, not the actual
735 * product name of the display device.
737 * Returns: a newly-allocated string containing the name of the monitor,
738 * or %NULL if the name cannot be determined
743 gdk_screen_get_monitor_plug_name (GdkScreen *screen,
746 return GDK_SCREEN_GET_CLASS(screen)->get_monitor_plug_name (screen, monitor_num);
750 * gdk_screen_get_monitor_geometry:
751 * @screen: a #GdkScreen
752 * @monitor_num: the monitor number, between 0 and gdk_screen_get_n_monitors (screen)
753 * @dest: (out) (allow-none): a #GdkRectangle to be filled with the monitor geometry
755 * Retrieves the #GdkRectangle representing the size and position of
756 * the individual monitor within the entire screen area.
758 * Note that the size of the entire screen area can be retrieved via
759 * gdk_screen_get_width() and gdk_screen_get_height().
764 gdk_screen_get_monitor_geometry (GdkScreen *screen,
768 GDK_SCREEN_GET_CLASS(screen)->get_monitor_geometry (screen, monitor_num, dest);
772 * gdk_screen_list_visuals:
773 * @screen: the relevant #GdkScreen.
775 * Lists the available visuals for the specified @screen.
776 * A visual describes a hardware image data format.
777 * For example, a visual might support 24-bit color, or 8-bit color,
778 * and might expect pixels to be in a certain format.
780 * Call g_list_free() on the return value when you're finished with it.
782 * Return value: (transfer container) (element-type GdkVisual):
783 * a list of visuals; the list must be freed, but not its contents
788 gdk_screen_list_visuals (GdkScreen *screen)
790 return GDK_SCREEN_GET_CLASS(screen)->list_visuals (screen);
794 * gdk_screen_get_system_visual:
795 * @screen: a #GdkScreen.
797 * Get the system's default visual for @screen.
798 * This is the visual for the root window of the display.
799 * The return value should not be freed.
801 * Return value: (transfer none): the system visual
806 gdk_screen_get_system_visual (GdkScreen * screen)
808 return GDK_SCREEN_GET_CLASS(screen)->get_system_visual (screen);
812 * gdk_screen_get_rgba_visual:
813 * @screen: a #GdkScreen
815 * Gets a visual to use for creating windows with an alpha channel.
816 * The windowing system on which GTK+ is running
817 * may not support this capability, in which case %NULL will
818 * be returned. Even if a non-%NULL value is returned, its
819 * possible that the window's alpha channel won't be honored
820 * when displaying the window on the screen: in particular, for
821 * X an appropriate windowing manager and compositing manager
822 * must be running to provide appropriate display.
824 * This functionality is not implemented in the Windows backend.
826 * For setting an overall opacity for a top-level window, see
827 * gdk_window_set_opacity().
829 * Return value: (transfer none): a visual to use for windows with an
830 * alpha channel or %NULL if the capability is not available.
835 gdk_screen_get_rgba_visual (GdkScreen *screen)
837 return GDK_SCREEN_GET_CLASS(screen)->get_rgba_visual (screen);
841 * gdk_screen_is_composited:
842 * @screen: a #GdkScreen
844 * Returns whether windows with an RGBA visual can reasonably
845 * be expected to have their alpha channel drawn correctly on
848 * On X11 this function returns whether a compositing manager is
849 * compositing @screen.
851 * Return value: Whether windows with RGBA visuals can reasonably be
852 * expected to have their alpha channels drawn correctly on the screen.
857 gdk_screen_is_composited (GdkScreen *screen)
859 return GDK_SCREEN_GET_CLASS(screen)->is_composited (screen);
863 * gdk_screen_make_display_name:
864 * @screen: a #GdkScreen
866 * Determines the name to pass to gdk_display_open() to get
867 * a #GdkDisplay with this screen as the default screen.
869 * Return value: a newly allocated string, free with g_free()
874 gdk_screen_make_display_name (GdkScreen *screen)
876 return GDK_SCREEN_GET_CLASS(screen)->make_display_name (screen);
880 * gdk_screen_get_active_window:
881 * @screen: a #GdkScreen
883 * Returns the screen's currently active window.
885 * On X11, this is done by inspecting the _NET_ACTIVE_WINDOW property
886 * on the root window, as described in the <ulink
887 * url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
888 * Manager Hints</ulink>. If there is no currently currently active
889 * window, or the window manager does not support the
890 * _NET_ACTIVE_WINDOW hint, this function returns %NULL.
892 * On other platforms, this function may return %NULL, depending on whether
893 * it is implementable on that platform.
895 * The returned window should be unrefed using g_object_unref() when
898 * Return value: (transfer full): the currently active window, or %NULL.
903 gdk_screen_get_active_window (GdkScreen *screen)
905 return GDK_SCREEN_GET_CLASS(screen)->get_active_window (screen);
909 * gdk_screen_get_window_stack:
910 * @screen: a #GdkScreen
912 * Returns a #GList of #GdkWindow<!-- -->s representing the current
915 * On X11, this is done by inspecting the _NET_CLIENT_LIST_STACKING
916 * property on the root window, as described in the <ulink
917 * url="http://www.freedesktop.org/Standards/wm-spec">Extended Window
918 * Manager Hints</ulink>. If the window manager does not support the
919 * _NET_CLIENT_LIST_STACKING hint, this function returns %NULL.
921 * On other platforms, this function may return %NULL, depending on whether
922 * it is implementable on that platform.
924 * The returned list is newly allocated and owns references to the
925 * windows it contains, so it should be freed using g_list_free() and
926 * its windows unrefed using g_object_unref() when no longer needed.
928 * Return value: (transfer full) (element-type GdkWindow):
929 * a list of #GdkWindow<!-- -->s for the current window stack,
935 gdk_screen_get_window_stack (GdkScreen *screen)
937 return GDK_SCREEN_GET_CLASS(screen)->get_window_stack (screen);
941 * gdk_screen_get_setting:
942 * @screen: the #GdkScreen where the setting is located
943 * @name: the name of the setting
944 * @value: location to store the value of the setting
946 * Retrieves a desktop-wide setting such as double-click time
947 * for the #GdkScreen @screen.
949 * FIXME needs a list of valid settings here, or a link to
952 * Returns: %TRUE if the setting existed and a value was stored
953 * in @value, %FALSE otherwise.
958 gdk_screen_get_setting (GdkScreen *screen,
962 return GDK_SCREEN_GET_CLASS(screen)->get_setting (screen, name, value);