Xdp.InputCapturePointerBarrier

g GObject.Object GObject.Object Xdp.InputCapturePointerBarrier Xdp.InputCapturePointerBarrier GObject.Object->Xdp.InputCapturePointerBarrier

Subclasses:

None

Methods

Inherited:

GObject.Object (37)

Structs:

GObject.ObjectClass (5)

Virtual Methods

Inherited:

GObject.Object (7)

Properties

Name

Type

Flags

Short Description

id

int

r/w/co

The id assigned to this barrier by the caller

is-active

bool

r

true if active, false otherwise

x1

int

r/w/co

The pointer barrier x offset in logical pixels

x2

int

r/w/co

The pointer barrier x offset in logical pixels

y1

int

r/w/co

The pointer barrier y offset in logical pixels

y2

int

r/w/co

The pointer barrier y offset in logical pixels

Signals

Inherited:

GObject.Object (1)

Fields

Inherited:

GObject.Object (1)

Class Details

class Xdp.InputCapturePointerBarrier(**kwargs)
Bases:

GObject.Object

Abstract:

No

Structure:

Xdp.InputCapturePointerBarrierClass

A representation of a pointer barrier on an [class`InputCaptureZone`]. Barriers can be assigned with [method`InputCaptureSession`.set_pointer_barriers], once the Portal interaction is complete the barrier’s “is-active” state indicates whether the barrier is active. Barriers can only be used once, subsequent calls to [method`InputCaptureSession`.set_pointer_barriers] will invalidate all current barriers.

Property Details

Xdp.InputCapturePointerBarrier.props.id
Name:

id

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The caller-assigned unique id of this barrier

Xdp.InputCapturePointerBarrier.props.is_active
Name:

is-active

Type:

bool

Default Value:

False

Flags:

READABLE

A boolean indicating whether this barrier is active. A barrier cannot become active once it failed to apply, barriers that are not active can be thus cleaned up by the caller.

Xdp.InputCapturePointerBarrier.props.x1
Name:

x1

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The pointer barrier x offset in logical pixels

Xdp.InputCapturePointerBarrier.props.x2
Name:

x2

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The pointer barrier x offset in logical pixels

Xdp.InputCapturePointerBarrier.props.y1
Name:

y1

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The pointer barrier y offset in logical pixels

Xdp.InputCapturePointerBarrier.props.y2
Name:

y2

Type:

int

Default Value:

0

Flags:

READABLE, WRITABLE, CONSTRUCT_ONLY

The pointer barrier y offset in logical pixels