Module awful.ewmh

Implements EWMH requests handling.

Info:

  • Copyright: 2009 Julien Danjou
  • Author: Julien Danjou <[email protected]>

Functions

add_activate_filter (f[, context]) Add an activate (focus stealing) filter function.
remove_activate_filter (f[, context]) Remove an activate (focus stealing) filter function.

Request handlers

awful.ewmh.activate Activate a window.
awful.ewmh.tag Tag a window with its requested tag.
awful.ewmh.urgent Handle client urgent request
awful.ewmh.geometry Move and resize the client.
awful.ewmh.merge_maximization Merge the 2 requests sent by clients wanting to be maximized.
awful.ewmh.client_geometry_requests Allow the client to move itself.

Theme variables

beautiful.maximized_honor_padding Honor the screen padding when maximizing.
beautiful.fullscreen_hide_border Hide the border on fullscreen clients.

Tables

generic_activate_filters The list of all registered generic request::activate (focus stealing) filters.
contextual_activate_filters The list of all registered contextual request::activate (focus stealing) filters.


Functions

Methods
add_activate_filter (f[, context])

Add an activate (focus stealing) filter function.

The callback takes the following parameters:

  • c (client) The client requesting the activation
  • context (string) The activation context.
  • hints (table) Some additional hints (depending on the context)

If the callback returns true, the client will be activated. If the callback returns false, the activation request is cancelled unless the force hint is set. If the callback returns nil, the previous callback will be executed. This will continue until either a callback handles the request or when it runs out of callbacks. In that case, the request will be granted if the client is visible.

For example, to block Firefox from stealing the focus, use:

awful.ewmh.add_activate_filter(function(c)
    if c.class == "Firefox" then return false end
end, "ewmh")
  • f function The callback
  • context string The request::activate context (optional)

See also:

remove_activate_filter (f[, context])
Remove an activate (focus stealing) filter function. This is an helper to avoid dealing with ewmh.add_activate_filter directly.
  • f function The callback
  • context string The request::activate context (optional)

Returns:

    boolean If the callback existed

See also:

Request handlers

awful.ewmh.activate
Activate a window.

This sets the focus only if the client is visible.

It is the default signal handler for request::activate on a client.

Arguments:

  • c client.object A client to use
  • context string The context where this signal was used.
  • hints A table with additional hints:
    • raise boolean should the client be raised? (default false)
awful.ewmh.tag
Tag a window with its requested tag.

It is the default signal handler for request::tag on a client.

Arguments:

  • c client.object A client to tag
  • t tag or boolean A tag to use. If true, then the client is made sticky. (optional)
  • hints table Extra information (default {})
awful.ewmh.urgent
Handle client urgent request

Arguments:

  • c client.object A client
  • urgent boolean If the client should be urgent
awful.ewmh.geometry
Move and resize the client.

This is the default geometry request handler.

Arguments:

  • c client The client
  • context string The context
  • hints table The hints to pass to the handler (default {})
awful.ewmh.merge_maximization
Merge the 2 requests sent by clients wanting to be maximized.

The X clients set 2 flags (atoms) when they want to be maximized. This caused 2 request::geometry to be sent. This code gives some time for them to arrive and send a new request::geometry (through the property change) with the combined state.

Arguments:

  • c client The client
  • context string The context
  • hints table The hints to pass to the handler (default {})
awful.ewmh.client_geometry_requests
Allow the client to move itself.

This is the default geometry request handler when the context is ewmh.

Arguments:

  • c client The client
  • context string The context
  • hints table The hints to pass to the handler (default {})

Theme variables

beautiful.maximized_honor_padding
Honor the screen padding when maximizing.

Type:

  • maximized_honor_padding boolean (default true)
beautiful.fullscreen_hide_border
Hide the border on fullscreen clients.

Type:

  • fullscreen_hide_border boolean (default true)

Tables

generic_activate_filters
The list of all registered generic request::activate (focus stealing) filters. If a filter is added to only one context, it will be in ewmh.contextual_activate_filters[“context_name”].

See also:

contextual_activate_filters
The list of all registered contextual request::activate (focus stealing) filters. If a filter is added to only one context, it will be in ewmh.generic_activate_filters.

See also:

generated by LDoc 1.4.6 Last updated 2017-07-25 16:21:08