From 1cbcb06f6910d7d8ccb153c4dc101320fbf77c62 Mon Sep 17 00:00:00 2001 From: "Anna (navi) Figueiredo Gomes" Date: Tue, 10 Oct 2023 21:54:52 +0200 Subject: ext-action-binder: add binding interface ext-action-binding-v1 as an object that represents a single binded action. Signed-off-by: Anna (navi) Figueiredo Gomes --- staging/ext-action-binder/ext-action-binder-v1.xml | 211 +++++++++++---------- 1 file changed, 106 insertions(+), 105 deletions(-) diff --git a/staging/ext-action-binder/ext-action-binder-v1.xml b/staging/ext-action-binder/ext-action-binder-v1.xml index 545b917..9373a62 100644 --- a/staging/ext-action-binder/ext-action-binder-v1.xml +++ b/staging/ext-action-binder/ext-action-binder-v1.xml @@ -1,122 +1,123 @@ - - Copyright © 2015-2017 Quentin “Sardem FF7” Glidic, 2023 Anna "navi" Figueiredo Gomes + + Copyright © 2015-2017 Quentin “Sardem FF7” Glidic, 2023 Anna "navi" Figueiredo Gomes - 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. + 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. - + 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. + - - - This interface is designed to allow any application to bind - an action. + + + This interface is designed to allow any application to bind + an action. - An action is an arbitrary couple of a namespace and a name describing the - wanted behaviour. These two strings are not meant to be user-visible. - Some namespaces are well-known and shared by applications while each - application can have its own namespaces for internal actions. - It is possible to have the same action in several namespaces, e.g. to - allow application-specific bindings in addition to global actions. + An action is an arbitrary couple of a namespace and a name describing the + wanted behaviour. These two strings are not meant to be user-visible. + Some namespaces are well-known and shared by applications while each + application can have its own namespaces for internal actions. + It is possible to have the same action in several namespaces, e.g. to + allow application-specific bindings in addition to global actions. - It is left to the compositor to determine which client will get events. - The choice can be based on policy, heuristic, user configuration, or any - other mechanism that may be relevant. - Here are some examples of dispatching choice: all applications, last - focused, user-defined preference order, latest fullscreened application. + It is left to the compositor to determine which client will get events. + The choice can be based on policy, heuristic, user configuration, or any + other mechanism that may be relevant. + Here are some examples of dispatching choice: all applications, last + focused, user-defined preference order, latest fullscreened application. - This interface is exposed as global - + This interface is exposed as global + - - - The client no longer wants to receive events for any action. - - + + + The client no longer wants to receive events for any action. + + - - - Bind an action to the object. Multiple actions can be bound at the same - time. That means any combination of events can occur. - After calling bind, the "action_bound" event is fired by the compositor - with the status of the request. - + + + + + + - - - - - + + + + The client no longer wants to receive events for this binding. + + - - - Removes a specific binding to the object. if the client does not hold any - binding to the namespace:name combo, no operation is performed. - - - - + + + Bind an action to the object. this is a one-time request. + After calling bind, the "action_bound" event is fired by the compositor + with the status of the request. + Subsequent calls to bind should be ignored. + + + + + + - - - - - + + + + - - - After the compositor processes a bind request, it should call this - event to notify the client of the result, as well as the trigger, in - case of success. - - - - + + + After the compositor processes a bind request, it calls this + event to notify the client of the result. + in case of success, the trigger set to this action is returned, if any. + in case of failure, this action is destroyed and should not be used anymore. + + + + - - - Depending on the user configuration, an action can be either one-off or - sustained. The client must handle all the three event types and either make - sense of them or ignore them properly. - - - - - + + + Depending on the user configuration, an action can be either one-off or + sustained. The client must handle all the three event types and either make + sense of them or ignore them properly. + + + + + - - - This event is sent when actions are triggered. - If a binding would trigger both triggered and started events, the - started event must be sent first. - - - - - - + + + This event is sent when actions are triggered. + If a binding would trigger both triggered and started events, the + started event must be sent first. + + + + -- cgit v1.2.3