All Manuals > CAPI User Guide and Reference Manual > 21 CAPI Reference Entries

pane-screen-internal-geometry Function

Summary

Returns the internal geometry of the monitor in which a pane's interface is displayed.

Package

capi

Signature

pane-screen-internal-geometry pane => x, y, width, height

Arguments
pane
A CAPI pane.
Values
An integer.
An integer.
width
A positive integer.
height
A positive integer.
Description

The function pane-screen-internal-geometry returns the internal geometry of the "monitor" in which the interface that contains pane is displayed. A "monitor" is typically a physical monitor, but can be anything that the underlying GUI system considers a monitor.

pane must be inside an interface that is already displayed. pane-screen-internal-geometry returns the internal geometry of the monitor on which this interface is displayed. If the interface spreads across multiple monitors, it returns the geometry for the monitor on which the largest area of the interface is displayed.

The internal geometry of a monitor is a rectangle which excludes "system areas" like taskbars and global menu bars and so on. Examples of these include the Windows taskbar, the macOS menu bar, and the macOS Dock. See screen-internal-geometry for information about displaying CAPI windows in system areas.

x, y, width and height specify a screen rectangle. x and y are offsets from the top-left of the primary monitor.

Notes

On GTK+ the internal geometry is of the workspace in which the interface is displayed. When there are multiple monitors these values may be incorrect. You can check the number of monitors by screen-monitor-geometries.

See also

screen-internal-geometry
screen-internal-geometries
virtual-screen-geometry
3.13 Screens
4.3 Support for multiple monitors
11.6 Querying and modifying interface geometry


CAPI User Guide and Reference Manual (Unix version) - 01 Dec 2021 19:32:42