|
|
|
|
<protocol name="desktop">
|
|
|
|
|
|
|
|
|
|
<interface name="desktop_shell" version="1">
|
|
|
|
|
<description summary="create desktop widgets and helpers">
|
|
|
|
|
Traditional user interfaces can rely on this interface to define the
|
|
|
|
|
foundations of typical desktops. Currently it's possible to set up
|
|
|
|
|
background, panels and locking surfaces.
|
|
|
|
|
</description>
|
|
|
|
|
|
|
|
|
|
<request name="set_background">
|
|
|
|
|
<arg name="output" type="object" interface="wl_output"/>
|
|
|
|
|
<arg name="surface" type="object" interface="wl_surface"/>
|
|
|
|
|
</request>
|
|
|
|
|
|
|
|
|
|
<request name="set_panel">
|
|
|
|
|
<arg name="output" type="object" interface="wl_output"/>
|
|
|
|
|
<arg name="surface" type="object" interface="wl_surface"/>
|
|
|
|
|
</request>
|
|
|
|
|
|
desktop-shell: screen locking protocol
Add protocol and functions for supporting screen locking, triggered by
activity timeout.
After activity timeout, compositor starts the fade to black, and then
enters SLEEPING state. At that point it calls lock() in the shell
plugin.
When input events trigger a wakeup, unlock() in the shell plugin is
called. This sends prepare_lock_surface event to the desktop-shell
client. The screen stays locked while the compositor starts fade-in.
At this point, desktop-shell client usually creates a surface for the
unlocking GUI (e.g. a password prompt), and sends it with the
set_lock_surface request. The compositor supposedly shows and allows
interaction only with the given lock surface (not yet implemented).
When desktop-shell has authenticated the user, or instead of issuing
set_lock_surface, it sends the unlock request. Upon receiving the unlock
request, the shell plugin unlocks the screen.
If desktop-shell client dies, the screen is unlocked automatically.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
13 years ago
|
|
|
<request name="set_lock_surface">
|
|
|
|
|
<arg name="surface" type="object" interface="wl_shell_surface"/>
|
desktop-shell: screen locking protocol
Add protocol and functions for supporting screen locking, triggered by
activity timeout.
After activity timeout, compositor starts the fade to black, and then
enters SLEEPING state. At that point it calls lock() in the shell
plugin.
When input events trigger a wakeup, unlock() in the shell plugin is
called. This sends prepare_lock_surface event to the desktop-shell
client. The screen stays locked while the compositor starts fade-in.
At this point, desktop-shell client usually creates a surface for the
unlocking GUI (e.g. a password prompt), and sends it with the
set_lock_surface request. The compositor supposedly shows and allows
interaction only with the given lock surface (not yet implemented).
When desktop-shell has authenticated the user, or instead of issuing
set_lock_surface, it sends the unlock request. Upon receiving the unlock
request, the shell plugin unlocks the screen.
If desktop-shell client dies, the screen is unlocked automatically.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
13 years ago
|
|
|
</request>
|
|
|
|
|
|
|
|
|
|
<request name="unlock"/>
|
|
|
|
|
|
|
|
|
|
<request name="set_busy_surface">
|
|
|
|
|
<arg name="surface" type="object" interface="wl_surface"/>
|
|
|
|
|
</request>
|
|
|
|
|
|
|
|
|
|
<!-- We'll fold most of wl_shell into this interface and then
|
|
|
|
|
they'll share the configure event. -->
|
|
|
|
|
<event name="configure">
|
|
|
|
|
<arg name="edges" type="uint"/>
|
|
|
|
|
<arg name="surface" type="object" interface="wl_surface"/>
|
|
|
|
|
<arg name="width" type="int"/>
|
|
|
|
|
<arg name="height" type="int"/>
|
|
|
|
|
</event>
|
|
|
|
|
|
|
|
|
|
<event name="prepare_lock_surface">
|
|
|
|
|
<description summary="tell the client to create, set the lock surface">
|
|
|
|
|
Tell the shell we want it to create and set the lock surface, which is
|
|
|
|
|
a GUI asking the user to unlock the screen. The lock surface is
|
|
|
|
|
announced with 'set_lock_surface'. Whether or not the shell actually
|
|
|
|
|
implements locking, it MUST send 'unlock' request to let the normal
|
|
|
|
|
desktop resume.
|
|
|
|
|
</description>
|
|
|
|
|
</event>
|
|
|
|
|
</interface>
|
|
|
|
|
|
protocol: add screensaver interface
Add the screensaver interface to the desktop-shell protocol file. Also
add stubs for it in the compositor, and make wscreensaver to bind to the
screensaver interface. Wscreensaver gets a new option --demo to retain
the current behaviour as a regular wayland client.
When a screensaver application starts, it should bind to the screensaver
interface, enumerate all outputs, create a surface per output, and
register those surfaces via screensaver::set_surface request. Then it
continues with the usual animation loop, waiting for frame events. The
compositor will decide, when the given screensaver surfaces are
displayed. A screensaver application should respond to outputs coming
and going away by creating and destroying surfaces.
The compositor is supposed to activate a screensaver by exec'ing it, and
stop the screensaver by killing the client process. Only one client may
be bound to the screensaver interface at a time. If there already is a
client, the compositor could either kill it first, or not exec a new
one.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
13 years ago
|
|
|
<interface name="screensaver" version="1">
|
|
|
|
|
<description summary="interface for implementing screensavers">
|
|
|
|
|
Only one client can bind this interface at a time.
|
|
|
|
|
</description>
|
protocol: add screensaver interface
Add the screensaver interface to the desktop-shell protocol file. Also
add stubs for it in the compositor, and make wscreensaver to bind to the
screensaver interface. Wscreensaver gets a new option --demo to retain
the current behaviour as a regular wayland client.
When a screensaver application starts, it should bind to the screensaver
interface, enumerate all outputs, create a surface per output, and
register those surfaces via screensaver::set_surface request. Then it
continues with the usual animation loop, waiting for frame events. The
compositor will decide, when the given screensaver surfaces are
displayed. A screensaver application should respond to outputs coming
and going away by creating and destroying surfaces.
The compositor is supposed to activate a screensaver by exec'ing it, and
stop the screensaver by killing the client process. Only one client may
be bound to the screensaver interface at a time. If there already is a
client, the compositor could either kill it first, or not exec a new
one.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
13 years ago
|
|
|
|
|
|
|
|
<request name="set_surface">
|
|
|
|
|
<description summary="set the surface type as a screensaver">
|
|
|
|
|
A screensaver surface is normally hidden, and only visible after an
|
|
|
|
|
idle timeout.
|
|
|
|
|
</description>
|
|
|
|
|
|
protocol: add screensaver interface
Add the screensaver interface to the desktop-shell protocol file. Also
add stubs for it in the compositor, and make wscreensaver to bind to the
screensaver interface. Wscreensaver gets a new option --demo to retain
the current behaviour as a regular wayland client.
When a screensaver application starts, it should bind to the screensaver
interface, enumerate all outputs, create a surface per output, and
register those surfaces via screensaver::set_surface request. Then it
continues with the usual animation loop, waiting for frame events. The
compositor will decide, when the given screensaver surfaces are
displayed. A screensaver application should respond to outputs coming
and going away by creating and destroying surfaces.
The compositor is supposed to activate a screensaver by exec'ing it, and
stop the screensaver by killing the client process. Only one client may
be bound to the screensaver interface at a time. If there already is a
client, the compositor could either kill it first, or not exec a new
one.
Signed-off-by: Pekka Paalanen <ppaalanen@gmail.com>
13 years ago
|
|
|
<arg name="surface" type="object" interface="wl_shell_surface"/>
|
|
|
|
|
<arg name="output" type="object" interface="wl_output"/>
|
|
|
|
|
</request>
|
|
|
|
|
|
|
|
|
|
</interface>
|
|
|
|
|
|
|
|
|
|
<interface name="input_panel" version="1">
|
|
|
|
|
<description summary="interface for implementing keyboards">
|
|
|
|
|
Only one client can bind this interface at a time.
|
|
|
|
|
</description>
|
|
|
|
|
|
|
|
|
|
<request name="set_surface">
|
|
|
|
|
<description summary="set the surface type as a keyboard">
|
|
|
|
|
A keybaord surface is only shown, when a text model is active
|
|
|
|
|
</description>
|
|
|
|
|
|
|
|
|
|
<arg name="surface" type="object" interface="wl_shell_surface"/>
|
|
|
|
|
<arg name="output" type="object" interface="wl_output"/>
|
|
|
|
|
</request>
|
|
|
|
|
|
|
|
|
|
</interface>
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</protocol>
|
