Files
dotfiles/quickshell/backend/protocols/hyprland_lock_notify_v1.py
T
2026-11-17 18:15:16 +07:00

161 lines
5.7 KiB
Python

# This file has been autogenerated by the pywayland scanner
# Copyright © 2025 Maximilian Seidler
# All rights reserved.
#
# Redistribution and use in source and binary forms, with or without
# modification, are permitted provided that the following conditions are met:
#
# 1. Redistributions of source code must retain the above copyright notice, this
# list of conditions and the following disclaimer.
#
# 2. Redistributions in binary form must reproduce the above copyright notice,
# this list of conditions and the following disclaimer in the documentation
# and/or other materials provided with the distribution.
#
# 3. Neither the name of the copyright holder nor the names of its
# contributors may be used to endorse or promote products derived from
# this software without specific prior written permission.
#
# THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
# AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
# IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
# DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
# FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
# DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
# SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
# CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
# OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
# OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
from __future__ import annotations
from pywayland.protocol_core import Argument, ArgumentType, Global, Interface, Proxy, Resource
class HyprlandLockNotificationV1(Interface):
"""Lock notification
This interface is used by the compositor to send lock notification events
to clients.
Typically the "locked" and "unlocked" events are emitted when a client
locks/unlocks the session via ext-session-lock, but the compositor may
choose to send notifications for any other locking mechanisms.
The compositor must notfiy after possible transition periods between locked
and unlocked states of the session. In the context of ext-session-lock,
that means the "locked" event is expected to be sent after the session-lock
client has presented a lock screen frame on every output, which corresponds
to the "locked" event of ext-session-lock.
"""
name = "hyprland_lock_notification_v1"
version = 1
class HyprlandLockNotifierV1(Interface):
"""Lock notification manager
This interface allows clients to monitor whether the wayland session is
locked or unlocked.
"""
name = "hyprland_lock_notifier_v1"
version = 1
class HyprlandLockNotificationV1Resource(Resource[HyprlandLockNotificationV1]):
interface = HyprlandLockNotificationV1
@HyprlandLockNotificationV1.event()
def locked(self) -> None:
"""Session is locked
This event is sent when the wayland session is locked.
It's a compositor protocol error to send this event twice without an
unlock event in-between.
"""
self._post_event(0)
@HyprlandLockNotificationV1.event()
def unlocked(self) -> None:
"""Session is no longer locked
This event is sent when the wayland session is unlocked.
It's a compositor protocol error to send this event twice without an
locked event in-between. It's a compositor protocol error to send this
event prior to any locked event.
"""
self._post_event(1)
class HyprlandLockNotifierV1Resource(Resource[HyprlandLockNotifierV1]):
interface = HyprlandLockNotifierV1
class HyprlandLockNotificationV1Proxy(Proxy[HyprlandLockNotificationV1]):
interface = HyprlandLockNotificationV1
@HyprlandLockNotificationV1.request()
def destroy(self) -> None:
"""Destroy the notification object
Destroy the notification object.
"""
self._marshal(0)
self._destroy()
class HyprlandLockNotifierV1Proxy(Proxy[HyprlandLockNotifierV1]):
interface = HyprlandLockNotifierV1
@HyprlandLockNotifierV1.request()
def destroy(self) -> None:
"""Destroy the manager
Destroy the manager object. All objects created via this interface
remain valid.
"""
self._marshal(0)
self._destroy()
@HyprlandLockNotifierV1.request(
Argument(ArgumentType.NewId, interface=HyprlandLockNotificationV1),
)
def get_lock_notification(self) -> HyprlandLockNotificationV1Proxy:
"""Create a notification object
Create a new lock notification object.
If the session is already locked when calling this method, the locked
event shall be sent immediately.
:returns:
:class:`~pywayland.protocol.hyprland_lock_notify_v1.HyprlandLockNotificationV1`
"""
id = self._marshal_constructor(1, HyprlandLockNotificationV1)
return id
class HyprlandLockNotificationV1Global(Global[HyprlandLockNotificationV1]):
interface = HyprlandLockNotificationV1
class HyprlandLockNotifierV1Global(Global[HyprlandLockNotifierV1]):
interface = HyprlandLockNotifierV1
HyprlandLockNotificationV1._gen_c()
HyprlandLockNotificationV1.proxy_class = HyprlandLockNotificationV1Proxy
HyprlandLockNotificationV1.resource_class = HyprlandLockNotificationV1Resource
HyprlandLockNotificationV1.global_class = HyprlandLockNotificationV1Global
HyprlandLockNotifierV1._gen_c()
HyprlandLockNotifierV1.proxy_class = HyprlandLockNotifierV1Proxy
HyprlandLockNotifierV1.resource_class = HyprlandLockNotifierV1Resource
HyprlandLockNotifierV1.global_class = HyprlandLockNotifierV1Global