xdg_activation_v1

# xdg_activation_v1

A global interface used for informing the compositor about applications being activated or started, or for applications to request to be activated.

Requests
- #
  destroy
  
  destroy the xdg_activation object
  
  void xdg_activation_v1_destroy(
  struct xdg_activation_v1* xdg_activation_v1
  )
  
  Notify the compositor that the xdg_activation object will no longer be used. The child objects created via this interface are unaffected and should be destroyed separately.
- #
  get_activation_token
  
  requests a token
  
  struct xdg_activation_token_v1* xdg_activation_v1_get_activation_token(
  struct xdg_activation_v1* xdg_activation_v1
  )
  
  Creates an xdg_activation_token_v1 object that will provide the initiating client with a unique token for this activation. This token should be offered to the clients to be activated.
- #
  activate
  
  notify new interaction being available
  
  void xdg_activation_v1_activate(
  struct xdg_activation_v1* xdg_activation_v1,
  
  const char* token, /* the activation token of the initiating client */
  
  struct wl_surface* surface /* the wl_surface to activate */
  )
  
  Requests surface activation. It's up to the compositor to display this information as desired, for example by placing the surface above the rest. The compositor may know who requested this by checking the activation token and might decide not to follow through with the activation if it's considered unwanted. Compositors can ignore unknown activation tokens when an invalid token is passed.
# xdg_activation_token_v1

An object for setting up a token and receiving a token handle that can be passed as an activation token to another client. The object is created using the xdg_activation_v1.get_activation_token request. This object should then be populated with the app_id, surface and serial information and committed. The compositor shall then issue a done event with the token. In case the request's parameters are invalid, the compositor will provide an invalid token.

Requests
- #
  set_serial
  
  specifies the seat and serial of the activating event
  
  void xdg_activation_token_v1_set_serial(
  struct xdg_activation_token_v1* xdg_activation_token_v1,
  
  uint32_t serial, /* the serial of the event that triggered the activation */
  
  struct wl_seat* seat /* the wl_seat of the event */
  )
  
  Provides information about the seat and serial event that requested the token. The serial can come from an input or focus event. For instance, if a click triggers the launch of a third-party client, the launcher client should send a set_serial request with the serial and seat from the wl_pointer.button event. Some compositors might refuse to activate toplevels when the token doesn't have a valid and recent enough event serial. Must be sent before commit. This information is optional.
- #
  set_app_id
  
  specifies the application being activated
  
  void xdg_activation_token_v1_set_app_id(
  struct xdg_activation_token_v1* xdg_activation_token_v1,
  
  const char* app_id /* the application id of the client being activated. */
  )
  
  The requesting client can specify an app_id to associate the token being created with it. Must be sent before commit. This information is optional.
- #
  set_surface
  
  specifies the surface requesting activation
  
  void xdg_activation_token_v1_set_surface(
  struct xdg_activation_token_v1* xdg_activation_token_v1,
  
  struct wl_surface* surface /* the requesting surface */
  )
  
  This request sets the surface requesting the activation. Note, this is different from the surface that will be activated. Some compositors might refuse to activate toplevels when the token doesn't have a requesting surface. Must be sent before commit. This information is optional.
- #
  commit
  
  issues the token request
  
  void xdg_activation_token_v1_commit(
  struct xdg_activation_token_v1* xdg_activation_token_v1
  )
  
  Requests an activation token based on the different parameters that have been offered through set_serial, set_surface and set_app_id.
- #
  destroy
  
  destroy the xdg_activation_token_v1 object
  
  void xdg_activation_token_v1_destroy(
  struct xdg_activation_token_v1* xdg_activation_token_v1
  )
  
  Notify the compositor that the xdg_activation_token_v1 object will no longer be used. The received token stays valid.
Events
- #
  done
  
  the exported activation token
  
  const char* token /* the exported activation token */
  
  The 'done' event contains the unique token of this activation request and notifies that the provider is done.
Enums
- #
  error
  
  XDG_ACTIVATION_TOKEN_V1_ERROR_ALREADY_USED /* The token has already been used previously */

Copyright Info

Copyright © 2020 Aleix Pol Gonzalez <aleixpol@kde.org> Copyright © 2020 Carlos Garnacho <carlosg@gnome.org> Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions: The above copyright notice and this permission notice (including the next paragraph) shall be included in all copies or substantial portions of the Software. THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

xdg_activation_v1

# xdg_activation_v1

Requests

# xdg_activation_token_v1

Requests

Events

Enums

Copyright Info