Preface  Introduction  Topic index  Glossary

AfterStep Function

built in AfterStep functions

Preface  Introduction  Topic index  Glossary  Back to Top


AfterStep version 2.2.6 /A>

Shade ["name"]

Emulates the MacOS WindowShade feature. Once activated the window will become a titlebar only.

Delete ["name"]

Sends a WM_DELETE message to a window asking that it remove itself, frequently causing the application to exit.

Destroy ["name"]

Sends the XKillClient(3) to a window. Guaranteed to get rid of the window.

Close ["name"]

First sends the WM_DELETE message, if this is not understood, then the XKillClient(3) is sent to the window.

Iconify ["name"] [value]

Iconifies a window if it is not already iconified, or de-iconifies it if it is already iconified. If the optional argument value is positive, then only iconification will be allowed, and de-iconification will be inhibited. If the optional argument is negative, only de-iconification will be allowed.

Maximize ["name"] [horizontal vertical]

Causes the window to alternately switch from a full-screen size to its normal size. Specifying the optional arguments of horizontal and vertical, control can be attained as to the percentage of the full screen that the new size of the window becomes. If horizontal > 0, then the horizontal dimension of the window will be set to horizontal*screen_width/100. The vertical resizing is similar. Values larger than 100 can be used with caution. The defaults for horizontal and vertical are 100s (ie, fullscreen).

Fullscreen

Toggle window Fullscreen state. Will disregard any AvoidCover windows and will try to make window as big as the screen unless it's hints set certain limitation on size. Window in Fullscreen mode cannot be Maximized.

Stick ["name"]

Makes a window sticky (stays on screen when desks/views are switched) if it is not already sticky, or non-sticky if it is already sticky.

Focus

Moves the view or window as needed to make the selected window visible. Sets the keyboard focus to the selected window. Raises the window if needed to make it visible. Warps the pointer into the selected window in focus-follows-mouse mode. Does not de-iconify. This function is primarily handy when used with a module such as the WinList.

ChangeWindowUp ["name" window_name]

Causes the pointer to move to the previous window in the list of windows for which CirculateSkip has not not been specified.

The mouse will jump to the first window whose name (or icon name or class) matches window_name. The "name" entry then becomes required, but serves no purpose if the function is not called from a menu or popup.

ChangeWindowDown ["name" window_name]

Causes the pointer to move to the previous window in the list of windows for which CirculateSkip has not not been specified.

The mouse will jump (going backwards) to the first window whose name (or icon name or class) matches window_name. The "name" entry then becomes required, but serves no purpose if the function is not called from a menu or popup.

GoToBookmark ["name" window_bookmark ]

Focuses window specified by previously placed window_bookmark.

GetHelp

Runs afterstepdoc script, that attempts to guess which web browser is available on the system, and then launches it to display HTML documentation for AfterStep.

PasteSelection

This function allows for substitute of X clipboard copy-pasting if application is missing it.

WindowsDesk new_desk [10000]

Moves the selected window to the desktop specified as new_desk. If second argument is set to 10000 then first is treated as relative desktop number.

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