Namespace

Xdp – 1.0

Flatpak portal library

Version0.8.1
AuthorsFlatpak
LicenseLGPL-3.0-only
Websitehttps://libportal.org/
Sourcehttps://github.com/flatpak/libportal

Build

C headerslibportal/portal.h
pkg-config fileslibportal

Dependencies

GObject—2.0 The base type system library
Browse documentation

Classes

InputCapturePointerBarrier

A representation of a pointer barrier on an XdpInputCaptureZone. Barriers can be assigned with xdp_input_capture_session_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 xdp_input_capture_session_set_pointer_barriers() will invalidate all current barriers.

InputCaptureSession

A representation of a long-lived input capture portal interaction.

InputCaptureZone

A representation of a zone that supports input capture.

Portal

Context for portal calls.

Session

A representation of long-lived screencast portal interactions.

Settings

A representation of the settings exposed by the portal.

Structs

Parent

Parent window abstraction.

Enumerations

ButtonState

The XdpButtonState enumeration is used to describe the state of buttons.

CameraFlags

DiscreteAxis

The XdpDiscreteAxis enumeration is used to describe the discrete scroll axes.

EmailFlags

KeyState

The XdpKeyState enumeration is used to describe the state of keys.

LocationAccuracy

The values of this enum indicate the desired level of accuracy for location information.

LocationMonitorFlags

LoginSessionState

The values of this enum are returned in the XdpPortal::session-state-changed signal to indicate the current state of the user session.

NotificationFlags

PersistMode

Options for how the screencast session should persist.

PrintFlags

SaveFileFlags

SessionMonitorFlags

SessionState

The state of a session.

SessionType

The type of a session.

UpdateInstallFlags

UpdateMonitorFlags

UpdateStatus

The values of this enum are returned in the XdpPortal::update-progress signal to indicate the current progress of an installation.

UserInformationFlags

Bitfields

BackgroundFlags

Options to use when requesting background.

CursorMode

Options for how the cursor is handled.

DeviceType

Flags to specify what input devices to control for a remote desktop session.

InhibitFlags

Flags that determine what session status changes are inhibited.

InputCapability

Flags to specify what input device capabilities should be captured.

LauncherType

The type of a launcher.

OpenFileFlags

Options for opening files.

OpenUriFlags

Options for opening uris.

OutputType

Flags to specify what kind of sources to offer for a screencast session.

RemoteDesktopFlags

Options for starting remote desktop sessions.

ScreencastFlags

Options for starting screen casts.

ScreenshotFlags

SpawnFlags

Flags influencing the spawn operation and how the new sandbox is created.

WallpaperFlags

The values of this enumeration determine where the wallpaper is being set.