Updated Spanish translation

[~andy/gtk] / gdk / gdkscreen.c

diff --git a/gdk/gdkscreen.c b/gdk/gdkscreen.c
index 7658bfab9ca2077619667258ef7adbe0f7bdd26a..9493e168ff28f391a5ae5446f27371e16f6cf0ce 100644 (file)
--- a/gdk/gdkscreen.c
+++ b/gdk/gdkscreen.c
@@ -34,14 +34,17 @@
  * @Short_description: Object representing a physical screen
  * @Title: GdkScreen
  *
- * #GdkScreen objects are the GDK representation of a physical screen. It is used
- * throughout GDK and GTK+ to specify which screen the top level windows
- * are to be displayed on.
- * It is also used to query the screen specification and default settings such as
- * the screen width (gdk_screen_get_width()), etc.
- *
- * Note that a screen may consist of multiple monitors which are merged to
- * form a large screen area.
+ * #GdkScreen objects are the GDK representation of the screen on
+ * which windows can be displayed and on which the pointer moves.
+ * X originally identified screens with physical screens, but
+ * nowadays it is more common to have a single #GdkScreen which
+ * combines several physical monitors (see gdk_screen_get_n_monitors()).
+ *
+ * GdkScreen is used throughout GDK and GTK+ to specify which screen
+ * the top level windows are to be displayed on. it is also used to
+ * query the screen specification and default settings such as
+ * the default visual (gdk_screen_get_system_visual()), the dimensions
+ * of the physical monitors (gdk_screen_get_monitor_geometry()), etc.
  */
 
 
@@ -284,13 +287,14 @@ gdk_screen_get_monitor_at_point (GdkScreen *screen,
  * gdk_screen_get_monitor_at_window:
  * @screen: a #GdkScreen.
  * @window: a #GdkWindow
- * @returns: the monitor number in which most of @window is located,
- *           or if @window does not intersect any monitors, a monitor,
- *           close to @window.
  *
- * Returns the number of the monitor in which the largest area of the 
+ * Returns the number of the monitor in which the largest area of the
  * bounding rectangle of @window resides.
  *
+ * Returns: the monitor number in which most of @window is located,
+ *     or if @window does not intersect any monitors, a monitor,
+ *     close to @window.
+ *
  * Since: 2.2
  **/
 gint 
@@ -746,12 +750,16 @@ gdk_screen_get_monitor_plug_name (GdkScreen *screen,
 /**
  * gdk_screen_get_monitor_geometry:
  * @screen: a #GdkScreen
- * @monitor_num: the monitor number, between 0 and gdk_screen_get_n_monitors (screen)
- * @dest: (out) (allow-none): a #GdkRectangle to be filled with the monitor geometry
+ * @monitor_num: the monitor number
+ * @dest: (out) (allow-none): a #GdkRectangle to be filled with
+ *     the monitor geometry
  *
  * Retrieves the #GdkRectangle representing the size and position of
  * the individual monitor within the entire screen area.
  *
+ * Monitor numbers start at 0. To obtain the number of monitors of
+ * @screen, use gdk_screen_get_n_monitors().
+ *
  * Note that the size of the entire screen area can be retrieved via
  * gdk_screen_get_width() and gdk_screen_get_height().
  *
@@ -765,6 +773,33 @@ gdk_screen_get_monitor_geometry (GdkScreen    *screen,
   GDK_SCREEN_GET_CLASS(screen)->get_monitor_geometry (screen, monitor_num, dest);
 }
 
+/**
+ * gdk_screen_get_monitor_workarea:
+ * @screen: a #GdkScreen
+ * @monitor_num: the monitor number
+ * @dest: (out) (allow-none): a #GdkRectangle to be filled with
+ *     the monitor workarea
+ *
+ * Retrieves the #GdkRectangle representing the size and position of
+ * the "work area" on a monitor within the entire screen area.
+ *
+ * The work area should be considered when positioning menus and
+ * similar popups, to avoid placing them below panels, docks or other
+ * desktop components.
+ *
+ * Monitor numbers start at 0. To obtain the number of monitors of
+ * @screen, use gdk_screen_get_n_monitors().
+ *
+ * Since: 3.4
+ */
+void
+gdk_screen_get_monitor_workarea (GdkScreen    *screen,
+                                 gint          monitor_num,
+                                 GdkRectangle *dest)
+{
+  GDK_SCREEN_GET_CLASS(screen)->get_monitor_workarea (screen, monitor_num, dest);
+}
+
 /**
  * gdk_screen_list_visuals:
  * @screen: the relevant #GdkScreen.
@@ -934,32 +969,6 @@ gdk_screen_get_window_stack (GdkScreen *screen)
   return GDK_SCREEN_GET_CLASS(screen)->get_window_stack (screen);
 }
 
-/**
- * gdk_screen_broadcast_client_message:
- * @screen: the #GdkScreen where the event will be broadcasted.
- * @event: the #GdkEvent.
- *
- * On X11, sends an X ClientMessage event to all toplevel windows on
- * @screen.
- *
- * Toplevel windows are determined by checking for the WM_STATE property,
- * as described in the Inter-Client Communication Conventions Manual (ICCCM).
- * If no windows are found with the WM_STATE property set, the message is
- * sent to all children of the root window.
- *
- * On Windows, broadcasts a message registered with the name
- * GDK_WIN32_CLIENT_MESSAGE to all top-level windows. The amount of
- * data is limited to one long, i.e. four bytes.
- *
- * Since: 2.2
- */
-void
-gdk_screen_broadcast_client_message (GdkScreen *screen,
-                                    GdkEvent  *event)
-{
-  return GDK_SCREEN_GET_CLASS(screen)->broadcast_client_message (screen, event);
-}
-
 /**
  * gdk_screen_get_setting:
  * @screen: the #GdkScreen where the setting is located