Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

overlap-notify: New protocol #30

Merged
merged 1 commit into from
Sep 3, 2024
Merged

overlap-notify: New protocol #30

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,7 @@ unstable_protocols = \
unstable/cosmic-output-management-unstable-v1.xml \
unstable/cosmic-toplevel-info-unstable-v1.xml \
unstable/cosmic-toplevel-management-unstable-v1.xml \
unstable/cosmic-overlap-notify-unstable-v1.xml \
unstable/cosmic-workspace-unstable-v1.xml \

check: $(unstable_protocols)
Expand Down
12 changes: 12 additions & 0 deletions src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,18 @@ pub mod toplevel_management {
}
}

pub mod overlap_notify {
//! Get overlap notifications for layer surfaces

#[allow(missing_docs)]
pub mod v1 {
wayland_protocol!(
"./unstable/cosmic-overlap-notify-unstable-v1.xml",
[wayland_protocols_wlr::layer_shell::v1, wayland_protocols::ext::foreign_toplevel_list::v1]
);
}
}

pub mod workspace {
//! Receive information about and control workspaces.

Expand Down
117 changes: 117 additions & 0 deletions unstable/cosmic-overlap-notify-unstable-v1.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,117 @@
<?xml version="1.0" encoding="UTF-8"?>
<protocol name="cosmic_overlap_notify_unstable_v1">
<copyright>
Copytight © 2024 Victoria Brekenfeld

Permission to use, copy, modify, distribute, and sell this
software and its documentation for any purpose is hereby granted
without fee, provided that the above copyright notice appear in
all copies and that both that copyright notice and this permission
notice appear in supporting documentation, and that the name of
the copyright holders not be used in advertising or publicity
pertaining to distribution of the software without specific,
written prior permission. The copyright holders make no
representations about the suitability of this software for any
purpose. It is provided "as is" without express or implied
warranty.

THE COPYRIGHT HOLDERS DISCLAIM ALL WARRANTIES WITH REGARD TO THIS
SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND
FITNESS, IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY
SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN
AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION,
ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF
THIS SOFTWARE.
</copyright>

<interface name="zcosmic_overlap_notify_v1" version="1">
<description summary="get notifications of other elements overlapping layer surfaces">
The purpose of this protocol is to enable layer-shell client to get
notifications if part of their surfaces are occluded other elements
(currently toplevels and other layer-surfaces).

You can request a notification object for any of your zwlr_layer_surface_v1
surfaces, which will then emit overlap events.
</description>

<request name="notify_on_overlap">
<description summary="get notified if a layer-shell is obstructed by a toplevel">
Requests notifications for toplevels and layer-surfaces entering and leaving the
surface-area of the given zwlr_layer_surface_v1. This can be used e.g. to
implement auto-hide functionality.

To stop receiving notifications, destroy the returned
zcosmic_overlap_notification_v1 object.
</description>
<arg name="overlap_notification" type="new_id" interface="zcosmic_overlap_notification_v1"/>
<arg name="layer_surface" type="object" interface="zwlr_layer_surface_v1"/>
</request>
</interface>

<interface name="zcosmic_overlap_notification_v1" version="1">
<description summary="Subscription for overlapping toplevels on a layer-surface"/>

<event name="toplevel_enter">
<description summary="Toplevel entered the surface area">
A ext_foreign_toplevel_handle_v1 has entered the surface area.

This event will be emitted once for every ext_foreign_toplevel_handle_v1
representing this toplevel.

Compositors are free to update the overlapping area by sending additional
`toplevel_enter` events for the same toplevel without sending `toplevel_leave`
in between.
</description>
<arg name="toplevel" type="object" interface="ext_foreign_toplevel_handle_v1"/>
<arg name="x" type="int" summary="x coordinate of the upper-left corner of the overlapping area"/>
<arg name="y" type="int" summary="y coordinate of the upper-left corner of the overlapping area"/>
<arg name="width" type="int" summary="width of the overlapping area"/>
<arg name="height" type="int" summary="height of the overlapping area"/>
</event>

<event name="toplevel_leave">
<description summary="Toplevel entered the surface area">
A ext_foreign_toplevel_handle_v1 has left the surface area.

This event will be emitted once for every ext_foreign_toplevel_handle_v1
representing this toplevel.
</description>
<arg name="toplevel" type="object" interface="ext_foreign_toplevel_handle_v1"/>
</event>

<event name="layer_enter">
<description summary="Layer surface entered the surface area">
A zwlr_layer_surface_v1 has entered the surface area.

Compositors are free to update the overlapping area by sending additional
`layer_enter` events for the same surface without sending `layer_leave`
in between.

The overlapping region is given surface-relative to the zwlr_layer_surface_v1
used to create this notification object.
</description>
<arg name="identifier" type="string" summary="unique identifier for the overlapping layer-surface"/>
<arg name="exclusive" type="uint" summary="if the overlapping surface is requesting an exclusive area or not"/>
<arg name="layer" type="uint" enum="zwlr_layer_shell_v1.layer" summary="layer the overlapping surface sits on"/>
<arg name="x" type="int" summary="x coordinate of the upper-left corner of the overlapping area"/>
<arg name="y" type="int" summary="y coordinate of the upper-left corner of the overlapping area"/>
<arg name="width" type="int" summary="width of the overlapping area"/>
<arg name="height" type="int" summary="height of the overlapping area"/>
</event>

<event name="layer_leave">
<description summary="Layer surface left the surface area">
A zwlr_layer_surface_v1 has left the surface area.
</description>
<arg name="identifier" type="string" summary="unique identifier for the overlapping layer-surface"/>
</event>

<request name="destroy" type="destructor">
<description summary="destroy the notification object">
This request should be called when the client has no interest in overlap
notifications anymore.
</description>
</request>
</interface>
</protocol>
Loading