Function: frame-monitor-workarea

frame-monitor-workarea is a byte-compiled function defined in frame.el.gz.

Signature

(frame-monitor-workarea &optional FRAME X Y)

Documentation

Return the workarea of FRAME's monitor.

FRAME can be a frame name, a terminal name, or a frame. If FRAME is omitted or nil, use currently selected frame.

By default, the current monitor is said to be the physical monitor dominating the selected frame. A frame is dominated by a physical monitor when either the largest area of the frame resides in the monitor, or the monitor is the closest to the frame if the frame does not intersect any physical monitors.

If X and Y are both numbers, then ignore the value of FRAME; the monitor is determined to be the physical monitor that contains the pixel coordinate (X, Y).

See display-monitor-attributes-list for information on the workarea attribute.

Source Code

;; Defined in /usr/src/emacs/lisp/frame.el.gz
(defun frame-monitor-workarea (&optional frame x y)
  "Return the workarea of FRAME's monitor.
FRAME can be a frame name, a terminal name, or a frame.
If FRAME is omitted or nil, use currently selected frame.

By default, the current monitor is said to be the physical
monitor dominating the selected frame.  A frame is dominated by
a physical monitor when either the largest area of the frame resides
in the monitor, or the monitor is the closest to the frame if the
frame does not intersect any physical monitors.

If X and Y are both numbers, then ignore the value of FRAME; the
monitor is determined to be the physical monitor that contains
the pixel coordinate (X, Y).

See `display-monitor-attributes-list' for information on the
workarea attribute."
  (frame-monitor-attribute 'workarea frame x y))