Atspi.ComponentLayer
Description: Reference for Atspi.ComponentLayer

### Enumeration

# AtspiComponentLayer

since: 2.0

#### Declaration

    enum Atspi.ComponentLayer

#### Description [src]

The `AtspiComponentLayer` of an `AtspiComponent` instance indicates its relative stacking order with respect to the onscreen visual representation of the UI. `AtspiComponentLayer`, in combination with `AtspiComponent` bounds information, can be used to compute the visibility of all or part of a component. This is important in programmatic determination of region-of-interest for magnification, and in flat screen review models of the screen, as well as for other uses. Objects residing in two of the `AtspiComponentLayer` categories support further z-ordering information, with respect to their peers in the same layer: namely, `ATSPI_LAYER_WINDOW` and `ATSPI_LAYER_MDI`. Relative stacking order for other objects within the same layer is not available; the recommended heuristic is first child paints first. In other words, assume that the first siblings in the child list are subject to being overpainted by later siblings if their bounds intersect. The order of layers, from bottom to top, is: `ATSPI_LAYER_BACKGROUND`, `ATSPI_LAYER_WINDOW`, `ATSPI_LAYER_MDI`, `ATSPI_LAYER_CANVAS`, `ATSPI_LAYER_WIDGET`, `ATSPI_LAYER_POPUP`, and `ATSPI_LAYER_OVERLAY`.

Available since: 2.0

#### Members

`ATSPI_LAYER_INVALID`

  Indicates an error condition or uninitialized value.

  - Value: `0`
  - Nickname: `invalid`
  - Available since: 2.0
`ATSPI_LAYER_BACKGROUND`

  The bottom-most layer, over which everything else is painted. The ‘desktop background’ is generally in this layer.

  - Value: `1`
  - Nickname: `background`
  - Available since: 2.0
`ATSPI_LAYER_CANVAS`

  The ‘background’ layer for most content renderers and UI `AtspiComponent` containers.

  - Value: `2`
  - Nickname: `canvas`
  - Available since: 2.0
`ATSPI_LAYER_WIDGET`

  The layer in which the majority of ordinary ‘foreground’ widgets reside.

  - Value: `3`
  - Nickname: `widget`
  - Available since: 2.0
`ATSPI_LAYER_MDI`

  A special layer between `ATSPI_LAYER_CANVAS` and `ATSPI_LAYER_WIDGET`, in which the ‘pseudo windows’ (e.g. the MDI frames) reside. See #atspi_component_get_mdi_z_order.

  - Value: `4`
  - Nickname: `mdi`
  - Available since: 2.0
`ATSPI_LAYER_POPUP`

  A layer for popup window content, above `ATSPI_LAYER_WIDGET`.

  - Value: `5`
  - Nickname: `popup`
  - Available since: 2.0
`ATSPI_LAYER_OVERLAY`

  The topmost layer.

  - Value: `6`
  - Nickname: `overlay`
  - Available since: 2.0
`ATSPI_LAYER_WINDOW`

  The layer in which a toplevel window background usually resides.

  - Value: `7`
  - Nickname: `window`
  - Available since: 2.0
`ATSPI_LAYER_LAST_DEFINED`

  Used only to determine the end of the enumeration.

  - Value: `8`
  - Nickname: `last-defined`
  - Available since: 2.0