Xdp.InputCaptureZone¶

Subclasses:: None

Methods¶

Inherited:: GObject.Object (37)
Structs:: GObject.ObjectClass (5)

Virtual Methods¶

Inherited:: GObject.Object (7)

Properties¶

Name	Type	Flags	Short Description
`height`	`int`	r/w/co	The zone height in logical pixels
`is-valid`	`bool`	r/w	True if this zone is currently valid
`width`	`int`	r/w/co	The zone width in logical pixels
`x`	`int`	r/w/co	The zone x offset in logical pixels
`y`	`int`	r/w/co	The zone y offset in logical pixels
`zone-set`	`int`	r/w/co	The zone_set number when this zone was retrieved

Signals¶

Inherited:: GObject.Object (1)

Fields¶

Inherited:: GObject.Object (1)

Class Details¶

class Xdp.InputCaptureZone(**kwargs)¶

Bases:: GObject.Object
Abstract:: No
Structure:: Xdp.InputCaptureZoneClass

A representation of a zone that supports input capture.

The [class`XdpInputCaptureZone`] object is used to represent a zone on the user-visible desktop that may be used to set up [class`XdpInputCapturePointerBarrier`] objects. In most cases, the set of [class`XdpInputCaptureZone`] objects represent the available monitors but the exact implementation is up to the implementation.

Property Details¶

Xdp.InputCaptureZone.props.height¶

Name:: height
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The height of this zone in logical pixels

Xdp.InputCaptureZone.props.is_valid¶

Name:: is-valid
Type:: bool
Default Value:: True
Flags:: READABLE, WRITABLE

A boolean indicating whether this zone is currently valid. Zones are invalidated by the Portal’s ZonesChanged signal, see [signal`InputCaptureSession`:py:func:::zones-changed<Xdp.InputCaptureZone.signals.zones_changed>].

Once invalidated, a Zone can be discarded by the caller, it cannot become valid again.

Xdp.InputCaptureZone.props.width¶

Name:: width
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The width of this zone in logical pixels

Xdp.InputCaptureZone.props.x¶

Name:: x
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The x offset of this zone in logical pixels

Xdp.InputCaptureZone.props.y¶

Name:: y
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The x offset of this zone in logical pixels

Xdp.InputCaptureZone.props.zone_set¶

Name:: zone-set
Type:: int
Default Value:: 0
Flags:: READABLE, WRITABLE, CONSTRUCT_ONLY

The zone_set number when this zone was retrieved