Module awful.mouse

Mouse module for awful

Author:

Julien Danjou <julien@danjou.info>

Copyright© 2008 Julien Danjou

Release: v3.3.4

Functions

client.corner (c, corner) Get a client corner coordinates.
client.dragtotag.border (c) Move a client to a tag by dragging it onto the left / right side of the screen
client.dragtotag.widget (c) Move a client to a tag by drag'n'dropping it over a taglist widget
client.move (c, snap) Move a client.
client.resize (c, corner) Resize a client.
client.snap (c, snap, x, y, fixed_x, fixed_y) Snap a client to the closest client or screen edge.
client_under_pointer () Get the client object under the pointer.
wibox.move (w) Move the wibox under the cursor
wibox_under_pointer () Get the wibox object under the pointer.
widget_under_pointer () Get the widget under the pointer.


Functions

client.corner (c, corner)
Get a client corner coordinates.

Parameters

  • c: The client to get corner from, focused one by default.
  • corner: The corner to use: auto, top_left, top_right, bottom_left, bottom_right. Default is auto, and auto find the nearest corner.

Return value:

Actual used corner and x and y coordinates.
client.dragtotag.border (c)
Move a client to a tag by dragging it onto the left / right side of the screen

Parameters

  • c: The client to move
client.dragtotag.widget (c)
Move a client to a tag by drag'n'dropping it over a taglist widget

Parameters

  • c: The client to move
client.move (c, snap)
Move a client.

Parameters

  • c: The client to move, or the focused one if nil.
  • snap: The pixel to snap clients.
client.resize (c, corner)
Resize a client.

Parameters

  • c: The client to resize, or the focused one by default.
  • corner: The corner to grab on resize. Auto detected by default.
client.snap (c, snap, x, y, fixed_x, fixed_y)
Snap a client to the closest client or screen edge.

Parameters

  • c: The client to snap.
  • snap: The pixel to snap clients.
  • x: The client x coordinate.
  • y: The client y coordinate.
  • fixed_x: True if the client isn't allowed to move in the x direction.
  • fixed_y: True if the client isn't allowed to move in the y direction.
client_under_pointer ()
Get the client object under the pointer.

Return value:

The client object under the pointer, if one can be found.
wibox.move (w)
Move the wibox under the cursor

Parameters

  • w: The wibox to move, or none to use that under the pointer
wibox_under_pointer ()
Get the wibox object under the pointer.

Return value:

The wibox object under the pointer, if one can be found.
widget_under_pointer ()
Get the widget under the pointer.

Return value:

The widget object under the pointer, if it can be found.

Valid XHTML 1.0!