Module mousegrabber - awesome API documentation

# Module `mousegrabber`

awesome mousegrabber API

### Info:

- Copyright: 2008-2009 Julien Danjou
- Author: Julien Danjou <julien@danjou.info>

## Functions

run (func, cursor) | Grab the mouse pointer and list motions, calling callback function at each motion.
stop () | Stop grabbing the mouse pointer.
isrunning () | Check if mousegrabber is running.

## Functions

Methods

run (func, cursor)

  Grab the mouse pointer and list motions, calling callback function at each motion. The callback function must return a boolean value: true to continue grabbing, false to stop. The function is called with one argument: a table containing modifiers pointer coordinates.

  The list of valid cusrors are:

  - num_glyphs
    cursor
    arrow
    basedarrowdown
    basedarrowup
    boat
    bogosity
    bottomleftcorner
    bottomrightcorner
    bottom_side
    bottom_tee
    box_spiral
    center_ptr
    circle
    clock
    coffee_mug
    cross
    cross_reverse
    crosshair
    diamond_cross
    dot
    dotbox
    double_arrow
    draft_large
    draft_small
    draped_box
    exchange
    fleur
    gobbler
    gumby
    hand
    hand
    heart
    icon
    iron_cross
    left_ptr
    left_side
    left_tee
    leftbutton
    ll_angle
    lr_angle
    man
    middlebutton
    mouse
    pencil
    pirate
    plus
    question_arrow
    right_ptr
    right_side
    right_tee
    rightbutton
    rtl_logo
    sailboat
    sbdownarrow
    sbhdouble_arrow
    sbleftarrow
    sbrightarrow
    sbuparrow
    sbvdouble_arrow
    shuttle
    sizing
    spider
    spraycan
    star
    target
    tcross
    topleftarrow
    topleftcorner
    toprightcorner
    top_side
    top_tee
    trek
    ul_angle
    umbrella
    ur_angle
    watch
    xterm

  - func A callback function as described above.
  - cursor The name of a X cursor to use while grabbing.
stop ()
  Stop grabbing the mouse pointer.
isrunning ()
  Check if mousegrabber is running.

  ### Returns:

  boolean True if running, false otherwise.

generated by LDoc 1.5.0 Last updated 2025-09-27 02:02:16