GNU Info

(sawfish.info)Standard Hooks

---

Next: Standard Properties Prev: Miscellaneous Functions Up: Top

---

Enter node , (file) or (file)node

Standard Hooks
**************

   Sawfish provides many hooks to allow extension of previously defined
functions. Also, many X events are exported to the Lisp environment via
the hooks mechanism. For more details on the hooks mechanism see Note:
Normal Hooks.

   As well as using the standard `call-hook' function, sawfish also
provides the `call-window-hook' function. This is used to invoke hooks
which refer to a single window. If the hook has a local value defined
in the window's property list then this value is used, before the
default value defined by the actual variable.

 - Function: call-window-hook hook window &optional args hook-type
     Call HOOK for WINDOW with further arguments ARGS. See `call-hook'
     for a description of HOOK-TYPE. Each function in the hook is
     called with arguments `(WINDOW . ARGS)'.

   The following table describes all standard hooks called by Sawfish,
and the arguments they are called with:

`pre-command-hook'
     Called before each command is evaluated.

`post-command-hook'
     Called after each command is evaluated.

`unbound-key-hook'
     Called when an key or pointer event has been received which there
     is no binding for.

`before-add-window-hook'
`add-window-hook'
     Called with a single window when the window is first adopted by the
     window manager. `before-add-window-hook' is called first, it
     should only set properties of the window.

`destroy-notify-hook'
     Called when the window is destroyed. Note that this may be called
     asynchronously to the normal event loop. In general, the window
     manager will attempt to call this hook as soon after it knows the
     window has been destroyed as is possible.

`map-notify-hook'
`unmap-notify-hook'
`reparent-notify-hook'
`enter-notify-hook'
`leave-notify-hook'
`focus-in-hook'
`focus-out-hook'
`shape-notify-hook'
     Called with a single window argument, analogous to the X events of
     the same names.

`configure-request-hook'
     Called with two arguments `(WINDOW ALIST)' when an X
     `ConfigureRequest' event is received. ALIST may include items
     `(stack . above)', `(stack . below)', `(position .  COORDINATES)',
     `(dimensions . DIMENSIONS)'.

`enter-frame-part-hook'
`leave-frame-part-hook'
     Called with two arguments, the window and the frame part class
     (Note: Frame Part Classes), when the pointer enters or leaves a
     frame part.

`window-moved-hook'
`window-resized-hook'
     Called with a single window argument whenever the window is moved
     or resized.

`visibility-notify-hook'
     Called with two arguments, the window, and a symbol, one of:
     `fully-obscured', `partially-obscured', `unobscured'.

`property-notify-hook'
     Called with arguments `(WINDOW ATOM-NAME TYPE)' where TYPE is
     `new-value' or `deleted'.

`client-message-hook'
     An `or' type hook. Called with arguments `(WINDOW TYPE
     DATA-ARRAY)'.

`enter-workspace-hook'
`leave-workspace-hook'
`workspace-state-change-hook'
     Called with a single argument: the workspace.

`add-to-workspace-hook'
`remove-from-workspace-hook'
     Called with a single argument: the window.

`viewport-resized-hook'
     Called when the number of rows and columns in each virtual
     workspace is changed.

`viewport-moved-hook'
     Called when the origin of the viewport into the virtual workspace
     is moved.

`place-window-hook'
     An `or' type hook. Called the first a window is mapped.

`window-state-change-hook'
`iconify-window-hook'
`uniconify-window-hook'
`shade-window-hook'
`unshade-window-hook'
`window-maximized-hook'
`window-unmaximized-hook'
`window-depth-change-hook'
     Called with a single window.

`after-initialization-hook'
     Called after adopting the initial set of windows.

`before-exit-hook'
     Called immediately before exiting.

`sm-window-save-functions'
`sm-restore-window-hook'
`sm-after-restore-hook'
     Session management hooks, Note: Session Management.

`before-move-hook'
`before-resize-hook'
     Called before starting an interactive move or resize, with a single
     argument: the window.

`while-moving-hook'
`while-resizing-hook'
     Called while interactively moving or resizing the window passed as
     the argument to the hook.

`after-move-hook'
`after-resize-hook'
     Called after completion of an interactive move or resize. Called
     with two arguments: the window, and a list of symbols defining how
     the window was moved or resized.

`gtkrc-changed-hook'
     When using the `gtkrc' module to load the current gtk style
     parameters, this hook is called when the style changes.

`enter-flipper-hook'
`leave-flipper-hook'
     When viewport edge-flipping is enabled, these hooks are called as
     the pointer enters and leaves the pixel-wide border on the edge of
     the screen. They're called with a single argument, one of the
     symbols `left', `right', `top', `bottom' defining the edge in
     question.