Preface  Introduction  Topic index  Glossary

AfterStep Function

built in AfterStep functions

Preface  Introduction  Topic index  Glossary  Back to Top


AfterStep version 2.2.6 indow">BookmarkWindow "name" new_bookmark

Places a bookmark on the selected window, to be used later on to get back to that window.

PinMenu ["name"]

Pins menu on desktop.

TakeWindowShot "name" filename

Grabs screenshot of the client window excluding frame decorations and save it in specifyed files.

TakeFrameShot "name" filename

Grabs screenshot of the client window including frame decorations and save it in specifyed files.

SwallowWindow "pattern" shell_command

will cause already opened window to be swallowed, while just Swallow will run application, if there are no windows matching pattern

Send_WindowList

This Function is used by modules to obtain list of open windows.

SET_MASK

FIXME: add proper description here.

SET_NAME

Used by modules to identify self to AfterStep.

UNLOCK

FIXME: add proper description here.

SET_FLAGS

Used by modules to set communication flags - identifying which messages module wishes to receive.

Folder "folder-name"

Defines a slide-out folder inside the current folder. The following button definitions will be placed inside of the subfolder, until a *Wharf ~Folder line is encountered. See the EXAMPLES section below for an example. Folders may be nested.

This is a Wharf specific Function.

Swallow "window-name" command

Causes Wharf to run command, capture the first window whose name or resource is window-name, and display it in the associated button. The application window will be shrunk to fit the size of the button.

This is a Wharf specific Function.

MaxSwallow "window-name" command

Like Swallow, except the button will be resized to fit the application.

This is a Wharf specific Function.

SwallowModule "window-name" command

Like Swallow, except the command is an AfterStep module.

This is a Wharf specific Function.

MaxSwallowModule "window-name" command

Like MaxSwallow, except the command is an AfterStep module.

This is a Wharf specific Function.

Size width height

Sets the size of the associated button, overriding any other size consideration.

The Wharf button size depends on several things. The order of precedence is:

1) Size definition
2) MaxSwallow'd window size
3) WharfPixmap size
4) Use 64x64.

This is a Wharf specific Function.

Transient

Specifies that this button will not perform any action, will not be pushable, and will not have an associated balloon.

Preface  Introduction  Topic index  Glossary  Back to Top


AfterStep version 2.2.6