---
name: "Tk_Grab"
section: "3"
platform: "linux"
package: "tk"
version: "8.6.16-1"
release: "Arch Linux 2026-11-01"
platforms: ["linux"]
url: "https://new.carta.tech/Tk_Grab"
---

# Tk\_Grab(3)

manipulate grab state in an application

```

```

## NAME

Tk\_Grab, Tk\_Ungrab - manipulate grab state in an application

## SYNOPSIS

```
#include <tk.h>

int
Tk_Grab(interp, tkwin, grabGlobal)

void
Tk_Ungrab(tkwin)
```

## ARGUMENTS

- Tcl\_Interp *\*interp* (in)

  Interpreter to use for error reporting

- Tk\_Window *tkwin* (in)

  Window on whose behalf the pointer is to be grabbed or released

- int *grabGlobal* (in)

  Boolean indicating whether the grab is global or application local

  ```

  ```

## DESCRIPTION

These functions are used to set or release a global or application local grab.  When a grab is set on a particular window in a Tk application, mouse and keyboard events can only be received by that window and its descendants.  Mouse and keyboard events for windows outside the tree rooted at *tkwin* will be redirected to *tkwin*.  If the grab is global, then all mouse and keyboard events for windows outside the tree rooted at *tkwin* (even those intended for windows in other applications) will be redirected to *tkwin*.  If the grab is application local, only mouse and keyboard events intended for a windows within the same application (but outside the tree rooted at *tkwin*) will be redirected.

**Tk\_Grab** sets a grab on a particular window.  *Tkwin* specifies the window on whose behalf the pointer is to be grabbed. *GrabGlobal* indicates whether the grab should be global or application local; if it is non-zero, it means the grab should be global.  Normally, **Tk\_Grab** returns **TCL\_OK**; if an error occurs and the grab cannot be set, **TCL\_ERROR** is returned and an error message is left if *interp*'s result.  Once this call completes successfully, no window outside the tree rooted at *tkwin* will receive pointer- or keyboard-related events until the next call to Tk\_Ungrab.  If a previous grab was in effect within the application, then it is replaced with a new one.

**Tk\_Ungrab** releases a grab on the mouse pointer and keyboard, if there is one set on the window given by *tkwin*.  Once a grab is released, pointer and keyboard events will start being delivered to other windows again.

## KEYWORDS

grab, window