Scwm Reference Manual The Emacs of Window Managers Greg J. Badros
gjb@cs.washington.edu
Maciej Stachowiak
mstachow@alum.mit.edu
Release pre-1.0 23 February 2000 1997-2000 Greg J. Badros and Maciej Stachowiak
Concepts Introduction This chapter discusses some high level concepts in Scwm. Colors Colors are first-class objects. However, anywhere that a color is taken as an argument, a string containing an X color specification will also be accepted, and will be automatically converted to the proper color object. Using the same color specifier string more than once is not inefficient, as caching ensures that color objects are shared. Creating themes Currently, the best documentation on themes is the source code; however, here are a few notes. To create a theme, create a new subdirectory of a directory in `*theme-path*' (you'll probably want to add a private directory to `*theme-path*'). This subdirectory should be named the same as the theme. This subdirectory must contain (at least) a file named theme.scm. This file must create a module named (app scwm theme your-theme-name), and define (in this module) a theme object named the-theme. See the existing themes for examples of what you can do when building the-theme. Decors Decors are a means of managing the abundance of visual appearance options for windows. In the original Fvwm code, there were many options that could only be set globally, although they affected window appearance. Decors are a compromise between leaving them global and making them fully settable per window. These quasi-global options may be set in a particular decor, and a decor may be attached to one or more windows. Having to use decors to change certain aspects of the look and feel is confusing. Scwm will probably move to some way of making these options directly settable per-window at some point, especially if we can figure out a way to not increase the memory overhead much. Desks Multiple virtual desktops are supported. A virtual desktop may be bigger than the physical screen, in which case the current viewport on the desktop may be moved around, as described in the Viewports entry. Desks are identified by integers. There is currently an arbitrary limit on the number of desks, but it should be much higher than anyone will ever need. You can change the current desk with set-current-desk!; find out what the current desk is with current-desk; and set the desk a window is on with set-window-desk!. Event Contexts There are various event contexts that are used as arguments to the binding procedures. Among these are: 'window 'title 'icon 'root 'frame-corners 'frame-sides 'client-window 'root-window 'left-button-N (N=1-5) 'right-button-N (N=1-5) GJB:FIXME:: This should be a definition list or a table, and give real explanations of what these contexts mean! Face Flags Face flags are two-element lists that specify certain properties that are set once and only once for a give face (as opposed to specs, which may be chained arbitrarily). Nearly all flags may be used for button faces. Exceptions, as well as the flags that may be used for title and border faces, are indicated below. Face Flags Key Possible values Explanation 'justify 'left 'right 'center Horizontal justification for the face (pixmap, relief pattern, etc.) 'vertical-justify 'top 'bottom 'center Vertical justification for the face (pixmap, relief pattern, etc.) 'relief 'flat 'sunk 'raised Use for titles and buttons to control appearance (only flag for titles) 'use-style-of 'title 'border #f Inherit the face flags from the title or border first, then add these flags 'hidden-handles #t #f Set visibility of the corner handles -- only used for border faces 'no-inset #t #f Win-9x-like effect of relieving borders on outside instead of inside
Face Specification Flags Face specification flags are two-element lists that specify certain properties that may be chained to indicate how a face is drawn. Face specs may be fully or partially destructive. A fully destructive spec indicates how the whole area of the element is to be drawn, making previous specs irrelevant. A partially destructive spec overlays part, but not all, of the drawing area. All specs may be used for button faces. All but non-tiled pixmaps may be used for titlebars, and only tiled pixmaps may be used for borders. Face Specification Flags Format Explanation '(relief-pattern ((X Y BOOL) ...)) Draw a relief pattern using the list of triples, each of which indicates a pair of X,Y coordinates given as a percentage of the button size, and a boolean value indicating whether to use the lighter or darker color. This spec is partially destructive. '(solid COLOR) Use COLOR as the color for this element; fully destructive. '(gradient ({horizontal|vertical} NCOLORS {COLOR_PERCENT}* FINAL)) Draw a gradient in this element. The gradient may be horizontal or vertical. The number of colors is specified, followed by a number of colors with percentages and a final color. The percentages must add to 100. '(pixmap {mini-icon|IMAGE|(tiled IMAGE)}) Specify a pixmap to use, either the window's mini-icon, an image object or image specifier string, or a list of tiled and an image, indicating the image should be tiled. Partially destructive, except when tiled, which makes it fully destructive.
Faces Faces are a data type used to specify in detail the way in which window decorations like the titlebar, the border and titlebar buttons will be drawn. They are currently somewhat kludgey and ad-hoc. However, they offer a great deal of flexibility. All faces are set in the current decor, so multiple decors must be used to use different faces for different windows. The low-level functionality offered in the face primitives will rarely be needed; the button-style, title-style and border-style procedures in the (app scwm face) module provide a more convenient interface to this functionality. Focus Styles Scwm supports several focus styles, which are settable per-window. A window with the 'click focus style is click-to-focus: it requires that the user click on it before it will receive the input focus, and will not lose it again until some other window gains focus. The 'mouse focus style is mouse-focus in the traditional sense - the window will gain and lose focus as the mouse enters and leaves it. 'sloppy indicates the sloppy-focus style. This is like mouse-focus, but the window will not lose the focus until another gains it. So if you focus the window with the mouse and then let the pointer slide into the root window or a window that has focus styles of 'click or 'none, the window will not lose the focus. This style of focus was first introduced in fvwm. A focus style of 'none indicates that the window should never gain the input focus, no matter what. This can be used for clocks, mailboxes, and other desktop gadgets that never need keyboard input. Fonts Fonts are first-class objects. However, anywhere that a font is taken as an argument, a string containing an X font specification will also be accepted, and will be automatically converted to the proper font object. Using the same font specifier string more than once is not inefficient, as caching ensures that font objects are shared. Hooks Hooks are used throughout scwm to provide a convenient mechanism for user callbacks on particular events. Fundamentally, a hook is just a variable that contains a list of procedures that are called in order when the relevant event occurs. However, several convenience macros are provided for manipulating hooks; see add-hook!, remove-hook!, reset-hook!, and run-hook. Image Loaders Different loaders are available for various images types. load-xbm and load-xpm load X bitmaps and X pixmaps respectively. The user may register other image loaders using the extension or the special string "default" for the loader to be tried for an image that cannot be loaded any other way. Images Images are first-class objects. However, anywhere that an image is taken as an argument, a string containing a filename will also be accepted, and will be automatically converted to the proper image object by loading the image. Using the same image filename more than once is not inefficient, as caching ensures that image objects are shared. Input Hooks Input hooks are a special form of hook that is called whenever input is available on a particular port. They are treated differently than normal hooks - use add-input-hook! and remove-input-hook! to manipulate them. Like regular hooks and unlike timer hooks, input hooks are not one-shot - they trigger every time input is made available on the particular port, and do not go away until explicitly removed. An input hook may safely remove itself from within its own invocation. Interactive specifications Procedures can have an interactive specification that looks like: (interactive) or (interactive "%W") This declaration must be the first s-exp after the docstring of a procedure. Primitive procedures may also have interactive specifications and use the SCWM_IPROC macro to support them. The interactive specification marks that a procedure may be invoked interactively (i.e., bound to a mouse or keypress event). The specification also is used to construct the arguments when the procedure is invoked in an interactive context or via call-interactively. The meaning of the various possible substrings in the interactive specification are as follows: Interactive specifiers Marker Meaning %W get-window %K get-window using skull & crossbones cursor
Key Specifier A key specifier is a string denoting a keystroke, perhaps including modifiers. The available modifiers include S-, C-, M-, A-, H-, and s- for Shift, Control, Meta, Alt, Hyper, and Super, respectively. They can be combined arbitrarily, and in any order, but should precede the key name. They may also be combined without the dash separator; e.g., CSM-Left refers to the keysym "Left" with the control, shift, and meta modifiers. When a key specifier is being used to indicate a binding, the additional special modifier *- may be used; it indicates that the key should be bound with every possible modifier combination, including possibly no modifiers. *- may not be combined with any other modifier. Menu Looks Menus have an associated menu look, which determines how the menus are drawn. Menu look objects are created by dynamically-loaded C modules. For example, the xpm-menus module creates a variable xpm-shaped-menu-look that specifies that the menu should be drawn using that code. copy-menu-look can be used to copy a menu look and change some of its properties. Run-time command-line options read startup commands from the specified file instead of ".scwmrc" or "system.scwmrc". evaluate Scheme expression expr instead of reading from ".scwmrc" or "system.scwmrc". Multiple -e and -f options may be specified on a single command line and in this case will be processed in the order in which they were specified. sets scwm's client id to a specific value. This is probably of no use to you unless you're a session manager or debbuging. SCWMEXEC Protocol Scwm supports a protocol for other programs to send commands to the window manager. Programs send ordinary configuration language expressions and are returned a string representation of the return value, and the output and error output generated, if any. For more information on how to make use of this protocol, see the documentation for the scwmexec and scwmrepl programs, the scwm.el emacs interaction mode, the libscwmexec library, and the details of the SCWMEXEC protocol (as documented in doc/scwmexec.proto). FIXDOC: Link to file! Shadow and Highlight Factors Many decorations are supposed to look "three-dimensional". To implement this, the decorations use three colors: the specified decoration color, a brighter "highlight" color, and a darker "shadow" color. For "raised" decorations, the top and left edges are drawn in the highlight color, and the bottom and right edges are drawn in the shadow color; this is reversed for "sunken" decorations. The highlight and shadow colors are computed from the decoration color using the highlight and shadow factors. The highlight factor should be a floating-point number greater than 1. If the highlight factor is 1, then the highlight color is the same as the decoration color; the larger the highlight factor, the brighter the highlight color. The shadow factor should be a floating-point number between 0 and 1. If the shadow factor is 1, then the shadow color is the same as the decoration color; the smaller the shadow factor, the darker the shadow color. (It is actually possible to give a highlight factor which is less than 1 (which makes the highlight color darker than the decoration color) and a shadow factor which is greater than 1 (which makes the shadow color brighter than the decoration color); the effect is to reverse "raised" and "sunken" elements throughout the user interface.) Sticky A "sticky" window will appear on all desktops, and will remain at the same screen position regardless of scrolling within the current desktop. Themes A theme is a named collection of window manager settings. Themes are still under development, but they are planned to affect window styles, menus, icons, backgrounds, and various global settings. Timer Hooks Timer hooks are a special form of hook that is called after a specified amount of time has passed. They are treated differently than normal hooks - use add-timer-hook! and remove-timer-hook! to manipulate them. Timer hooks, unlike regular hooks, are one-shot - once the time limit expires and the timer hook is triggered, it is removed. Viewports The current viewport is the area of the current desk that may be seen on the physical screen. Since a desk can be larger than the physical screen size, the viewport can move around the desk. Viewports give rise to two concepts of coordinates. A viewport coordinate is relative to the current viewport (i.e., it is the coordinate you actually see on the screen). A virtual coordinate is relative to the origin of the current desk. Window Context When actions are triggered by mouse or keyboard events, or menu actions from menus originally popped up by mouse or keyboard events, a context window is saved, which is used as the default for window operations that are not passed their optional window argument. This allows the user to easily bind actions to events without worrying about passing around the window argument. However, it is unclear whether behind-the-scenes magic like this is a good idea. The merit of this approach is still under consideration; it may be changed entirely. Window Style Window styles encapsulate the behaviour and appearance of windows. They are applied to windows arbitrarily so different windows can use different styles at the same time. Numerous options are permitted for window styles. For some of the below options you will need to use the appropriate module to make the options available. The options include at least: window style options Option Type Implementation scheme/auto-raise.scm:138 scheme/auto-raise.scm:139 scheme/auto-raise.scm:140 scheme/auto-raise.scm:142 scheme/auto-raise.scm:143 scheme/auto-unobscure.scm:65 scheme/auto-unobscure.scm:66 scheme/easyraise.scm:26 scheme/hover-focus.scm:73 scheme/hover-focus.scm:95 scheme/style.scm:201 scheme/style.scm:202 scheme/style.scm:203 scheme/style.scm:204 scheme/style.scm:205 scheme/style.scm:206 scheme/style.scm:208 scheme/style.scm:209 scheme/style.scm:211 scheme/style.scm:212 scheme/style.scm:213 scheme/style.scm:214 scheme/style.scm:215 scheme/style.scm:218 scheme/style.scm:219 scheme/style.scm:220 scheme/style.scm:221 scheme/style.scm:228 scheme/style.scm:230 scheme/style.scm:232 scheme/style.scm:233 scheme/style.scm:234 scheme/style.scm:235 scheme/style.scm:238 scheme/style.scm:240 scheme/style.scm:243 scheme/style.scm:244 scheme/style.scm:245 scheme/style.scm:246 scheme/style.scm:247 scheme/style.scm:248 scheme/style.scm:250 scheme/style.scm:251 scheme/style.scm:252 scheme/style.scm:272 scheme/style.scm:273 scheme/style.scm:277 scheme/style.scm:278 scheme/style.scm:279 scheme/style.scm:281 scheme/themes.scm:48 scheme/winlist.scm:89 scheme/winlist.scm:136 scheme/winlist.scm:137 scheme/winops-menu.scm:33 scheme/winops.scm:192
Windows Windows are the most important scwm data type. A window object represents an on-screen window that scwm is managing, and is used to perform window management operations on the window, as well as to set options and retrieve information about the window. X atoms X windows allows certain entities (for example, X properties [FIXME: XREF to X properties]) to have arbitrary names. To avoid exchanging strings ever so often, these names are in fact X atoms. New X atoms can be created, or old ones retrieved simply by specifying the string the atom stands for. An X atom can also be converted back to a string. Scwm provides primitives for these actions. X Properties X has a notion of window properties, which live in the X server. X window properties are often used to implement protocols between applications and the window manager, which can have several levels of standardization, from official X standard, to standardized by some other organization, to made up informally by groups of programmers, to specific to one window manager, to specific to an individual, or installation. Scwm already internally implements many of these protocols, including all X standard protocols, as well as the Motif and Open Look protocols. However, the user should be able to implement any of these he likes, including making up his own for personal use. This is possible through the low-level X property interface. Scwm has one procedure to get, and set them, respectively.
Hooks Introduction This chapter lists the hooks provided by Scwm ordered alphabetically by name. after-change-desk-hook (2 args) This hook is invoked just after the current desktop is changed.\n\ It is called with two argument, both integers. The first is the\n\ new desktop number, the second is the old desktop number. It\n\ is called after the desk is changed. See also change-desk-hook. after-new-window-hook (1 arg) This hook is invoked after a window is created and placed.\n\ Its procedures are each called with a single argument, WIN, the new window.\n\ Any window operations may be performed at this time. However, it is\n\ recommended that placement-related operations, such as setting the\n\ position, desk, viewport location and z-ordering of a window be done\n\ in the placement procedure instead. It should be used for setting\n\ window styles, as the window geometry needs to be fully and correctly\n\ specified before the window is placed. The window-style mechanism\n\ from the "(app scwm style)" module provides a convenient interface to\n\ setting the relevant parameters when a new window is created. \n\ \n\ See also before-new-window-hook and before-place-new-window-hook. after-viewport-position-change-hook (4 args) This hook is invoked just after the viewport position is changed.\n\ It is called with four arguments, all integers. The first two are \n\ the x and y coordinates of the new viewport position in pixels and\n\ the second two are the change in x and y from the previous position. before-new-window-hook (1 arg) This hook is invoked when first creating a new window object.\n\ Its procedures are each called with a single argument, WIN, the new\n\ window. Only a subset of the usual window parameters should be set\n\ here, in particular, those that control what hints will be respected\n\ for this window, and those that control how the window will be placed.\n\ \n\ This hook does not typically need to be used directly by the user;\n\ window-style from the "(app scwm style)" module provides a convenient\n\ interface to setting the relevant parameters when a new window is\n\ created.\n\ \n\ See also before-place-new-window-hook and after-new-window-hook. before-place-new-window-hook (1 arg) This hook is invoked just before placing a new window.\n\ It comes after before-new-window-hook, but before after-new-window-hook. \n\ Its procedures are each called with a single argument, WIN, the new window.\n\ This hook may be removed later since it is mostly redundant with the other\n\ two hooks, despite being invoked at a slightly different time. \n\ \n\ See also before-new-window-hook and after-new-window-hook. broadcast-config-hook (2 args) This hook is invoked whenever fvwm2 would call BroadcastConfig.\n\ This hook is principally of use in implementing the fvwm2\n\ module interface and for stuff that needs to be notified in ways that\n\ can't be done with the proper hooks that have been included so\n\ far. The procedures in this hook are passed two arguments: the event-type\n\ and the window object. broadcast-hook (9 args) This hook is invoked whenever fvwm2 would call Broadcast.\n\ This hook is principally of use in implementing the fvwm2\n\ module interface and for stuff that needs to be notified in ways that\n\ can't be done with the proper hooks that have been included so\n\ far. The procedures in this hook are passed a numerical code\n\ representing the event type, a number that indicates how many of the\n\ following data arguments are meaningful, and 7 numeric data arguments. broadcast-mini-icon-hook (2 args) This hook is invoked whenever fvwm2 would call BroadcastMiniIcon.\n\ This hook is principally of use in implementing the fvwm2\n\ module interface and for stuff that needs to be notified in ways that\n\ can't be done with the proper hooks that have been included so\n\ far. The procedures The procedures in this hook are passed two arguments:\n\ the event-type and the window object. broadcast-name-hook (5 args) This hook is invoked whenever fvwm2 would call BroadcastName.\n\ This hook is principally of use in implementing the fvwm2\n\ module interface and for stuff that needs to be notified in ways\n\ that can't be done with the proper hooks that have been included so\n\ far. The procedures in this hook are passed an event type, three\n\ numeric data arguments, and a string. change-desk-hook (2 args) This hook is invoked whenever the current desktop is changed.\n\ It is called with two argument, both integers. The first is the\n\ new desktop number, the second is the old desktop number. It is\n\ called before the desk is changed. See also after-change-desk-hook. client-message-hook (4 args) This hook is invoked whenever Scwm receives an X/11 client message.\n\ It is called with four arguments: the window, the message-type atom, the format (8, 16, or 32), \n\ and the vector of data. deiconify-hook (2 args) This hook is invoked when a window is deiconified.\n\ It is called with two arguments: WINDOW, WAS-ICONIFIED?.\n\ WINDOW is the window iconfied, and WAS-ICONIFIED? is\n\ a boolean telling whether the window was iconified previously. desk-size-change-hook (2 args) This hook is invoked whenever the desk size is changed. It is called with two arguments, both integers, which are the width and height of the new desk size in screens. edge-enter-hook (1 arg) This hook is invoked whenever the mouse pointer enters a screen edge.\n\ Procedures in the hook are called with one argument, one of the\n\ symbols 'north, 'south, 'east or 'west indicating which edge was\n\ entered. edge-leave-hook (1 arg) This hook is invoked whenever the mouse pointer leaves a screen edge.\n\ Procedures in the hook are called with one argument, one of the\n\ symbols 'north, 'south, 'east or 'west indicating which edge was\n\ entered. edge-scroll-hook (thunk) This hook is invoked whenever an edge scroll takes place.\n\ Procedures in the hook are called with no arguments. error-hook (1 arg) Called on all kinds of errors and exceptions.\n\ Whenever an error or other uncaught throw occurs on any callback,\n\ whether a hook, a mouse binding, a key binding, a menu entry, a file\n\ being processed, or anything else, error-hook will be invoked. Each\n\ procedure in the hook will be called with the throw arguments; these\n\ will generally include information about the nature of the error. iconify-hook (2 args) This hook is invoked when a window is iconified.\n\ It is called with two arguments: WINDOW, WAS-ICONIFIED?.\n\ WINDOW is the window iconfied, and WAS-ICONIFIED? is\n\ a boolean telling whether the window was iconified previously. image-not-found-hook (1 arg) Called with image name as a string when not found. interactive-move-finish-hook (1 arg) This hook is invoked at the end of an interactive move.\n\ It is called with one argument, WINDOW. interactive-move-new-position-hook (3 args) This hook is invoked during an interactive move.\n\ It is called with three arguments, WINDOW, NEW-VP-X, and NEW-VP-Y,\n\ whenever the window is moved to a new location. The position refers\n\ to the position of the frame window (not the client window) in\n\ viewport coordinates. interactive-move-start-hook (1 arg) This hook is invoked at the start of an interactive move.\n\ It is called with one argument, WINDOW. interactive-resize-finish-hook (1 arg) This hook is invoked at the end of an interactive resize.\n\ It is called with one argument, WINDOW. interactive-resize-new-size-hook (7 args) This hook is invoked during an interactive resize. \n\ It is called with seven arguments, WINDOW, X-POSITION, Y-POSITION,\n\ NEW-WIDTH-PIXELS, NEW-HEIGHT-PIXELS, NEW-WIDTH-UNITS, and\n\ NEW-HEIGHT-UNITS whenever the window is changed to a new size. The\n\ first five arguments refer to the size and position of the frame\n\ window (not the client window). The -UNITS arguments refer to the size\n\ of the client window and are in client units (e.g., characters for\n\ Emacsen and XTerms). interactive-resize-start-hook (3 args) This hook is invoked at the start of an interactive resize.\n\ It is called with three arguments: WINDOW, XMOTION, YMOTION.\n\ XMOTION and YMOTION are -1, 0, or 1, indicating motion in that dimension\n\ can happen on the right/bottom side, not at all, or the top/left side,\n\ respectively. invalid-interaction-hook (thunk) This hook is invoked with no arguments when the user hits an invalid\n\ key or performs an invalid mouse action during an interactive\n\ operation like interactive-resize or interactive-move. beep is\n\ one example of a procedure to use here. load-processing-hook (1 arg) This hook is invoked for every several top-level s-exps in the startup file.\n\ The hook procedures are invoked with one argument, the count of the\n\ s-expressions evaluated thus far. See also set-load-processing-hook-frequency!. post-command-hook (2 args) This hook is invoked with two arguments after every call-interactively execution.\n\ The arguments are the procedure just called, and the list of the arguments passed. pre-command-hook (2 args) This hook is invoked with two arguments before every call-interactively execution.\n\ The arguments are the procedure to be called, and a list of the arguments passed.\n\ Global variable this-command and this-command-args can be modified to change \n\ either of these. scwm-test-hook-0 (thunk) Just a test hook that takes no arguments.\n\ See scwm-run-test-hook-0 scwm-test-hook-1 (1 arg) Just a test hook that takes one argument.\n\ See scwm-run-test-hook-1. select-window-done-hook (1 arg) This hooks is run when a window is selected.\n\ The hook procedures are called with a single argument, the window just left.\n\ See also select-window-enter-hook and select-window-leave-hook. select-window-enter-hook (1 arg) This hook is invoked when a window is entered during window selection.\n\ The hook procedures are called with a single argument, the window just entered.\n\ This hook is invoked once select-window-interactively-no-message is\n\ called if the pointer is already in a window. (But the\n\ leave hook is not invoked similarly when the selection completes). select-window-leave-hook (1 arg) This hook is invoked when a window is left during window selection.\n\ The hook procedures are called with a single argument, the window just left.\n\ This hook is not invoked upon selection completion (unlike\n\ select-window-enter-hook that is called initially upon calling\n\ select-window-interactively-no-message). See also select-window-done-hook. shutdown-hook (1 arg) The procedures in shutdown-hook are before scwm quits or restarts.\n\ A single boolean argument is passed that is #t iff scwm is restarting. startup-hook (thunk) The procedures in startup-hook are called with no arguments after scwm\n\ has processed the scwmrc and captured all application windows, and\n\ right before it enters the main event loop. Note that during\n\ processing of the .scwmrc startup file, windows have not already been\n\ captured, so the window-list (as reported by list-all-windows) is\n\ empty. To provide behviour conditioned on a property of an existing\n\ window, this hook should be used instead. viewport-position-change-hook (4 args) This hook is invoked whenever the viewport position is changed.\n\ It is called with four arguments, all integers. The first two are \n\ the x and y coordinates of the new viewport position in pixels and\n\ the second two are the change in x and y from the previous position. vv-recognition-hook (3 args) This hook is invoked when ViaVoice recognizes a phrase. \n\ Called with 3 arguments: (was-accepted? phrase-string annotations-vector) window-close-hook (1 arg) This hook is invoked whenever a scwm-managed window is closed.\n\ It is invoked on deletes, destroys, or for any reason that a window\n\ is closed. The hook procedures are invoked with one argument,\n\ WIN, the window being closed. The WIN is still valid during the hook\n\ procedures. window-enter-hook (1 arg) This hook is invoked whenever the mouse pointer enters a top-level window.\n\ It is called with one argument, the window object of the window just\n\ entered. window-focus-change-hook (1 arg) This hook is invoked whenever the keyboard focus is changed.\n\ It is called with one argument, the window object of the window\n\ that now has the focus, or #f if no window now has the focus. \n\ See also window-focus-lost-hook. window-focus-lost-hook (1 arg) This hook is invoked whenever the focus is lost on a window.\n\ It is called with one argument, the window object of the window\n\ that just lost the keyboard focus. See also window-focus-change-hook. window-fully-obscured-hook (2 args) Invoked when window receives a VisibilityFullyObscured event.\n\ The hook procedures are invoked with two arguments: the window object\n\ of the window that is now fully obscured, resulting-from-viewport-move? (a boolean).\n\ See also window-visibility. window-leave-hook (1 arg) This hook is invoked whenever the mouse pointer leaves a top-level window.\n\ The hook procedures are invoked with one argument, the window object\n\ of the window just left. window-partially-obscured-hook (2 args) Invoked when window receives a VisibilityPartiallyObscured\n\ event. The hook procedures are invoked with two arguments: the window object\n\ of the window that is now fully obscured, resulting-from-viewport-move? (a boolean).\n\ Beware that this event happens more often than you might expect and an action procedure\n\ attached here should be very careful about manipulating windows in a way\n\ that might cause more Visibility events. See also window-visibility. window-property-change-hook (4 args) This hook is invoked whenever a window property changes. The hook procedures are invoked with four arguments, the window whose property changed, the name of the changed property, the new value and the old value. window-unobscured-hook (2 args) Invoked when window receives a VisibilityUnobscured event.\n\ The hook procedures are invoked with two arguments: the window object\n\ of the window that is now fully obscured, resulting-from-viewport-move? (a boolean).\n\ Beware that this event happens more often than you might expect and an action procedure\n\ attached here should be very careful about manipulating windows in a way\n\ that might cause more Visibility events. See also window-visibility. X-ConfigureRequest-hook (6 args) This hook is invoked upon ConfigureRequest events.\n\ The arguments are: '(win icon? x y width height) where win\n\ is the window requesting the configuration change, icon? is #t\n\ iff that window's icon is requesting the change, x, y, width,\n\ and height are either integers or #f to indicate that that\n\ aspect was not part of the configure request event. \n\ If configure-request-handled is #t after execution of the\n\ hook procedures, then no C-level handling of the request\n\ will be performed. X-DestroyNotify-hook (1 arg) This hook is invoked upon DestroyNotify X events.\n\ It indicates a window was destroyed. The hook procedures are\n\ invoked with one argument, WINID, the X id of the window that was destroyed. \n\ This hook is invoked for both the client window and the window frame\n\ IDs (i.e., twice per top-level window). You probably want to use\n\ window-close-hook or X-UnmapNotify-hook instead. X-MappingNotify-hook (thunk) This hook is invoked whenever a MappingNotify X event is\n\ received. A MappingNotify event indicates a change of keymapping - in\n\ particular, it may indicate a change of available modifiers or mouse\n\ buttons. The hook procedures are invoked with no arguments. X-MapRequest-hook (1 arg) This hook is invoked upon MapRequest X events. It indicates a\n\ window is trying to map itself (add itself to the display). The hook \n\ procedures are invoked with one argument, WIN, the window being mapped. \n\ The WIN is valid during the hook procedures. X-PropertyNotify-hook (2 args) This hook is invoked whenever a PropertyNotify event is received\n\ for a window scwm is managing. This indicates that an X window\n\ property has changed. Watching for window property changes can be used\n\ to construct your own custom window manager protocols. The hook\n\ procedures are invoked with two arguments, the name of the property\n\ that changed (as a string) and the window that it changed for. See also\n\ X-root-PropertyNotify-hook but beware it gets passed different\n\ arguments. X-root-PropertyNotify-hook (2 args) This hook is invoked whenever a PropertyNotify event is received\n\ on the root window. This indicates that an X window\n\ property has changed. Watching for window property changes can be used\n\ to construct your own custom window manager protocols, or interface\n\ to other desktop environments such as KDE or GNOME. The hook\n\ procedures are invoked with two arguments: the atom for the changed\n\ property and a boolean telling whether the property was deleted. \n\ These arguments are different from those passed to\n\ X-PropertyNotify-hook's procedures. X-SelectionNotify-hook (thunk) Called when there is no selection after a X-convert-selection request. X-UnmapNotify-hook (1 arg) This hook is invoked upon UnmapNotify X events. It indicates a\n\ window is being unmapped (removed from display). The hook procedures\n\ are invoked with one argument, WIN, the window being destroyed. The\n\ WIN is still valid during the hook procedures. User variables Introduction This chapter lists the user options defined by Scwm. animation-delay Number of milliseconds to delay between frames of animation. Defaults to 10 milliseconds if this is not a number. See also animated-resize-window, animated-move-window, etc. circle-pie-menu-look A menu-look that gives pie menus in a circular window. configure-request-handled Set to #t by an X-ConfigureRequest-hook procedure if no C handling should be done. See also X-ConfigureRequest-hook. cursor-icon The cursor to use for icon windows, defaults to top_left_arrow. cursor-kill The cursor to use for selecting a window to kill, defaults to pirate. cursor-menu The cursor to use when in a menu, defaults to sb_left_arrow. cursor-move The cursor to use for move actions, defaults to fleur. cursor-select The cursor to use for selecting a window, defaults to dot. cursor-set-focus The cursor to use for set focus actions, defaults to hand2. default-placement-proc The default procedure to use to place windows that do not have a placement proc. default-transient-placement-proc The default procedure to use to place transient windows that do not have a transient placement proc. image-load-path List of strings of directories in which to look for image files. locale-fullname Full name of the current locale, as a string. locale-language-territory The language territory name, as a string pie-menu-look A menu-look that gives pie menus in a rectangular window scroll-region The number of pixels at the edge of the screen within which virtual scrolling will occur. scwm-menu-look The default menu look for Scwm. Used as an argument to set-menu-look. shaped-pie-menu-look A menu-look that gives pie menus with only the labels visible this-command The current command when executing the pre-command-hook; may be mutated to affect what command is run. See also this-command-args. this-command-args The arguments to the current command when executing the post-command-hook; may be mutated to affect the arguments when the command is run. See also this-command. xpm-shaped-menu-look The shaped XPM menu look. Procedure Synopses by Group Introduction This chapter lists the procedures supplied by Scwm grouped and ordered by the source file that they are defined in. modules/background/background.c set-background-color! -- Sets the color of the root window to COLOR. clone-resized-image -- Makes a new image from IMAGE of the given WIDTH and HEIGHT. set-background-image! -- Sets the background of the root window to be IMAGE. reset-background! -- Resets the root window to the default "weave". modules/c-animation/c-animation.c set-animation! -- Set the animation parameters to VECTOR. animated-window-shade -- Cause WIN to become "window-shaded". animated-window-unshade -- Reverse the effect of window-shade on WIN. animate-windows -- Animate multiple windows. animated-move-window -- Move WIN to virtual coordinates X, Y with animation. animated-resize-window -- Resize the client area of WIN to size W, H (pixels) with animation. animated-resize-frame -- Resize the frame of WIN to size W, H (pixels) with animation. modules/corba/scwmcorba.c corba-evaluator-ior -- Returns the "IOR" string for the scwm-scheme-evaluator servant. modules/esdsound/sound.c sound-load -- Load sound from FILE, tagging it with NAME. sound-unload -- Unload SOUND, freeing any resources it occupies. sound-play -- Play SOUND. esd-reconnect -- Connect to the ESound daemon on the machine named HOST. modules/overlay-plane/overlay-plane.c has-overlay-plane? -- Return #t if the current screen has an overlay plane, #f otherwise. draw-overlay-plane -- Draw a box in the overlay plane. hide-overlay-plane -- Draw a box in the overlay plane. modules/proplist/scwmproplist.c proplist-make-array-from-elements -- Return a newly created array object populated with elements ITEMS. proplist-make-dictionary-from-entries -- Return a newly created dictionary object with elements ITEMS. proplist-remove-array-element -- Return PL-ARRAY after deleting the element at position INDEX. proplist-insert-array-element -- Return the PL-ARRAY after inserting ITEM at offset INDEX. proplist-append-array-element -- Return the PL-ARRAY after appending ITEM to the end. proplist-insert-dictionary-entry -- Return PL-DICT after inserting (KEY,VALUE) into it. proplist-remove-dictionary-entry -- Return PL-DICT after removing KEY and its corresponding value from it. proplist-merge-dictionaries -- Return PL-DICT-DEST after merging in all entries from PL-DICT-SOURCE. proplist-shallow-copy -- Return a shallow copy of property list PL. proplist-deep-copy -- Return a deep copy of property list PL. proplist-is-equal -- Return #t iff PLA is equal to PLB. proplist-set-string-cmp-hook -- Use PRED as a predicate for doing proplist string comparisons. string->proplist -- Return a proplist object containing STRING. proplist-make-data -- Return a proplist argument containing arbitrary data from DATA. proplist-get-container -- Return the array or dictionary of which PL is an element. proplist-get-array-element -- Return the element at INDEX offset of PL. proplist-get-number-of-elements -- Return the number of elements in PL. proplist-get-all-dictionary-keys -- Return a proplist array object that contains all the keys of PL-DICT. proplist-get-dictionary-entry -- Return the proplist dictionary entry associated with entry KEY in PL-DICT. proplist-get-string-description -- Retuns a description of PL (a string proplist object) in GNUstep format. proplist-get-data-description -- Returns a description of PL (a data proplist object) in GNUstep format. proplist-get-data -- Returns the raw data from PL (a data proplist object) as a string. proplist-get-string -- Returns the string from PL (a string proplist object). proplist-is-string -- Return #t iff PL is a string proplist object, #f otherwise. proplist-is-data -- Return #t iff PL is a data proplist object, #f otherwise. proplist-is-array -- Return #t iff PL is an array proplist object, #f otherwise. proplist-is-dictionary -- Return #t iff PL is a dictionary proplist object, #f otherwise. proplist-is-simple -- Return #t iff PL is a string or data proplist object, #f otherwise. proplist-is-compound -- Return #t iff PL is a dictionary or array proplist object, #f otherwise. proplist-unregister -- No longer invoke callback when domain associated with PL-DOMAIN-NAME is changed. proplist-register -- Register thunk CALLBACK to be called when PL-DOMAIN-NAME changes. proplist-set-domain -- Set PL-DOMAIN-NAME to have VALUE. proplist-delete-domain -- Delete domain PL-DOMAIN-NAME. proplist-get-domain -- Return a property list represeting the domain PL-DOMAIN-NAME. proplist-get-domainnames -- Return a array proplist containing all registered domain names. proplist-get-filename -- Return the filename of PL. proplist-set-filename! -- Set the filename for PL to be FILENAME. proplist-save -- Save PL, atomically if ATOMICALLY? is #t. proplist-synchronize -- Synchronize the in-memory proplist PL with the disk contents. get-proplist-with-path -- Return the proplist from path FILENAME. get-proplist-with-description -- Return a property list by parsing DESC in GNUstep proplist format. modules/scwmgtkhelper/scwmgtkhelper.c scwm-gdk-X-fdes -- Return the integer connection number of the gdk_display. restore-scwm-handlers -- Restore the scwm behavior for signals and for X errors. modules/viavoice/scwmviavoice.c vv-connect -- Connect to the ViaVoice speech recognizer, calling PROC after connected. vv-disconnect -- Disconnect from the ViaVoice speech recognizer, calling PROC after disconnected. vv-close -- Close connect to the ViaVoice speech recognizer. vv-connected? -- Return #t if we are connected to the ViaVoice speech recognizer. vv-define-grammar -- Use GRAMMAR-FILE as the ViaVoice grammar and give it name NAME. vv-enable-vocab -- Enable vocabulary/grammar NAME. vv-turn-microphone-on -- Turn the microphone on to start recognizing commands. vv-turn-microphone-off -- Turn the microphone off to stop recognizing commands. modules/xlib-drawing/drawing.c xlib-set-drawing-mask! -- Set the drawing mask used by the xlib-* primitives. xlib-draw-rectangle! -- Draws a rectangle to the screen using the Xlib call XDrawRectangle. xlib-draw-line! -- Draws a line using the Xlib call XDrawLine. xlib-draw-arc! -- Draws a arc to the screen using the Xlib call XDrawArc. xlib-set-line-attributes! -- Sets the line width of the DrawingGC to WIDTH and style to STYLE. xlib-set-fill-style! -- Sets the fill style of the DrawingGC to STYLE. modules/xtest/scwmxtest.c xtest-supported? -- Returns #t iff the XTest extension is supported on this server. xtest-fake-button-event -- Fake an X event of button number BUTTON after a delay of MS-DELAY. xtest-fake-key-event -- Fake an X event of key KEYCODE after a delay of MS-DELAY. xtest-fake-motion-event -- Fake an X motion event to X,Y after a delay of MS-DELAY on SCREEN. xtest-fake-relative-motion-event -- Fake an X motion relative event of a move DX, DY after a delay of MS-DELAY. scheme/animated-edge-moves.scm animated-move-to-nw -- Move WIN to the northwest edge and update its gravity. animated-move-to-ne -- Move WIN to the northeast edge and update its gravity. animated-move-to-sw -- Move WIN to the southwest edge and update its gravity. animated-move-to-se -- Move WIN to the southeast edge and update its gravity. animated-move-to-n -- Move WIN to the north edge and update its gravity. animated-move-to-e -- Move WIN to the east edge and update its gravity. animated-move-to-s -- Move WIN to the south edge and update its gravity. animated-move-to-w -- Move WIN to the west edge and update its gravity. animated-move-to-center -- Move WIN to the center of the viewport and update its gravity. scheme/animated-iconify.scm animated-iconify -- Iconify WIN using a simple animation of a shrinking rectangle. animated-deiconify -- Deiconify WIN using a simple animation of a growing rectangle. animated-deiconify-to-viewport -- Deiconify WIN with an animation to the same viewport position as it was iconified from. animated-toggle-iconify -- Iconify WIN if not iconified, or de-iconify WIN if it is iconified. animated-deiconify-to-vp-focus -- Deiconify WIN to the current viewport, and give it the focus. scheme/animation.scm animated-move-to -- Move WIN to viewport coordinates X, Y with animation. scheme/auto-raise.scm set-auto-raise! -- Turn auto-raise on (#t) or off (#f) for WIN. set-auto-raise-delay! -- Set the auto-raise delay to DELAY (in ms) for WIN. set-auto-raise-unfocus-delay! -- Set the timeout to DELAY (in ms) for the unfocus-proc of WIN. set-auto-raise-focus-proc! -- Set the auto-raise-focus-proc for WIN. set-auto-raise-unfocus-proc! -- Set the auto-raise-unfocus-proc for WIN. scheme/auto-shrink.scm shrink-window -- Shrink the window WIN to FRAC * its old size. not-focussed-for? -- No documentation supplied. shrink-inactive-windows -- No documentation supplied. enable-timed-autoshrink-windows -- Turn on auto-shrinking window behaviour. disable-timed-autoshrink-windows -- Turn off auto-shrinking window behaviour. scheme/auto-unobscure.scm set-auto-unobscure! -- Turn auto-unobscure on (#t) or off (#f) for WIN. set-auto-unobscure-proc! -- Set the auto-unobscure-proc for WIN. enable-auto-unobscure -- No documentation supplied. disable-auto-unobscure -- No documentation supplied. scheme/base.scm program-exists? -- Return #t iff PROGRAM-NAME is in the current $PATH. add-hook-once! -- Add PROC to HOOK only if it does not contain PROC already. append-hook-once! -- Append PROC to HOOK only if it does not contain PROC already. round/ -- Return the closest integer to X divided by Y. half -- Return the closest integer to half of X. sleep-ms -- Delay for MS milliseconds. maybe-make-color -- Try to make OBJ into a color and return that color object. %x -- Return the number of pixels that is X percent of the display width. %y -- Return the number of pixels that is Y percent of the display height. pix->%x -- Return the percent of the display width that PIX is. pix->%y -- Return the percent of the display height that PIX is. x- -- Return the viewport pixel coordinate X pixels left of the right display edge. y- -- Return the viewport pixel coordinate Y pixels up from the bottom display edge. viewport-x-position -- Return the x coordinate of the current viewport. viewport-y-position -- Return the y coordinate of the current viewport. viewport-center-x -- Return the x coordinate of the center of the current viewport. viewport-center-y -- Return the y coordinate of the center of the current viewport. viewport->virtual -- Return the virtual coordinates for viewport X,Y. virtual->viewport -- Return the viewport coordinates for virtual X,Y. vpx->vx -- Convert from a viewport to a virtual X coordinate. vpy->vy -- Convert from a viewport to a virtual Y coordinate. vx->vpx -- Convert from a virtual to a viewport X coordinate. vy->vpy -- Convert from a virtual to a viewport Y coordinate. virtual-size -- Return the size of the virtual screen in pixels. vx- -- Return the virtual coordinate X pixels left of the right virtual edge. vy- -- Return the virtual coordinate Y pixels up from the bottom virtual edge. %x- -- Return the pixel coordinate X percent of the width away from the right edge. %y- -- Return the pixel coordinate Y percent of the height away from the bottom edge. w%x -- Return a pixel width X percent of the width of window W. w%y -- Return a pixel height Y percent of the height of window W. set-default-menu-foreground! -- Set the default color for menu text to FG. set-default-menu-background! -- Set the default background for menus to BG. set-default-menu-stipple! -- Set the default color for stippled (inactive) menu text to STIPPLE. set-default-menu-font! -- Set the default font for menu text to FONT. set-default-menu-title-font! -- Set the default font for menu title text to FONT. set-default-menu-side-image! -- Set the default menu side image to IMAGE. set-default-menu-side-background! -- Set the default background for the menu side image to BG. set-default-menu-bg-image! -- Set the default menu background image to IMAGE. set-default-menu-look! -- Set the default menu look to LOOK. set-default-menu-hl-fg-color! -- Set the default menu highlight foreground color to FG. set-default-menu-hl-bg-color! -- Set the default menu highlight background color to BG. set-highlight-colors! -- Set the highlight window's background color to BG, foreground color to FG. set-window-colors! -- Set WIN's background color to BG, foreground color to FG. move-pointer -- Move the X11 pointer X pixels to the right, and Y pixels down. move-to -- Move WIN to viewport position X, Y. delta-position -- Return a new coordinate list that is DX,DY offset from XY-LIST. move-window-relative -- Move WIN X, Y pixels from where it is currently. window-title-height -- Return WIN's titlebar's height. window-title-width -- Return WIN's titlebar's width. window-viewport-position -- Return the position of WIN in pixels within the viewport. window-virtual-position -- Return the virtual position of WIN in pixels. icon-viewport-position -- Return the position of WIN's icon in pixels within the viewport. move-viewport -- Move the viewport onto the virtual desktop relatively. use-placement-hint -- Do nothing when placing WIN, just let it be where hinted to be. menu-style -- Set various properites for the menus. simple-title-style -- Set the style for titlebars. menu-title -- Return a menuitem object that is a title. menuitem -- Return a menuitem object with the given attributes. menu -- Return a menu object with the given attributes. popup-menu-from-decoration -- Popup MENU from WIN's decoration numbered BUTTON-NUMBER. image-property -- Return the KEY property of IMAGE. font-property -- Return the KEY property of FONT. color-property -- Return the KEY property of COLOR. exe -- Return a procedure that, when invoked, executes COMMAND in the background. run-in-xterm -- Return a procedure that runs CMD in an xterm. start-xterm -- Start an xterm using `*xterm-command*' and `*xterm-user-shell-options*'. xterm-other-host -- Run an xterm on machine HOSTNAME. bell -- Ring the X11 bell (just calls beep). set-edge-resistance! -- Set the edge scroll delay to S, and the edge move threshold to M. set-edge-wrap! -- Set the edge x and y wrap values to X and Y, respectively. set-edge-scroll! -- Set the edge scroll values to X and Y, respectively. unset-message-window-position! -- Move the message window back to the default screen-center position. scwm-is-constraint-enabled? -- Return #t if scwm has the constraint solver primitives, #f otherwise. scwm-system -- Run CMD using /bin/sh -c CMD and return a list: (exit-status child-pid). execute -- Execute COMMAND in the background. background-system -- Run CMD using /bin/sh -c CMD and return the exit status. select-window -- Select a window interactively, and return the specified window. caught-error -- No documentation supplied. select-window-interactively -- Return an interactively-selected window after prompting (optionally) with MSG. run-dot-xclients-script -- Runs the ~/. run-dot-xclients-at-startup -- After done reading your startup file, run your ~/. keycode->keysym -- Return a string containing the X11 keysym for key with code KEYCODE. window-class -- Return the window resources class of WIN. window-resource -- Return the window resource instance of WIN. window-visible-frame-size -- Return the visible frame size of WIN. make-image-or-warn -- Return an image object for FILENAME and report a warning if it fails. image-not-found-message -- Report a missing image filename, but do not error. X-server-synchronize -- Handle all pending events. scheme/bincomm.scm binary-write -- Writes STR as binary data to PORT. binary-read -- Reads LENGTH bytes of binary data from PORT and return it as a string. binary-read-long -- Reads a binary representation of a C long and return as a scheme number. scheme/cascade.scm cascade-windows -- Cascade WINDOWS according to several parameters. cascade -- Cascade the windows on the specified desk. cascade-windows-interactively -- Cascade a set of selected windows. scheme/constraint-animation.scm start-animating-scwm-resolves -- Turn on animating windows to new positions following re-solves. stop-animating-scwm-resolves -- Turn off animating windows to new positions following re-solves. scheme/constraint-investigator.scm start-constraint-investigator -- Start the GTk+-based constraint investigator window. scheme/constraints.scm reset-constraints -- Reset the constraint solving system. start-constraints -- Start using the constraint solver. end-constraints -- Terminate using the constraint solver. scheme/corba.scm publish-scwm-evaluator-servant -- Publish the scwm-evaluator-servant by putting its IOR as a property on the root window. scheme/cursor.scm image-name->cursor -- Make a cursor given only the NAME. apply-fancy-resize-cursors -- Use the fancy resize cursors for WIN. scheme/debianapps-menu.scm make-debianapps-menu -- Read menu-file and return a menu object. scheme/decor.scm call-with-decor -- Eval THUNK using DECOR as the current decor. scheme/defoption.scm define-scwm-group-proc -- Helper procedure for define-scwm-group-- use that instead. scwm-group-properties -- Return the group properties for group SYM. scwm-group-name -- Return the prettified name for group SYM. scwm-group-docstring -- Return the prettified name for group SYM. scwm-group-icon -- Return the icon for group SYM. prompt-from-symbol -- Return a string prompt that is appropriate for the option symbol SYM. define-scwm-option-proc -- Helper procedure for define-scwm-option. scwm-option-module -- Return the module in which option SYM was defined. scwm-option-name -- Return the name of SYM. scwm-option-documentation -- Return the documentation for SYM. scwm-option-setter -- Return the setter for SYM. scwm-option-getter -- Return the getter for SYM. scwm-option-range -- Return the range for SYM. scwm-option-favorites -- Return the favorites for SYM. scwm-option-group -- Return the group for SYM. scwm-option-permit-disable -- Return the permit-disable flag for SYM. scwm-option-layout-hint -- Return the permit-disable flag for SYM. scwm-option-type -- Return the type for SYM. scwm-option-symset! -- Set option SYM to VALUE. scwm-option-symget -- Get option SYM's value. scheme/describe.scm is-mouse-event? -- Return #t iff EVENT is a mouse event. describe-event -- Display a message giving the bindings of the next event, key or mouse. describe-key -- Display a message giving the bindings of the next key event. describe-mouse -- Display a message giving the bindings of the next mouse event. scheme/desk-background.scm desk-background -- Set the background to use on desk DESK. scheme/dir-focus.scm dir-focus -- Move focus to the closest window in direction DIR. dir-focus-west -- Switch focus to the window to the west. dir-focus-south -- Switch focus to the window to the south. dir-focus-north -- Switch focus to the window to the north. dir-focus-east -- Switch focus to the window to the east. scheme/doc.scm hook-documentation -- Return the docstring for HOOK. documentation -- Print the documentation for the string or symbol. help -- Print all possible documentation for string or symbol. object-documentation -- Return documentation attached to SYM or to (eval SYM). proc-doc -- Return documentation for PROC. scheme/easyraise.scm set-easyraise-window! -- easyraise-window? -- list-easyraise-windows -- No documentation supplied. raise-easyraise-windows -- lower-easyraise-windows -- easyraise-window-is-hidden? -- No documentation supplied. toggle-easyraise-windows -- scheme/face.scm title-style -- Set the title style in the current decor. border-style -- Set the border style in the current decor. set-left-button-face! -- Set the button face for the left-button numbered BUTTON. set-right-button-face! -- Set the button face for the right-button numbered BUTTON. button-style -- Set the button style for button number BUTTON in the current decor. scheme/file.scm filename-is-complete? -- Return true if FNAME is a fully qualified pathname. find-file-in-path -- Search for file named FNAME in PATH. path-list->string-with-colons -- Convert L, a list of string directory names, to a single colon-separated string. string-with-colons->path-list -- Convert S, a colon-separated directory pathlist, into a list of directory strings. read-until-eof -- Return all the text from input port IN until eof. output-of-system-cmd -- Return the output of command shell execution of CMD. first-line-output-of-system-cmd -- Return the first line of output of command shell execution of CMD. execute-with-pidprop -- Execute COMMAND in the background and permit use of window-pid on its windows. scheme/flash-window.scm flash-window-on -- Flash WIN's titlebar and boundary color to COLOR indefinitely. flash-window -- Flash WIN's titlebar and boundary color to COLOR for UNFLASH-DELAY seconds. window-flashing? -- Return #t iff WIN is currently flashing, #f otherwise. unflash-window -- Revert WIN's titlebar and boundary color to state before a flash-window. stop-flashing-window -- Turn off window flashing of WIN. raise-and-stop-flashing -- Turn off window flashing of WIN and raise it. scheme/flux-gtk.scm rename-window-interactively -- Prompt for a new name for WIN and change its title. show-window-list-matching-interactively -- Prompt for a wildcard, and popup a list of matching windows (by title). chop-string -- No documentation supplied. netscape-bookmark-search -- Prompt for a string, and popup a list of matching netscape bookmarks. scheme/flux.scm wiggle-window -- Animatedly window shade and then unshade WIN. system-info-string -- Return a string with various system information. make-file-menu -- Return a menu-object for viewing or editing FILE. quotify-single-quotes -- Return a string that has single quote characters backslashified. message -- Display the string arguments STR in a message window. show-mesg -- Return a lambda to display the string arguments STR in a message window. show-file -- Return a lambda to display the contents of filename in a window. show-com -- Return a lambda to show the stdout generated by the COM shell pipeline. window-info -- Display information about WIN in a message window. show-system-info -- Display the system-info-string system details in a window. start-program-in-xterm -- Return a string to be the arguments to xterm for starting PROGRAM in it. start-xlogo -- Start an XLogo window. make-menuitems-from-menu-information-list -- Return a list of menu-items from a list of detailed programs list. select-window-group -- Prompt for multiple windows and return the list of selected windows. make-rhosts-menu -- Returns a menu which lets you rlogin to each host mentioned in your . close-all-xlogo-windows -- Close each window with class == XLogo. use-change-desk-commands -- Execute one of the VECTOR-OF-COMMANDS shell commands when the desk changes. extreme -- Find extreme value e of PRED in LST. take-screenshot -- Take a snapshot of the whole screen. put-string-in-palm-clipboard -- No documentation supplied. X-cut-buffer->palm-clipboard -- No documentation supplied. delete-multiple-windows-interactively -- Delete multiple windows as they are interactively clicked on. move-nonsticky-windows-relative -- Move all windows right X, down Y pixels. show-X-properties -- Displays the X properties of WIN in a message window. bind-wheel-mouse-prior-next -- No documentation supplied. send-key-press-up -- Send a synthetic "Up" keypress. send-key-press-down -- Send a synthetic "Down" keypress. send-key-press-prior -- Send a synthetic "Prior" keypress. send-key-press-next -- Send a synthetic "Next" keypress. window-background-color -- No documentation supplied. float->integer -- No documentation supplied. make-X-geometry -- No documentation supplied. interactive-move-rubberband -- Move interactively, using the rubberband (unless constraint solver is active. interactive-resize-rubberband -- Resize interactively, using the rubberband (unless constraint solver is active. config-request-animate -- A procedure for X-ConfigureRequest-hook to do window configuration animatedly. focus-window-with-pointer -- Set the focus to be the window containing the pointer. resize-xdvi-full-page-100% -- Resize an Xdvi window to be full-page, 100%. eval-expression-interactively -- Prompt for an expression and evaluate it interactively. scheme/focus-stack.scm push-focus-window -- Save the current focus window on a stack. pop-focus-window -- Restore the focus to the window on the top of the focus-stack focus-stack-empty? -- Return #t iff the focus-stack is empty, else #f. close-window-and-pop-focus -- Close WIN and pop the focus with pop-focus-window. scheme/focus-titlebar.scm turn-on-only-focus-window-has-titlebar -- Start displaying a titlebar only on the focussed window. turn-off-only-focus-window-has-titlebar -- Do not display titlebars on only the focuessed window. scheme/fvwm-compat.scm fvwm-exec-use-shell -- Use SHELL when emulating fvwm "EXEC" commands. fvwm-exec -- Run COMMAND as fvwm would. fvwm-pipe-read -- No documentation supplied. fvwm-nop -- No documentation supplied. %x-permit-negative -- No documentation supplied. %y-permit-negative -- No documentation supplied. scheme/fvwm-eval.scm eval-fvwm-command -- Evaluate an fvwm2 command. scheme/fvwm-module.scm get-fvwm2-module-config -- No documentation supplied. register-fvwm2-module-config -- No documentation supplied. append-fvwm2-module-config -- No documentation supplied. clear-fvwm2-module-config -- No documentation supplied. run-fvwm2-module -- No documentation supplied. kill-fvwm2-module -- No documentation supplied. kill-all-fvwm2-modules -- No documentation supplied. kill-fvwm2-modules-by-name -- No documentation supplied. fvwm2-pager-window -- Return a fvwm2 pager window, or #f if there is none. raise-fvwm2-pager -- Raise a fvwm2 pager window in the stacking order. lower-fvwm2-pager -- Lower a fvwm2 pager window in the stacking order. scheme/gnome-hints.scm gnome-desktop-press -- Send a button-press N to the gnome desktop manager. gnome-desktop-click -- Send a button-press N to the gnome desktop manager. gnome-desktop-menu -- Pop-up the gnome desktop menu. gnome-desktop-press-1 -- Send a button-press 1 to the gnome desktop manager. gnome-desktop-press-2 -- Send a button-press 1 to the gnome desktop manager. gnome-desktop-press-3 -- Send a button-press 1 to the gnome desktop manager. gnome-desktop-click-1 -- Send a button-press 1 and button-release 1 to the gnome desktop manager. gnome-desktop-click-2 -- Send a button-press 1 and button-release 2 to the gnome desktop manager. gnome-desktop-click-3 -- Send a button-press 1 and button-release 3 to the gnome desktop manager. enable-gnome-hints -- Enable support for GNOME hints. disable-gnome-hints -- Disable support for GNOME hints. gnome-install-window-styles -- Initialize various window styles for GNOME support. scheme/gnome-panel-menus.scm make-all-submenus -- No documentation supplied. make-menu-from-structured-directory -- No documentation supplied. make-menu-from-list-of-structured-directories -- No documentation supplied. make-menu-gnome-system -- No documentation supplied. make-menu-another-level -- No documentation supplied. make-menu-gnome-user -- No documentation supplied. make-menu-kde -- No documentation supplied. scheme/group.scm group-window -- Returns a distinguished window of GROUP. group->windows -- Returns a list of windows belonging to GROUP. raise-group -- Raise members of GROUP above all other windows. lower-group -- Raise members of GROUP above all other windows. move-group-relative -- Move all members of GROUP by DX, DY pixels. move-group -- Move GROUP to virtual coordinates X, Y. move-group-to-desk -- Move all members of GROUP to DESK. interactive-move-group -- Move GROUP interactively. deiconify-group -- Deiconify all members of GROUP. deiconify-group-or-window -- Deiconify WIN, and perhaps all members of its group. iconify-group -- Iconify GROUP into one icon. make-window-group-menu -- Return a menu for window group operations. popup-window-group-menu -- Popup the window group menu. popup-window-group-menu-no-warp -- Popup the window group menu without warping to the first menu item. interactive-move-selected-group-or-window -- Interactively move either the selected windows or the current window. scheme/gtk-about.scm gtk-about -- No documentation supplied. gtk-about-scwm -- No documentation supplied. scheme/gtk-menu.scm scwm-gtk-menu-title -- No documentation supplied. scwm-gtk-menuitem -- No documentation supplied. menuitem->scwm-gtk-menuitem -- No documentation supplied. scwm-gtk-menu -- No documentation supplied. scwm-gtk-popup-menu -- No documentation supplied. scheme/gtk-message.scm gtk-message -- It display a message on the display, using a gtk window scheme/gtk-table-display.scm for-each-column -- No documentation supplied. gtk-table-from-string -- No documentation supplied. scheme/gtk.scm scwm-gtk-sync -- Dispatch all pending gtk-events. start-handling-gtk-events -- No documentation supplied. gtk-pixmap-new-search-scwm-path -- Return the new pixmap object as gtk-pixmap-new does, but search Scwm's image-load-path for it. image->gtk-pixmap -- Return a gtk-pixmap widget for IMG for use in BUTTON. gtk-window->scwm-window -- Return the Scwm window object corresponding to GTKWIN. use-gtk-error-window-for-scwm -- No documentation supplied. gtk-clist-get-row-values -- Return a list of the COL columns of row ROW of CLIST. gtk-text-replace -- Replace all the text in TEXTWIDGET with TEXT. gtk-scrolled-window-set-vadjustment-value -- Set the vadjustment for SW, a scrolled window, to FLOAT. gtk-scrolled-window-set-hadjustment-value -- Set the hadjustment for SW, a scrolled window, to FLOAT. scheme/highlight-current-window.scm start-highlighting-selected-window -- Highlight the current window during window selections. end-highlighting-selected-window -- Stop highlighting the current window during window selections. start-highlighting-current-window -- Add appropriate hook procedures to make the window with the mouse be highlighted. end-highlighting-current-window -- Remove the hook procedures that make the window with mouse be highlighted. highlight-current-window -- No documentation supplied. scheme/hover-focus.scm set-hover-focus-delay! -- Set the hover-focus delay to DELAY (in ms) for WIN. set-hover-focus! -- Turn hover-focus on (#t) or off (#f) for WIN. uninstall-hover-focus -- Remove the hover-focus procedures from the Scwm hooks. scheme/image-loaders.scm ImageMagick-loader -- Tries to load an arbitrary image using ImageMagick's convert. netpbm-loader -- Tries to load an arbitrary image using the netpbm packge. try-everything-loader -- Tries to load an arbitrary image, using any available loader. support-image-conversion -- Set things up to try to load arbitrary images. scheme/image-path-suggestor.scm enable-image-path-suggestor -- Turn on the image path suggestor. scheme/kde-hints.scm kwm-send-window-list -- No documentation supplied. kwm-emulation-initialize -- No documentation supplied. kwm-emulation-reset -- No documentation supplied. scheme/key-mover-xtest.scm key-mouse-moves -- Bind four keys to move the mouse in compass directions by PCT-OF-SCREEN. key-viewport-moves -- Bind four keys to move the viewport in compass directions by PCT-OF-SCREEN. scheme/key-mover.scm key-mouse-moves -- Bind four keys to move the mouse in compass directions by PCT-OF-SCREEN. key-viewport-moves -- Bind four keys to move the viewport in compass directions by PCT-OF-SCREEN. scheme/lambda-startup-logo.scm logo-setup -- Setup to display the startup logo. logo-remove -- Remove the Scwm lambda startup logo. scheme/last-mapped-window.scm last-mapped-window -- Return the window that was mapped most recently. focus-last-mapped-window -- Focus and warp to the window that was mapped most recently. scheme/listops.scm iota -- Generate a list of the integers from 0 to N-1 in order. reverse-iota -- Generate a list of the integers from N-1 to 0 in order. accumulate -- Repeatedly apply PROC to a current value and a member of L. reduce -- Repeatedly apply PROC to a current value and a member of L. append-map -- Do the same thing as map, but collect results with append, not cons. filter -- Return a list of those elements of L for which PRED is true. there-exists? -- Return true if PRED is true for at least one elements of L, otherwise false. for-all? -- Return true if PRED is true for all elements of L, otherwise false. and-map -- Apply PROC repeatedly, returning the first false value. or-map -- Apply PROC repeatedly, returning the first true value. list-index -- Return the integer position of OBJ in list L. make-list -- Return a list containing N elements equal to the optional second argument. map-in-order -- Process FIRST and the lists comprising REST as map would. filter-map -- Process FIRST and the lists comprising REST as map would. filter-list -- Like list, but ignore #f and unspecified values. delete-duplicates -- Return a list that has the elements of L with duplicates omitted. list-without-elem -- Return the list L with element E deleted. repeat -- Builds a list of repeating values. flatten -- Return LIST-OF-LISTS as a single flat list. scheme/menus-extras.scm menu-max-fold-lines -- Return an approximation of the number of menuitems that will fit vertically on screen. sorted-by-car-string -- Sort the elements of list L based on the string value of their car. fold-menu-list -- Split ML into chained menus of no more than MAX-LINES items. split-list-by-group -- Split the a-list LS into groups according to the car of each of its cells. fold-menu-list-by-group -- Split ML-CONS into chained menus based on their group. scheme/message-window.scm gravity->alignments -- Return a list of two numeric alignments corresponding to a GRAVITY. position-message-window! -- Move the move/resize message window's GRAVITY point to (X,Y). message-window-options -- Allow specification of message-window behavior for standard actions. message-window-style -- Set visual style of MSGWIN. make-message-window-with-image -- Return a new message window with IMG as a background, sized appropriately. make-message-window-clone-default -- Return a new message window that has the default style. message-window-copy-style! -- Copy the visual style of MSGWIN-SOURCE to the style for MSGWIN. display-message-briefly -- Display MSG in the message window for SEC-TIMEOUT seconds. make-message-window-win-copy -- Return a message window with a background that is a copy of the image in WIN. with-frozen-root-window -- Execute THUNK with a frozen root window. scheme/minimal.scm append-hook! -- Add PROC to HOOK at the end of the list. scwm-module-loaded? -- Return #t iff MODULE has been loaded. eval-after-load -- Run PROC after MODULE is loaded. process-use-scwm-modules -- Returns a list of all the modules loaded in successfully. standard-place-window -- Do an ordinary placement of a window. scheme/modifier-key-bindings.scm bind-two-modifier-key-events -- Bind PROC-PRESS and PROC-RELEASE to be invoked on a multi-modifier key event. unbind-two-modifier-key-events -- Unbind events attached to a multi-modifier key event. bind-three-modifier-key-events -- Bind PROC-PRESS and PROC-RELEASE to be invoked on a multi-modifier key event. unbind-three-modifier-key-events -- Unbind events attached to a multi-modifier key event. bind-four-modifier-key-events -- Bind PROC-PRESS and PROC-RELEASE to be invoked on a multi-modifier key event. unbind-four-modifier-key-events -- Unbind events attached to a multi-modifier key event. scheme/module-types.scm module-event-name-from-number -- Return the string module event name for event number NUM. scheme/netscape.scm netscape-win -- Return a netscape window, prefer a visible netscape window. run-in-netscape -- Runs COMMAND in a Netscape window, calling COMPLETION when done, if set. uri-escapify-comma -- Replace commas in URI with the %2C escape code. cgi-escapify-space -- Replace spaces in URI with the + escape code. netscape-goto-url -- Make netscape go to the location URL. netscape-goto-selection-url -- Goto the url that is held in the X11 selection, SELECTION. netscape-goto-cut-buffer-url -- Goto the url that is held in the X11 cut buffer. netscape-download-closed-action -- Execute the closed action for WIN, a netscape download window. enable-autosave-netscape-dialog -- Enable the netscape autosaving "Save as. disable-autosave-netscape-dialog -- Disable the netscape autosaving "Save as. enable-dynamic-netscape-actions -- Enable the netscape download-closed action. netscape-google-search -- Use Netscape to do a google search for WORD. netscape-av-search -- Use Netscape to do an AltaVista search for WORD. netscape-google-search-cut-buffer -- Use Netscape to do a Google search of the X-cut-buffer-string. netscape-google-search-selection-url -- Use Netscape to do a Google search of the selection, SELECTION. netscape-av-search-selection-url -- Use Netscape to do a AltaVista search of the selection, SELECTION. netscape-application-menu -- No documentation supplied. scheme/nonants.scm get-window-with-nonant -- Select a WINDOW and a NONANT, defaulting to the current window context. nonant-decoration -- Return the window id numbers of the decoration for WIN corresponding to NONANT. get-window-with-nonant-interactively -- Interactively select a window and a nonant. window-and-offsets->nonant -- Return a nonant number in [0,8] from a window position and an offset. get-window-nonant -- SELECT-LIST is a list of (win x y), returns the nonant selected. nonant->string -- Return the brief string name for NONANT, an integer. scheme/number-convert.scm char-value -- Return the integer that corresponds to the Ascii code for CH. number-in-base -- Return the integer that corresponds to string NUMBER in base BASE. hex -- Return the integer that corresponds to string NUMBER as a hexadecimal value. oct -- Return the integer that corresponds to string NUMBER as an octal value. binary -- Return the integer that corresponds to string NUMBER as a binary value. scheme/optargs.scm set-*-procedure-properties -- Add the ARGLIST and INTERACTIVE-SPEC properties to procedure PROC. scheme/path-cache.scm program-exists? -- Return #t iff PROGRAM-NAME is in the current $PATH. initialize-programs-that-exist -- Initializes the cache with programs that exist in the current $PATH. cached-program-exists? -- Return #t if PROGRAM-NAME is in the cache of programs that exist. scheme/placement.scm place-in-viewport -- Move WIN to the (XX, YY) viewport. place-on-desk -- Move window WIN to desk DESK. place-interactively -- Place WIN interactively. place-at-point -- Place WIN at the pointer position. place-at-center -- Place window in the center of the current viewport. at-virtual-offset-placement -- Return a procedure that takes a window and places it at virtual offset X, Y. at-vp-offset-placement -- Return a procedure that takes a window and places it at viewport offset X, Y. in-viewport-placement -- Return a procedure that takes a window and places it in viewport (XX, YY). on-desk-placement -- Return a procedure that takes a window and places it on DESK. interactive-placement -- Return a procedure that takes a window and places it interactively. at-point-placement -- Return a procedure that places a window at the pointer position. auto-accept-dialog-placement -- Return a procedure that auto-accepts a dialog box window. near-window-placement -- Return a procedure that places a window near the window returned by WINDOW-GETTER. virtual-switch-placement -- Wrap placement procedure PROC with virtual switching code. make-keep-winclass-centered -- Return a procedure that keeps windows of CLASS centered in the viewport. scheme/preferences.scm scwm-option-short-documentation -- No documentation supplied. popup-docs-for -- No documentation supplied. toggle-docs-for -- No documentation supplied. choices-from-favorites -- No documentation supplied. gui-set -- No documentation supplied. dummy-prompt-hbox -- Create and return a dummy-prompting hbox and entry. option-widget-and-getter -- No documentation supplied. option-menu -- No documentation supplied. popup-option-menu -- No documentation supplied. scwm-options-menu -- No documentation supplied. scwm-options-dialog -- Popup a scwm options dialog box. sort-options-by-type -- No documentation supplied. scwm-options-notebook -- No documentation supplied. scwm-options-listbook -- No documentation supplied. scwm-options-vbox-page -- Popup a scwm options dialog box. scwm-options-string -- Return a string that, when evalled, resets preferences to current values. save-preferences -- Save the current Scwm preferences to FILENAME. load-preferences -- Load FILENAME to restore the Scwm preferences. scheme/prefs-menu.scm save-settings -- No documentation supplied. mod-desk-size! -- Modify the current desktop size by the given parameter. help-mesg -- No documentation supplied. ask-string -- Ask for a string with PROMPT. menu-prefs -- Generate the Preferences menu. scheme/prompt-binding.scm clist-find -- Return the row number of the first row in CLIST that PRED answers #t for. clist-set-row-text -- Set the text of ROW of CLIST to COLS. raw-binding->key-descriptor -- No documentation supplied. debug-clist-select -- No documentation supplied. prompt-binding-vbox -- No documentation supplied. prompt-binding -- No documentation supplied. scheme/prompt-bool.scm prompt-bool -- Prompt with PROMPT for a boolean value, and call PROC with result if Ok button is clicked. prompt-bool-hbox -- Create and return a boolean-prompting hbox and button. scheme/prompt-color.scm prompt-color -- Prompt using PROMPT for a color and call PROC with value if Ok is clicked. prompt-color-hbox -- Create and return a color-prompting hbox, complete with link to full color dialog. scheme/prompt-enum.scm prompt-enum -- Prompt with PROMPT for one of CHOICES, and call PROC with result. prompt-enum-hbox -- Create and return an enum-prompting hbox and button. scheme/prompt-file.scm prompt-file -- Prompt using PROMPT for a file and call PROC with value if Ok is clicked. prompt-file-hbox -- Create and return a file-prompting hbox, complete with link to full file dialog. scheme/prompt-font.scm prompt-font -- Prompt using PROMPT for a font and call PROC with value if Ok is clicked. prompt-font-hbox -- Create and return a font-prompting hbox, complete with link to full font dialog. scheme/prompt-proc.scm prompt-proc -- Prompt using PROMPT for a proc and call PROC with value if Ok is clicked. prompt-proc-hbox -- Create and return a proc-prompting hbox, complete with link to full proc dialog. gtk-proc-selection-new -- Returns a new procedure-selecting dialog box. gtk-proc-selection-toplevel-widget -- Returns the toplevel window widget from PROC-DIALOG. gtk-proc-selection-ok-button -- Returns the ok button from PROC-DIALOG. gtk-proc-selection-cancel-button -- Returns the cancel button from PROC-DIALOG. gtk-proc-selection-clist-widget -- Returns the clist widgetfrom PROC-DIALOG. gtk-proc-selection-get-procname -- Returns the currently selected procedure name from PROC-DIALOG. gtk-proc-selection-get-procedure -- Returns the currently selected procedure from PROC-DIALOG. module-and-proc-names->proc -- Return the procedure named PROC-NAME from module named MODULE-NAME. scheme/prompt-range.scm prompt-range -- Prompt using PROMPT for a numeric value in RANGE, and call PROC with value if Ok is clicked. prompt-integer-range -- Prompt using PROMPT for an integer value in RANGE, and call PROC with value if Ok is clicked. prompt-range-hbox -- Create and return a range-prompting hbox and scale, label. prompt-integer-range-hbox -- Create and return an integer-range-prompting hbox and scale, label. scheme/prompt-string.scm prompt-string -- Use PROMPT as prompt in text entry widget and call PROC with the entered string. prompt-string-hbox -- Create and return a string-prompting hbox and entry. prompt-path-hbox -- Create and return a path-prompting hbox and entry. simple-prompt-proc-hbox -- Create and return a procedure-prompting hbox and entry. scheme/prompting-shell.scm prompting-shell -- Create a GTk+ shell window and return a procedure that closes it. scheme/property-respond.scm property-changed-debug -- Print debugging information about the property change of PROP on WIN. property-changed-respond -- Handle various property changes of PROP on WIN. start-property-respond -- Turn on property-change responses. stop-property-respond -- Turn off property-change responses. scheme/quote.scm quote-key-event -- Quote the next key event and let it pass to the application. quote-mouse-event -- Quote the next mouse event and let it pass to the application. quote-next-event -- Quote the next mouse or keyboard event and let it pass to the application. mask->keycodes -- Return a list of keycodes corresponding to keys that generate the modifiers in MASK. xtest-fake-modmask -- No documentation supplied. xtest-fake-modmask-key -- No documentation supplied. xtest-fake-modmask-button -- No documentation supplied. scheme/rectangle.scm window-corners -- Return the four coordinates of the corners of the location of WIN. enclosing-rectangle -- Return the smallest rectangle that encloses the windows WINS. scheme/reflection.scm procedure->string -- No documentation supplied. interpret-as-procedure -- Return a procedure given its value, its symbol, or its name. procedure-string->procedure -- Return a procedure given its name. procedure-arity -- Return the arity values for PROC. procedure-num-required-args -- Return the number of required arguments for PROC. procedure-num-optional-args -- Return the number of optional arguments for PROC. procedure-takes-rest-arg? -- Return #t iff PROC take a rest argument. procedure-formals -- Return a list of the formal arguments for PROC. procedure-required-formals -- Return a list of the required formal arguments for PROC. procedure-optargs-arglist -- Return a list of the optargs keyword arguments for PROC. procedure-keyword-formals -- Returns an a-list of the optargs keyword arguments and default values for PROC. procedure-optional-formals -- Returns a list of the optional arguments for PROC. apropos-internal-with-modules -- Return a list of accessible variable names and the modules they are defined in. procedure-interactive-spec -- No documentation supplied. procedure-is-interactive? -- Return #t iff PROC is interactive. procedure-apropos-with-modules -- Returns a list of procedures that match RGX along with defined-in modules. procedure-apropos -- Returns a list of procedures that match RGX. interactive-procedure-apropos-with-modules -- Returns a list of procedures that match RGX and that can take no arguments. interactive-procedure-apropos -- Returns a list of interactive procedures that match RGX. context->brief-context -- No documentation supplied. context->string -- No documentation supplied. raw-binding->string -- No documentation supplied. procedure->bindings-description -- No documentation supplied. scheme/register.scm get-register-name -- Prompt for a register name and return a corresponding symbol. set-register -- Set contents of Scwm register named REGISTER to VALUE. get-register -- Return contents of Scwm register named REGISTER, or #f if none. focus-to-register -- Save the currently-focused window to REGISTER. window-configuration-to-register -- Save the configuration of WIN to REGISTER. selected-windows-to-register -- Save the current set of selected windows to REGISTER. global-window-configuration-to-register -- Save the global configuration of windows to REGISTER. list-of-windows? -- No documentation supplied. jump-to-register -- Restore the state saved in REGISTER. scheme/report-usage.scm report-scwm-usage -- Log your usage of scwm to a central host. scheme/rgb-database.scm read-and-append-to -- Read in the lines from port P and return them. rgb-colors -- Read in the rgb-colors database. scheme/ScwmBiff.scm close-ScwmBiff -- Close the ScwmBiff notification window. activate-ScwmBiff -- Turn on the ScwmBiff notification service. deactivate-ScwmBiff -- Make ScwmBiff no longer notify, but leave visible. scheme/ScwmButtons.scm run-ScwmButtons -- Start a ScwmButtons window giving a simple toolbar button/action interface. close-ScwmButtons -- Close the ScwmButtons window of SB. button-item -- Create a button item for a ScwmButtons window. scheme/ScwmClock.scm run-ScwmClock -- Start a ScwmClock window display. close-ScwmClock -- Close the ScwmClock with handle SC. scheme/ScwmDeskButtons.scm run-ScwmDeskButtons -- Start a ScwmDeskButtons toolbar interface. close-ScwmDeskButtons -- Close a ScwmDeskButtons object that was returned from run-ScwmDeskButtons. scheme/send-string.scm printable-char->keysym-string -- Return the keysym string corresponding to a printable character. X-synthetic-send-string -- Send string STR to WIN via synthetic X events. scheme/session.scm string->scwm-module -- Return the module corresponding to the given string. scheme/shove-window.scm shove-window-prefix -- Display prompt to shove the current window to an edge or center. scheme/shutdown-opts.scm shutdown-options -- Configure shutdown preferences. scheme/simple-constraints.scm keep-tops-even -- Keep W1 and W2 aligned at the top. keep-lefts-even -- Keep W1 and W2 aligned at the left. keep-bottoms-even -- Keep W1 and W2 aligned at the bottom. keep-rights-even -- Keep W1 and W2 aligned at the right. keep-to-left-of -- Keep W1 to the left of W2. keep-above -- Keep W1 wholly above W2. keep-top-at-v -- Keep W1's top at cl-variable V's pixel value. keep-left-at-v -- Keep W1's left at cl-variable V's pixel value. keep-right-at-v -- Keep W1's right at cl-variable Vs pixel value. keep-full-width -- Keep W1 and W2 sum of widths equal to the display's width. keep-full-height -- Keep W1 and W2 sum of heights equal to the display's height. keep-adjacent-horizontal -- Keep W1's right edge aligned with W2's left edge. keep-adjacent-vertical -- Keep W1's bottom edge aligned with W2's top edge. keep-at-left-edge -- Keep W's left edge at the left edge of the desktop. keep-at-top-edge -- Keep W's top edge at the top edge of the desktop. keep-at-right-edge -- Keep W's right edge at the right edge of the desktop. keep-constant-width -- Keep W's width at WIDTH. keep-constant-size -- Keep W's size from changing. cl-set-solver-var -- Set solver S's variable CLV to value VALUE. scheme/simplebiff.scm simplebiff -- Run a simple xbiff-like notification system. stop-simplebiff -- Call this with the object returned from simplebiff to turn off the notifier scheme/smart-push.scm midpoint -- No documentation supplied. line-slope -- No documentation supplied. window-segment -- No documentation supplied. draw-line -- No documentation supplied. segment-ray-intersects-segment -- Return the point of intersection for a edge moving to ENDX,ENDY and a SEGMENT. scheme/smart-push2.scm midpoint -- No documentation supplied. line-slope -- No documentation supplied. window-segment -- No documentation supplied. draw-line -- No documentation supplied. segment-ray-intersects-segment -- Return the point of intersection for a edge moving to ENDX,ENDY and a SEGMENT. scheme/snap-constraints.scm edges->nonant -- Return a nonant number from a list of edges that are involved. invert-nonant -- Return the opposite nonant from NONANT. snap-reset -- Turn off auto-snapping during interactive moves. snap-initialize -- Turn on auto-snapping during interactive moves. scheme/snap.scm snap-reset -- Turn off auto-snapping during interactive moves. snap-initialize -- Turn on auto-snapping during interactive moves. scheme/sort.scm sort -- Returned LS sorted according to COMPARE (defaults to ascending numerical order). scheme/stacking.scm list-windows-above -- List the windows above w from bottom to top. list-windows-below -- List the windows below w from top to bottom. lower-window-below -- Restack window W immediately below W2. raise-window-above -- Restack window W immediately above W2. lower-by-one -- Lower window W below the next window down that overlaps it. raise-by-one -- Raise window W above the next window up that overlaps it. scheme/std-menus.scm execute-on-selection -- Run COMMAND in the background, with arguments supplied by the X selection. exe-on-selection -- Return a procedure that runs COMMAND in the background on the X selection. make-hosts-menu -- Create a telnet menu. make-context-menu -- Create a menu of actions applicable to the filename in the X selection. make-menu-window-theme -- Return a menu that lets the user set the theme for a single window. make-menu-global-theme -- Return a menu that lets the user set the theme for all windows. scheme/stringops.scm make-string-usable-for-resource-key -- Return a converted string from STRING that can be used as an X resource key. bool->string -- Return the string "false" if ARG is #f, "true" otherwise. color->string -- Convert scwm color object COLOR into an X11 name of that color. size->string -- Convert a two-element list to a string. number->hex-string -- A convenience wrapper around `number->string' that returns N in base-16. window-state->string -- Returns a string representation of the numerical WIN-STATE. gravity->string -- Returns a string representation of the numerical GRAVITY. chop-newline -- Return STR up to but not including the first newline character. write-all -- Write all arguments into the port. to-string -- Dump all arguments into a string. string-join -- Concatenates the list STRINGS into a single string. remove-suffix -- Return STR with trailing SUFFIX removed if it exists. string-has-prefix -- Return #t iff STRING starts with PREFIX. string-ci-has-prefix -- Return #t iff STRING starts with PREFIX ignoring case. scheme/style-options.scm add-window-style-option -- No documentation supplied. add-boolean-style-option -- No documentation supplied. add-window-hint-option -- No documentation supplied. add-boolean-hint-option -- No documentation supplied. add-window-both-option -- No documentation supplied. add-boolean-both-option -- No documentation supplied. add-property-style-option -- No documentation supplied. style-option:handler -- No documentation supplied. style-option:type -- No documentation supplied. style-option:cumulative? -- No documentation supplied. scheme/style.scm style-one-window -- No documentation supplied. window-style -- Specify various properties for windows matching CONDITION. window-unstyle -- Remove STYLE definition from list of window styles. clear-window-style -- No documentation supplied. make-style -- No documentation supplied. make-conditional-style -- No documentation supplied. apply-style -- No documentation supplied. set-window-placement-proc! -- Set the 'placement-proc property of WIN to PROC. set-window-transient-placement-proc! -- Like set-window-placement-proc!, but for transient windows. scheme/stylist.scm make-window-style-menu -- Offer a choice to style the window, like named windows, or a whole class. scheme/synth-events.scm send-button-1 -- Send a mouse-1 button press and release event. send-button-2 -- Send a mouse-2 button press and release event. send-button-3 -- Send a mouse-3 button press and release event. scheme/task-switcher.scm window-task-switcher-menu -- Popup a task-switcher window list. window-task-switcher-menu-backwards -- Popup a task-switcher window list. scheme/theme-impl.scm load-theme-image -- No documentation supplied. make-theme -- Creates a theme object with the given NAME, WINDOW-STYLE, and BACKGROUND-STYLE. theme:name -- No documentation supplied. theme:window-style -- No documentation supplied. theme:background-style -- No documentation supplied. scheme/themes.scm use-theme -- Use settings from THEME to set up the window manager. load-theme -- Returns a theme FNAME which is loaded from `*theme-path*'. load-cached-theme -- No documentation supplied. theme-names -- No documentation supplied. scheme/tile.scm tile-windows -- Tile WINDOWS according to several parameters. tile -- Tile the windows on the specified desk. tile-windows-interactively -- Tile a set of selected windows either vertically or horizontally. scheme/time-convert.scm sec->msec -- Convert SEC seconds into an equivalent number of milliseconds. msec->usec -- Convert MSEC milliseconds into an equivalent number of microseconds. sec->usec -- Convert SEC seconds into an equivalent number of microseconds. scheme/titlebar-buttons.scm reset-buttons! -- Resets button numbers. add-left-button -- Add a left button to the current decor. add-right-button -- Add a right button to the current decor. scheme/ui-constraints-buttons.scm initialize-ui-constraints-buttons -- No documentation supplied. change-ui-constraints-buttons -- No documentation supplied. start-ui-constraints-buttons -- No documentation supplied. close-ui-constraints-buttons -- No documentation supplied. scheme/ui-constraints-classes.scm two-window-prompter -- No documentation supplied. two-window-or-more-prompter -- No documentation supplied. one-window-prompter -- No documentation supplied. two-window-or-more-nonant-prompter -- No documentation supplied. nonant->dirvector -- No documentation supplied. scheme/ui-constraints-composition.scm ui-constraints-composition-begin -- Begin recording the constraints used for the creation of a composition. ui-constraints-composition-end -- End the recording of a constraint composition. cncat -- No documentation supplied. replace-proxies-with-windows -- No documentation supplied. scheme/ui-constraints-gdk-drawing.scm gdk-drawing-initialize -- Setup the draw functions for drawing onto the root window. gdk-drawing-initialized? -- Returns whether or not the module has been initialized. gdk-drawing-get-gc -- Returns the gc used to draw on the root window. gdk-drawing-get-drawable -- Returns the drawable object used to draw on the root window. gdk-drawing-set-line-width! -- Set the width of the line to draw with. gdk-draw-rectangle! -- Draw a rectangle on the root window. gdk-draw-line! -- Draw a line on the root window. gdk-draw-arc! -- Draw an arc on the root window. scheme/ui-constraints-toggle-menu.scm ui-constraints-toggle-menu -- Return a menu of constraints that permits toggling their enabled? state. popup-ui-constraints-toggle-menu -- Popup a menu that can be used to turn added constraints on and off. scheme/ui-constraints.scm make-ui-constraint-class -- Creates a new ui-constraint-class object. ui-constraint-class-creator -- Return a list that contains a code snippet can create CLASS. delete-ui-constraint-class! -- Removes UI-CONSTRAINT-CLASS from the global class list. reset-ui-constraint-classes! -- Empty the global list of ui-constraint-classes. ui-constraint-class? -- Returns a boolean: true if UI-CONSTRAINT-CLASS is a vector and starts with the get-ui-constraint-class-by-name -- No documentation supplied. ui-constraint-class-name -- Returns the name of the constraint class. ui-constraint-class-description -- Returns the description for the constraint class. ui-constraint-class-num-windows -- Returns the number of windows constrainable by instances of the constraint ui-constraint-class-ctr -- Returns the constructor for instance of the constraint class. ui-constraint-class-ui-ctr -- Returns the UI constructor for instances of the constraint class. ui-constraint-class-draw-proc -- returns the drawing procedure for instances of the constraint class. ui-constraint-class-satisfied-proc -- Returns the satisfaction checking procedure for instances of the ui-constraint-class-pixmap-name -- Return the pixmap-name of UI-CONSTRAINT-CLASS. ui-constraint-class-pixmap2-name -- Return the pixmap2-name of UI-CONSTRAINT-CLASS. ui-constraint-class-menuname-proc -- Return the proc for determining the name for the constraint in make-ui-constraint -- UI-CONSTRAINT-CLASS specified the type of constraint to be created. make-ui-constraint-interactively -- Uses the UI constructor of the constraint class to prompt the user to delete-ui-constraint! -- Removes the UI-CONSTRAINT permanently. ui-constraint? -- Returns #t if UI-CONSTRAINT is a ui-constraint. ui-constraint-cn -- Returns the CN list from the ui-constraint object UI-CONSTRAINT. ui-constraint-enabled? -- Returns the ENABLE from the ui-constraint object UI-CONSTRAINT. ui-constraint-class -- Returns the UI-CONSTRAINT-CLASS from the ui-constraint object UI-CONSTRAINT. ui-constraint-windows -- Returns the LIST-OF-WINDOWS from the ui-constraint object UI-CONSTRAINT. ui-constraint-opts -- Returns the list of optional data that may be added by the constraint class. ui-constraint-button -- Returns the a reference to panel representing the UI-CONSTRAINT in the toggle menu. ui-constraint-set-button! -- Sets the reference to the gtk button for this instance in the toggle menu. enable-ui-constraint -- Enables the constraint in the constraint solver. disable-ui-constraint -- Disables the constraint in the constraint solver constraint-satisfied? -- Returns the status of whether a UI-CONSTRAINT is satisfied. constrained-window-in-focus? -- Returns #t if one of the windows in the constraint is in focus. ui-constraints-involving-window -- Returns the list of ui-constraint objects that involve WIN. ui-constraints-involving-two-windows -- Returns the list of ui-constraint objects that involve WIN1 and WIN2. delete-ui-constraints-involving-window! -- Delete all the ui-constraint objects that involve WIN. delete-inferred-ui-constraints-involving-window! -- Delete all the ui-constraint objects that involve WIN. draw-constraint -- Draw the UI-CONSTRAINT. undraw-constraint -- Undraw the UI-CONSTRAINT. draw-constraints-of-window -- Draw all constraints associated with WIN. undraw-constraints-of-window -- Undraw all constraints associated with WIN. draw-all-constraints -- Draw all constraints in the global instance list. undraw-all-constraints -- Undraw all constraints in the global instance list. disable-all-constraints -- Disable all constraints in the global instance list. enable-all-constraints -- Enable all constraints in the global instance list. delete-all-constraints -- Delete all constraints in the global instance list. ui-constraint-add-enable-hook -- Adds a HOOK proc which will be called when UI-CONSTRAINT enable state changes. ui-constraint-remove-enable-hook -- Removes a HOOK proc from the list in UI-CONSTRAINT. ui-constraint-enable-hooks -- Returns a list of the enable-hook functions added to the UI-CONSTRAINT. move-after-deleting-constraints -- Move WIN after deleting all constraints that involve it. move-after-deleting-inferred-constraints -- Move WIN after deleting all inferred constraints that involve it. scheme/undo.scm reset-undo! -- Reset the undo system. increment-in-range -- Return v+1 but no more than high. decrement-in-range -- Return v-1 but no less than low. decrement-undo-index -- Decrement the undo-index. increment-undo-index -- Increment the undo-index. push-undo-global -- Push the global state onto the undo list. insert-undo-global -- Insert the global state into the undo list at undo-index. push-undo-state -- Push STATE onto the undo list. insert-undo-state -- Insert STATE into the undo list at undo-index. undo-state-at-index -- Return the state from undo-list at INDEX, or #f if bad index. undo -- Undo the last operation that was undoable. redo -- Redo the last undone operation. undo-use -- Apply the state from the undo-list contained at INDEX. scheme/viavoice.scm vv-smrc->error -- No documentation supplied. vv-initialize-environment -- No documentation supplied. vv-use-grammar -- No documentation supplied. vv-setup-recognition-hook -- No documentation supplied. vv-terminate -- Use this to terminate ViaVoice recognition. vv-initialize -- Use this to start ViaVoice recognition. vv-recognition-actions -- No documentation supplied. vv-recognition-debug -- No documentation supplied. scheme/virtual.scm containing-aligned-viewport -- Compute the viewport-position of the viewport that contains POS. nearest-aligned-viewport -- Compute the nearest valid integral viewport position to POS. window-aligned-viewport -- Return the viewport that contains the center of WIN. current-viewport-offset-xx -- Return the current viewport horizontal offset as a multiple of the display width. current-viewport-offset-yy -- Return the current viewport vertical offset as a multiple of the display height. window-position-in-viewport -- Return a virtual position for WIN that is in viewport (XX,YY). move-window-to-viewport -- Move WIN to the viewport numbered (XX,YY). move-inside-viewport -- Ensure that WIN is entirely inside the X, Y viewport if possible. move-inside-aligned-viewport -- Ensure that WIN is entirely inside the XX, YY viewport if possible. move-inside-current-viewport -- Ensure that WIN is entirely inside the current viewport, if possible. move-inside-own-viewport -- Ensure that WIN is entirely inside the closest viewport to its center. deiconify-to-current-viewport -- De-iconify WIN and make it visible in the current viewport. move-to-viewport -- Move to the viewport numbered (XX,YY). align-viewport -- Set the viewport position to the nearest multiple of the desk size. warp-to-window-viewport -- Change to the desk and viewport of WIN. switch-to-first-desk -- Switch to the first desktop. switch-to-second-desk -- Switch to the second desktop. scheme/visibility-reporter.scm install-visibility-reporter -- Install procedures to print debugging messages on window visibility change events. uninstall-visibility-reporter -- Uninstall procedures that print debugging messages on window visibility change events. scheme/where-is.scm where-is -- Show bindings that invoke PROC. scheme/window-configuration.scm window-configuration -- Return a list containing the state of WIN. window-configuration? -- Return #t if WCFG is a window configuration. copy-window-configuration -- Apply a saved state CONFIGURATION to window WIN. restore-window-configuration -- Restore the state of WIN from GLOBAL-CONFIGURATION. global-window-configuration -- Return an object abstracting all of the current windows' states. window-configuration->xform-to-it -- Create a transformation element for going from the current state to CFG. restore-global-window-configuration -- Restore the states of all windows from GLOBAL-CONFIGURATION. push-window-configuration -- Save the configuration of WIN on its stack of previous configurations. pop-window-configuration -- Restore the last configuration of WIN that was saved on its stack of previous configurations. scheme/window-locations.scm pair-virtual->viewport -- Convert a pair point from virtual to viewport coordinates. window-center-middle -- Return pair (viewport-x . window-center-top -- Return a pair (X . window-center-bottom -- Return a pair (X . window-left-middle -- Return a pair (X . window-right-middle -- Return a pair (X . window-left-top -- Return a pair (X . window-left-bottom -- Return a pair (X . window-right-top -- Return a pair (X . window-right-bottom -- Return a pair (X . window-viewport-position-of -- Return a list (X Y) that is the viewport position of the SYM part of WIN. scheme/window-selection.scm window-is-selected? -- Return #t if W is in the selected window list, else #f. selected-windows-list -- Returns the list of windows selected by select-window-interactively-and-highlight. select-window-toggle -- Toggle the selectedness of W. select-window-add -- Select a single window, highlight it, and add it to the selected-windows-list. select-window-remove -- Unselect a single window, de-highlight it, and remove it from the selected-windows-list. select-matching-windows -- Select windows for which predicate PROC returns #t. unselect-matching-windows -- Unselect windows for which predicate PROC returns #t. unselect-all-windows -- Unselect all windows selected via select-window-add. select-multiple-windows-interactively -- Return a list of user-selected windows, up to MAX. set-markwin-offset! -- No documentation supplied. place-nonant-marker -- Place a nonant marker on W. remove-nonant-marker -- Remove a nonant marker from W. show-selected-nonants -- Show nonant markers on window when they are selected. hide-selected-nonants -- Hide nonant markers on window when they are selected. flash-selected-windows-on -- Make sure that the selected windows are marked as selected. set-selected-windows-list! -- Make LIST be the set of selected windows. scheme/wininfo.scm on-desk? -- Return #t if WIN is on desk N, else #f. on-desk-n? -- Returns a function which takes WIN and returns #t if WIN is on desk N, else #f. on-current-desk? -- Return #t if WIN is on the current desk. rectangle-overlap? -- Returns #t iff the two specified rectangles overlap. intersection-area -- Returns the size of the intersection of two rectangles. in-viewport-any-desk? -- Return #t if WIN is in the current viewport ignoring the desk, else #f. windows-overlap? -- Return #t if WIN and WIN2 overlap at all, else #f. window-overlaps-window? -- Return a function that takes WIN2 and returns #t if it overlaps WIN. list-overlapping-windows -- Return a list of windows that overlap WIN. list-non-overlapping-windows -- Return a list of windows that do not overlap WIN. visible? -- Return #t if any of WIN is currently potentially visible, else #f. percent-visible -- Return the percent of WIN currently in the viewport as a real in [0,100]. window-center-position -- Return the virtual coordinates of the center of WIN as a list of the X and Y coordinate. window-geometry-string -- Return a string corresponding to the geometry specifications for WIN. time-t->seconds-ago -- Return the number of seconds that have passed since TIMET was the current time. window-last-focus-time-string -- Return a string corresponding to the last focus time for WIN. wildcard->regexp -- Return the regular expresision string corresponding to WILDCARD. window-client-machine-name -- Return the name of the client machine on which WIN is running. wildcard-matcher -- Return a procedure that matches WILDCARD against a window. wildcard-match? -- Returns #t if WILDCARD matches WIN (in the sense of wildcard-matcher). title-match?? -- Return a predicate that tests a window's title. class-match?? -- Return a predicate that tests a window's resource class. resource-match?? -- Return a predicate that tests a window's resource instance. icon-title-match?? -- Return a predicate that tests a window's icon title. client-hostname-match?? -- Return a predicate that tests a window's client hostname. find-window-by -- Return a window satisfying predicate PRED. find-window-by-name -- Return a window with name WINDOW-NAME. find-window-by-class-resource -- Return a window by its CLASS and RESOURCE names (as strings). scheme/winlist-menu.scm make-window-list-menu -- Popup a window list menu and permit a selection to be made. show-window-list-menu -- Popup a window list menu. select-window-from-window-list -- Permit selecting a window from a window list. show-icon-list-menu -- Show a window list of only iconfied programs. show-xterm-window-list-menu -- Show a window list of only xterms. show-netscape-window-list-menu -- Show a window list of only Netscape windows. scheme/winlist.scm listify-if-atom -- Make L into a list if it is not. filter-only-except -- Return a filtered list of the elements from L. list-windows -- Return the list of windows matching ONLY and not matching EXCEPT. winlist-hit -- Permit WIN to be displayed in the window list by default. winlist-skip -- Do not show WIN in the window list by default. winlist-skip? -- Return #t if WIN is skipped in the window list, #f otherwise. circulate-hit -- Include WIN among the windows in the circulate list. circulate-skip -- Do not include WIN among the windows in the circulate list. circulate-skip? -- Return #t if WIN is not among the windows in the circulate list. circulate-hit-icon -- Include WIN's icon among the windows in the circulate list. circulate-skip-icon -- Do not include WIN's icon among the windows in the circulate list. circulate-skip-icon? -- Return #t if WIN's icon is not among the windows in the circulate list. should-circulate-skip? -- Return #t if WIN should now be skipped when circulating, #f otherwise. next-window -- Switch to the next matching window. prev-window -- Circulate to the previous matching window. scheme/winops-menu.scm window-application-menu -- Return the application menu for WIN, or #f if there is none. set-window-application-menu! -- Set the application menu for WIN to MENU. make-small-window-ops-menu -- Return a short menu of window operations for window W. make-menu-focus-options -- Create a menu of focus options for WIN. scheme/winops.scm make-toggling-winop -- Returns a procedure which takes a window WIN and toggles a property of it. close-window -- Close WIN either by deleting it or destroying it. focus-or-toggle-raise -- Focus on WIN if it does not have the focus, else toggle-raise WIN. hide-titlebar-in-place -- Turn off display of the titlebar for WIN without moving the client window. show-titlebar-in-place -- Turn on display of the titlebar for WIN without moving the client window. hide-side-decorations -- Do not display the sidebar decorations for WIN. show-side-decorations -- Display the sidebar decorations for WIN. maximize -- Maximize WIN to new pixel width NW and new pixel height NH. maximized? -- Return #t if WIN is maximized, #f otherwise. unmaximize -- Unmaximize WIN so it returns to its size/position before maximization. toggle-maximize -- Maximize to width NW, height NH if not maximized, or unmaximize. window-frame-area -- Return the area of WIN's frame in square pixels. default-resize-opaquely? -- Return #t if WIN has area <= *opaque-resize-percent* of the screen, else #f. default-move-opaquely? -- Return #t if WIN has area <= *opaque-move-percent* of the screen, else #f. interactive-move -- Move WINDOW interactively and possibly opaquely. interactive-resize -- Resize WINDOW interactively and possibly opaquely. resize-window -- Resize WIN's client area to a size of W by H in pixels. sort-windows-by-middle-pos -- Sort WINLIST (a list of windows) by their middle positioins. next-visible-non-iconified-window -- Switch focus to the next visible and not iconified window. prev-visible-non-iconified-window -- Switch focus to the previous visible and not iconified window. resize-quarterscreen -- Resize the current window with the pointer to 1/4 of the screen. resize-halfscreen -- Resize the current window with the pointer to full height and half the screen size in width. resize-fullscreen -- Resize the current window with the pointer to 90% of the full screen size. interactive-set-window-gravity! -- Permit user to click on an area of a window and anchor that nonant. nonant->gravity -- Return a gravity symbol given NONANT in [0,8]. interactive-move-window-with-focus -- Interactively move the window which currently has the focus. interactive-resize-window-with-focus -- Interactively resize the window which currently has the focus. interactive-move-window-with-pointer -- Interactively move the window which currently contains the pointer. interactive-resize-window-with-pointer -- Interactively resize the window which currently contains the pointer. toggle-maximize-vertical -- Toggle the current window's maximized-vertically state. toggle-maximize-horizontal -- Toggle the WIN's maximized-horizontally state. toggle-maximize-both -- Toggle the WIN's maximization (both vertically and horizontally). toggle-maximize-vertical-part -- Toggle the WIN's maximization-vertically to 95% of the screen height. maximize-vertical -- Maximize WIN vertically. maximize-horizontal -- Maximize WIN horizontally. maximize-both -- Maximize WIN both horizontally and vertically. focus-change-warp-pointer -- Deiconify, focus, raise, and warp-to WIN. warp-placement -- Return a list, (%x %y), for the desired pointer placement for WIN. toggle-focus -- Focus window that had the focus before the current one. scheme/wmconfig-menu.scm make-wmconfig-menu -- Return a menu object for the window-manager configuration menu. scheme/xlock-menus.scm xlock-query-modes -- Returns a list of mode names queried from the given XLOCK program. make-xlock-menu -- Create an xlock menu. scheme/xprop-extras.scm set-window-title! -- Change the window title X-Property of WIN to TITLE. X-cut-buffer-string -- Return the text of the primary cut buffer. X-set-cut-buffer-string! -- Set the text of the primary cut buffer. copy-window-title-to-cut-buffer -- Set X cut buffer to be a string that is the title of WINDOW. paste-window-title-from-cut-buffer -- Set the window title of WINDOW to be the string in the X cut buffer. propagate-selection-to-cut-buffer -- Make the cut-buffer contain the current selection. X-handle-selection-string -- Run VALUE-HANDLER on the selection SELECTION after retrieving it. get-wm-command -- Get the "WM_COMMAND" X-Property of WIN and return that string. X-atomic-property-set-if-unset! -- Set property NAME on WINDOW to VALUE, if it's currently unset. window-pid -- Returns the process id of the process that created WIN. window-other-id -- Returns the other id string given to the process that created WIN. mwm-functions->string -- Converts the MWM function flags into a readable form. mwm-decorations->string -- Converts the MWM decoration flags into a readable form. X-properties->string -- Prints the X properties of WIN into a string. src/binding.c set-quote-key-events! -- Set key event quoting to QUOTING-ON?. quote-key-events? -- Return #t iff key events are being qutoed. lookup-key -- Return the procedures bound to KEY within the CONTEXTS. unbind-key -- Remove any bindings attached to KEY in given CONTEXTS. keysym->keycode -- Returns a list of X/11 keycodes that generate the keysym, KEYSYM-NAME. unbind-mouse -- Remove any bindings attached to mouse BUTTON in given CONTEXTS. bind-key -- Bind the given KEY within the CONTEXTS to invoke PROC. bind-keycode -- Bind the given KEYCODE within the CONTEXTS to invoke PROC. unbind-keycode -- Unbind the given KEYCODE within the CONTEXTS. bind-mouse -- Bind the given mouse BUTTON within the CONTEXTS to invoke PROC. lookup-mouse -- Return the procedure bound to mouse BUTTON within the CONTEXTS. lookup-procedure-bindings -- Return any bindings that invoke PROC in context CONTEXT. mouse-event-type -- Return a symbol corresponding to the type of the most recent mouse event. number-of-mouse-buttons -- Return the number of mouse buttons of the current mouse. mod-mask-shift -- Return the bit-mask for the Shift modifier key, or #f. mod-mask-control -- Return the bit-mask for the Control modifier key, or #f. mod-mask-meta -- Return the bit-mask for the Meta modifier key, or #f. mod-mask-alt -- Return the bit-mask for the Alt modifier key, or #f. mod-mask-hyper -- Return the bit-mask for the Hyper modifier key, or #f. mod-mask-super -- Return the bit-mask for the Super modifier key, or #f. mod-mask-numlock -- Return the bit-mask for the NumLock modifier key, or #f. mod-mask-scrolllock -- Return the bit-mask for the ScrollLock modifier key, or #f. set-mod-mask-numlock! -- Set the bit-mask for the NumLock modifier key. set-mod-mask-scrolllock! -- Set the bit-mask for the ScrollLock modifier key. set-ignore-dubious-modifiers! -- If FLAG is #t, ignore scoll/num/lock modifiers on all bindings made. ignore-dubious-modifiers? -- Return the status of the ignore-dubious-modifiers flag. undo-all-passive-grabs -- Remove all passive grabs of keys and buttons of bindings. redo-all-passive-grabs -- Re-instate all passive grabs of keys and buttons of bindings. undo-passive-grab -- Remove the passive grabs of KEYCODE-OR-BUTNUM with MODMASK on all windows. redo-passive-grab -- Re-instate the passive grab of KEYCODE-OR-BUTNUM with MODMASK on all windows. X-pointer-mapping -- Return the mapping of physical->logical pointer buttons as a list. keymask->string -- Return a string representing KEYMASK. keymask-keycode->string -- Return a string representing the key press with mask KEYMASK, code KEYCODE. src/callbacks.c safe-load -- Load file FNAME while trapping and displaying errors. set-load-processing-frequency! -- Invoke hooks on load-processing-hook every NUM-LINES lines. add-timer-hook! -- Add a timer hook to call PROC once sometime after MSEC milliseconds. remove-timer-hook! -- Remove a timer hook identified by HANDLE. reset-timer-hook! -- Remove all timer-hook procedures. get-timer-hooks-list -- Return the timer-hooks list. add-input-hook! -- Add an input hook to run PROC on input from PORT. remove-input-hook! -- Remove an input hook identified by HANDLE. reset-input-hook! -- Remove all procedures from the input hook. get-input-hooks-list -- Return the input-hooks list. call-interactively -- Invoke THUNK interactively. src/color.c color? -- Returns #t if OBJ is a color object, otherwise #f. color-properties -- Return an association list giving some properties of COLOR. make-color -- Return the color object corresponding to the X color specifier CNAME. clear-color-cache-entry -- Colors are cached by name. make-relief-color -- Convert a color into a new color appropriate for a relief. make-reversed-color -- Return a new color that is opposite COLOR. set-highlight-factor! -- Use FACTOR to generate highlight colors for the current decor. highlight-factor -- Return the current highlight factor. set-shadow-factor! -- Use FACTOR to generate shadow colors in the current decor. shadow-factor -- Return the current shadow factor. set-menu-highlight-factor! -- Use FACTOR to generate highlight colors for menus. menu-highlight-factor -- Return the current menu highlight factor. set-menu-shadow-factor! -- Use FACTOR to generate shadow colors for menus. menu-shadow-factor -- Return the current menu shadow factor. set-highlight-foreground! -- Use FG for the foreground color of a window with the input focus. highlight-foreground -- Return the default foreground color for windows with the input focus. set-highlight-background! -- Use BG as the background color for a window with the input focus. highlight-background -- Return the default background color for windows with the input focus. set-not-menu-foreground! -- Use FG as the default foreground color for icons, titlebars, etc. not-menu-foreground -- Return the default foreground color for icons, titlebars, etc. set-not-menu-background! -- Use BG as the default background color for icons, window frames, etc. not-menu-background -- Return the default background color for icons, window frames, etc. src/cursor.c set-window-cursor! -- Set the default cursor for WIN to CURSOR. get-x-cursor -- Return the cursor object corresponding to NAME-OR-NUMBER. create-pixmap-cursor -- Create and return a new cursor object from the pixmap image. src/decor.c make-decor -- Create a new decor object. default-decor -- Return the default decor. set-current-decor! -- Set the current decor to DECOR. current-decor -- Return the current decor. set-window-decor! -- Set WIN's decor to DECOR, updating its decorations appropriately. window-decor -- Return WIN's decor. src/deskpage.c set-current-desk! -- Change the current desk to DESK. current-desk -- Returns the integer identifying the current desk. set-viewport-position! -- Position the upper left corner of the viewport at coordinates X, Y. viewport-position -- Returns the current position of the viewport in pixels. set-edge-x-scroll! -- Set the horizontal edge scroll increment to PIXELS. edge-x-scroll -- Return the horizontal edge scroll increment as set by set-edge-x-scroll!. set-edge-y-scroll! -- Set the vertical edge scroll increment to PIXELS. edge-y-scroll -- Return the vertical edge scroll increment as set by set-edge-y-scroll!. set-edge-x-wrap! -- Set whether to wrap pointer around horizontal edges. edge-x-wrap -- Return the current horizonatal edge wrap setting as set by set-edge-x-wrap!. set-edge-y-wrap! -- Set whether to wrap pointer around vertical edges. edge-y-wrap -- Return the current vertical edge wrap setting as set by set-edge-y-wrap!. set-edge-scroll-delay! -- Set the edge scroll delay to MS milliseconds. edge-scroll-delay -- Return the edge scroll delay (in ms) as set by set-edge-scroll-delay!. set-edge-move-threshold! -- Set the edge move threshold to PIXELS. edge-move-threshold -- Return the edge move threshold as set by set-edge-move-threshold!. set-desk-size! -- Sets the desk size to WIDTH, HEIGHT. desk-size -- Returns the size of the current desk. display-size -- Returns the size of the physical screen in pixels. src/events.c handle-pending-events -- Handle all pending Scwm events, returns number of dispatched events. reset-scwmexec-protocol -- Reset the scwmexec protocol. add-motion-handler! -- Call PROC on XMotionEvents. remove-motion-handler! -- No longer call PROC on XMotionEvents. reset-motion-handlers! -- Call no procedures on XMotionEvents. send-key -- Send a synthetic press/release of KEY. send-button -- Send a synthetic mouse button/release event. src/face.c set-face-flag! -- Set the given FLAG to the given FLAGVAL for face FACE. make-face -- Create a new face. set-title-face! -- Set the titlebar faces for the various window states. set-button-face! -- Set the button faces for the various window states. set-button-mwm-flag! -- Specify the Mwm flag for BUTTON. set-border-face! -- Set the face for the border In the current decor. src/focus.c focussable-window? -- Return #t iff WIN may receive the keyboard focus. src/font.c make-font -- Return the font object for the X font specifier FNAME. font? -- Returns #t if OBJ is a font object, otherwise #f. font-properties -- Return an association list giving some properties of FONT. set-icon-font! -- Set the font used for drawing icon titles to FONT. icon-font -- Return the font used for drawing icon titles. set-title-font! -- Set the font for window titles In the current decor to FONT. title-font -- Return the font used for drawing window titles in the current decor. clear-font-cache-entry -- Fonts are cached by name. src/Grab.c X-grab-server -- Grab the X server. X-ungrab-server -- Ungrab the X server. X-server-grabs -- Return the number of nested server grabs. src/ICCCM.c send-client-message -- Send WIN the message "ATOM DATA". src/image.c image? -- Returns #t if OBJ is an image object, otherwise #f. image-properties -- Return an association list giving some properties of IMAGE. image-short-name -- Return the short name of IMAGE. image-size -- Return the size of IMAGE as a list (width height). load-xbm -- Load an X Bitmap file identified by the pathname FULL-PATH. load-xpm -- Load an X Pixmap file identified by the pathname FULL-PATH. load-imlib-image -- Load an image file using imlib identified by the pathname FULL-PATH. register-image-loader -- Register PROC as the loader to use for images ending in EXTENSION. unregister-image-loader -- Unregister the loader, if any, for images ending in EXTENSION. make-image -- Loads an image from the file NAME. clear-image-cache-entry -- Images are cached by both name and full pathname. window->image -- Return an image with the contents of window WIN. clone-scaled-image -- Returns a copy of IMAGE scaled to have dimensions WIDTH by HEIGHT. src/menu.c menu? -- Return #t if and only if OBJ is a menu object. menu-properties -- Returns the a list of the menu properties of MENU, a menu object. make-menu -- Make and return a menu object from the given arguments. set-menu-popup-delay! -- Set MENU's submenu popup delay to POPUP-DELAY. menu-popup-delay -- Return MENU's submenu popup delay. set-menu-hover-delay! -- Set MENU's hover delay to HOVER-DELAY. menu-hover-delay -- Return MENU's hover action delay. set-menu-look! -- Use MENU-LOOK as the menu-look for MENU. set-menu-title! -- Use MENU-TITLE as the title for MENU. set-menu-colors! -- Use TEXT-COLOR and BG-COLOR as the colors for MENU. set-menu-highlight-colors! -- Use TEXT-COLOR and BG-COLOR as the highlight colors for MENU. set-menu-highlight-relief! -- If HIGHLIGHT-RELIEF? is #t, then draw a relief on selected items in MENU. menu-highlight-colors -- Return list text-color, bg-color, the highlight colors for MENU. menu-highlight-relief? -- Return #t if MENU's selected item is relieved, #f otherwise. set-menu-font! -- Use FONT as the font for MENU. set-menu-side-picture! -- Use PICTURE as the side picture for MENU. set-menu-background-picture! -- Use PICTURE as the background image for MENU. set-menu-extra-options! -- Set MENU's extra options to OPTIONS. set-menu-hotkeys-activate-item! -- If ACTIVATE? is #t, let menu hotkeys invoke the item. menu-hotkeys-activate-item? -- Return #t if hotkeys invoke item, #f if they just select the item. popup-menu -- Popup MENU, a menu object, and warp to the item WARP-TO-INDEX if it is a number. src/menuitem.c menuitem? -- Return #t if and only if OBJ is a menu item object. menuitem-properties -- Return a list of the properties of the given MENU-ITEM. make-menuitem -- Return a newly created menuitem object using the given arguments. set-menuitem-colors! -- Sets the fg and bg colors of MENUITEM to FG and BG respectively. menuitem-colors -- Returns a list of the fg and bg colors for MENUITEM. set-menuitem-font! -- Sets the font of MENUITEM to FONT. menuitem-font -- Returns the font of MENUITEM. src/menulook.c menu-look? -- Return #t if OBJ is a menulook object, #f otherwise. copy-menu-look -- Copy menu look ORIGINAL-MENU-LOOK with a new NAME and optional EXTRA. src/message-window.c message-window? -- Returns #t if MWN is a msgwindow object, otherwise #f. make-message-window -- Returns a newly created message window object with string MESSAGE. id->message-window -- Return the message-window of an X/11 window id (a long integer). message-window-set-message! -- Changes the message displayed by the message window MWN. message-window-set-image! -- Changes the background image for the message window MWN to IMAGE. message-window-set-font! -- Set the font to be used for the message window MWN. message-window-set-colors! -- Set the fore- and background colors to be used for the message window MWN. message-window-set-position! -- Set the position to be used for the message window MWN. message-window-set-size! -- Set the size of message window MWN to WIDTH pixels by HEIGHT pixels. message-window-set-relief! -- Sets the relief for the window MWN. message-window-show! -- Displays the message window MWN on the screen. message-window-hide! -- Hide the message window MWN. message-window-visible? -- Return #t if the message window MWN is visible, #f otherwise. message-window-message -- Returns the message that message window MWN displays. message-window-image -- Returns the image that message window MWN displays. message-window-position -- Returns the position that message window MWN is/will be displayed at. message-window-size -- Returns the size of message window MWN in pixels. message-window-font -- Returns the font that the message window MWN uses for displaying text. message-window-id -- Returns the X11 id of message window MWN. message-window-colors -- Returns the colors that the message window MWN is displayed with. message-window-relief? -- Returns the relief setting for the message window MWN. src/miscprocs.c set-title-justify! -- Set the justification for the title to JUST. title-justify -- Return the current justification for the title, as set by set-title-justify!. set-title-height! -- Set the height of the titlebar in pixels to HEIGHT. title-height -- Return the height of the titlebar in pixels, as set by set-title-height!. restarted? -- Returns true if scwm is being restarted by itself. capturing? -- Returns #t when the windows are being captured. refresh -- Make sure all windows and their decorations are up to date. set-click-delay! -- Set the delay used in identifying mouse clicks and drags. click-delay -- Returns the delay used in identifying mouse clicks and drags, in milliseconds. set-colormap-focus! -- Set the colormap focus policy to FTYPE. colormap-focus -- Return the colormap focus policy, as set by set-colormap-focus!. pointer-position -- Return the current position of the mouse pointer in pixels. move-pointer-to -- Move the mouse pointer to viewport coordinates SX, SY. recapture -- Recapture all the windows. beep -- Ring the standard X bell. set-click-to-focus-passes-click! -- Determine whether a click-to-focus window receives the click. click-to-focus-passes-click? -- Returns #t iff a click-to-focus window is sent the click, else #f. set-click-to-focus-raises! -- Determine whether a click to focus raises the clicked-on window. click-to-focus-raises? -- Returns #t iff a click-to-focus window gets raised on focus, else #f. set-mouse-focus-click-raises! -- Determine whether a mouse-focus-click will raise the window. mouse-focus-click-raises? -- Returns a boolean value indicating whether a mouse-focus-click will raise the window. X-rotate-cut-buffers -- Rotate the X cut buffers by N positions. elapsed-time -- Return the elapsed time in milliseconds since O. scwm-last-timestamp -- Return the timestamp of the last event Scwm handled. scwm-version -- Return the version of scwm running. scwm-version-date -- Return the date that the running scwm was last changed as a string. scwm-path-prefix -- Return the $PREFIX directory path that scwm was installed with. scwm-path-exec-prefix -- Return the $EXEC_PREFIX directory path that scwm was installed with. set-X-server-synchronize! -- Set X server sychronization flag to FLAG. X-version-information -- Return some information about the version of the running X server. X-display-information -- Return some information about the screen. user-name -- Return the current user's name. user-home -- Return the current user's home directory. done-startup? -- Return #t iff Scwm is fully initialized, else #f. force-segv-for-testing -- Cause a segmentation violation. set-reset-on-segv! -- Reset Scwm to the main event loop on the next NUMBER-TO-RESET segv signals. reset-on-segv -- Return the number of segv signals Scwm will reset on. set-handle-segv! -- If FLAG, tell Scwm to catch segv signals. x-connection-number -- Return the X connection file descriptor number. scwm-run-test-hook-0 -- Invoke scwm-test-hook-0 COUNT times. scwm-run-test-hook-1 -- Invoke scwm-test-hook-1 COUNT times with ARG as the single argument. get-next-event -- Return a represention of the next key or mouse event. get-key-event -- Return a represention of the next key event. get-mouse-event -- Return a represention of the next mouse event. X-fetch-bytes -- Returns a string representing the value of the cut buffer. X-store-bytes -- Set the cut buffer to STRING by calling XStoreBytes. src/module-interface.c marshal-fvwm2-config-info -- Constructs a fvwm2 BroadcastInfo module packet. marshal-fvwm2-iconify-info -- Constructs a fvwm2 "M_ICONIFY" module packet. src/move.c rubber-band-move -- Move WIN interactively, using a rubber band frame. opaque-move -- Move WIN interactively, opaquely. src/placement.c place-on-default-desk -- Place WIN on a desk according to the default algorithm. smart-place-window -- Places WIN using fvwm2's SmartPlacement algorithm. clever-place-window -- Places WIN using fvwm2's "ReallySmart" algorithm. random-place-window -- Places WIN just as if being placed by fvwm2's RandomPlacement. initial-place-window -- Pick a desk for WIN and return #t iff WIN should be placed. interactive-place-window -- Interactively place WIN. null-place-window -- This is simplest, fallback placement procedure for windows. src/resize.c set-rubber-band-mask! -- Set the rubber band mask used when dragging or resizing. rubber-band-resize -- Resize WIN interactively, using a rubber band frame. opaque-resize -- Resize WIN interactively, opaquely. src/session-manager.c SM-error-message -- Return a string, describing why session management is not available. SM-register -- Register Scwm with the session manager, and return the client id. src/shutdown.c restart -- Restart the window manager. scwm-quit -- Exit scwm cleanly. src/window.c window? -- Returns #t if OBJ is a window object, otherwise returns #f. window-valid? -- Returns #t if OBJ is window object and is still valid, otherwise returns #f. window-fully-constructed? -- Returns #t if WIN is a fully-constructed window, otherwise #f. window-mapped? -- Returns #t if WIN is mapped, otherwise returns #f. window-map-pending? -- Returns #t if the mapping of WIN is pending, otherwise returns #f. select-viewport-position -- Select a viewport position and return the window there. get-window -- Retrieve the window context or select interactively. force-reset-window-frame! -- This redraws the window frame and decorations of WIN. set-window-context! -- Set the current window context to WIN and return the old context. window-context -- Returns the current window context, or #f if there is none. window-with-focus -- Return the window that currently has the input focus. window-with-pointer -- Return the window that currently contains the mouse pointer. delete-window -- Request that WIN remove itself from the display. destroy-window -- Forcibly remove WIN from the screen. window-deletable? -- Return #t if WIN is able to be deleted, #f otherwise. focus-window -- Give WIN the keyboard input focus. unfocus -- Remove the input focus from any window that may have it. warp-to-window -- Move the mouse pointer to the upper left corner of WIN. raise-window -- Raise WIN to the top of the window stack. lower-window -- Lower WIN to the bottom of the window stack. restack-windows -- Restack the windows in WINLIST from front to back. raised? -- Return #t if WIN is currently raised, #f if not. transient? -- Return #t if WIN is transient, #f if not. window-transient-for -- Return the window for which WIN is transient. iconify-window -- Iconify WIN. deiconify-window -- Deiconify WIN. iconified-window? -- Return #t if WIN is iconified, otherwise return #f. stick-window -- Make WIN "sticky" so that it stays stationary in the viewport. unstick-window -- Cause a window to no longer be "sticky", if it is. sticky-window? -- Return #t if WIN is "sticky", #f otherwise. shade-window -- Cause WIN to become "window-shaded". unshade-window -- Reverse the effect of shade-window on WIN. shaded-window? -- Return #t if WIN is shaded. window-decoration-size -- Return (decor-width decor-height) for WIN. move-window -- Move WIN to virtual coordinates X, Y. resize-frame -- Resize WIN to a size of W by H in pixels. window-size-hints -- Return a list of the window size hints associated with WIN. refresh-window -- Refresh the decorations on window WIN. move-window-to-desk -- Move WIN to DESK. window-gravity -- Return the gravity for WIN as a symbol. set-window-gravity! -- Sets the gravity for WIN to GRAVITY. window-position -- Return the position of WIN in pixels. icon-position -- Return the position of the icon for WIN. icon-size -- Return the size of the icon for WIN. window-frame-size -- Return the size of the frame of WIN. window-size -- Return the size of the application window of WIN. window-title-size -- Return a list with the width and height of WIN's titlebar. window-frame-border-width -- Return the width of WIN's frame's border. window-id -- Return the X window id for WIN. window-frame-id -- Return the X window id for the outermost frame window of WIN. id->window -- Return the window object corresponding to an application WINDOW-ID. frame-id->window -- Return the window object corresponding to a frame WINDOW-ID. any-id->window -- Return the window object that contains the window with id WINDOW-ID. window-desk -- Return the desk that WIN is currently on. window-title -- Return the window title of WIN, as requested by the application. window-icon-title -- Return the icon window title of WIN. window-class-hint -- DEPRECATED. window-resource-hint -- DEPRECATED. window-last-focus-time -- Return the time that WIN was last focussed in seconds since 1/1/70. window-last-focus-x-time -- Return the X11 time that WIN was last focussed. window-creation-time -- Return the time that WIN was created in seconds since 1/1/70. window-visibility -- Return the visibility state for WIN. list-all-windows -- Return a list of all of the top-level window objects. list-stacking-order -- Return a list of all non-iconified the top-level window objects, from top to bottom. list-focus-order -- Return a list of all the top-level window objects in focus order. keep-on-top -- Ensure that WIN is kept on top of all other windows. un-keep-on-top -- Remove the on-top property from WIN, if it has it. kept-on-top? -- Return #t if WIN is an on-top window, #f otherwise. show-titlebar -- Cause WIN to be decorated with a titlebar. hide-titlebar -- Cause WIN not to be decorated with a titlebar. titlebar-shown? -- Return #t if WIN is decorated with a titlebar, #f otherwise. normal-border -- Cause WIN to be decorated with a normal border. plain-border -- Cause WIN to be decorated with a plain border. border-normal? -- Return #t if WIN has a normal border, #f if it has a plain border. set-border-width! -- Set the border width of WIN's border to WIDTH pixels. stick-icon -- Cause WIN's icon to become "sticky". unstick-icon -- Cause WIN's icon to no longer be "sticky". icon-sticky? -- Return #t if WIN is "sticky", #f otherwise. set-icon-box! -- Set the icon box in which WIN's icon will be placed. set-window-focus! -- Set the focus style of WIN to SYM. window-focus-style -- Get the focus style of WIN. get-window-colors -- Return a two-element list, '(fg bg), the colors for WIN. get-window-highlight-colors -- Return a two-element list, '(fg bg), the highlight colors for WIN. window-decoration-ids -- Returns a list of long integer window ids of the decoration windows for WIN. set-window-id-background! -- Set the background color of X11 window with id WINID to BG. set-window-highlighted-nonant! -- Highlight NONANT for WIN. window-highlighted-nonant -- Returnt the highlighted nonant for WIN, or #f if none highlighted. set-nonant-highlight-color! -- Use COLOR for highlighting nonants. nonant-highlight-color -- Return the color used for highlighting nonants. set-window-foreground! -- Set the foreground color of WIN to FG. set-window-background! -- Set the background color of WIN to BG. set-window-highlight-foreground! -- Set the highlighted foreground color of WIN to FG. set-window-highlight-background! -- Set the highlighted background color of WIN to BG. set-window-button! -- Set the visibility of button number N on window WIN. set-mwm-buttons! -- Set the mwm-buttons flag of WIN to boolean FLAG. set-mwm-border! -- Set the mwm-border style flag of WIN to boolean FLAG. set-icon-title! -- Set the visibility of WIN's icon title according to FLAG. set-force-icon! -- Set the window-manager-overriding property for WIN to boolean FLAG. set-show-icon! -- Set whether or not the icon of WIN will be visible. set-icon! -- Set the image to use for the icon of WIN to IMAGE. window-icon -- Get the icon image being used for WIN. set-mini-icon! -- Set the image to use for the mini-icon of WIN to IMAGE. window-mini-icon -- Get the mini-icon image being used for WIN. window-shaped? -- Return #t if WIN is a shaped window, #f otherwise. window-icon-shaped? -- Return #t if WIN has shaped icon, #f otherwise. set-hint-override! -- Set whether or not Mwm and Open Look function hints are used. set-decorate-transient! -- Set decoration of transients property on WIN. set-mwm-decor-hint! -- Set whether or not Motif decoration hints are used for WIN. set-mwm-func-hint! -- Set whether or not Motif function hints are used for WIN. set-PPosition-hint! -- Set or reset the program-specified position hint for WIN. set-OL-decor-hint! -- Determine whether or not to respect Open Look decoration hints. set-start-on-desk! -- Make WIN start on DESK when first mapped. set-skip-mapping! -- Set or reset whether scwm should not change desktops on a map. set-lenience! -- Set or reset the input focus lenience flag. src/winprop.c set-window-property! -- Set window property PROP of WIN to VAL. window-property -- Retrieve window property PROP of WIN. src/xproperty.c X-property-set! -- Set X property NAME on window WIN to VALUE. X-property-get -- Get X property NAME of window WIN. X-property-delete! -- Delete X property NAME of window WIN. X-properties -- Returns a list of WIN's X property names. string->X-atom -- Returns an X atom representing STRING. X-atom->string -- Returns the string represented by ATOM. X-get-selection-owner -- Return the window that owns the selection denoted by ATOM. X-convert-selection -- Ask the owner of selection SELECTION to provide its value. src/xrm.c X-resource-put -- Stores string VALUE as X resource RESOURCE (also a string). X-resource-get -- Get X resource specified by NAME and XCLASS from Xrm database. X-resource-database-save -- Save the Scwm resource database to FILENAME. Procedures in Alphabetical Order %x Return the number of pixels that is X percent of the display width. (%x x) Description Return the number of pixels that is X percent of the display width. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 151 (CVS log) %x- Return the pixel coordinate X percent of the width away from the right edge. (%x- x) Description Return the pixel coordinate X percent of the width away from the right edge. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 239 (CVS log) %x-permit-negative No documentation supplied. (%x-permit-negative x) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-compat) Defined in scheme/fvwm-compat.scm at line 120 (CVS log) %y Return the number of pixels that is Y percent of the display height. (%y y) Description Return the number of pixels that is Y percent of the display height. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 155 (CVS log) %y- Return the pixel coordinate Y percent of the height away from the bottom edge. (%y- y) Description Return the pixel coordinate Y percent of the height away from the bottom edge. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 243 (CVS log) %y-permit-negative No documentation supplied. (%y-permit-negative y) Description No documentation supplied. Implementation Notes Module: Defined in scheme/fvwm-compat.scm at line 126 (CVS log) accumulate Repeatedly apply PROC to a current value and a member of L. (accumulate proc init l) Description Repeatedly apply PROC to a current value and a member of L. The initial current value is INIT. The list is processed from left to right. The final result is returned. Compare to reduce. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 53 (CVS log) activate-ScwmBiff Turn on the ScwmBiff notification service. (activate-ScwmBiff sb) Description Turn on the ScwmBiff notification service. Implementation Notes Module: (app scwm ScwmBiff) Defined in scheme/ScwmBiff.scm at line 101 (CVS log) add-boolean-both-option No documentation supplied. (add-boolean-both-option key th fh #&optional (cumulative? #f)) Description No documentation supplied. Implementation Notes Module: (app scwm style-options) Defined in scheme/style-options.scm at line 59 (CVS log) add-boolean-hint-option No documentation supplied. (add-boolean-hint-option key th fh #&optional (cumulative? #f)) Description No documentation supplied. Implementation Notes Module: (app scwm style-options) Defined in scheme/style-options.scm at line 53 (CVS log) add-boolean-style-option No documentation supplied. (add-boolean-style-option key th fh #&optional (cumulative? #f)) Description No documentation supplied. Implementation Notes Module: (app scwm style-options) Defined in scheme/style-options.scm at line 47 (CVS log) add-hook-once! Add PROC to HOOK only if it does not contain PROC already. (add-hook-once! hook proc) Description Add PROC to HOOK only if it does not contain PROC already. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 51 (CVS log) add-input-hook! Add an input hook to run PROC on input from PORT. (add-input-hook! port proc) Description Add an input hook to run proc on input from port. Whenever input becomes available on port, procedure proc will be called with no arguments repeatedly until no unprocessed input remains on port. port must be open, it must be an input port, and it must be a file port (this includes pipes and sockets, but not string ports or soft ports). A handle suitable for passing to remove-input-hook! is returned. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 702 (CVS log) add-left-button Add a left button to the current decor. (add-left-button button-face hook #&optional (immed-hook #f)) Description Add a left button to the current decor. Implementation Notes Module: (app scwm titlebar-buttons) Defined in scheme/titlebar-buttons.scm at line 33 (CVS log) add-motion-handler! Call PROC on XMotionEvents. (add-motion-handler! proc) Description Call proc on XMotionEvents. This can considerably slow Scwm down so use it only when necessary. See remove-motion-handler and reset-motion-handlers. Implementation Notes Module: Built-in Primitive Defined in src/events.c at line 2180 (CVS log) add-property-style-option No documentation supplied. (add-property-style-option key property #&optional (cumulative? #f)) Description No documentation supplied. Implementation Notes Module: (app scwm style-options) Defined in scheme/style-options.scm at line 71 (CVS log) add-right-button Add a right button to the current decor. (add-right-button button-face hook #&optional (immed-hook #f)) Description Add a right button to the current decor. Implementation Notes Module: Defined in scheme/titlebar-buttons.scm at line 43 (CVS log) add-timer-hook! Add a timer hook to call PROC once sometime after MSEC milliseconds. (add-timer-hook! msec proc) Description Add a timer hook to call proc once sometime after msec milliseconds. When at least msec milliseconds have passed, procedure proc will be called with no arguments. A handle suitable for passing to remove-timer-hook! is returned. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 553 (CVS log) add-window-both-option No documentation supplied. (add-window-both-option key handler #&optional (cumulative? #f)) Description No documentation supplied. Implementation Notes Module: (app scwm style-options) Defined in scheme/style-options.scm at line 56 (CVS log) add-window-hint-option No documentation supplied. (add-window-hint-option key handler #&optional (cumulative? #f)) Description No documentation supplied. Implementation Notes Module: (app scwm style-options) Defined in scheme/style-options.scm at line 50 (CVS log) add-window-style-option No documentation supplied. (add-window-style-option key handler #&optional (type 'normal) (cumulative? #f)) Description No documentation supplied. Implementation Notes Module: (app scwm style-options) Defined in scheme/style-options.scm at line 32 (CVS log) align-viewport Set the viewport position to the nearest multiple of the desk size. (align-viewport) Description Set the viewport position to the nearest multiple of the desk size. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 154 (CVS log) and-map Apply PROC repeatedly, returning the first false value. (and-map proc first . rest) Description Apply PROC repeatedly, returning the first false value. PROC is applied to elements of FIRST and the lists comprising REST much as map would do it. If proc never returns a false value, return #t instead. If all the lists are empty, return #t. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 110 (CVS log) animate-windows Animate multiple windows. (animate-windows xforms #&optional move-pointer-too?) Description Animate multiple windows. xforms is a list of transform operations where each xform operation describes how a single window should move and resize by giving its old and new configuration. Each xfrom element of the xforms list should look like: (window frame? (start-width . start-height) (end-width . end-height) (start-x . start-y) (end-x . end-y) (set-end-x? . set-end-y?)) If move-pointer-too? is #t, then the X11 pointer will move in conjunction with the first window in the xforms list; defaults to #f. Implementation Notes Module: Primitive from (app scwm c-animation) Defined in modules/c-animation/c-animation.c at line 439 (CVS log) animated-deiconify Deiconify WIN using a simple animation of a growing rectangle. (animated-deiconify #&optional (win (get-window))) Description Deiconify WIN using a simple animation of a growing rectangle. The rectangle grows outwards from the icon, if there is one. Implementation Notes Module: (app scwm animated-iconify) Defined in scheme/animated-iconify.scm at line 67 (CVS log) animated-deiconify-to-viewport Deiconify WIN with an animation to the same viewport position as it was iconified from. (animated-deiconify-to-viewport #&optional (win (get-window))) Description Deiconify WIN with an animation to the same viewport position as it was iconified from. Implementation Notes Module: (app scwm animated-iconify) Defined in scheme/animated-iconify.scm at line 79 (CVS log) animated-deiconify-to-vp-focus Deiconify WIN to the current viewport, and give it the focus. (animated-deiconify-to-vp-focus #&optional (win (get-window))) Description Deiconify WIN to the current viewport, and give it the focus. Implementation Notes Module: Defined in scheme/animated-iconify.scm at line 112 (CVS log) animated-iconify Iconify WIN using a simple animation of a shrinking rectangle. (animated-iconify #&optional (win (get-window))) Description Iconify WIN using a simple animation of a shrinking rectangle. The rectangle moves towards the icon's location, if there is one. Implementation Notes Module: (app scwm animated-iconify) Defined in scheme/animated-iconify.scm at line 51 (CVS log) animated-move-to Move WIN to viewport coordinates X, Y with animation. (animated-move-to x y #&optional (win (get-window)) (move-pointer-too? #t)) Description Move WIN to viewport coordinates X, Y with animation. If X or Y is #f, then do not change that coordinate during the move. At least one of X and Y must be a number. This moves the pointer with the window unless MOVE-POINTER-TOO? is #f. Implementation Notes Module: Defined in scheme/animation.scm at line 46 (CVS log) animated-move-to-center Move WIN to the center of the viewport and update its gravity. (animated-move-to-center #&optional (win (get-window))) Description Move WIN to the center of the viewport and update its gravity. Implementation Notes Module: Defined in scheme/animated-edge-moves.scm at line 77 (CVS log) animated-move-to-e Move WIN to the east edge and update its gravity. (animated-move-to-e #&optional (win (get-window))) Description Move WIN to the east edge and update its gravity. Implementation Notes Module: (app scwm animated-edge-moves) Defined in scheme/animated-edge-moves.scm at line 53 (CVS log) animated-move-to-n Move WIN to the north edge and update its gravity. (animated-move-to-n #&optional (win (get-window))) Description Move WIN to the north edge and update its gravity. Implementation Notes Module: (app scwm animated-edge-moves) Defined in scheme/animated-edge-moves.scm at line 45 (CVS log) animated-move-to-ne Move WIN to the northeast edge and update its gravity. (animated-move-to-ne #&optional (win (get-window))) Description Move WIN to the northeast edge and update its gravity. Implementation Notes Module: (app scwm animated-edge-moves) Defined in scheme/animated-edge-moves.scm at line 20 (CVS log) animated-move-to-nw Move WIN to the northwest edge and update its gravity. (animated-move-to-nw #&optional (win (get-window))) Description Move WIN to the northwest edge and update its gravity. Implementation Notes Module: (app scwm animated-edge-moves) Defined in scheme/animated-edge-moves.scm at line 12 (CVS log) animated-move-to-s Move WIN to the south edge and update its gravity. (animated-move-to-s #&optional (win (get-window))) Description Move WIN to the south edge and update its gravity. Implementation Notes Module: (app scwm animated-edge-moves) Defined in scheme/animated-edge-moves.scm at line 61 (CVS log) animated-move-to-se Move WIN to the southeast edge and update its gravity. (animated-move-to-se #&optional (win (get-window))) Description Move WIN to the southeast edge and update its gravity. Implementation Notes Module: (app scwm animated-edge-moves) Defined in scheme/animated-edge-moves.scm at line 36 (CVS log) animated-move-to-sw Move WIN to the southwest edge and update its gravity. (animated-move-to-sw #&optional (win (get-window))) Description Move WIN to the southwest edge and update its gravity. Implementation Notes Module: (app scwm animated-edge-moves) Defined in scheme/animated-edge-moves.scm at line 28 (CVS log) animated-move-to-w Move WIN to the west edge and update its gravity. (animated-move-to-w #&optional (win (get-window))) Description Move WIN to the west edge and update its gravity. Implementation Notes Module: (app scwm animated-edge-moves) Defined in scheme/animated-edge-moves.scm at line 69 (CVS log) animated-move-window Move WIN to virtual coordinates X, Y with animation. (animated-move-window x y #&optional win move-pointer-too?) Description Move win to virtual coordinates x, y with animation. If x or y is #f, then do not change that coordinate during the move. If move-pointer-too? is specified and true, move the mouse pointer by the same amount as the window, animating the motion of the pointer along with the window. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Primitive from (app scwm c-animation) Defined in modules/c-animation/c-animation.c at line 477 (CVS log) animated-resize-frame Resize the frame of WIN to size W, H (pixels) with animation. (animated-resize-frame w h #&optional win x y move-pointer-too?) Description Resize the frame of win to size w, h (pixels) with animation. win defaults to the window context in the usual way if not specified. If x and y are given, they are a new virtual position for the northwest corder of the window. If move-pointer-too? is specified and true, move the mouse pointer by the same amount as the window, animating the motion of the pointer along with the window. Implementation Notes Module: Primitive from (app scwm c-animation) Defined in modules/c-animation/c-animation.c at line 603 (CVS log) animated-resize-window Resize the client area of WIN to size W, H (pixels) with animation. (animated-resize-window w h #&optional win x y move-pointer-too?) Description Resize the client area of win to size w, h (pixels) with animation. win defaults to the window context in the usual way if not specified. If x and y are given, they are a new virtual position for the northwest corder of the window. If move-pointer-too? is specified and true, move the mouse pointer by the same amount as the window, animating the motion of the pointer along with the window. Implementation Notes Module: Primitive from (app scwm c-animation) Defined in modules/c-animation/c-animation.c at line 588 (CVS log) animated-toggle-iconify Iconify WIN if not iconified, or de-iconify WIN if it is iconified. (animated-toggle-iconify #&optional (win (get-window))) Description Iconify WIN if not iconified, or de-iconify WIN if it is iconified. Uses animation, in either case. Implementation Notes Module: (app scwm animated-iconify) Defined in scheme/animated-iconify.scm at line 102 (CVS log) animated-window-shade Cause WIN to become "window-shaded". (animated-window-shade #&optional win) Description Cause win to become "window-shaded". That is, to roll up into just a titlebar. The window will be animated as it rolls up, producing a pleasing visual effect. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Primitive from (app scwm c-animation) Defined in modules/c-animation/c-animation.c at line 341 (CVS log) animated-window-unshade Reverse the effect of window-shade on WIN. (animated-window-unshade #&optional win) Description Reverse the effect of window-shade on win. The window will be animated as it rolls down, producing a pleasing visual effect. win defaults to the window context in the usual way if not specified. See also window-unshade, animated-window-shade. Implementation Notes Module: Primitive from (app scwm c-animation) Defined in modules/c-animation/c-animation.c at line 400 (CVS log) any-id->window Return the window object that contains the window with id WINDOW-ID. (any-id->window window-id) Description Return the window object that contains the window with id window-id. window-id can be the X id of any child window in the application. If there is no such window object, return #f. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2822 (CVS log) append-fvwm2-module-config No documentation supplied. (append-fvwm2-module-config module-type . args) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 416 (CVS log) append-hook! Add PROC to HOOK at the end of the list. (append-hook! hook proc) Description Add PROC to HOOK at the end of the list. Implementation Notes Module: Defined in scheme/minimal.scm at line 131 (CVS log) append-hook-once! Append PROC to HOOK only if it does not contain PROC already. (append-hook-once! hook proc) Description Append PROC to HOOK only if it does not contain PROC already. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 56 (CVS log) append-map Do the same thing as map, but collect results with append, not cons. (append-map proc first . rest) Description Do the same thing as map, but collect results with append, not cons. In particular, PROC is applied in succession to each member of FIRST and the corresponding members of REST if any, and is expected to return a list. These lists are concatenated together with append. In effect, this is a version of map that allows the mapping function to return any number of elements to be inserted into the result list, including possibly none. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 73 (CVS log) apply-fancy-resize-cursors Use the fancy resize cursors for WIN. (apply-fancy-resize-cursors #&optional (win (get-window))) Description Use the fancy resize cursors for WIN. Implementation Notes Module: (app scwm cursor) Defined in scheme/cursor.scm at line 24 (CVS log) apply-style No documentation supplied. (apply-style style win) Description No documentation supplied. Implementation Notes Module: (app scwm style) Defined in scheme/style.scm at line 136 (CVS log) apropos-internal-with-modules Return a list of accessible variable names and the modules they are defined in. (apropos-internal-with-modules rgx) Description Return a list of accessible variable names and the modules they are defined in. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 153 (CVS log) ask-string Ask for a string with PROMPT. (ask-string prompt) Description Ask for a string with PROMPT. Implementation Notes Module: (app scwm prefs-menu) Defined in scheme/prefs-menu.scm at line 138 (CVS log) at-point-placement Return a procedure that places a window at the pointer position. (at-point-placement #&key (offset '(0 0)) (proportional-offset '(-0.5 -0.5)) (switch #t) (return #f) (auto-focus #f)) Description Return a procedure that places a window at the pointer position. If the keyword argument OFFSET is specified, it is interpreted as a list of x and y offsets to add to the pointer position. If the keyword argument PROPORTIONAL-OFFSET is specified, it is interpreted as a list of numbers to multiply by the window's width and height, and is treated as an extra offset.The defaults are (0 0) for OFFSET and (-0.5 -0.5) for PROPORTIONAL-OFFSET, with the result that by default the window is centered at the mouse pointer position by the returned procedure. If SWITCH is true, the returned procedure will switch to the virtual desk and viewport of its window argument before placing it. This is the default. If RETURN is false, the returned procedure will switch back to the previous desk and viewport after placing the window. The default is false. See also the related place-at-point procedure which directly places a window at the pointer position. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 131 (CVS log) at-virtual-offset-placement Return a procedure that takes a window and places it at virtual offset X, Y. (at-virtual-offset-placement x y) Description Return a procedure that takes a window and places it at virtual offset X, Y. The procedure will act just like calling move-window on the window with the same X and Y arguments. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 90 (CVS log) at-vp-offset-placement Return a procedure that takes a window and places it at viewport offset X, Y. (at-vp-offset-placement x y) Description Return a procedure that takes a window and places it at viewport offset X, Y. The procedure will act just like calling move-window-viewport-position on the window with the same X and Y arguments. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 96 (CVS log) auto-accept-dialog-placement Return a procedure that auto-accepts a dialog box window. (auto-accept-dialog-placement #&optional (delay 500)) Description Return a procedure that auto-accepts a dialog box window. DELAY is the number of msec to delay before sending the "Return" keystroke to accept the dialog. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 162 (CVS log) background-system Run CMD using /bin/sh -c CMD and return the exit status. (background-system command) Description Run CMD using /bin/sh -c CMD and return the exit status. The CMD is run synchronously, and Bourne-shell meta characters are interpreted by /bin/sh. E.g., to start CMD in the background, use a trailing "&" character. See also guile's system, but note that it may permit signals on the controlling tty to be seen by children (observed on Linux, Free/NetBSD, but not on Solaris or HP/UX. This may be a bug (not meeting POSIX.2 specifications). Returns the child-pid, or #f if the fork fails. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 770 (CVS log) beep Ring the standard X bell. (beep) Description Ring the standard X bell. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 285 (CVS log) bell Ring the X11 bell (just calls beep). (bell) Description Ring the X11 bell (just calls beep). Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 698 (CVS log) binary Return the integer that corresponds to string NUMBER as a binary value. (binary number) Description Return the integer that corresponds to string NUMBER as a binary value. Implementation Notes Module: Defined in scheme/number-convert.scm at line 62 (CVS log) binary-read Reads LENGTH bytes of binary data from PORT and return it as a string. (binary-read length #&optional (port (current-input-port))) Description Reads LENGTH bytes of binary data from PORT and return it as a string. Implementation Notes Module: (app scwm bincomm) Defined in scheme/bincomm.scm at line 175 (CVS log) binary-read-long Reads a binary representation of a C long and return as a scheme number. (binary-read-long #&optional (port (current-input-port))) Description Reads a binary representation of a C long and return as a scheme number. The value is read from PORT, or the current-input-port. Implementation Notes Module: Defined in scheme/bincomm.scm at line 185 (CVS log) binary-write Writes STR as binary data to PORT. (binary-write str #&optional (port (current-output-port))) Description Writes STR as binary data to PORT. Implementation Notes Module: (app scwm bincomm) Defined in scheme/bincomm.scm at line 170 (CVS log) bind-four-modifier-key-events Bind PROC-PRESS and PROC-RELEASE to be invoked on a multi-modifier key event. (bind-four-modifier-key-events modkey1 modkey2 modkey3 modkey4 proc-press proc-release) Description Bind PROC-PRESS and PROC-RELEASE to be invoked on a multi-modifier key event. MODKEY1, MODKEY2, MODKEY3, MODKEY4 are the four modifiers that, when pressed at the same time, will invoke PROC-PRESS. When either is released, PROC-RELEASE is invoked. Implementation Notes Module: (app scwm modifier-key-bindings) Defined in scheme/modifier-key-bindings.scm at line 108 (CVS log) bind-key Bind the given KEY within the CONTEXTS to invoke PROC. (bind-key contexts key proc #&optional release-proc) Description Bind the given key within the contexts to invoke proc. Return value is #t if the binding was made successfully, #f otherwise (e.g., if unbound modifiers or an unknown keysym is used, the binding will fail). contexts is a list of event-contexts (e.g., '(left-button-1 frame-sides)) key is a string giving the key-specifier (e.g., M-Delete for Meta+Delete) proc is a procedure that will be invoked (with no arguments) when the specified key is pressed in the specified context. The optional argument release-proc, if specified, is a procedure that will be invoked when the key is released. The contexts include: 'window 'title 'icon 'root 'frame-corners 'frame-sides 'client-window 'root-window 'left-button-N (N=1-5) 'right-button-N (N=1-5) Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1031 (CVS log) bind-keycode Bind the given KEYCODE within the CONTEXTS to invoke PROC. (bind-keycode contexts keycode modifier-mask proc #&optional release-proc) Description Bind the given keycode within the contexts to invoke proc. contexts is a list of event-contexts (e.g., '(button1 sidebar)) keycode is an X/11 key code, modifier-mask is the bitmask of modifiers, proc is a procedure that will be invoked (with no arguments) when the specified key is pressed in the specified context. release-proc is a procedure that will be invoked (with no arguments) when the specified key is released in the specified context, or #f or omitted if nothing should be done on key release. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1107 (CVS log) bind-mouse Bind the given mouse BUTTON within the CONTEXTS to invoke PROC. (bind-mouse contexts button proc #&optional immediate-proc) Description Bind the given mouse button within the contexts to invoke proc. contexts is a list of event-contexts (e.g., '(button1 sidebar)) button is a string or integer giving the mouse button number proc is a procedure that will be invoked (with no arguments) when the specified button is pressed in the specified context. See bind-key for a list of the contexts. If immediate-proc is given, it will be executed immediately on a button-click. If immediate-proc returns #f, then proc will still get executed after determining the mouse click type. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1161 (CVS log) bind-three-modifier-key-events Bind PROC-PRESS and PROC-RELEASE to be invoked on a multi-modifier key event. (bind-three-modifier-key-events modkey1 modkey2 modkey3 proc-press proc-release) Description Bind PROC-PRESS and PROC-RELEASE to be invoked on a multi-modifier key event. MODKEY1, MODKEY2, MODKEY3 are the three modifiers that, when pressed at the same time, will invoke PROC-PRESS. When either is released, PROC-RELEASE is invoked. Implementation Notes Module: (app scwm modifier-key-bindings) Defined in scheme/modifier-key-bindings.scm at line 62 (CVS log) bind-two-modifier-key-events Bind PROC-PRESS and PROC-RELEASE to be invoked on a multi-modifier key event. (bind-two-modifier-key-events modkey1 modkey2 proc-press proc-release) Description Bind PROC-PRESS and PROC-RELEASE to be invoked on a multi-modifier key event. MODKEY1 and MODKEY2 are the two modifiers that, when pressed at the same time, will invoke PROC-PRESS. When either is released, PROC-RELEASE is invoked. Implementation Notes Module: (app scwm modifier-key-bindings) Defined in scheme/modifier-key-bindings.scm at line 23 (CVS log) bind-wheel-mouse-prior-next No documentation supplied. (bind-wheel-mouse-prior-next matching-proc) Description No documentation supplied. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 373 (CVS log) bool->string Return the string "false" if ARG is #f, "true" otherwise. (bool->string arg) Description Return the string "false" if ARG is #f, "true" otherwise. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 25 (CVS log) border-normal? Return #t if WIN has a normal border, #f if it has a plain border. (border-normal? #&optional win) Description Return #t if win has a normal border, #f if it has a plain border. win defaults to the window context in the usual way if not specified. See normal-border and plain-border. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3295 (CVS log) border-style Set the border style in the current decor. (border-style #&key (active '()) (inactive '()) #&allow-other-keys #&rest rest) Description Set the border style in the current decor. This function takes the keyword arguments #:hidden-handles, #:no-inset, and #:pixmap, with effects as described under the `Face Flags' and `Face Specification Flags' concepts (except that #:pixmap is always tiled). These keyword arguments can either be included in the main argument list, or lists of these arguments can be used as the ACTIVE or INACTIVE arguments. Implementation Notes Module: (app scwm face) Defined in scheme/face.scm at line 69 (CVS log) button-item Create a button item for a ScwmButtons window. (button-item pixmap-file #&key (action noop) (tooltip #f)) Description Create a button item for a ScwmButtons window. Implementation Notes Module: Defined in scheme/ScwmButtons.scm at line 189 (CVS log) button-style Set the button style for button number BUTTON in the current decor. (button-style button #&key mwm (active-up '()) (active-down '()) (inactive '()) #&allow-other-keys #&rest rest) Description Set the button style for button number BUTTON in the current decor. MWM sets the button's mwm flag (see set-button-mwm-flag!. This function also takes the keyword arguments #:justify, #:relief, #:vertical-justify, #:use-style-of, #:solid, #:gradient, #:h-gradient, #:v-gradient, #:relief-pattern, #:vector, #:pixmap, and #:tiled-pixmap, with effects as described under the `Face Flags' and `Face Specification Flags' concepts (with the additions that #:tiled-pixmap is an always-tiled pixmap, #:vector is a synonym for #:relief-pattern, and #:h-gradient and #:v-gradient are horizontal and vertical gradients). These extra keyword arguments can either be included in the main argument list, or lists of these arguments can be used as the ACTIVE-UP, ACTIVE-DOWN, or INACTIVE arguments. Implementation Notes Module: (app scwm face) Defined in scheme/face.scm at line 104 (CVS log) cached-program-exists? Return #t if PROGRAM-NAME is in the cache of programs that exist. (cached-program-exists? program-name) Description Return #t if PROGRAM-NAME is in the cache of programs that exist. Returns #f otherwise. If debug-program-cache is true, a message will print to stdout on hits and misses. You must call initialize-programs-that-exist before calling this function; otherwise, it reverts to the (inefficient) implementation of program-exists?. Implementation Notes Module: Defined in scheme/path-cache.scm at line 41 (CVS log) call-interactively Invoke THUNK interactively. (call-interactively thunk #&optional debug) Description Invoke thunk interactively. thunk can be either a procedure or a symbol. If it is a symbol it is dereferenced. Write a debug message if debug is #t. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 853 (CVS log) call-with-decor Eval THUNK using DECOR as the current decor. (call-with-decor decor thunk) Description Eval THUNK using DECOR as the current decor. Implementation Notes Module: (app scwm decor) Defined in scheme/decor.scm at line 28 (CVS log) capturing? Returns #t when the windows are being captured. (capturing?) Description Returns #t when the windows are being captured. This happens at two times: during initial startup, or during a recapture operation. In either case, placement procedures should probably avoid interaction and perhaps avoid moving the window being placed at all. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 149 (CVS log) cascade Cascade the windows on the specified desk. (cascade #&key (only ()) (except ()) (by-stacking #f) (by-focus #f) (reverse #f) (all-viewports #f) (desk (current-desk)) (ignore-default-exceptions #f) (start-pos '(0 0)) (max-size (display-size)) (resize #f) (raise #t) (x-increment (meta-apply + window-title-height window-frame-border-width)) (y-increment (meta-apply + window-title-height window-frame-border-width))) Description Cascade the windows on the specified desk. The DESK option, defaulting to the current desk, specifies which desk; ALL-VIEWPORTS, when true indicates that the windows in all viewports of this desk should be cascaded, otherwise only the current viewport is cascaded. The options ONLY, EXCEPT, BY-STACKING, BY-FOCUS and REVERSE indicate the windows to use and the order to use them in, as with list-windows. However, unless IGNORE-DEFAULT-EXCEPTIONS is #t, transient, maximized, sticky and iconified windows will be always be excluded. START-POS, MAX-SIZE, RESIZE, RAISE, X-INCREMENT and Y-INCREMENT control the cascading options as for cascade-windows. Implementation Notes Module: (app scwm cascade) Defined in scheme/cascade.scm at line 100 (CVS log) cascade-windows Cascade WINDOWS according to several parameters. (cascade-windows windows #&key (start-pos '(0 0)) (max-size (display-size)) (resize 'shrink-only) (raise 'restack-only) (x-increment (meta-apply + window-title-height window-frame-border-width)) (y-increment (meta-apply + window-title-height window-frame-border-width))) Description Cascade WINDOWS according to several parameters. Cascading places the windows in a diagonal order starting at START-POS, (0 0) by default. Each window's size is limited to MAX-SIZE, by default the display size. RESIZE may be #f, 'shrink-only or 'always, indicating that the windows should never be resized, that they should be resized to the max-size only if they are bigger, or that they should always be resized to the max size. The default is 'shrink-only. RAISE may be #f, #t, or 'restack-only, indicating that the windows should not be moved in the stacking order; that they should be raised on top of other windows and placed in the cascade order with the upper left window lowest in the stacking order; or that they should be restacked as for #t but not raised above other windows, respectively. The default is 'restack-only. X-INCREMENT may be an integer or a procedure that takes a window and returns an integer, and which will be applied to a window to get the horizontal offset for the next in the cascade order. The default is the sum of the window's border width and title height. Y-INCREMENT may be an integer or a procedure that takes a window and returns an integer, and which will be applied to a window to get the vertical offset for the next in the cascade order. The default is the sum of the window's border width and title height. Implementation Notes Module: (app scwm cascade) Defined in scheme/cascade.scm at line 41 (CVS log) cascade-windows-interactively Cascade a set of selected windows. (cascade-windows-interactively . args) Description Cascade a set of selected windows. The windows used are selected either by selected-windows-list or select-window-group. If selected-windows-list is empty, then select-window-group is used. See also the undo module and insert-undo-global to save the window configuration before executing this in case the effect is not what you expected. Implementation Notes Module: Defined in scheme/cascade.scm at line 145 (CVS log) caught-error No documentation supplied. (caught-error descriptor args) Description No documentation supplied. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 813 (CVS log) cgi-escapify-space Replace spaces in URI with the + escape code. (cgi-escapify-space uri) Description Replace spaces in URI with the + escape code. This is useful since netscape's remote command invocation does a stupid syntactic scan of the passed url and treats commas as argument command separators, so the url gets chopped off at the first literal comma. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 100 (CVS log) change-ui-constraints-buttons No documentation supplied. (change-ui-constraints-buttons #&key (vertical toggle-vertical) (pixmap toggle-pixmap)) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-buttons) Defined in scheme/ui-constraints-buttons.scm at line 188 (CVS log) char-value Return the integer that corresponds to the Ascii code for CH. (char-value ch) Description Return the integer that corresponds to the Ascii code for CH. Implementation Notes Module: (app scwm number-convert) Defined in scheme/number-convert.scm at line 28 (CVS log) choices-from-favorites No documentation supplied. (choices-from-favorites fav) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 91 (CVS log) chop-newline Return STR up to but not including the first newline character. (chop-newline str) Description Return STR up to but not including the first newline character. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 62 (CVS log) chop-string No documentation supplied. (chop-string str) Description No documentation supplied. Implementation Notes Module: (app scwm flux-gtk) Defined in scheme/flux-gtk.scm at line 54 (CVS log) circulate-hit Include WIN among the windows in the circulate list. (circulate-hit #&optional (win (get-window))) Description Include WIN among the windows in the circulate list. This resets the 'circulate-skip property of WIN. See also circulate-skip. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 92 (CVS log) circulate-hit-icon Include WIN's icon among the windows in the circulate list. (circulate-hit-icon #&optional (win (get-window))) Description Include WIN's icon among the windows in the circulate list. This resets the 'circulate-skip-icon property of WIN. See also circulate-skip-icon. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 107 (CVS log) circulate-skip Do not include WIN among the windows in the circulate list. (circulate-skip #&optional (win (get-window))) Description Do not include WIN among the windows in the circulate list. This sets the 'circulate-skip property of WIN. See also circulate-hit. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 97 (CVS log) circulate-skip-icon Do not include WIN's icon among the windows in the circulate list. (circulate-skip-icon #&optional (win (get-window))) Description Do not include WIN's icon among the windows in the circulate list. This sets the 'circulate-skip-icon property of WIN. See also circulate-hit-icon. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 113 (CVS log) circulate-skip-icon? Return #t if WIN's icon is not among the windows in the circulate list. (circulate-skip-icon? #&optional (win (get-window))) Description Return #t if WIN's icon is not among the windows in the circulate list. Otherwise return #f. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 119 (CVS log) circulate-skip? Return #t if WIN is not among the windows in the circulate list. (circulate-skip? #&optional (win (get-window))) Description Return #t if WIN is not among the windows in the circulate list. Otherwise return #f. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 102 (CVS log) cl-set-solver-var Set solver S's variable CLV to value VALUE. (cl-set-solver-var s clv value) Description Set solver S's variable CLV to value VALUE. Implementation Notes Module: Defined in scheme/simple-constraints.scm at line 149 (CVS log) class-match?? Return a predicate that tests a window's resource class. (class-match?? STRING TYPE CASE-SENSITIVE?) Description Return a predicate that tests a window's resource class. When applied to a window, this predicate will return true if the resource class matches STRING in the manner specified by the optional argument TYPE, which may be 'exact, 'regexp, or 'wildcard. The optional CASE-SENSITIVE argument determines whether the matching is case-sensitive or not. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 312 (CVS log) clear-color-cache-entry Colors are cached by name. (clear-color-cache-entry name) Description Colors are cached by name. It is remotely possible that the meaning of a particular string as a color will change in your X server, if you try hard enough. For this unlikely eventuality, clear-color-cache-entry is provided - it removes the color associated with name from the color cache Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 272 (CVS log) clear-font-cache-entry Fonts are cached by name. (clear-font-cache-entry name) Description Fonts are cached by name. It is remotely possible that the meaning of a particular string as a fonts will change in your X server, if you try hard enough (perhaps if you add or remove font servers). For this unlikely eventuality, clear-font-cache-entry is provided - it removes the font associated with name from the font cache Implementation Notes Module: Built-in Primitive Defined in src/font.c at line 306 (CVS log) clear-fvwm2-module-config No documentation supplied. (clear-fvwm2-module-config module-type) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 420 (CVS log) clear-image-cache-entry Images are cached by both name and full pathname. (clear-image-cache-entry name) Description Images are cached by both name and full pathname. It is remotely possible that the file that should be used for a particular name will change, for example if you alter the image file or change your image path. For this unlikely eventuality, clear-image-cache-entry is provided - it removes the image associated with name from the image cache Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 633 (CVS log) clear-window-style No documentation supplied. (clear-window-style) Description No documentation supplied. Implementation Notes Module: (app scwm style) Defined in scheme/style.scm at line 66 (CVS log) clever-place-window Places WIN using fvwm2's "ReallySmart" algorithm. (clever-place-window win #&optional no-move x-sugg y-sugg) Description Places win using fvwm2's "ReallySmart" algorithm. The placement is just as if being placed by fvwm2's SmartPlacement, as if SmartPlacementIsReallySmart were in effect. That is, it tries to place the window so as to minimize its area of overlap with other windows. Several parameters give different weight to various kinds of windows, but they are not tunable at runtime currently. If it fails to place the window, it returns #f; otherwise it returns #t. If no-move is #t, then the position is returned instead of actually moving the window to that position. This can be useful for finding a new location for an existing window. x-sugg and y-sugg are suggested coordinates that clever-place-window may try to use as a preferred location for win. Implementation Notes Module: Built-in Primitive Defined in src/placement.c at line 490 (CVS log) click-delay Returns the delay used in identifying mouse clicks and drags, in milliseconds. (click-delay) Description Returns the delay used in identifying mouse clicks and drags, in milliseconds. See also set-click-delay! Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 191 (CVS log) click-to-focus-passes-click? Returns #t iff a click-to-focus window is sent the click, else #f. (click-to-focus-passes-click?) Description Returns #t iff a click-to-focus window is sent the click, else #f. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 311 (CVS log) click-to-focus-raises? Returns #t iff a click-to-focus window gets raised on focus, else #f. (click-to-focus-raises?) Description Returns #t iff a click-to-focus window gets raised on focus, else #f. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 338 (CVS log) client-hostname-match?? Return a predicate that tests a window's client hostname. (client-hostname-match?? STRING TYPE CASE-SENSITIVE?) Description Return a predicate that tests a window's client hostname. When applied to a window, this predicate will return true if the client hostname matches STRING in the manner specified by the optional argument TYPE, which may be 'exact, 'regexp, or 'wildcard. The optional CASE-SENSITIVE argument determines whether the matching is case-sensitive or not. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 339 (CVS log) clist-find Return the row number of the first row in CLIST that PRED answers #t for. (clist-find clist cols pred) Description Return the row number of the first row in CLIST that PRED answers #t for. PRED is called with arguments that are strings of the first COLS columns of successive rows of CLIST. Returns -1 if PRED never evaluates to #t. Implementation Notes Module: (app scwm prompt-binding) Defined in scheme/prompt-binding.scm at line 50 (CVS log) clist-set-row-text Set the text of ROW of CLIST to COLS. (clist-set-row-text clist row cols) Description Set the text of ROW of CLIST to COLS. COLS is a list of strings. Implementation Notes Module: (app scwm prompt-binding) Defined in scheme/prompt-binding.scm at line 68 (CVS log) clone-resized-image Makes a new image from IMAGE of the given WIDTH and HEIGHT. (clone-resized-image image width height #&optional bgcolor) Description Makes a new image from image of the given width and height. It does not scale image. If the resized image is smaller than the original, it is cropped; if larger, the extra space in the new image is filled with bgcolor. See also clone-scaled-image. Implementation Notes Module: Primitive from (app scwm background) Defined in modules/background/background.c at line 76 (CVS log) clone-scaled-image Returns a copy of IMAGE scaled to have dimensions WIDTH by HEIGHT. (clone-scaled-image image width height) Description Returns a copy of image scaled to have dimensions width by height. See also clone-resized-image from the background module. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 683 (CVS log) close-all-xlogo-windows Close each window with class == XLogo. (close-all-xlogo-windows) Description Close each window with class == XLogo. Greg uses XLogo windows as a sample window, so this is useful for clearing the xlogos away when there get to be more than desired. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 268 (CVS log) close-ScwmBiff Close the ScwmBiff notification window. (close-ScwmBiff sb) Description Close the ScwmBiff notification window. Implementation Notes Module: (app scwm ScwmBiff) Defined in scheme/ScwmBiff.scm at line 97 (CVS log) close-ScwmButtons Close the ScwmButtons window of SB. (close-ScwmButtons sb) Description Close the ScwmButtons window of SB. SB should be a handle returned from run-ScwmButtons. Implementation Notes Module: (app scwm ScwmButtons) Defined in scheme/ScwmButtons.scm at line 184 (CVS log) close-ScwmClock Close the ScwmClock with handle SC. (close-ScwmClock sc) Description Close the ScwmClock with handle SC. Implementation Notes Module: (app scwm ScwmClock) Defined in scheme/ScwmClock.scm at line 75 (CVS log) close-ScwmDeskButtons Close a ScwmDeskButtons object that was returned from run-ScwmDeskButtons. (close-ScwmDeskButtons sdb) Description Close a ScwmDeskButtons object that was returned from run-ScwmDeskButtons. Implementation Notes Module: Defined in scheme/ScwmDeskButtons.scm at line 67 (CVS log) close-ui-constraints-buttons No documentation supplied. (close-ui-constraints-buttons) Description No documentation supplied. Implementation Notes Module: Defined in scheme/ui-constraints-buttons.scm at line 201 (CVS log) close-window Close WIN either by deleting it or destroying it. (close-window #&optional (win (get-window #t #t #t))) Description Close WIN either by deleting it or destroying it. WIN is only destroyed if it is not deleteable. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 54 (CVS log) close-window-and-pop-focus Close WIN and pop the focus with pop-focus-window. (close-window-and-pop-focus #&optional (win (or (window-with-focus) (window-with-pointer)))) Description Close WIN and pop the focus with pop-focus-window. Implementation Notes Module: Defined in scheme/focus-stack.scm at line 50 (CVS log) cncat No documentation supplied. (cncat list) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-composition) Defined in scheme/ui-constraints-composition.scm at line 159 (CVS log) color->string Convert scwm color object COLOR into an X11 name of that color. (color->string color) Description Convert scwm color object COLOR into an X11 name of that color. The resulting string can, e.g., be used in command lines for executing other applications. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 29 (CVS log) color-properties Return an association list giving some properties of COLOR. (color-properties color) Description Return an association list giving some properties of color. Currently defined properties are 'name, the string name of the color, and 'pixel, the X pixel value it uses. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 122 (CVS log) color-property Return the KEY property of COLOR. (color-property color key) Description Return the KEY property of COLOR. See color-properties for a list of the keys. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 604 (CVS log) color? Returns #t if OBJ is a color object, otherwise #f. (color? obj) Description Returns #t if obj is a color object, otherwise #f. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 110 (CVS log) colormap-focus Return the colormap focus policy, as set by set-colormap-focus!. (colormap-focus) Description Return the colormap focus policy, as set by set-colormap-focus!. The value can be either be 'mouse, indicating that the window under the mouse pointer will always colormap installed, or 'focus to indicate that the window with the input focus should also get the colormap focus. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 225 (CVS log) config-request-animate A procedure for X-ConfigureRequest-hook to do window configuration animatedly. (config-request-animate win icon? x y width height) Description A procedure for X-ConfigureRequest-hook to do window configuration animatedly. Use add-hook! to attach this to X-ConfigureRequest-hook. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 446 (CVS log) constrained-window-in-focus? Returns #t if one of the windows in the constraint is in focus. (constrained-window-in-focus? ui-constraint) Description Returns #t if one of the windows in the constraint is in focus. Returns #f otherwise or if UI-CONSTRAINT is not a ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 547 (CVS log) constraint-satisfied? Returns the status of whether a UI-CONSTRAINT is satisfied. (constraint-satisfied? ui-constraint) Description Returns the status of whether a UI-CONSTRAINT is satisfied. errors if UI-CONSTRAINT is not an ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 525 (CVS log) containing-aligned-viewport Compute the viewport-position of the viewport that contains POS. (containing-aligned-viewport pos) Description Compute the viewport-position of the viewport that contains POS. POS is a list of x and y virtual coordinates in that order. The viewport coordinates returned will be in the same format and will be a integral multiples of the desk size. If POS is not contained in any valid viewport, for instance if it includes coordinates greater than zero or greater than the desk size times the display size, the nearest viewport will be returned instead. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 34 (CVS log) context->brief-context No documentation supplied. (context->brief-context context) Description No documentation supplied. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 234 (CVS log) context->string No documentation supplied. (context->string context) Description No documentation supplied. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 239 (CVS log) copy-menu-look Copy menu look ORIGINAL-MENU-LOOK with a new NAME and optional EXTRA. (copy-menu-look original-menu-look name #&optional extra) Description Copy menu look original-menu-look with a new name and optional extra. If extra is not given, the extra information from the original menu is used. The form and purpose of the extra information varies with the menu look, and is documented with the original menu looks; currently, only the Xpm menu look uses the extra information. Implementation Notes Module: Built-in Primitive Defined in src/menulook.c at line 93 (CVS log) copy-window-configuration Apply a saved state CONFIGURATION to window WIN. (copy-window-configuration configuration #&optional (win (get-window))) Description Apply a saved state CONFIGURATION to window WIN. Implementation Notes Module: (app scwm window-configuration) Defined in scheme/window-configuration.scm at line 53 (CVS log) copy-window-title-to-cut-buffer Set X cut buffer to be a string that is the title of WINDOW. (copy-window-title-to-cut-buffer #&optional (window (get-window))) Description Set X cut buffer to be a string that is the title of WINDOW. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 30 (CVS log) corba-evaluator-ior Returns the "IOR" string for the scwm-scheme-evaluator servant. (corba-evaluator-ior) Description Returns the "IOR" string for the scwm-scheme-evaluator servant. Implementation Notes Module: Primitive from (app scwm corba) Defined in modules/corba/scwmcorba.c at line 114 (CVS log) create-pixmap-cursor Create and return a new cursor object from the pixmap image. (create-pixmap-cursor image #&optional fg-color bg-color x-hotspot y-hotspot) Description Create and return a new cursor object from the pixmap image. image specifies the look of the cursor that will be returned. fg-color and bg-color specify the foreground and background colors respectively. x-hotspot, y-hotspot give the x and y offset for the cursor's hot spot (from the top-left of the cursor). Implementation Notes Module: Built-in Primitive Defined in src/cursor.c at line 269 (CVS log) current-decor Return the current decor. (current-decor) Description Return the current decor. Implementation Notes Module: Built-in Primitive Defined in src/decor.c at line 259 (CVS log) current-desk Returns the integer identifying the current desk. (current-desk) Description Returns the integer identifying the current desk. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 81 (CVS log) current-viewport-offset-xx Return the current viewport horizontal offset as a multiple of the display width. (current-viewport-offset-xx) Description Return the current viewport horizontal offset as a multiple of the display width. The returned value will be a non-negative real number. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 67 (CVS log) current-viewport-offset-yy Return the current viewport vertical offset as a multiple of the display height. (current-viewport-offset-yy) Description Return the current viewport vertical offset as a multiple of the display height. The returned value will be a non-negative real number. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 72 (CVS log) deactivate-ScwmBiff Make ScwmBiff no longer notify, but leave visible. (deactivate-ScwmBiff sb) Description Make ScwmBiff no longer notify, but leave visible. Implementation Notes Module: Defined in scheme/ScwmBiff.scm at line 105 (CVS log) debug-clist-select No documentation supplied. (debug-clist-select clist-name row col event) Description No documentation supplied. Implementation Notes Module: (app scwm prompt-binding) Defined in scheme/prompt-binding.scm at line 174 (CVS log) decrement-in-range Return v-1 but no less than low. (decrement-in-range v low) Description Return v-1 but no less than low. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 48 (CVS log) decrement-undo-index Decrement the undo-index. (decrement-undo-index) Description Decrement the undo-index. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 53 (CVS log) default-decor Return the default decor. (default-decor) Description Return the default decor. Implementation Notes Module: Built-in Primitive Defined in src/decor.c at line 230 (CVS log) default-move-opaquely? Return #t if WIN has area <= *opaque-move-percent* of the screen, else #f. (default-move-opaquely? win) Description Return #t if WIN has area <= *opaque-move-percent* of the screen, else #f. If *opaque-move-percent* is a boolean, not a number, just return it. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 231 (CVS log) default-resize-opaquely? Return #t if WIN has area <= *opaque-resize-percent* of the screen, else #f. (default-resize-opaquely? win) Description Return #t if WIN has area <= *opaque-resize-percent* of the screen, else #f. If *opaque-resize-percent* is a boolean, not a number, just return it. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 222 (CVS log) define-scwm-group-proc Helper procedure for define-scwm-group-- use that instead. (define-scwm-group-proc sym name #&key (docstring #f) (icon #f) (widget #f)) Description Helper procedure for define-scwm-group-- use that instead. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 76 (CVS log) define-scwm-option-proc Helper procedure for define-scwm-option. (define-scwm-option-proc var sym docstring default #&key (type #f) (name #f) (permit-disable #f) (range #f) (favorites #f) (group #f) (layout-hint #f) (setter #f) (getter #f)) Description Helper procedure for define-scwm-option. See define-scwm-option. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 156 (CVS log) deiconify-group Deiconify all members of GROUP. (deiconify-group #&optional (group (get-window)) x y) Description Deiconify all members of GROUP. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 148 (CVS log) deiconify-group-or-window Deiconify WIN, and perhaps all members of its group. (deiconify-group-or-window #&optional (win (get-window)) x y) Description Deiconify WIN, and perhaps all members of its group. If WIN's icon was the result of an iconify-group, all members of the group are deiconified; otherwise, only WIN is affected. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 156 (CVS log) deiconify-to-current-viewport De-iconify WIN and make it visible in the current viewport. (deiconify-to-current-viewport #&optional (win (get-window))) Description De-iconify WIN and make it visible in the current viewport. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 136 (CVS log) deiconify-window Deiconify WIN. (deiconify-window #&optional win x y) Description Deiconify win. Hides its icon, and shows its regular window. win defaults to the window context in the usual way if not specified. If x and y are given, then move win to virtual position (x . y) before de-iconifying. If x is specified, y must be specified, too. These arguments are useful since move-window and move-to will refer to the icon window (not the frame window) if a window is iconified. Without being able to specify a position on de-iconification, the window cannot, e.g., cleanly be brought back onto the current viewport. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2076 (CVS log) delete-all-constraints Delete all constraints in the global instance list. (delete-all-constraints) Description Delete all constraints in the global instance list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 676 (CVS log) delete-duplicates Return a list that has the elements of L with duplicates omitted. (delete-duplicates l) Description Return a list that has the elements of L with duplicates omitted. The first instance of any alement that appears more than once is retained, all other instances are removed. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 220 (CVS log) delete-inferred-ui-constraints-involving-window! Delete all the ui-constraint objects that involve WIN. (delete-inferred-ui-constraints-involving-window! win) Description Delete all the ui-constraint objects that involve WIN. This removes the constraints from the global-constraint-instance-list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 580 (CVS log) delete-multiple-windows-interactively Delete multiple windows as they are interactively clicked on. (delete-multiple-windows-interactively) Description Delete multiple windows as they are interactively clicked on. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 348 (CVS log) delete-ui-constraint! Removes the UI-CONSTRAINT permanently. (delete-ui-constraint! ui-constraint) Description Removes the UI-CONSTRAINT permanently. SIDE-EFFECT: removes instance object from the global list Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 363 (CVS log) delete-ui-constraint-class! Removes UI-CONSTRAINT-CLASS from the global class list. (delete-ui-constraint-class! ui-constraint-class) Description Removes UI-CONSTRAINT-CLASS from the global class list. SIDE-EFFECT: removes class object from the global class list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 131 (CVS log) delete-ui-constraints-involving-window! Delete all the ui-constraint objects that involve WIN. (delete-ui-constraints-involving-window! win) Description Delete all the ui-constraint objects that involve WIN. This removes the constraints from the global-constraint-instance-list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 575 (CVS log) delete-window Request that WIN remove itself from the display. (delete-window #&optional win) Description Request that win remove itself from the display. This is the friendly way of closing a window, but it will not work if the application does not cooperate. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1728 (CVS log) delta-position Return a new coordinate list that is DX,DY offset from XY-LIST. (delta-position xy-list dx dy) Description Return a new coordinate list that is DX,DY offset from XY-LIST. E.g., if XY-LIST is (2 10) and DX is 5, DY is 7, returns (7 17). Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 345 (CVS log) describe-event Display a message giving the bindings of the next event, key or mouse. (describe-event) Description Display a message giving the bindings of the next event, key or mouse. Implementation Notes Module: (app scwm describe) Defined in scheme/describe.scm at line 27 (CVS log) describe-key Display a message giving the bindings of the next key event. (describe-key) Description Display a message giving the bindings of the next key event. Implementation Notes Module: (app scwm describe) Defined in scheme/describe.scm at line 35 (CVS log) describe-mouse Display a message giving the bindings of the next mouse event. (describe-mouse) Description Display a message giving the bindings of the next mouse event. Implementation Notes Module: Defined in scheme/describe.scm at line 42 (CVS log) desk-background Set the background to use on desk DESK. (desk-background desk #&key (reset #f) (color #f) (image #f) (image-style 'centered)) Description Set the background to use on desk DESK. RESET determines whether to reset the background to the standard X crosshatch before enacting any other settings. COLOR is a background color to set, either a color name or a color object. IMAGE is a background image, either an image name or an image object. IMAGE-STYLE is either 'tiled or 'centered. The default may be set by setting the background for DESK #t. Implementation Notes Module: (app scwm desk-background) Defined in scheme/desk-background.scm at line 25 (CVS log) desk-size Returns the size of the current desk. (desk-size) Description Returns the size of the current desk. The returned value is in units of the physical screen size, as a list of the width and the height. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 327 (CVS log) destroy-window Forcibly remove WIN from the screen. (destroy-window #&optional win) Description Forcibly remove win from the screen. This will kill the application without giving it a chance to save its state or do any other shutdown, but is guaranteed to work. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1753 (CVS log) dir-focus Move focus to the closest window in direction DIR. (dir-focus dir #&optional (win (window-with-pointer))) Description Move focus to the closest window in direction DIR. DIR must be one of the symbols 'north, 'south, 'east, or 'west. Implementation Notes Module: (app scwm dir-focus) Defined in scheme/dir-focus.scm at line 50 (CVS log) dir-focus-east Switch focus to the window to the east. (dir-focus-east) Description Switch focus to the window to the east. Implementation Notes Module: Defined in scheme/dir-focus.scm at line 86 (CVS log) dir-focus-north Switch focus to the window to the north. (dir-focus-north) Description Switch focus to the window to the north. Implementation Notes Module: (app scwm dir-focus) Defined in scheme/dir-focus.scm at line 81 (CVS log) dir-focus-south Switch focus to the window to the south. (dir-focus-south) Description Switch focus to the window to the south. Implementation Notes Module: (app scwm dir-focus) Defined in scheme/dir-focus.scm at line 76 (CVS log) dir-focus-west Switch focus to the window to the west. (dir-focus-west) Description Switch focus to the window to the west. Implementation Notes Module: (app scwm dir-focus) Defined in scheme/dir-focus.scm at line 71 (CVS log) disable-all-constraints Disable all constraints in the global instance list. (disable-all-constraints) Description Disable all constraints in the global instance list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 665 (CVS log) disable-auto-unobscure No documentation supplied. (disable-auto-unobscure) Description No documentation supplied. Implementation Notes Module: (app scwm auto-unobscure) Defined in scheme/auto-unobscure.scm at line 62 (CVS log) disable-autosave-netscape-dialog Disable the netscape autosaving "Save as. (disable-autosave-netscape-dialog) Description Disable the netscape autosaving "Save as..." dialog. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 168 (CVS log) disable-gnome-hints Disable support for GNOME hints. (disable-gnome-hints) Description Disable support for GNOME hints. GNOME hint support allows for better integration with the GNOME desktop environment, including support for the GNOME panel and pager applet. Reverses the effect of enable-gnome-hints. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 540 (CVS log) disable-timed-autoshrink-windows Turn off auto-shrinking window behaviour. (disable-timed-autoshrink-windows) Description Turn off auto-shrinking window behaviour. Implementation Notes Module: Defined in scheme/auto-shrink.scm at line 64 (CVS log) disable-ui-constraint Disables the constraint in the constraint solver (disable-ui-constraint ui-constraint) Description Disables the constraint in the constraint solver errors if UI-CONSTRAINT is not a ui-constraint returns the constraint Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 505 (CVS log) display-message-briefly Display MSG in the message window for SEC-TIMEOUT seconds. (display-message-briefly msg #&optional (sec-timeout 3)) Description Display MSG in the message window for SEC-TIMEOUT seconds. See display-message for details about MSG. Implementation Notes Module: (app scwm message-window) Defined in scheme/message-window.scm at line 276 (CVS log) display-size Returns the size of the physical screen in pixels. (display-size) Description Returns the size of the physical screen in pixels. The return value is list of the width and the height. The width is the car, the height is the cadr of the returned list. See also the variables "display-width" and "display-height". Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 341 (CVS log) documentation Print the documentation for the string or symbol. (documentation func #&optional (port (current-output-port))) Description Print the documentation for the string or symbol. Works by searching through the files listed in doc-files. Returns #t if any documentation was found, #f otherwise. Implementation Notes Module: (app scwm doc) Defined in scheme/doc.scm at line 25 (CVS log) done-startup? Return #t iff Scwm is fully initialized, else #f. (done-startup?) Description Return #t iff Scwm is fully initialized, else #f. Windows must all be captured and the startup-hook must have already run for this to return #t. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 617 (CVS log) draw-all-constraints Draw all constraints in the global instance list. (draw-all-constraints #&key (draw-disabled #t)) Description Draw all constraints in the global instance list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 651 (CVS log) draw-constraint Draw the UI-CONSTRAINT. (draw-constraint ui-constraint) Description Draw the UI-CONSTRAINT. error if UI-CONSTRAINT is not an ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 607 (CVS log) draw-constraints-of-window Draw all constraints associated with WIN. (draw-constraints-of-window win #&key (draw-disabled #t)) Description Draw all constraints associated with WIN. If WIN is not specified, the user is prompted to select a window. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 635 (CVS log) draw-line No documentation supplied. (draw-line mx my endx endy) Description No documentation supplied. Implementation Notes Module: (app scwm smart-push) Defined in scheme/smart-push2.scm at line 59 (CVS log) draw-overlay-plane Draw a box in the overlay plane. (draw-overlay-plane) Description Draw a box in the overlay plane. This is just for demonstration and testing purposes for now. Implementation Notes Module: Primitive from (app scwm overlay-plane) Defined in modules/overlay-plane/overlay-plane.c at line 100 (CVS log) dummy-prompt-hbox Create and return a dummy-prompting hbox and entry. (dummy-prompt-hbox prompt initval) Description Create and return a dummy-prompting hbox and entry. PROMPT is the prompt, and INITVAL is the initial string. The returned value is a list: (hbox getter entry). See also prompt-string. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 137 (CVS log) easyraise-window-is-hidden? No documentation supplied. (easyraise-window-is-hidden?) Description No documentation supplied. Implementation Notes Module: (app scwm easyraise) Defined in scheme/easyraise.scm at line 47 (CVS log) easyraise-window? (easyraise-window? #&optional (win (get-window))) Description Implementation Notes Module: (app scwm easyraise) Defined in scheme/easyraise.scm at line 21 (CVS log) edge-move-threshold Return the edge move threshold as set by set-edge-move-threshold!. (edge-move-threshold) Description Return the edge move threshold as set by set-edge-move-threshold!. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 283 (CVS log) edge-scroll-delay Return the edge scroll delay (in ms) as set by set-edge-scroll-delay!. (edge-scroll-delay) Description Return the edge scroll delay (in ms) as set by set-edge-scroll-delay!. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 255 (CVS log) edge-x-scroll Return the horizontal edge scroll increment as set by set-edge-x-scroll!. (edge-x-scroll) Description Return the horizontal edge scroll increment as set by set-edge-x-scroll!. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 147 (CVS log) edge-x-wrap Return the current horizonatal edge wrap setting as set by set-edge-x-wrap!. (edge-x-wrap) Description Return the current horizonatal edge wrap setting as set by set-edge-x-wrap!. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 200 (CVS log) edge-y-scroll Return the vertical edge scroll increment as set by set-edge-y-scroll!. (edge-y-scroll) Description Return the vertical edge scroll increment as set by set-edge-y-scroll!. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 175 (CVS log) edge-y-wrap Return the current vertical edge wrap setting as set by set-edge-y-wrap!. (edge-y-wrap) Description Return the current vertical edge wrap setting as set by set-edge-y-wrap!. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 225 (CVS log) edges->nonant Return a nonant number from a list of edges that are involved. (edges->nonant horiz vert) Description Return a nonant number from a list of edges that are involved. HORIZ can be 'left, 'right. or 'none (or #f). VERT can be 'top, 'bottom, or 'none (or #f). Implementation Notes Module: (app scwm snap-constraints) Defined in scheme/snap-constraints.scm at line 143 (CVS log) elapsed-time Return the elapsed time in milliseconds since O. (elapsed-time) Description Return the elapsed time in milliseconds since O.S. has been up. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 402 (CVS log) enable-all-constraints Enable all constraints in the global instance list. (enable-all-constraints) Description Enable all constraints in the global instance list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 671 (CVS log) enable-auto-unobscure No documentation supplied. (enable-auto-unobscure) Description No documentation supplied. Implementation Notes Module: (app scwm auto-unobscure) Defined in scheme/auto-unobscure.scm at line 58 (CVS log) enable-autosave-netscape-dialog Enable the netscape autosaving "Save as. (enable-autosave-netscape-dialog) Description Enable the netscape autosaving "Save as..." dialog. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 162 (CVS log) enable-dynamic-netscape-actions Enable the netscape download-closed action. (enable-dynamic-netscape-actions) Description Enable the netscape download-closed action. See netscape-download-closed-action. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 174 (CVS log) enable-gnome-hints Enable support for GNOME hints. (enable-gnome-hints) Description Enable support for GNOME hints. GNOME hint support allows for better integration with the GNOME desktop environment, including support for the GNOME panel and pager applet. See also disable-gnome-hints. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 505 (CVS log) enable-image-path-suggestor Turn on the image path suggestor. (enable-image-path-suggestor) Description Turn on the image path suggestor. This can substantially slow down loading of a .scwmrc if there are lots of missing images. Implementation Notes Module: Defined in scheme/image-path-suggestor.scm at line 15 (CVS log) enable-timed-autoshrink-windows Turn on auto-shrinking window behaviour. (enable-timed-autoshrink-windows) Description Turn on auto-shrinking window behaviour. Implementation Notes Module: (app scwm auto-shrink) Defined in scheme/auto-shrink.scm at line 58 (CVS log) enable-ui-constraint Enables the constraint in the constraint solver. (enable-ui-constraint ui-constraint) Description Enables the constraint in the constraint solver. errors if UI-CONSTRAINT is not a ui-constraint. returns the constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 484 (CVS log) enclosing-rectangle Return the smallest rectangle that encloses the windows WINS. (enclosing-rectangle wins) Description Return the smallest rectangle that encloses the windows WINS. Return value's car is the top left of the rectangle, cdr is the bottom right. That is, the returned list is: ((nw-x nw-y) se-x se-y). Implementation Notes Module: Defined in scheme/rectangle.scm at line 31 (CVS log) end-constraints Terminate using the constraint solver. (end-constraints) Description Terminate using the constraint solver. Can restart with a fresh solver by using start-constraints. Implementation Notes Module: (app scwm constraints) Defined in scheme/constraints.scm at line 43 (CVS log) end-highlighting-current-window Remove the hook procedures that make the window with mouse be highlighted. (end-highlighting-current-window #&optional (win current-highlighted-window)) Description Remove the hook procedures that make the window with mouse be highlighted. See also start-highlighting-current-window. Implementation Notes Module: (app scwm highlight-current-window) Defined in scheme/highlight-current-window.scm at line 60 (CVS log) end-highlighting-selected-window Stop highlighting the current window during window selections. (end-highlighting-selected-window) Description Stop highlighting the current window during window selections. Implementation Notes Module: (app scwm highlight-current-window) Defined in scheme/highlight-current-window.scm at line 45 (CVS log) esd-reconnect Connect to the ESound daemon on the machine named HOST. (esd-reconnect #&optional host) Description Connect to the ESound daemon on the machine named host. If host is not set, the $ESPEAKER environmental variable will be used. If this is unset too, localhost is contacted. The esdsound module normally connects at startup. This function is useful if the connection was lost, esd was not running at startup, or its location unknown. Implementation Notes Module: Primitive from (app scwm esdsound) Defined in modules/esdsound/sound.c at line 119 (CVS log) eval-after-load Run PROC after MODULE is loaded. (eval-after-load module proc) Description Run PROC after MODULE is loaded. Run PROC immediately if MODULE has already been loaded. Implementation Notes Module: Defined in scheme/minimal.scm at line 165 (CVS log) eval-expression-interactively Prompt for an expression and evaluate it interactively. (eval-expression-interactively) Description Prompt for an expression and evaluate it interactively. Implementation Notes Module: Defined in scheme/flux.scm at line 475 (CVS log) eval-fvwm-command Evaluate an fvwm2 command. (eval-fvwm-command command #&optional (fmod #f) (window #f)) Description Evaluate an fvwm2 command. Implemented for compatibility with fvwm2 modules, which can send commands back to the window manager for evaluation. Not all fvwm2 commands are implemented; see the end of fvwm-eval.scm for a list of working commands. Implementation Notes Module: Defined in scheme/fvwm-eval.scm at line 546 (CVS log) exe Return a procedure that, when invoked, executes COMMAND in the background. (exe command) Description Return a procedure that, when invoked, executes COMMAND in the background. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 613 (CVS log) exe-on-selection Return a procedure that runs COMMAND in the background on the X selection. (exe-on-selection command #&optional (selection "PRIMARY")) Description Return a procedure that runs COMMAND in the background on the X selection. If there is no selection, then uses the X-cut-buffer-string. SELECTION default to "PRIMARY". Implementation Notes Module: (app scwm std-menus) Defined in scheme/std-menus.scm at line 48 (CVS log) execute Execute COMMAND in the background. (execute command) Description Execute COMMAND in the background. See also execute-with-pidprop if you want to know the process id of COMMAND and want to use window-id to be able to map back from the windows the process creates to the process id. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 755 (CVS log) execute-on-selection Run COMMAND in the background, with arguments supplied by the X selection. (execute-on-selection command #&optional (selection "PRIMARY")) Description Run COMMAND in the background, with arguments supplied by the X selection. If there is no selection, then uses the X-cut-buffer-string. SELECTION default to "PRIMARY". Implementation Notes Module: (app scwm std-menus) Defined in scheme/std-menus.scm at line 37 (CVS log) execute-with-pidprop Execute COMMAND in the background and permit use of window-pid on its windows. (execute-with-pidprop command) Description Execute COMMAND in the background and permit use of window-pid on its windows. Returns the PID of COMMAND. Implementation Notes Module: Defined in scheme/file.scm at line 121 (CVS log) extreme Find extreme value e of PRED in LST. (extreme pred lst) Description Find extreme value e of PRED in LST. If PRED defines a semi-ordering, `(PRED e x)' will hold for all members x of LST not equal to e. E.g. `(extreme < ...)' returns the lowest number. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 300 (CVS log) filename-is-complete? Return true if FNAME is a fully qualified pathname. (filename-is-complete? fname) Description Return true if FNAME is a fully qualified pathname. This is considered to be the case if the string FNAME starts with "/", "./" or "../", following the convention of many Unix programs. Implementation Notes Module: (app scwm file) Defined in scheme/file.scm at line 34 (CVS log) filter Return a list of those elements of L for which PRED is true. (filter pred l) Description Return a list of those elements of L for which PRED is true. The elements appear in the result list in the same order in which they appeared in L. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 84 (CVS log) filter-list Like list, but ignore #f and unspecified values. (filter-list . args) Description Like list, but ignore #f and unspecified values. See also filter-map. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 215 (CVS log) filter-map Process FIRST and the lists comprising REST as map would. (filter-map proc first . rest) Description Process FIRST and the lists comprising REST as map would. However, do not include any false or unspecified returns from PROC in the result list. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 190 (CVS log) filter-only-except Return a filtered list of the elements from L. (filter-only-except l only except) Description Return a filtered list of the elements from L. The returned list will contain only elements from L that have the predicate ONLY accepts but EXCEPT does not accept. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 38 (CVS log) find-file-in-path Search for file named FNAME in PATH. (find-file-in-path fname path) Description Search for file named FNAME in PATH. FNAME is a string specifying a file; if it is a fully qualified filename, as indicated by filename-is-complete?, it is checked for as is. Otherwise, each element of the list PATH is used as a directory name to check for the file. If the file is found, the full pathname to it is returned; if not, #f is returned. Implementation Notes Module: (app scwm file) Defined in scheme/file.scm at line 48 (CVS log) find-window-by Return a window satisfying predicate PRED. (find-window-by pred) Description Return a window satisfying predicate PRED. If there are multiple such windows, an unspecified one of them will be returned. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 427 (CVS log) find-window-by-class-resource Return a window by its CLASS and RESOURCE names (as strings). (find-window-by-class-resource class resource) Description Return a window by its CLASS and RESOURCE names (as strings). If there are multiple such windows, an unspecified one of them will be returned. See also find-window-by, class-match?? and title-match?? Implementation Notes Module: Defined in scheme/wininfo.scm at line 442 (CVS log) find-window-by-name Return a window with name WINDOW-NAME. (find-window-by-name window-name) Description Return a window with name WINDOW-NAME. If there are multiple such windows, an unspecified one of them will be returned. See also find-window-by and title-match??. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 436 (CVS log) first-line-output-of-system-cmd Return the first line of output of command shell execution of CMD. (first-line-output-of-system-cmd cmd) Description Return the first line of output of command shell execution of CMD. CMD is run synchronously and its output is piped into the return value of this function, as a string. See also output-of-system-cmd if you want to read all of the output of CMD. Implementation Notes Module: (app scwm file) Defined in scheme/file.scm at line 111 (CVS log) flash-selected-windows-on Make sure that the selected windows are marked as selected. (flash-selected-windows-on) Description Make sure that the selected windows are marked as selected. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 244 (CVS log) flash-window Flash WIN's titlebar and boundary color to COLOR for UNFLASH-DELAY seconds. (flash-window #&optional (win (get-window)) #&key (color "red") (unflash-delay .5) (continually #f)) Description Flash WIN's titlebar and boundary color to COLOR for UNFLASH-DELAY seconds. UNFLASH-DELAY may be #f to not automatically revert back to the original color. See unflash-window. Implementation Notes Module: (app scwm flash-window) Defined in scheme/flash-window.scm at line 18 (CVS log) flash-window-on Flash WIN's titlebar and boundary color to COLOR indefinitely. (flash-window-on #&optional (win (get-window)) (color "red")) Description Flash WIN's titlebar and boundary color to COLOR indefinitely. Returns the window changed. Use unflash-window to rever the window to its normal colors. Implementation Notes Module: (app scwm flash-window) Defined in scheme/flash-window.scm at line 9 (CVS log) flatten Return LIST-OF-LISTS as a single flat list. (flatten list-of-lists) Description Return LIST-OF-LISTS as a single flat list. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 251 (CVS log) float->integer No documentation supplied. (float->integer x) Description No documentation supplied. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 413 (CVS log) focus-change-warp-pointer Deiconify, focus, raise, and warp-to WIN. (focus-change-warp-pointer #&optional (win (get-window))) Description Deiconify, focus, raise, and warp-to WIN. This is initially the default behaviour when WIN is selected from the window list. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 447 (CVS log) focus-last-mapped-window Focus and warp to the window that was mapped most recently. (focus-last-mapped-window #&optional (push-focus? #t)) Description Focus and warp to the window that was mapped most recently. See also last-mapped-window. Implementation Notes Module: Defined in scheme/last-mapped-window.scm at line 25 (CVS log) focus-or-toggle-raise Focus on WIN if it does not have the focus, else toggle-raise WIN. (focus-or-toggle-raise #&optional (win (window-with-pointer))) Description Focus on WIN if it does not have the focus, else toggle-raise WIN. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 62 (CVS log) focus-stack-empty? Return #t iff the focus-stack is empty, else #f. (focus-stack-empty?) Description Return #t iff the focus-stack is empty, else #f. Implementation Notes Module: (app scwm focus-stack) Defined in scheme/focus-stack.scm at line 46 (CVS log) focus-to-register Save the currently-focused window to REGISTER. (focus-to-register #&optional (register (get-register-name "Focus-to-"))) Description Save the currently-focused window to REGISTER. Implementation Notes Module: (app scwm register) Defined in scheme/register.scm at line 65 (CVS log) focus-window Give WIN the keyboard input focus. (focus-window #&optional win) Description Give win the keyboard input focus. This will typically result in drawing win's frame in a special style as well. win defaults to the window context in the usual way if not specified. Note that win is not raised by giving it the focus; see raise-window if that is your intent. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1813 (CVS log) focus-window-with-pointer Set the focus to be the window containing the pointer. (focus-window-with-pointer) Description Set the focus to be the window containing the pointer. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 456 (CVS log) focussable-window? Return #t iff WIN may receive the keyboard focus. (focussable-window? #&optional win) Description Return #t iff win may receive the keyboard focus. This will return #f, e.g., if win's focus style is 'none, or its X11 hints do not permit it to receive the focus. Implementation Notes Module: Built-in Primitive Defined in src/focus.c at line 79 (CVS log) fold-menu-list Split ML into chained menus of no more than MAX-LINES items. (fold-menu-list ml #&optional (max-lines (optget *menu-max-fold-lines*))) Description Split ML into chained menus of no more than MAX-LINES items. ML is a list of menuitem objects. MAX-LINES is a number, which defaults to default-menu-max-fold-lines. Implementation Notes Module: (app scwm menus-extras) Defined in scheme/menus-extras.scm at line 59 (CVS log) fold-menu-list-by-group Split ML-CONS into chained menus based on their group. (fold-menu-list-by-group ml-cons #&rest rest) Description Split ML-CONS into chained menus based on their group. ML-CONS is a list of lists. Each sublist's car is the name of the group, and the cdr is a list of the menuitems for that group. The list must be sorted by GROUP. Returns a list of menu items for each group, popping up the group's MENUITEMs. Implementation Notes Module: Defined in scheme/menus-extras.scm at line 85 (CVS log) font-properties Return an association list giving some properties of FONT. (font-properties font) Description Return an association list giving some properties of font. Currently defined properties are 'name, the string name of the color, and 'height, its total height in pixels. Implementation Notes Module: Built-in Primitive Defined in src/font.c at line 232 (CVS log) font-property Return the KEY property of FONT. (font-property font key) Description Return the KEY property of FONT. See font-properties for a list of the keys. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 599 (CVS log) font? Returns #t if OBJ is a font object, otherwise #f. (font? obj) Description Returns #t if obj is a font object, otherwise #f. Implementation Notes Module: Built-in Primitive Defined in src/font.c at line 222 (CVS log) for-all? Return true if PRED is true for all elements of L, otherwise false. (for-all? l pred) Description Return true if PRED is true for all elements of L, otherwise false. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 102 (CVS log) for-each-column No documentation supplied. (for-each-column string char proc) Description No documentation supplied. Implementation Notes Module: (app scwm gtk-table-display) Defined in scheme/gtk-table-display.scm at line 31 (CVS log) force-reset-window-frame! This redraws the window frame and decorations of WIN. (force-reset-window-frame! #&optional win) Description This redraws the window frame and decorations of win. Ideally it would never be necessary, but it is useful for debugging and for new window objects set via object properties. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1094 (CVS log) force-segv-for-testing Cause a segmentation violation. (force-segv-for-testing) Description Cause a segmentation violation. Do not do this unless you are testing segv handling! Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 629 (CVS log) frame-id->window Return the window object corresponding to a frame WINDOW-ID. (frame-id->window window-id) Description Return the window object corresponding to a frame window-id. window-id should be the X id of a scwm frame window. If there is no such window object, return #f. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2805 (CVS log) fvwm-exec Run COMMAND as fvwm would. (fvwm-exec command) Description Run COMMAND as fvwm would. See also fvwm-exec-use-shell. Implementation Notes Module: (app scwm fvwm-compat) Defined in scheme/fvwm-compat.scm at line 43 (CVS log) fvwm-exec-use-shell Use SHELL when emulating fvwm "EXEC" commands. (fvwm-exec-use-shell #&optional (shell #f)) Description Use SHELL when emulating fvwm "EXEC" commands. Defaults to $SHELL or /bin/sh. Implementation Notes Module: (app scwm fvwm-compat) Defined in scheme/fvwm-compat.scm at line 32 (CVS log) fvwm-nop No documentation supplied. (fvwm-nop . args) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-compat) Defined in scheme/fvwm-compat.scm at line 73 (CVS log) fvwm-pipe-read No documentation supplied. (fvwm-pipe-read command) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-compat) Defined in scheme/fvwm-compat.scm at line 53 (CVS log) fvwm2-pager-window Return a fvwm2 pager window, or #f if there is none. (fvwm2-pager-window) Description Return a fvwm2 pager window, or #f if there is none. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 592 (CVS log) gdk-draw-arc! Draw an arc on the root window. (gdk-draw-arc! top_left width height angle1 angle2) Description Draw an arc on the root window. Implementation Notes Module: Defined in scheme/ui-constraints-gdk-drawing.scm at line 98 (CVS log) gdk-draw-line! Draw a line on the root window. (gdk-draw-line! p1 p2) Description Draw a line on the root window. Implementation Notes Module: (app scwm ui-constraints-gdk-drawing) Defined in scheme/ui-constraints-gdk-drawing.scm at line 88 (CVS log) gdk-draw-rectangle! Draw a rectangle on the root window. (gdk-draw-rectangle! top-left width height) Description Draw a rectangle on the root window. Implementation Notes Module: (app scwm ui-constraints-gdk-drawing) Defined in scheme/ui-constraints-gdk-drawing.scm at line 80 (CVS log) gdk-drawing-get-drawable Returns the drawable object used to draw on the root window. (gdk-drawing-get-drawable) Description Returns the drawable object used to draw on the root window. Implementation Notes Module: (app scwm ui-constraints-gdk-drawing) Defined in scheme/ui-constraints-gdk-drawing.scm at line 68 (CVS log) gdk-drawing-get-gc Returns the gc used to draw on the root window. (gdk-drawing-get-gc) Description Returns the gc used to draw on the root window. Implementation Notes Module: (app scwm ui-constraints-gdk-drawing) Defined in scheme/ui-constraints-gdk-drawing.scm at line 64 (CVS log) gdk-drawing-initialize Setup the draw functions for drawing onto the root window. (gdk-drawing-initialize) Description Setup the draw functions for drawing onto the root window. Requires the ui-constraints-buttons window be initialized and made visible, otherwise initialization will not occur. Implementation Notes Module: (app scwm ui-constraints-gdk-drawing) Defined in scheme/ui-constraints-gdk-drawing.scm at line 44 (CVS log) gdk-drawing-initialized? Returns whether or not the module has been initialized. (gdk-drawing-initialized?) Description Returns whether or not the module has been initialized. Implementation Notes Module: (app scwm ui-constraints-gdk-drawing) Defined in scheme/ui-constraints-gdk-drawing.scm at line 60 (CVS log) gdk-drawing-set-line-width! Set the width of the line to draw with. (gdk-drawing-set-line-width! width) Description Set the width of the line to draw with. Implementation Notes Module: (app scwm ui-constraints-gdk-drawing) Defined in scheme/ui-constraints-gdk-drawing.scm at line 76 (CVS log) get-fvwm2-module-config No documentation supplied. (get-fvwm2-module-config module-type) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 408 (CVS log) get-input-hooks-list Return the input-hooks list. (get-input-hooks-list) Description Return the input-hooks list. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 762 (CVS log) get-key-event Return a represention of the next key event. (get-key-event) Description Return a represention of the next key event. The return value is (string modmask keycode). The cdr of the return value can be used as the arguments to undo-passive-grab and redo-passive-grab. The string is usable as a key binding string. Modifiers are listed first, separated by "-" followed by a "-" and the keysym name. E.g., "S-C-M-z" is Shift+Control+Meta + 'z' key. If the event is only modifier keys, then the string will end in a "-"; e.g., "S-C-M-". See also get-next-event. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 829 (CVS log) get-mouse-event Return a represention of the next mouse event. (get-mouse-event) Description Return a represention of the next mouse event. The return value is (string modmask button-number #t). The cdr of the return value can be used as the arguments to undo-passive-grab and redo-passive-grab. The string is usable as a mouse binding string. Modifiers are listed first, separated by "-" followed by a "-" and the button number. E.g., "S-C-M-1" is Shift+Control+Meta + button 1. See also get-next-event. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 894 (CVS log) get-next-event Return a represention of the next key or mouse event. (get-next-event) Description Return a represention of the next key or mouse event. The return value is (string modmask keycode) for key events or (string modmask button-number #t). The cdr of the return value can be used as the arguments to undo-passive-grab and redo-passive-grab. The string is usable as a key binding string. Modifiers are listed first, separated by "-" followed by a "-" and the keysym name. E.g., "S-C-M-z" is Shift+Control+Meta + 'z' key. If the event is only modifier keys, then the string will end in a "-"; e.g., "S-C-M-". See also get-mouse-event and get-key-event. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 732 (CVS log) get-proplist-with-description Return a property list by parsing DESC in GNUstep proplist format. (get-proplist-with-description desc) Description Return a property list by parsing desc in GNUstep proplist format. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 843 (CVS log) get-proplist-with-path Return the proplist from path FILENAME. (get-proplist-with-path filename) Description Return the proplist from path filename. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 826 (CVS log) get-register Return contents of Scwm register named REGISTER, or #f if none. (get-register register) Description Return contents of Scwm register named REGISTER, or #f if none. Implementation Notes Module: (app scwm register) Defined in scheme/register.scm at line 44 (CVS log) get-register-name Prompt for a register name and return a corresponding symbol. (get-register-name #&optional (descriptor #f)) Description Prompt for a register name and return a corresponding symbol. If DESCRIPTOR is given, then use DECRIPTOR before "Register?" in the prompt. Implementation Notes Module: (app scwm register) Defined in scheme/register.scm at line 15 (CVS log) get-timer-hooks-list Return the timer-hooks list. (get-timer-hooks-list) Description Return the timer-hooks list. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 612 (CVS log) get-ui-constraint-class-by-name No documentation supplied. (get-ui-constraint-class-by-name name) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 171 (CVS log) get-window Retrieve the window context or select interactively. (get-window #&optional select? release? cursor) Description Retrieve the window context or select interactively. If there is no window context, a window is selected interactively. The boolean select? argument (default #t) determines whether or not a window should be selected interactively if there is no current window context. The release? argument (default #t) determines whether or not interactive selection (if any) should wait for a mouse release event or just a press. The latter behavior is useful if the action being performed on the window is an interactive one involving mouse drags. The cursor argument is either a cursor object or #t to use the "skull and crossbones" cursor, or #f to use the standard circle cursor. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1053 (CVS log) get-window-colors Return a two-element list, '(fg bg), the colors for WIN. (get-window-colors #&optional win) Description Return a two-element list, '(fg bg), the colors for win. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3507 (CVS log) get-window-highlight-colors Return a two-element list, '(fg bg), the highlight colors for WIN. (get-window-highlight-colors #&optional win) Description Return a two-element list, '(fg bg), the highlight colors for win. fg or bg may be #f, which means that the color is inherited from the decor. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3521 (CVS log) get-window-nonant SELECT-LIST is a list of (win x y), returns the nonant selected. (get-window-nonant select-list) Description SELECT-LIST is a list of (win x y), returns the nonant selected. The nonant is a number in [0,8] referring to which of the tic-tac-toe board squares x,y is in of WIN. x,y are root-window relative viewport positions. select-viewport-position returns lists of the form needed by this procedure. Implementation Notes Module: (app scwm nonants) Defined in scheme/nonants.scm at line 180 (CVS log) get-window-with-nonant Select a WINDOW and a NONANT, defaulting to the current window context. (get-window-with-nonant #&optional (window #f) (nonant 4)) Description Select a WINDOW and a NONANT, defaulting to the current window context. If the WINDOW is not specified and there is no window context, perform interactive selection. If WINDOW is passed in but NONANT is not specified, the center nonant is used. The nonant is stored as an object-property of the window for use with the window-selection and constraints modules. Implementation Notes Module: (app scwm nonants) Defined in scheme/nonants.scm at line 44 (CVS log) get-window-with-nonant-interactively Interactively select a window and a nonant. (get-window-with-nonant-interactively #&optional (orientation #f)) Description Interactively select a window and a nonant. The nonant is stored as an object-property of the window for use with the window-selection and constraints modules. ORIENTATION can be either 'horizontal or 'vertical to designate whether we are picking a horizontal slice or a vertical slice of a window; when #f, we are picking a nonant, not a slice. Implementation Notes Module: (app scwm nonants) Defined in scheme/nonants.scm at line 136 (CVS log) get-wm-command Get the "WM_COMMAND" X-Property of WIN and return that string. (get-wm-command win) Description Get the "WM_COMMAND" X-Property of WIN and return that string. WIN is a Scwm window object. The "WM_COMMAND" X-Property is the application's notion of what the command line was used to run the application. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 73 (CVS log) get-x-cursor Return the cursor object corresponding to NAME-OR-NUMBER. (get-x-cursor name-or-number) Description Return the cursor object corresponding to name-or-number. name-or-number can be either a string naming an X11 cursor (e.g., "trek") or a number specifying the cursor number. See X11/cursorfont.h for the standard cursors. Note that the "XC_" macro prefix should be omitted when used with this procedure.. Implementation Notes Module: Built-in Primitive Defined in src/cursor.c at line 244 (CVS log) global-window-configuration Return an object abstracting all of the current windows' states. (global-window-configuration) Description Return an object abstracting all of the current windows' states. Implementation Notes Module: (app scwm window-configuration) Defined in scheme/window-configuration.scm at line 67 (CVS log) global-window-configuration-to-register Save the global configuration of windows to REGISTER. (global-window-configuration-to-register #&optional (register (get-register-name "Global-configurations-to-"))) Description Save the global configuration of windows to REGISTER. Implementation Notes Module: (app scwm register) Defined in scheme/register.scm at line 88 (CVS log) gnome-desktop-click Send a button-press N to the gnome desktop manager. (gnome-desktop-click n) Description Send a button-press N to the gnome desktop manager. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 442 (CVS log) gnome-desktop-click-1 Send a button-press 1 and button-release 1 to the gnome desktop manager. (gnome-desktop-click-1) Description Send a button-press 1 and button-release 1 to the gnome desktop manager. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 466 (CVS log) gnome-desktop-click-2 Send a button-press 1 and button-release 2 to the gnome desktop manager. (gnome-desktop-click-2) Description Send a button-press 1 and button-release 2 to the gnome desktop manager. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 471 (CVS log) gnome-desktop-click-3 Send a button-press 1 and button-release 3 to the gnome desktop manager. (gnome-desktop-click-3) Description Send a button-press 1 and button-release 3 to the gnome desktop manager. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 476 (CVS log) gnome-desktop-menu Pop-up the gnome desktop menu. (gnome-desktop-menu) Description Pop-up the gnome desktop menu. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 446 (CVS log) gnome-desktop-press Send a button-press N to the gnome desktop manager. (gnome-desktop-press n) Description Send a button-press N to the gnome desktop manager. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 438 (CVS log) gnome-desktop-press-1 Send a button-press 1 to the gnome desktop manager. (gnome-desktop-press-1) Description Send a button-press 1 to the gnome desktop manager. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 451 (CVS log) gnome-desktop-press-2 Send a button-press 1 to the gnome desktop manager. (gnome-desktop-press-2) Description Send a button-press 1 to the gnome desktop manager. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 456 (CVS log) gnome-desktop-press-3 Send a button-press 1 to the gnome desktop manager. (gnome-desktop-press-3) Description Send a button-press 1 to the gnome desktop manager. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 461 (CVS log) gnome-install-window-styles Initialize various window styles for GNOME support. (gnome-install-window-styles) Description Initialize various window styles for GNOME support. This handles desktop icons, splash screens, and the panel. Implementation Notes Module: (app scwm gnome-hints) Defined in scheme/gnome-hints.scm at line 566 (CVS log) gravity->alignments Return a list of two numeric alignments corresponding to a GRAVITY. (gravity->alignments gravity) Description Return a list of two numeric alignments corresponding to a GRAVITY. GRAVITY can be one of 'nw, 'n, 'ne, 'w, 'center, 'e, 'sw, 's, 'se or spelled-out versions of these. Implementation Notes Module: (app scwm message-window) Defined in scheme/message-window.scm at line 23 (CVS log) gravity->string Returns a string representation of the numerical GRAVITY. (gravity->string gravity) Description Returns a string representation of the numerical GRAVITY. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 55 (CVS log) group->windows Returns a list of windows belonging to GROUP. (group->windows group) Description Returns a list of windows belonging to GROUP. GROUP can be any window belonging to the group. All its peers, including itself, are returned. If GROUP is a list, it is treated as the list of windows and is just returned. This permits all the group action procedures to be used on lists of windows, too. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 53 (CVS log) group-window Returns a distinguished window of GROUP. (group-window group) Description Returns a distinguished window of GROUP. Since a group is represented either by a single window or by a list, this returns either GROUP or the car of the list. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 45 (CVS log) gtk-about No documentation supplied. (gtk-about title text #&optional (pixmap #f) (width 500) (height 400)) Description No documentation supplied. Implementation Notes Module: (app scwm gtk-about) Defined in scheme/gtk-about.scm at line 15 (CVS log) gtk-about-scwm No documentation supplied. (gtk-about-scwm) Description No documentation supplied. Implementation Notes Module: (app scwm gtk-about) Defined in scheme/gtk-about.scm at line 38 (CVS log) gtk-clist-get-row-values Return a list of the COL columns of row ROW of CLIST. (gtk-clist-get-row-values clist row col) Description Return a list of the COL columns of row ROW of CLIST. Implementation Notes Module: (app scwm gtk) Defined in scheme/gtk.scm at line 105 (CVS log) gtk-message It display a message on the display, using a gtk window (gtk-message message #&key (close-message "close") (title "message")) Description It display a message on the display, using a gtk window MESSAGE is a string representing the message to be displayed on the screen. Implementation Notes Module: Defined in scheme/gtk-message.scm at line 44 (CVS log) gtk-pixmap-new-search-scwm-path Return the new pixmap object as gtk-pixmap-new does, but search Scwm's image-load-path for it. (gtk-pixmap-new-search-scwm-path pixmap-name button) Description Return the new pixmap object as gtk-pixmap-new does, but search Scwm's image-load-path for it. Implementation Notes Module: (app scwm gtk) Defined in scheme/gtk.scm at line 61 (CVS log) gtk-proc-selection-cancel-button Returns the cancel button from PROC-DIALOG. (gtk-proc-selection-cancel-button proc-dialog) Description Returns the cancel button from PROC-DIALOG. Implementation Notes Module: (app scwm prompt-proc) Defined in scheme/prompt-proc.scm at line 216 (CVS log) gtk-proc-selection-clist-widget Returns the clist widgetfrom PROC-DIALOG. (gtk-proc-selection-clist-widget proc-dialog) Description Returns the clist widgetfrom PROC-DIALOG. Implementation Notes Module: (app scwm prompt-proc) Defined in scheme/prompt-proc.scm at line 220 (CVS log) gtk-proc-selection-get-procedure Returns the currently selected procedure from PROC-DIALOG. (gtk-proc-selection-get-procedure proc-dialog) Description Returns the currently selected procedure from PROC-DIALOG. Implementation Notes Module: (app scwm prompt-proc) Defined in scheme/prompt-proc.scm at line 232 (CVS log) gtk-proc-selection-get-procname Returns the currently selected procedure name from PROC-DIALOG. (gtk-proc-selection-get-procname proc-dialog) Description Returns the currently selected procedure name from PROC-DIALOG. Implementation Notes Module: (app scwm prompt-proc) Defined in scheme/prompt-proc.scm at line 224 (CVS log) gtk-proc-selection-new Returns a new procedure-selecting dialog box. (gtk-proc-selection-new title #&optional (proclist #f)) Description Returns a new procedure-selecting dialog box. Implementation Notes Module: (app scwm prompt-proc) Defined in scheme/prompt-proc.scm at line 130 (CVS log) gtk-proc-selection-ok-button Returns the ok button from PROC-DIALOG. (gtk-proc-selection-ok-button proc-dialog) Description Returns the ok button from PROC-DIALOG. Implementation Notes Module: (app scwm prompt-proc) Defined in scheme/prompt-proc.scm at line 212 (CVS log) gtk-proc-selection-toplevel-widget Returns the toplevel window widget from PROC-DIALOG. (gtk-proc-selection-toplevel-widget proc-dialog) Description Returns the toplevel window widget from PROC-DIALOG. Implementation Notes Module: (app scwm prompt-proc) Defined in scheme/prompt-proc.scm at line 208 (CVS log) gtk-scrolled-window-set-hadjustment-value Set the hadjustment for SW, a scrolled window, to FLOAT. (gtk-scrolled-window-set-hadjustment-value sw float) Description Set the hadjustment for SW, a scrolled window, to FLOAT. Implementation Notes Module: Defined in scheme/gtk.scm at line 127 (CVS log) gtk-scrolled-window-set-vadjustment-value Set the vadjustment for SW, a scrolled window, to FLOAT. (gtk-scrolled-window-set-vadjustment-value sw float) Description Set the vadjustment for SW, a scrolled window, to FLOAT. Implementation Notes Module: (app scwm gtk) Defined in scheme/gtk.scm at line 123 (CVS log) gtk-table-from-string No documentation supplied. (gtk-table-from-string string select-proc) Description No documentation supplied. Implementation Notes Module: Defined in scheme/gtk-table-display.scm at line 51 (CVS log) gtk-text-replace Replace all the text in TEXTWIDGET with TEXT. (gtk-text-replace textwidget text) Description Replace all the text in TEXTWIDGET with TEXT. Implementation Notes Module: (app scwm gtk) Defined in scheme/gtk.scm at line 116 (CVS log) gtk-window->scwm-window Return the Scwm window object corresponding to GTKWIN. (gtk-window->scwm-window gtkwin) Description Return the Scwm window object corresponding to GTKWIN. GTKWIN is a GTk+ window object returned from gtk-window-new. Return value is #f if no corresponding window exists now. Also will return #f if your guile-gtk implementation does not support this procedure (you should upgrade!). Implementation Notes Module: (app scwm gtk) Defined in scheme/gtk.scm at line 76 (CVS log) gui-set No documentation supplied. (gui-set sym) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 99 (CVS log) half Return the closest integer to half of X. (half x) Description Return the closest integer to half of X. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 65 (CVS log) handle-pending-events Handle all pending Scwm events, returns number of dispatched events. (handle-pending-events) Description Handle all pending Scwm events, returns number of dispatched events. This is useful to maintain responsiveness of Scwm when in the middle of a long computation. Implementation Notes Module: Built-in Primitive Defined in src/events.c at line 344 (CVS log) has-overlay-plane? Return #t if the current screen has an overlay plane, #f otherwise. (has-overlay-plane?) Description Return #t if the current screen has an overlay plane, #f otherwise. Implementation Notes Module: Primitive from (app scwm overlay-plane) Defined in modules/overlay-plane/overlay-plane.c at line 42 (CVS log) help Print all possible documentation for string or symbol. (help obj #&optional (port (current-output-port))) Description Print all possible documentation for string or symbol. Implementation Notes Module: (app scwm doc) Defined in scheme/doc.scm at line 61 (CVS log) help-mesg No documentation supplied. (help-mesg . funcs) Description No documentation supplied. Implementation Notes Module: (app scwm prefs-menu) Defined in scheme/prefs-menu.scm at line 76 (CVS log) hex Return the integer that corresponds to string NUMBER as a hexadecimal value. (hex number) Description Return the integer that corresponds to string NUMBER as a hexadecimal value. Implementation Notes Module: (app scwm number-convert) Defined in scheme/number-convert.scm at line 54 (CVS log) hide-overlay-plane Draw a box in the overlay plane. (hide-overlay-plane) Description Draw a box in the overlay plane. This is just for demonstration and testing purposes for now. Implementation Notes Module: Primitive from (app scwm overlay-plane) Defined in modules/overlay-plane/overlay-plane.c at line 113 (CVS log) hide-selected-nonants Hide nonant markers on window when they are selected. (hide-selected-nonants) Description Hide nonant markers on window when they are selected. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 239 (CVS log) hide-side-decorations Do not display the sidebar decorations for WIN. (hide-side-decorations #&optional (win (get-window))) Description Do not display the sidebar decorations for WIN. See also show-side-decorations. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 101 (CVS log) hide-titlebar Cause WIN not to be decorated with a titlebar. (hide-titlebar #&optional win in-place?) Description Cause win not to be decorated with a titlebar. Keeps the client window at its current location if in-place? is #t. See also show-titlebar. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3199 (CVS log) hide-titlebar-in-place Turn off display of the titlebar for WIN without moving the client window. (hide-titlebar-in-place #&optional (win (get-window))) Description Turn off display of the titlebar for WIN without moving the client window. This may move the frame to keep the application client window area in the same position as before the call. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 87 (CVS log) highlight-background Return the default background color for windows with the input focus. (highlight-background) Description Return the default background color for windows with the input focus. Applies to the current decor. This is used only for windows that don't have their own background color. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 883 (CVS log) highlight-current-window No documentation supplied. (highlight-current-window . modifiers) Description No documentation supplied. Implementation Notes Module: (app scwm highlight-current-window) Defined in scheme/highlight-current-window.scm at line 68 (CVS log) highlight-factor Return the current highlight factor. (highlight-factor) Description Return the current highlight factor. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 675 (CVS log) highlight-foreground Return the default foreground color for windows with the input focus. (highlight-foreground) Description Return the default foreground color for windows with the input focus. Applies to the current decor. This is used only for windows that don't have their own foreground color. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 808 (CVS log) hook-documentation Return the docstring for HOOK. (hook-documentation hook) Description Return the docstring for HOOK. Implementation Notes Module: (app scwm doc) Defined in scheme/doc.scm at line 19 (CVS log) icon-font Return the font used for drawing icon titles. (icon-font) Description Return the font used for drawing icon titles. Implementation Notes Module: Built-in Primitive Defined in src/font.c at line 261 (CVS log) icon-position Return the position of the icon for WIN. (icon-position #&optional win) Description Return the position of the icon for win. The position is returned as a list of the x coordinate and the y coordinate in pixels. If the icon is sticky, the position will always be in the 0,0 viewport. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2615 (CVS log) icon-size Return the size of the icon for WIN. (icon-size #&optional win) Description Return the size of the icon for win. The position is returned as a list of the width and height in pixels. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2635 (CVS log) icon-sticky? Return #t if WIN is "sticky", #f otherwise. (icon-sticky? #&optional win) Description Return #t if win is "sticky", #f otherwise. See stick-icon and stick-window. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3389 (CVS log) icon-title-match?? Return a predicate that tests a window's icon title. (icon-title-match?? STRING TYPE CASE-SENSITIVE?) Description Return a predicate that tests a window's icon title. When applied to a window, this predicate will return true if the icon title matches STRING in the manner specified by the optional argument TYPE, which may be 'exact, 'regexp, or 'wildcard. The optional CASE-SENSITIVE argument determines whether the matching is case-sensitive or not. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 330 (CVS log) icon-viewport-position Return the position of WIN's icon in pixels within the viewport. (icon-viewport-position #&optional (win (get-window))) Description Return the position of WIN's icon in pixels within the viewport. The position is returned as a list of the x coordinate and the y coordinate in pixels. WIN defaults to the window context in the usual way if not specified. See also icon-position. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 386 (CVS log) iconified-window? Return #t if WIN is iconified, otherwise return #f. (iconified-window? #&optional win) Description Return #t if win is iconified, otherwise return #f. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2103 (CVS log) iconify-group Iconify GROUP into one icon. (iconify-group #&optional (group (get-window))) Description Iconify GROUP into one icon. The icon is that of the window GROUP represents. deiconify-group-or-window will deiconify this icon into the whole GROUP. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 164 (CVS log) iconify-window Iconify WIN. (iconify-window #&optional win) Description Iconify win. Iconifying hides the regular window, and shows the window's icon. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2056 (CVS log) id->message-window Return the message-window of an X/11 window id (a long integer). (id->message-window winid) Description Return the message-window of an X/11 window id (a long integer). Returns #f if winid does not correspond to a message-window. You can use the xwininfo program to get the window id of an arbitrary window on your X/11 display. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 306 (CVS log) id->window Return the window object corresponding to an application WINDOW-ID. (id->window window-id) Description Return the window object corresponding to an application window-id. window-id should be the X id of the application window. If there is no such window object, return #f. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2788 (CVS log) ignore-dubious-modifiers? Return the status of the ignore-dubious-modifiers flag. (ignore-dubious-modifiers?) Description Return the status of the ignore-dubious-modifiers flag. See set-ignore-dubious-modifiers!. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1552 (CVS log) image->gtk-pixmap Return a gtk-pixmap widget for IMG for use in BUTTON. (image->gtk-pixmap img button) Description Return a gtk-pixmap widget for IMG for use in BUTTON. Implementation Notes Module: (app scwm gtk) Defined in scheme/gtk.scm at line 66 (CVS log) image-name->cursor Make a cursor given only the NAME. (image-name->cursor name #&optional (x-hotspot 8) (y-hotspot 8)) Description Make a cursor given only the NAME. X-HOTSPOT and Y-HOTSPOT can specify the hotspot coordinates for the cursor. Implementation Notes Module: (app scwm cursor) Defined in scheme/cursor.scm at line 12 (CVS log) image-not-found-message Report a missing image filename, but do not error. (image-not-found-message filename) Description Report a missing image filename, but do not error. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 893 (CVS log) image-properties Return an association list giving some properties of IMAGE. (image-properties image) Description Return an association list giving some properties of image. Currently defined properties are 'filename, the fully expanded pathname of the image, 'width, its width, 'height, its height, and depth, its color depth. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 172 (CVS log) image-property Return the KEY property of IMAGE. (image-property image key) Description Return the KEY property of IMAGE. See image-properties for a list of the keys. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 594 (CVS log) image-short-name Return the short name of IMAGE. (image-short-name image) Description Return the short name of image. Use image-properties to access other properties of image including its full name. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 206 (CVS log) image-size Return the size of IMAGE as a list (width height). (image-size image) Description Return the size of image as a list (width height). Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 226 (CVS log) image? Returns #t if OBJ is an image object, otherwise #f. (image? obj) Description Returns #t if obj is an image object, otherwise #f. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 162 (CVS log) ImageMagick-loader Tries to load an arbitrary image using ImageMagick's convert. (ImageMagick-loader fname) Description Tries to load an arbitrary image using ImageMagick's convert. Uses convert to try to convert the file to an xpm, then attempts to load it as such. Implementation Notes Module: (app scwm image-loaders) Defined in scheme/image-loaders.scm at line 28 (CVS log) in-viewport-any-desk? Return #t if WIN is in the current viewport ignoring the desk, else #f. (in-viewport-any-desk? #&optional (win (get-window))) Description Return #t if WIN is in the current viewport ignoring the desk, else #f. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 73 (CVS log) in-viewport-placement Return a procedure that takes a window and places it in viewport (XX, YY). (in-viewport-placement xx yy) Description Return a procedure that takes a window and places it in viewport (XX, YY). The procedure will act just like calling place-in-viewport on the window with the same XX and YY arguments. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 103 (CVS log) increment-in-range Return v+1 but no more than high. (increment-in-range v high) Description Return v+1 but no more than high. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 42 (CVS log) increment-undo-index Increment the undo-index. (increment-undo-index) Description Increment the undo-index. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 57 (CVS log) initial-place-window Pick a desk for WIN and return #t iff WIN should be placed. (initial-place-window win) Description Pick a desk for win and return #t iff win should be placed. N.B. the return value is different from the return value of the various placement procedures. This return values is #f to signify that no further placement is necessary according to the various positioning hints attached to win. Implementation Notes Module: Built-in Primitive Defined in src/placement.c at line 581 (CVS log) initialize-programs-that-exist Initializes the cache with programs that exist in the current $PATH. (initialize-programs-that-exist) Description Initializes the cache with programs that exist in the current $PATH. This creates a list that cached-program-exists? then checks when queried whether a program exists or not. Currently, this procedure spawns a zsh process to get the list of files in the $PATH very quickly. Implementation Notes Module: (app scwm path-cache) Defined in scheme/path-cache.scm at line 22 (CVS log) initialize-ui-constraints-buttons No documentation supplied. (initialize-ui-constraints-buttons #&key (vertical #f) (pixmap #t) (show #f)) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-buttons) Defined in scheme/ui-constraints-buttons.scm at line 138 (CVS log) insert-undo-global Insert the global state into the undo list at undo-index. (insert-undo-global) Description Insert the global state into the undo list at undo-index. See also push-undo-global. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 68 (CVS log) insert-undo-state Insert STATE into the undo list at undo-index. (insert-undo-state state) Description Insert STATE into the undo list at undo-index. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 80 (CVS log) install-visibility-reporter Install procedures to print debugging messages on window visibility change events. (install-visibility-reporter) Description Install procedures to print debugging messages on window visibility change events. Implementation Notes Module: (app scwm visibility-reporter) Defined in scheme/visibility-reporter.scm at line 11 (CVS log) interactive-move Move WINDOW interactively and possibly opaquely. (interactive-move #&optional (win (get-window #t #f #f)) (opaquely? (if win ((optget *move-opaquely-proc*) win)))) Description Move WINDOW interactively and possibly opaquely. If OPAQUELY? is specified, it is used to determine if the window should be moved opaquely, or using a rubber-band. If it is not spcified, interactive-move calls `*move-opaquely-proc*' on WIN and moves opaquely if that returns #t and uses a rubber-band if it returns #f. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 253 (CVS log) interactive-move-group Move GROUP interactively. (interactive-move-group #&optional (group (get-window #t #f #f))) Description Move GROUP interactively. You can drag around the window GROUP represents. The other windows in GROUP will move along. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 120 (CVS log) interactive-move-rubberband Move interactively, using the rubberband (unless constraint solver is active. (interactive-move-rubberband #&optional (win (get-window))) Description Move interactively, using the rubberband (unless constraint solver is active. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 436 (CVS log) interactive-move-selected-group-or-window Interactively move either the selected windows or the current window. (interactive-move-selected-group-or-window) Description Interactively move either the selected windows or the current window. The current window alone is moved if no windows are selected. Implementation Notes Module: Defined in scheme/group.scm at line 253 (CVS log) interactive-move-window-with-focus Interactively move the window which currently has the focus. (interactive-move-window-with-focus) Description Interactively move the window which currently has the focus. `*move-opaquely-proc*' is used to control whether a rubberband outline or the window itself is moved. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 384 (CVS log) interactive-move-window-with-pointer Interactively move the window which currently contains the pointer. (interactive-move-window-with-pointer) Description Interactively move the window which currently contains the pointer. move-opaquely? is used to control whether a rubberband outline or the window itself is moved. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 398 (CVS log) interactive-place-window Interactively place WIN. (interactive-place-window win #&optional no-move x-sugg y-sugg) Description Interactively place win. Start at x-sugg, y-sugg. If no-move is #t, just return the final resting place instead of actually moving the window there. Implementation Notes Module: Built-in Primitive Defined in src/placement.c at line 612 (CVS log) interactive-placement Return a procedure that takes a window and places it interactively. (interactive-placement #&key (resize #f) (switch #t) (return #f)) Description Return a procedure that takes a window and places it interactively. If the RESIZE argument is true, the resulting procedure will interactively resize the window immediately after placing it. If SWITCH is true, the returned procedure will switch to the virtual desk and viewport of its window argument before placing it. This is the default. If RETURN is false, the returned procedure will switch back to the previous desk and viewport after placing the window. The default is false. See also the related interactive-place procedure which directly places a window interactively. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 115 (CVS log) interactive-procedure-apropos Returns a list of interactive procedures that match RGX. (interactive-procedure-apropos rgx) Description Returns a list of interactive procedures that match RGX. This returns a simple list of procedure objects. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 220 (CVS log) interactive-procedure-apropos-with-modules Returns a list of procedures that match RGX and that can take no arguments. (interactive-procedure-apropos-with-modules rgx) Description Returns a list of procedures that match RGX and that can take no arguments. I.e., they are interactive procedures useful for bindings. The returned list contains pairs (modulesym . procsym) Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 208 (CVS log) interactive-resize Resize WINDOW interactively and possibly opaquely. (interactive-resize #&optional (win (get-window #t #f #f)) (opaquely? (if win ((optget *resize-opaquely-proc*) win)))) Description Resize WINDOW interactively and possibly opaquely. If OPAQUELY? is specified, it is used to determine if the window should be resized opaquely, or using a rubber-band. If it is not spcified, interactive-resize calls `*resize-opaquely-proc*' on WIN and moves opaquely if that returns #t and uses a rubber-band if it returns #f. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 264 (CVS log) interactive-resize-rubberband Resize interactively, using the rubberband (unless constraint solver is active. (interactive-resize-rubberband #&optional (win (get-window))) Description Resize interactively, using the rubberband (unless constraint solver is active. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 441 (CVS log) interactive-resize-window-with-focus Interactively resize the window which currently has the focus. (interactive-resize-window-with-focus) Description Interactively resize the window which currently has the focus. `*resize-opaquely-proc*' is used to control whether a rubberband outline or the window itself is resized. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 391 (CVS log) interactive-resize-window-with-pointer Interactively resize the window which currently contains the pointer. (interactive-resize-window-with-pointer) Description Interactively resize the window which currently contains the pointer. resize-opaquely? is used to control whether a rubberband outline or the window itself is resized. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 405 (CVS log) interactive-set-window-gravity! Permit user to click on an area of a window and anchor that nonant. (interactive-set-window-gravity!) Description Permit user to click on an area of a window and anchor that nonant. E.g., if the user clicks on the northeast corner of a window, that window will be set to have northeast gravity so future resizes keep that corner fixed. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 360 (CVS log) interpret-as-procedure Return a procedure given its value, its symbol, or its name. (interpret-as-procedure proc-or-string-or-symbol) Description Return a procedure given its value, its symbol, or its name. Return #f if PROC-OR-STRING-OR-SYMBOL is none of those things. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 37 (CVS log) intersection-area Returns the size of the intersection of two rectangles. (intersection-area x1 y1 w1 h1 x2 y2 w2 h2) Description Returns the size of the intersection of two rectangles. X1,Y1 and W1 x H1 are the position and size of the first rectangle. X2,Y2 and W2 x H2 are the position and size of the second rectangle. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 52 (CVS log) invert-nonant Return the opposite nonant from NONANT. (invert-nonant nonant) Description Return the opposite nonant from NONANT. E.g., passing 0 answers 8, passing 1 answers 7, etc. Implementation Notes Module: (app scwm snap-constraints) Defined in scheme/snap-constraints.scm at line 169 (CVS log) iota Generate a list of the integers from 0 to N-1 in order. (iota n) Description Generate a list of the integers from 0 to N-1 in order. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 41 (CVS log) is-mouse-event? Return #t iff EVENT is a mouse event. (is-mouse-event? event) Description Return #t iff EVENT is a mouse event. EVENT should be a list returned by get-next-event, get-key-event, or get-mouse-event. Implementation Notes Module: (app scwm describe) Defined in scheme/describe.scm at line 10 (CVS log) jump-to-register Restore the state saved in REGISTER. (jump-to-register #&optional (register (get-register-name "Jump-to-"))) Description Restore the state saved in REGISTER. Implementation Notes Module: (app scwm register) Defined in scheme/register.scm at line 98 (CVS log) keep-above Keep W1 wholly above W2. (keep-above w1 w2 #&optional (enable? #f)) Description Keep W1 wholly above W2. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 48 (CVS log) keep-adjacent-horizontal Keep W1's right edge aligned with W2's left edge. (keep-adjacent-horizontal w1 w2 #&optional (enable? #f)) Description Keep W1's right edge aligned with W2's left edge. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 96 (CVS log) keep-adjacent-vertical Keep W1's bottom edge aligned with W2's top edge. (keep-adjacent-vertical w1 w2 #&optional (enable? #f)) Description Keep W1's bottom edge aligned with W2's top edge. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 104 (CVS log) keep-at-left-edge Keep W's left edge at the left edge of the desktop. (keep-at-left-edge w #&optional (enable? #f)) Description Keep W's left edge at the left edge of the desktop. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 112 (CVS log) keep-at-right-edge Keep W's right edge at the right edge of the desktop. (keep-at-right-edge w #&optional (enable? #f)) Description Keep W's right edge at the right edge of the desktop. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 126 (CVS log) keep-at-top-edge Keep W's top edge at the top edge of the desktop. (keep-at-top-edge w #&optional (enable? #f)) Description Keep W's top edge at the top edge of the desktop. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 119 (CVS log) keep-bottoms-even Keep W1 and W2 aligned at the bottom. (keep-bottoms-even w1 w2 #&optional (enable? #f)) Description Keep W1 and W2 aligned at the bottom. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 24 (CVS log) keep-constant-size Keep W's size from changing. (keep-constant-size w #&optional (enable? #f)) Description Keep W's size from changing. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 142 (CVS log) keep-constant-width Keep W's width at WIDTH. (keep-constant-width w width #&optional (enable? #f)) Description Keep W's width at WIDTH. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 133 (CVS log) keep-full-height Keep W1 and W2 sum of heights equal to the display's height. (keep-full-height w1 w2 #&optional (enable? #f)) Description Keep W1 and W2 sum of heights equal to the display's height. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 88 (CVS log) keep-full-width Keep W1 and W2 sum of widths equal to the display's width. (keep-full-width w1 w2 #&optional (enable? #f)) Description Keep W1 and W2 sum of widths equal to the display's width. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 80 (CVS log) keep-left-at-v Keep W1's left at cl-variable V's pixel value. (keep-left-at-v w1 v #&optional (enable? #f)) Description Keep W1's left at cl-variable V's pixel value. Use cl-set-solver-var to change V. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 64 (CVS log) keep-lefts-even Keep W1 and W2 aligned at the left. (keep-lefts-even w1 w2 #&optional (enable? #f)) Description Keep W1 and W2 aligned at the left. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 16 (CVS log) keep-on-top Ensure that WIN is kept on top of all other windows. (keep-on-top #&optional win) Description Ensure that win is kept on top of all other windows. Obviously, other windows that are also on-top may obscure win. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3058 (CVS log) keep-right-at-v Keep W1's right at cl-variable Vs pixel value. (keep-right-at-v w1 v #&optional (enable? #f)) Description Keep W1's right at cl-variable Vs pixel value. Use cl-set-solver-var to change V. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 72 (CVS log) keep-rights-even Keep W1 and W2 aligned at the right. (keep-rights-even w1 w2 #&optional (enable? #f)) Description Keep W1 and W2 aligned at the right. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 32 (CVS log) keep-to-left-of Keep W1 to the left of W2. (keep-to-left-of w1 w2 #&optional (enable? #f)) Description Keep W1 to the left of W2. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 40 (CVS log) keep-top-at-v Keep W1's top at cl-variable V's pixel value. (keep-top-at-v w1 v #&optional (enable? #f)) Description Keep W1's top at cl-variable V's pixel value. Use cl-set-solver-var to change V. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 56 (CVS log) keep-tops-even Keep W1 and W2 aligned at the top. (keep-tops-even w1 w2 #&optional (enable? #f)) Description Keep W1 and W2 aligned at the top. Implementation Notes Module: (app scwm simple-constraints) Defined in scheme/simple-constraints.scm at line 8 (CVS log) kept-on-top? Return #t if WIN is an on-top window, #f otherwise. (kept-on-top? #&optional win) Description Return #t if win is an on-top window, #f otherwise. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3116 (CVS log) key-mouse-moves Bind four keys to move the mouse in compass directions by PCT-OF-SCREEN. (key-mouse-moves modifiers pct-of-screen left down up right) Description Bind four keys to move the mouse in compass directions by PCT-OF-SCREEN. MODIFIERS specifies which modifiers must be depressed for the bindings to be active. LEFT, DOWN, UP, and RIGHT are the four keysym names to use for each of the directions. Implementation Notes Module: (app scwm key-mover) Defined in scheme/key-mover.scm at line 14 (CVS log) key-viewport-moves Bind four keys to move the viewport in compass directions by PCT-OF-SCREEN. (key-viewport-moves modifiers pct-of-screen left down up right) Description Bind four keys to move the viewport in compass directions by PCT-OF-SCREEN. MODIFIERS specifies which modifiers must be depressed for the bindings to be active. LEFT, DOWN, UP, and RIGHT are the four keysym names to use for each of the directions. Implementation Notes Module: Defined in scheme/key-mover.scm at line 29 (CVS log) keycode->keysym Return a string containing the X11 keysym for key with code KEYCODE. (keycode->keysym keycode) Description Return a string containing the X11 keysym for key with code KEYCODE. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 853 (CVS log) keymask->string Return a string representing KEYMASK. (keymask->string keymask) Description Return a string representing keymask. E.g., (keymask->string 4) => "C-". Returns #f on an error. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1658 (CVS log) keymask-keycode->string Return a string representing the key press with mask KEYMASK, code KEYCODE. (keymask-keycode->string keymask keycode) Description Return a string representing the key press with mask keymask, code keycode. E.g., (keymask-keycode->string 4 44) => "C-j". Returns #f on an error. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1678 (CVS log) keysym->keycode Returns a list of X/11 keycodes that generate the keysym, KEYSYM-NAME. (keysym->keycode keysym-name) Description Returns a list of X/11 keycodes that generate the keysym, keysym-name. keysym-name should be a string. E.g., "Control_L". Return #f if keysym-name is not a valid keysym. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 966 (CVS log) kill-all-fvwm2-modules No documentation supplied. (kill-all-fvwm2-modules) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 579 (CVS log) kill-fvwm2-module No documentation supplied. (kill-fvwm2-module fmod) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 576 (CVS log) kill-fvwm2-modules-by-name No documentation supplied. (kill-fvwm2-modules-by-name module-name) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 582 (CVS log) kwm-emulation-initialize No documentation supplied. (kwm-emulation-initialize) Description No documentation supplied. Implementation Notes Module: (app scwm kde-hints) Defined in scheme/kde-hints.scm at line 218 (CVS log) kwm-emulation-reset No documentation supplied. (kwm-emulation-reset) Description No documentation supplied. Implementation Notes Module: (app scwm kde-hints) Defined in scheme/kde-hints.scm at line 256 (CVS log) kwm-send-window-list No documentation supplied. (kwm-send-window-list) Description No documentation supplied. Implementation Notes Module: (app scwm kde-hints) Defined in scheme/kde-hints.scm at line 190 (CVS log) last-mapped-window Return the window that was mapped most recently. (last-mapped-window) Description Return the window that was mapped most recently. Returns #f if the most recently mapped window is already gone. See also focus-last-mapped-window. Implementation Notes Module: (app scwm last-mapped-window) Defined in scheme/last-mapped-window.scm at line 17 (CVS log) line-slope No documentation supplied. (line-slope x1 y1 x2 y2) Description No documentation supplied. Implementation Notes Module: (app scwm smart-push) Defined in scheme/smart-push2.scm at line 12 (CVS log) list-all-windows Return a list of all of the top-level window objects. (list-all-windows) Description Return a list of all of the top-level window objects. The list is in a semi-arbitrary order that is convenient for the sake of circulation Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2963 (CVS log) list-easyraise-windows No documentation supplied. (list-easyraise-windows) Description No documentation supplied. Implementation Notes Module: (app scwm easyraise) Defined in scheme/easyraise.scm at line 28 (CVS log) list-focus-order Return a list of all the top-level window objects in focus order. (list-focus-order) Description Return a list of all the top-level window objects in focus order. The order is from most recently focussed to least recently focussed. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3027 (CVS log) list-index Return the integer position of OBJ in list L. (list-index l obj) Description Return the integer position of OBJ in list L. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 145 (CVS log) list-non-overlapping-windows Return a list of windows that do not overlap WIN. (list-non-overlapping-windows win) Description Return a list of windows that do not overlap WIN. Iconified windows are ignored. See also windows-overlap?. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 109 (CVS log) list-of-windows? No documentation supplied. (list-of-windows? list-of-windows) Description No documentation supplied. Implementation Notes Module: (app scwm register) Defined in scheme/register.scm at line 95 (CVS log) list-overlapping-windows Return a list of windows that overlap WIN. (list-overlapping-windows win) Description Return a list of windows that overlap WIN. Iconified windows that would overlap when deiconified are not included. See also windows-overlap?. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 103 (CVS log) list-stacking-order Return a list of all non-iconified the top-level window objects, from top to bottom. (list-stacking-order) Description Return a list of all non-iconified the top-level window objects, from top to bottom. The order is the stacking order of the windows. The first element is the topmost window, the last is the bottommost Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2982 (CVS log) list-windows Return the list of windows matching ONLY and not matching EXCEPT. (list-windows #&key (only '()) (except '()) (by-stacking #f) (by-focus #f) (reverse #f)) Description Return the list of windows matching ONLY and not matching EXCEPT. The windows are returned their stacking order (top first) if BY-STACKING is #t (and that option omits iconified windows). They are returned sorted by their last focussed time (most recently focussed first) if BY-FOCUS is #t. If REVERSE is true, they are returned in the reverse of the usual order. ONLY and EXCEPT each are procedures which take a single window argument and returns #t if the window should be included (for ONLY) or excluded (for EXCEPT), or #f otherwise. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 53 (CVS log) list-windows-above List the windows above w from bottom to top. (list-windows-above w #&key (only ()) (except())) Description List the windows above w from bottom to top. Returns a list in the reverse of the stacking order of the windows above W, in other words, from the one immediately above, to the topmost window; the ONLY and EXCEPT keyword arguments operate as is usual for procedures that deal with the window list. Implementation Notes Module: (app scwm stacking) Defined in scheme/stacking.scm at line 30 (CVS log) list-windows-below List the windows below w from top to bottom. (list-windows-below w #&key (only ()) (except())) Description List the windows below w from top to bottom. Returns a list in the stacking order of the windows below in, in other words, from the one immediately below, to the bottommost window; the ONLY and EXCEPT keyword arguments operate as is usual for procedures that deal with the window list. Implementation Notes Module: (app scwm stacking) Defined in scheme/stacking.scm at line 42 (CVS log) list-without-elem Return the list L with element E deleted. (list-without-elem l e) Description Return the list L with element E deleted. Uses eq? for testing equality with E. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 233 (CVS log) listify-if-atom Make L into a list if it is not. (listify-if-atom l) Description Make L into a list if it is not. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 34 (CVS log) load-cached-theme No documentation supplied. (load-cached-theme fname #&optional force?) Description No documentation supplied. Implementation Notes Module: (app scwm themes) Defined in scheme/themes.scm at line 104 (CVS log) load-imlib-image Load an image file using imlib identified by the pathname FULL-PATH. (load-imlib-image full-path) Description Load an image file using imlib identified by the pathname full-path. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 372 (CVS log) load-preferences Load FILENAME to restore the Scwm preferences. (load-preferences #&optional (filename (string-append (getenv "HOME") "/.scwm-options"))) Description Load FILENAME to restore the Scwm preferences. Since the options file is just a bunch of S-expressions, this currently just loads the file to evaluate it. Returns #t iff the load was successful, false otherwise. Implementation Notes Module: Defined in scheme/preferences.scm at line 519 (CVS log) load-theme Returns a theme FNAME which is loaded from `*theme-path*'. (load-theme fname) Description Returns a theme FNAME which is loaded from `*theme-path*'. The theme should be either a directory, or a (possibly gzipped) tar file with extension .tar, .tar.gz, or .tgz. Implementation Notes Module: (app scwm themes) Defined in scheme/themes.scm at line 79 (CVS log) load-theme-image No documentation supplied. (load-theme-image fname) Description No documentation supplied. Implementation Notes Module: (app scwm theme-impl) Defined in scheme/theme-impl.scm at line 56 (CVS log) load-xbm Load an X Bitmap file identified by the pathname FULL-PATH. (load-xbm full-path) Description Load an X Bitmap file identified by the pathname full-path. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 269 (CVS log) load-xpm Load an X Pixmap file identified by the pathname FULL-PATH. (load-xpm full-path) Description Load an X Pixmap file identified by the pathname full-path. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 303 (CVS log) logo-remove Remove the Scwm lambda startup logo. (logo-remove) Description Remove the Scwm lambda startup logo. This is added to startup-hook by logo-setup and usually will not need to be invoked directly. Implementation Notes Module: Defined in scheme/lambda-startup-logo.scm at line 48 (CVS log) logo-setup Setup to display the startup logo. (logo-setup #&optional (should-rotate #f)) Description Setup to display the startup logo. If SHOULD-ROTATE is #t, then the logo will animate (this has some cost in perfromance and memory, but is useful as startup can be longer than ideal). Implementation Notes Module: (app scwm lambda-startup-logo) Defined in scheme/lambda-startup-logo.scm at line 26 (CVS log) lookup-key Return the procedures bound to KEY within the CONTEXTS. (lookup-key contexts key) Description Return the procedures bound to key within the contexts. key is a modifiers and keysym string. contexts is a list of event-contexts (e.g., '(left-button-1 frame-sides)) The return value is a list: (press-proc release-proc), or #f if there is no matching binding. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 880 (CVS log) lookup-mouse Return the procedure bound to mouse BUTTON within the CONTEXTS. (lookup-mouse contexts button) Description Return the procedure bound to mouse button within the contexts. button is a string that may contain modifier prefixes, e.g., "C-S-M-1". contexts is a list of event-contexts (e.g., '(button1 sidebar)) button is a string or integer giving the mouse button number and any modifiers as a prefix. The return values is the procedure object, or #f if there is no matching binding. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1236 (CVS log) lookup-procedure-bindings Return any bindings that invoke PROC in context CONTEXT. (lookup-procedure-bindings #&optional proc context) Description Return any bindings that invoke proc in context context. If proc is omitted or #f, match all bindings in context context. If context is omitted or #f, match bindings regardless of context. If both proc and context are omitted or #f, return all bindings. The return value is a list of binding descriptions. Each binding description is a list: (mouse? contexts modmask keycode-or-butnum press-proc release-or-immediate-proc). mouse? is a boolean, contexts is a list of symbols. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1294 (CVS log) lower-by-one Lower window W below the next window down that overlaps it. (lower-by-one #&optional (w (get-window))) Description Lower window W below the next window down that overlaps it. W defaults to the window context in the usual way. Implementation Notes Module: (app scwm stacking) Defined in scheme/stacking.scm at line 69 (CVS log) lower-easyraise-windows (lower-easyraise-windows) Description Implementation Notes Module: (app scwm easyraise) Defined in scheme/easyraise.scm at line 39 (CVS log) lower-fvwm2-pager Lower a fvwm2 pager window in the stacking order. (lower-fvwm2-pager) Description Lower a fvwm2 pager window in the stacking order. Implementation Notes Module: Defined in scheme/fvwm-module.scm at line 605 (CVS log) lower-group Raise members of GROUP above all other windows. (lower-group #&optional (group (get-window))) Description Raise members of GROUP above all other windows. Keeps the relative stacking order of the members intact. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 95 (CVS log) lower-window Lower WIN to the bottom of the window stack. (lower-window #&optional win) Description Lower win to the bottom of the window stack. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1890 (CVS log) lower-window-below Restack window W immediately below W2. (lower-window-below w w2) Description Restack window W immediately below W2. Implementation Notes Module: (app scwm stacking) Defined in scheme/stacking.scm at line 58 (CVS log) make-all-submenus No documentation supplied. (make-all-submenus structured-list #&optional title) Description No documentation supplied. Implementation Notes Module: (app scwm gnome-panel-menus) Defined in scheme/gnome-panel-menus.scm at line 542 (CVS log) make-color Return the color object corresponding to the X color specifier CNAME. (make-color cname) Description Return the color object corresponding to the X color specifier cname. If cname is not a valid X color name, or cannot be allocated, an error results. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 236 (CVS log) make-conditional-style No documentation supplied. (make-conditional-style condition . args) Description No documentation supplied. Implementation Notes Module: (app scwm style) Defined in scheme/style.scm at line 133 (CVS log) make-context-menu Create a menu of actions applicable to the filename in the X selection. (make-context-menu) Description Create a menu of actions applicable to the filename in the X selection. The selection must contain a single full pathname. Implementation Notes Module: (app scwm std-menus) Defined in scheme/std-menus.scm at line 104 (CVS log) make-debianapps-menu Read menu-file and return a menu object. (make-debianapps-menu #&key (title default-debianapps-menu-title) (menu-file "scwm_menus") #&allow-other-keys #&rest rest) Description Read menu-file and return a menu object. TITLE is the string to be used as title of the menu. MENU-FILE is the file used to create the menu entries, as generated by the menu program in the Debian systems. The rest of the arguments are passed to the menu procedure Implementation Notes Module: Defined in scheme/debianapps-menu.scm at line 72 (CVS log) make-decor Create a new decor object. (make-decor #&optional name) Description Create a new decor object. name optionally provides a string that is used to name the decor, and is displayed when the decor is printed. Implementation Notes Module: Built-in Primitive Defined in src/decor.c at line 209 (CVS log) make-face Create a new face. (make-face flags specs) Description Create a new face. flags is a list of face flags (see concept) and specs is a list of face specifiers. Implementation Notes Module: Built-in Primitive Defined in src/face.c at line 442 (CVS log) make-file-menu Return a menu-object for viewing or editing FILE. (make-file-menu file . rest) Description Return a menu-object for viewing or editing FILE. REST is a list of other menu-items to include in the returned menu. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 90 (CVS log) make-font Return the font object for the X font specifier FNAME. (make-font fname) Description Return the font object for the X font specifier fname. If fname is not a valid X font name, or cannot be allocated, an error results. Implementation Notes Module: Built-in Primitive Defined in src/font.c at line 97 (CVS log) make-hosts-menu Create a telnet menu. (make-hosts-menu host-list #&optional (user (user-name))) Description Create a telnet menu. To use this, add the following to the menu of your choice: (menuitem "telnet" #:action (make-hosts-menu '("host1" "host2" ...))) An optional USER argument specifies the user to telnet as. The element of the list of hosts can be a host (in which case telnet is used) or a cons of (host . command). Implementation Notes Module: (app scwm std-menus) Defined in scheme/std-menus.scm at line 54 (CVS log) make-image Loads an image from the file NAME. (make-image name) Description Loads an image from the file name. To load the image, the appropriate image loaders will be invoked as needed. If name starts with "/", "./" or "../", it is treated as a fully qualified pathname; otherwise, the image path is searched for an appropriate file. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 565 (CVS log) make-image-or-warn Return an image object for FILENAME and report a warning if it fails. (make-image-or-warn filename) Description Return an image object for FILENAME and report a warning if it fails. See make-image for details. Return value is #f on failure, but no error is thrown; image-not-found-message is used to write a warning instead. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 882 (CVS log) make-keep-winclass-centered Return a procedure that keeps windows of CLASS centered in the viewport. (make-keep-winclass-centered class) Description Return a procedure that keeps windows of CLASS centered in the viewport. The resulting procedure should be used put in the X-ConfigureRequest-hook. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 217 (CVS log) make-list Return a list containing N elements equal to the optional second argument. (make-list n . init) Description Return a list containing N elements equal to the optional second argument. If INIT is empty indicating the optional argument was not provided, use the empty list as the element. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 157 (CVS log) make-menu Make and return a menu object from the given arguments. (make-menu list-of-menuitems bg-color text-color stipple-color font #&optional picture-side side-picture-align side-bg-color picture-bg extra-options) Description Make and return a menu object from the given arguments. list-of-menuitems is a non-empty scheme list of menu items -- see make-menuitem; bg-color, text-color and stipple-color are color objects or symbols; font is a font object or symbol; picture-side is an image object to draw on the left side of the menu; side-picture-align is one of 'top, 'center, or 'bottom; side-bg-color is a color object or symbol; picture-bg is an image object; extra-options can be anything understood by the menu-look Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 237 (CVS log) make-menu-another-level No documentation supplied. (make-menu-another-level #&optional (path (string-append (getenv "HOME") "/.gnome/apps-redhat")) (title "AnotherLevel Menus")) Description No documentation supplied. Implementation Notes Module: (app scwm gnome-panel-menus) Defined in scheme/gnome-panel-menus.scm at line 608 (CVS log) make-menu-focus-options Create a menu of focus options for WIN. (make-menu-focus-options win) Description Create a menu of focus options for WIN. Implementation Notes Module: (app scwm winops-menu) Defined in scheme/winops-menu.scm at line 102 (CVS log) make-menu-from-list-of-structured-directories No documentation supplied. (make-menu-from-list-of-structured-directories directory-list title #&optional title-list) Description No documentation supplied. Implementation Notes Module: (app scwm gnome-panel-menus) Defined in scheme/gnome-panel-menus.scm at line 577 (CVS log) make-menu-from-structured-directory No documentation supplied. (make-menu-from-structured-directory directory #&optional title) Description No documentation supplied. Implementation Notes Module: (app scwm gnome-panel-menus) Defined in scheme/gnome-panel-menus.scm at line 564 (CVS log) make-menu-global-theme Return a menu that lets the user set the theme for all windows. (make-menu-global-theme #&optional force?) Description Return a menu that lets the user set the theme for all windows. If FORCE? is #t, then the cached theme file is reloaded. Implementation Notes Module: (app scwm std-menus) Defined in scheme/std-menus.scm at line 138 (CVS log) make-menu-gnome-system No documentation supplied. (make-menu-gnome-system #&optional (path "/usr/share/gnome/apps") (title "System Menus")) Description No documentation supplied. Implementation Notes Module: (app scwm gnome-panel-menus) Defined in scheme/gnome-panel-menus.scm at line 601 (CVS log) make-menu-gnome-user No documentation supplied. (make-menu-gnome-user #&optional (path (string-append (getenv "HOME") "/.gnome/apps")) (title "User Menus")) Description No documentation supplied. Implementation Notes Module: (app scwm gnome-panel-menus) Defined in scheme/gnome-panel-menus.scm at line 615 (CVS log) make-menu-kde No documentation supplied. (make-menu-kde #&optional (path "/usr/share/applnk") (title "KDE Menus")) Description No documentation supplied. Implementation Notes Module: Defined in scheme/gnome-panel-menus.scm at line 622 (CVS log) make-menu-window-theme Return a menu that lets the user set the theme for a single window. (make-menu-window-theme #&optional force?) Description Return a menu that lets the user set the theme for a single window. If FORCE? is #t, then the cached theme file is reloaded. Implementation Notes Module: (app scwm std-menus) Defined in scheme/std-menus.scm at line 125 (CVS log) make-menuitem Return a newly created menuitem object using the given arguments. (make-menuitem label action #&optional extra-label picture-above picture-left hover-action unhover-action hotkey-prefs submenu?) Description Return a newly created menuitem object using the given arguments. label is a string giving the main text label of the menu item; action is a procedure or menu object -- if it is a procedure, it gets invoked when the menuitem is selected, if it is a menu object, that menu is attached as a submenu from the enclosing menu that the created menuitem is put in. You can also force action to be treated as a submenu by setting submenu? to #t. extra-label is extra text describing the menu item -- often this contains a shortcut key description, or some other descriptive text. picture-above and picture-left are picture objects which correspond to images to display within the bounding region of the menuitem. hover-action and unhover-action are procedures to be invoked when the mouse pointer hovers over the item and is moved away after hovering over the item, respectively. hotkey-prefs is a string listing preferred alphanumeric shortcut-keys for the given menu-item; the menu creation routine uses these as hints for assigning shortcut keys to the various menuitems. For a higher-level interface to this function, see menuitem. Implementation Notes Module: Built-in Primitive Defined in src/menuitem.c at line 128 (CVS log) make-menuitems-from-menu-information-list Return a list of menu-items from a list of detailed programs list. (make-menuitems-from-menu-information-list menu-info-list) Description Return a list of menu-items from a list of detailed programs list. The format is subject to change. See sample.scwmrc/gjb.scwmrc for example usage. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 177 (CVS log) make-message-window Returns a newly created message window object with string MESSAGE. (make-message-window message) Description Returns a newly created message window object with string message. message is the initial string for the message window. Uses defaults from the ScreenInfo struct for the other values. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 260 (CVS log) make-message-window-clone-default Return a new message window that has the default style. (make-message-window-clone-default str) Description Return a new message window that has the default style. This is done by cloning the style (see message-window-style) of the variable default-message-window. Implementation Notes Module: (app scwm message-window) Defined in scheme/message-window.scm at line 252 (CVS log) make-message-window-win-copy Return a message window with a background that is a copy of the image in WIN. (make-message-window-win-copy #&optional (win 'root-window)) Description Return a message window with a background that is a copy of the image in WIN. The message-window will have no text and no relief, and be the same size as WIN. Implementation Notes Module: (app scwm message-window) Defined in scheme/message-window.scm at line 284 (CVS log) make-message-window-with-image Return a new message window with IMG as a background, sized appropriately. (make-message-window-with-image img #&optional (shaped? #f)) Description Return a new message window with IMG as a background, sized appropriately. Initially the message window is centered in the display. Implementation Notes Module: (app scwm message-window) Defined in scheme/message-window.scm at line 242 (CVS log) make-relief-color Convert a color into a new color appropriate for a relief. (make-relief-color color factor) Description Convert a color into a new color appropriate for a relief. Multiplies the luminosity and saturation of color by the positive floating point number factor. Using a factor smaller than 1 will result in a dimmer color, suitable for use as a darker relief. Using a factor greater than 1 will result in a brighter color which is suitable for use as a highlight. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 586 (CVS log) make-reversed-color Return a new color that is opposite COLOR. (make-reversed-color color) Description Return a new color that is opposite color. Note that the returned color will not necessarily contrast with color; (make-reversed-color "gray50") is almost indistinguishable from "gray50". Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 606 (CVS log) make-rhosts-menu Returns a menu which lets you rlogin to each host mentioned in your . (make-rhosts-menu) Description Returns a menu which lets you rlogin to each host mentioned in your .rhosts Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 235 (CVS log) make-small-window-ops-menu Return a short menu of window operations for window W. (make-small-window-ops-menu w) Description Return a short menu of window operations for window W. The menu lets you move, resize, maximize, minimize, set gravity, stick, shove, set the style, group, etc. Implementation Notes Module: (app scwm winops-menu) Defined in scheme/winops-menu.scm at line 37 (CVS log) make-string-usable-for-resource-key Return a converted string from STRING that can be used as an X resource key. (make-string-usable-for-resource-key string) Description Return a converted string from STRING that can be used as an X resource key. The returned string will have all non-alphanumeric characters replaced with underscores, so that the resulting string can be used as a key for X-resource-get and X-resource-put. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 12 (CVS log) make-style No documentation supplied. (make-style . args) Description No documentation supplied. Implementation Notes Module: (app scwm style) Defined in scheme/style.scm at line 69 (CVS log) make-theme Creates a theme object with the given NAME, WINDOW-STYLE, and BACKGROUND-STYLE. (make-theme name #&key (window-style (make-style #t)) (background-style (lambda () ()))) Description Creates a theme object with the given NAME, WINDOW-STYLE, and BACKGROUND-STYLE. Implementation Notes Module: (app scwm theme-impl) Defined in scheme/theme-impl.scm at line 62 (CVS log) make-toggling-winop Returns a procedure which takes a window WIN and toggles a property of it. (make-toggling-winop pred neg pos) Description Returns a procedure which takes a window WIN and toggles a property of it. PRED, NEG, and POS should be functions which take a window and check whether the property holds for the window, reset the property on the window, and set the property on the window, respectively. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 41 (CVS log) make-ui-constraint UI-CONSTRAINT-CLASS specified the type of constraint to be created. (make-ui-constraint ui-constraint-class arg-list #&key (visible? #t)) Description UI-CONSTRAINT-CLASS specified the type of constraint to be created. WIN-LIST specifies the windows to be constrained. Returns a new constraint object that is NOT enabled. errors if UI-CONSTRAINT-CLASS is not valid. Returned objects are #(obid-ui-constraint CLASS CN ENABLED? LIST-OF-WINDOWS OPTS BUT DHOOKS) The OPTS param is a spot for optional data to be specified by the ui-constraint-class constructor. If data returns from that constructor in list form, the first element of the list is assumed to be the CN and the cdr is stuck in OPTS. BUT may contain a reference to the gtk button for the constraint instance in the toggle menu if that feature is in use. DHOOKS is a list of hook procedures that should be called when the enable is changed on this constraint. These hook functions may only be added after an instance is created. SIDE-EFFECT: adds new instance object to the global list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 306 (CVS log) make-ui-constraint-class Creates a new ui-constraint-class object. (make-ui-constraint-class name description num-windows ctr ui-ctr draw-proc satisfied-proc pixmap-name pixmap2-name menuname-proc) Description Creates a new ui-constraint-class object. CTR takes a set of arguments and installs the appropriate constraints in the solver. A number of windows should be included in those arguments, falling somewhere in the range of NUM-WINDOWS. NUM-WINDOWS is a list of '(min-win max-win) where the values specify the minimum and maximum number of windows which may be constrained. Max-win may optionally be specified as a non-number (preferably as #t), in which case the constraint is taken to be able to constraint an infinite number of windows. SATISFIED-PROC is a procedure that takes a single argument, the cn, and tells if it is satisfied UI-CTR should return the arguments (as a list) for CTR to build the constraint with. UI-CTR should return #f if the user cancels the construction or fails to follow the interface correctly. PIXMAP-NAME is the name of the pixmap to associate with this constraint-class in the user interface. MENUNAME-PROC is a proc that takes a UI-CONSTRAINT as an arg and returns the name that should be used for the constraint in the toggle menu. This routine returns a new constraint class object based on the parameters. SIDE-EFFECT: addes new class obj to the global class list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 81 (CVS log) make-ui-constraint-interactively Uses the UI constructor of the constraint class to prompt the user to (make-ui-constraint-interactively ui-constraint-class) Description Uses the UI constructor of the constraint class to prompt the user to specify options for the constraint. errors if UI-CONSTRAINT-CLASS is not a ui-constraint-class. Calls make-ui-constraint (see above). Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 342 (CVS log) make-window-group-menu Return a menu for window group operations. (make-window-group-menu w) Description Return a menu for window group operations. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 175 (CVS log) make-window-list-menu Popup a window list menu and permit a selection to be made. (make-window-list-menu #&key (only '()) (except '()) (by-stacking #f) (by-focus #f) (by-resource #f) (reverse #f) (proc window-list-proc) (flash-window-proc flash-window-on) (unflash-window-proc unflash-window) (hover-delay 0) (popup-delay #f) (show-geometry #f) (show-last-focus-time #f) (ignore-winlist-skip #f) (show-mini-icon #t) (enumerate-hotkeys #t)) Description Popup a window list menu and permit a selection to be made. ONLY and EXCEPT are procedures that control which windows will appear in the list -- see list-windows for details. BY-STACKING, BY-FOCUS and REVERSE control the order in which windows appear. See list-windows for more on these as well. PROC is the procedure which will be called on the selected window. FLASH-WINDOW-PROC and UNFLASH-WINDOW-PROC are set as the hover-action and unhover-action (respectively) of the items in the menu. (See menuitem.) If SHOW-GEOMETRY is #t, the geometries of the windows will be listed in each menuitem. If SHOW-LAST-FOCUS-TIME is #t, the last focus time of the windows will be listed in each menuitem. If SHOW-MINI-ICON is #t, the mini-icon of the windows will be displayed with each menuitem. If WARP-TO-FIRST is #t, the mouse pointer will be warped to the first menuitem (see popup-menu). If BY-RESOURCE is #t, the window list is split into sublists by the window resource name (this is also the behaviour if too many windows exist to fit vertically on the menu). If ENUMERATE-HOT-KEYS is #t, then add alpha-numeric hot keys for the window-list. For the hotkey, the characters 1 through 9 are used first, followed by the letters a through z. Currently this is turned off if BY-RESOURCE is #t. Implementation Notes Module: (app scwm winlist-menu) Defined in scheme/winlist-menu.scm at line 18 (CVS log) make-window-style-menu Offer a choice to style the window, like named windows, or a whole class. (make-window-style-menu #&optional (win (get-window))) Description Offer a choice to style the window, like named windows, or a whole class. WIN is the window to style and defaults to the window-context. Implementation Notes Module: (app scwm stylist) Defined in scheme/stylist.scm at line 164 (CVS log) make-wmconfig-menu Return a menu object for the window-manager configuration menu. (make-wmconfig-menu #&optional (wmconfig-title default-wmconfig-title) (wmconfig-dir default-wmconfig-dir)) Description Return a menu object for the window-manager configuration menu. Implementation Notes Module: Defined in scheme/wmconfig-menu.scm at line 97 (CVS log) make-X-geometry No documentation supplied. (make-X-geometry #&key (x-size #f) (y-size #f) (x-offset #f) (y-offset #f)) Description No documentation supplied. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 418 (CVS log) make-xlock-menu Create an xlock menu. (make-xlock-menu #&optional (lock? #f)) Description Create an xlock menu. To use this, add the following to the menu of your choice: (menuitem "Screensaver" #:action (make-xlock-menu #f)) or (menuitem "Lock Screen" #:action (make-xlock-menu #t)) Implementation Notes Module: Defined in scheme/xlock-menus.scm at line 73 (CVS log) map-in-order Process FIRST and the lists comprising REST as map would. (map-in-order proc first . rest) Description Process FIRST and the lists comprising REST as map would. However, PROC is guaranteed to be called on these elements in the order in which they appear in the lists. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 173 (CVS log) marshal-fvwm2-config-info Constructs a fvwm2 BroadcastInfo module packet. (marshal-fvwm2-config-info win) Description Constructs a fvwm2 BroadcastInfo module packet. The return value is the contents of a BroadcastInfo fvwm2 module packet for win as a Scheme string. Implementation Notes Module: Built-in Primitive Defined in src/module-interface.c at line 133 (CVS log) marshal-fvwm2-iconify-info Constructs a fvwm2 "M_ICONIFY" module packet. (marshal-fvwm2-iconify-info win) Description Constructs a fvwm2 "M_ICONIFY" module packet. The return value is the contents of an "M_ICONIFY" fvwm module packet for win as a Scheme string. Implementation Notes Module: Built-in Primitive Defined in src/module-interface.c at line 176 (CVS log) mask->keycodes Return a list of keycodes corresponding to keys that generate the modifiers in MASK. (mask->keycodes mask) Description Return a list of keycodes corresponding to keys that generate the modifiers in MASK. Implementation Notes Module: (app scwm quote) Defined in scheme/quote.scm at line 76 (CVS log) maximize Maximize WIN to new pixel width NW and new pixel height NH. (maximize nw nh #&optional (win (get-window))) Description Maximize WIN to new pixel width NW and new pixel height NH. If NW or NH is 0, that dimension is not changed. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 132 (CVS log) maximize-both Maximize WIN both horizontally and vertically. (maximize-both #&optional (win (get-window))) Description Maximize WIN both horizontally and vertically. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 442 (CVS log) maximize-horizontal Maximize WIN horizontally. (maximize-horizontal #&optional (win (get-window))) Description Maximize WIN horizontally. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 437 (CVS log) maximize-vertical Maximize WIN vertically. (maximize-vertical #&optional (win (get-window))) Description Maximize WIN vertically. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 432 (CVS log) maximized? Return #t if WIN is maximized, #f otherwise. (maximized? #&optional (win (get-window))) Description Return #t if WIN is maximized, #f otherwise. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 165 (CVS log) maybe-make-color Try to make OBJ into a color and return that color object. (maybe-make-color obj) Description Try to make OBJ into a color and return that color object. Returns #f if OBJ is not a color object or a string. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 75 (CVS log) menu Return a menu object with the given attributes. (menu list-of-menuitems #&key (image-side 'menu-side-image) (image-align 'top) (color-bg-image-side 'menu-side-bg-color) (image-bg 'menu-bg-image) (color-text 'menu-text-color) (color-bg 'menu-bg-color) (color-stipple 'menu-stipple-color) (hl-color-fg 'menu-hl-fg-color) (hl-color-bg 'menu-hl-bg-color) (hl-relief? #t) (font 'menu-font) (look 'menu-look) popup-delay hover-delay (extra #f)) Description Return a menu object with the given attributes. LIST-OF-MENUITEMS is a list of menuitem objects (each created with make-menuitem or menuitem). IMAGE-SIDE is an image object to be displayed along the left edge of the menu. IMAGE-ALIGN determines whether to align that image to the 'top, 'center or 'bottom of the menu. COLOR-BG-IMAGE-SIDE is the background color for that image object. COLOR-TEXT is a color object or string for the foreground text color of menu items. COLOR-BG is a color object or string for the background color for the menu and menu items. COLOR-STIPPLE is a color object for stippled ("grayed") menu items. FONT is a font object for the font of the menu items. EXTRA is an extra argument specific to the menu look used for this menu. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 526 (CVS log) menu-highlight-colors Return list text-color, bg-color, the highlight colors for MENU. (menu-highlight-colors menu) Description Return list text-color, bg-color, the highlight colors for menu. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 460 (CVS log) menu-highlight-factor Return the current menu highlight factor. (menu-highlight-factor) Description Return the current menu highlight factor. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 739 (CVS log) menu-highlight-relief? Return #t if MENU's selected item is relieved, #f otherwise. (menu-highlight-relief? menu) Description Return #t if menu's selected item is relieved, #f otherwise. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 471 (CVS log) menu-hotkeys-activate-item? Return #t if hotkeys invoke item, #f if they just select the item. (menu-hotkeys-activate-item?) Description Return #t if hotkeys invoke item, #f if they just select the item. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 1638 (CVS log) menu-hover-delay Return MENU's hover action delay. (menu-hover-delay menu) Description Return menu's hover action delay. See set-menu-hover-delay!. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 359 (CVS log) menu-look? Return #t if OBJ is a menulook object, #f otherwise. (menu-look? obj) Description Return #t if obj is a menulook object, #f otherwise. Implementation Notes Module: Built-in Primitive Defined in src/menulook.c at line 52 (CVS log) menu-max-fold-lines Return an approximation of the number of menuitems that will fit vertically on screen. (menu-max-fold-lines) Description Return an approximation of the number of menuitems that will fit vertically on screen. Implementation Notes Module: (app scwm menus-extras) Defined in scheme/menus-extras.scm at line 31 (CVS log) menu-popup-delay Return MENU's submenu popup delay. (menu-popup-delay menu) Description Return menu's submenu popup delay. See set-menu-popup-delay!. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 334 (CVS log) menu-prefs Generate the Preferences menu. (menu-prefs . opts) Description Generate the Preferences menu. All the arguments are passed directly to the menu function. Implementation Notes Module: Defined in scheme/prefs-menu.scm at line 213 (CVS log) menu-properties Returns the a list of the menu properties of MENU, a menu object. (menu-properties menu) Description Returns the a list of the menu properties of menu, a menu object. The properties returned are: '(menu-title menu-items side-image side-image-align side-bg-color bg-color text-color stipple-color image-bg font extra-options used-shortcut-keys popup-delay hover-delay) Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 199 (CVS log) menu-shadow-factor Return the current menu shadow factor. (menu-shadow-factor) Description Return the current menu shadow factor. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 762 (CVS log) menu-style Set various properites for the menus. (menu-style #&key (fg #f) (foreground #f) (bg #f) (background #f) (hl-fg #f) (hl-foreground #f) (hl-bg #f) (hl-background #f) (bg-image #f) (stipple #f) (font #f) (title-font #f) (look #f) (side-image #f) (side-bg 'unset)) Description Set various properites for the menus. See make-menu for options on creation of individual menus. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 411 (CVS log) menu-title Return a menuitem object that is a title. (menu-title label . rest) Description Return a menuitem object that is a title. All arguments that menuitem takes are accepted as usual, except the font defaults to `*menu-title-font*' instead of `*menu-font*'. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 472 (CVS log) menu? Return #t if and only if OBJ is a menu object. (menu? obj) Description Return #t if and only if obj is a menu object. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 136 (CVS log) menuitem Return a menuitem object with the given attributes. (menuitem label #&key image-above image-left (fg #f) (bg #f) (font #f) extra-label action submenu hover-action unhover-action hotkey-prefs) Description Return a menuitem object with the given attributes. LABEL is a string for the name on the item. IMAGE-ABOVE is an image object to show above the label. IMAGE-LEFT is an image object to show to the left of the label. EXTRA_LABEL is a second label shown on the item. ACTION is a menu object or a procedure; if it is a menu object, the item will popup ACTION as a sub-menu, if it is a procedure, the procedure will be invoked when the item is selected. HOVER-ACTION is an procedure to be invoked when the item is highlighted but not invoked for a moment; UNHOVER-ACTION is a procedure to be invoked after the HOVER-ACTION is invoked when the item is unhighlighted. HOTKEY-PREFS is a string listing the characters which are appropriate shortcut-keys for the item; the first not-yet-used-in-this-menu character will be used for the shortcut key for the menu item. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 479 (CVS log) menuitem->scwm-gtk-menuitem No documentation supplied. (menuitem->scwm-gtk-menuitem mi) Description No documentation supplied. Implementation Notes Module: (app scwm gtk-menu) Defined in scheme/gtk-menu.scm at line 60 (CVS log) menuitem-colors Returns a list of the fg and bg colors for MENUITEM. (menuitem-colors menuitem) Description Returns a list of the fg and bg colors for menuitem. Will return #f for either/both components if menuitem inherits its color from the menu in which it is embedded. Implementation Notes Module: Built-in Primitive Defined in src/menuitem.c at line 226 (CVS log) menuitem-font Returns the font of MENUITEM. (menuitem-font menuitem) Description Returns the font of menuitem. Returns #f if menuitem inherits its font from the menu in which it is embedded. Implementation Notes Module: Built-in Primitive Defined in src/menuitem.c at line 256 (CVS log) menuitem-properties Return a list of the properties of the given MENU-ITEM. (menuitem-properties menu-item) Description Return a list of the properties of the given menu-item. menu-item is a menuitem object, created by make-menuitem. The returned list contains the following, in this order: '(label action extra-label picture-above picture-left hover-action unhover-action hotkey-preferences force-submenu?) Note that this is the same as the arguments to the make-menuitem primitive. Implementation Notes Module: Built-in Primitive Defined in src/menuitem.c at line 101 (CVS log) menuitem? Return #t if and only if OBJ is a menu item object. (menuitem? obj) Description Return #t if and only if obj is a menu item object. Implementation Notes Module: Built-in Primitive Defined in src/menuitem.c at line 91 (CVS log) message Display the string arguments STR in a message window. (message . str) Description Display the string arguments STR in a message window. Requires the program xmessage. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 104 (CVS log) message-window-colors Returns the colors that the message window MWN is displayed with. (message-window-colors mwn) Description Returns the colors that the message window mwn is displayed with. These are returned in a list of the form (fg_color,bg_color). Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 662 (CVS log) message-window-copy-style! Copy the visual style of MSGWIN-SOURCE to the style for MSGWIN. (message-window-copy-style! msgwin msgwin-source) Description Copy the visual style of MSGWIN-SOURCE to the style for MSGWIN. Returns a list of the font, fg-color, bg-color of msgwin-source Implementation Notes Module: (app scwm message-window) Defined in scheme/message-window.scm at line 260 (CVS log) message-window-font Returns the font that the message window MWN uses for displaying text. (message-window-font mwn) Description Returns the font that the message window mwn uses for displaying text. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 640 (CVS log) message-window-hide! Hide the message window MWN. (message-window-hide! mwn) Description Hide the message window mwn. See also message-window-show. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 554 (CVS log) message-window-id Returns the X11 id of message window MWN. (message-window-id mwn) Description Returns the X11 id of message window mwn. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 651 (CVS log) message-window-image Returns the image that message window MWN displays. (message-window-image mwn) Description Returns the image that message window mwn displays. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 594 (CVS log) message-window-message Returns the message that message window MWN displays. (message-window-message mwn) Description Returns the message that message window mwn displays. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 583 (CVS log) message-window-options Allow specification of message-window behavior for standard actions. (message-window-options action #&key enable follow-window position gravity offset proportional-offset) Description Allow specification of message-window behavior for standard actions. ACTION specifies the action for which this behavior should be used. Currently, 'interactive-move and 'interactive-resize are the only useful values. ENABLE is a boolean value inidicating whether to use a message window for that action at all. GRAVITY indicates which point on the message window is used as the control point for placing it. See `gravity->alignmnents' for a list of valid gravity specs. If FOLLOW-WINDOW is true, the message window will track the window on which an action is being performed, if applicable. In this case, POSITION is ignored; OFFSET is taken as a list of the X and Y offsets from the window's top left corner, and PROPORTIONAL-OFFSET is taken as a list of factors to multiply by the window's size. For instance, an OFFSET of (0 0) and a PROPORTIONAL-OFFSET of (0.5 0.5) will place the message window at the center of of the window being operated on. However, if FOLLOW-WINDOW is false, or there is no applicable window, POSITION is interpreted as a list of x, y coordinates at which to place the message window. These options are cumulative for repeated calls to message-window-options for the same action. Implementation Notes Module: (app scwm message-window) Defined in scheme/message-window.scm at line 52 (CVS log) message-window-position Returns the position that message window MWN is/will be displayed at. (message-window-position mwn) Description Returns the position that message window mwn is/will be displayed at. This is returned as a four element list: (x y x-align y-align). Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 605 (CVS log) message-window-relief? Returns the relief setting for the message window MWN. (message-window-relief? mwn) Description Returns the relief setting for the message window mwn. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 674 (CVS log) message-window-set-colors! Set the fore- and background colors to be used for the message window MWN. (message-window-set-colors! mwn fg-color bg-color) Description Set the fore- and background colors to be used for the message window mwn. The foreground color will be fg-color and the background color will be bg-color Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 418 (CVS log) message-window-set-font! Set the font to be used for the message window MWN. (message-window-set-font! mwn fnt) Description Set the font to be used for the message window mwn. The font will be fnt Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 394 (CVS log) message-window-set-image! Changes the background image for the message window MWN to IMAGE. (message-window-set-image! mwn image #&optional fg-color bg-color shaped?) Description Changes the background image for the message window mwn to image. fg-color, bg-color are the colors for the image, shaped? is whether it should use a shaped message window. If image is #f, then no image is used for mwn. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 351 (CVS log) message-window-set-message! Changes the message displayed by the message window MWN. (message-window-set-message! mwn message) Description Changes the message displayed by the message window mwn. The message will be message Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 330 (CVS log) message-window-set-position! Set the position to be used for the message window MWN. (message-window-set-position! mwn x y #&optional x-align y-align) Description Set the position to be used for the message window mwn. x and y specify the position of the control point of the window, while x-align and y-align specify a fraction of the width and height of the message window to offset it from the specified position. x-align and y-align should each be in the range [-1,0]. E.g., If x-align and y-align are both -0.5, the window will be centered at viewport pixel position x, y. Any of the parameters excep mwn can be #f to mean not to change the existing value. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 457 (CVS log) message-window-set-relief! Sets the relief for the window MWN. (message-window-set-relief! mwn draw-relief?) Description Sets the relief for the window mwn. Relief will be drawn if and only if draw-relief? is #t. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 509 (CVS log) message-window-set-size! Set the size of message window MWN to WIDTH pixels by HEIGHT pixels. (message-window-set-size! mwn width height) Description Set the size of message window mwn to width pixels by height pixels. If width or height is #f, that direction is automatically sized based on the message content. This procedure is especially useful when a message window is used to display an image. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 484 (CVS log) message-window-show! Displays the message window MWN on the screen. (message-window-show! mwn) Description Displays the message window mwn on the screen. Be sure to keep the displayed message window somewhere do that you can call message-window-hide! (otherwise the window will not ever disappear). Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 526 (CVS log) message-window-size Returns the size of message window MWN in pixels. (message-window-size mwn) Description Returns the size of message window mwn in pixels. Returns as a two element list: (width height). Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 621 (CVS log) message-window-style Set visual style of MSGWIN. (message-window-style msgwin #&key (font #f) (fg #f) (bg #f)) Description Set visual style of MSGWIN. FONT specifies the font, FG the foreground color, and BG the background color. Implementation Notes Module: (app scwm message-window) Defined in scheme/message-window.scm at line 234 (CVS log) message-window-visible? Return #t if the message window MWN is visible, #f otherwise. (message-window-visible? mwn) Description Return #t if the message window mwn is visible, #f otherwise. See also message-window-show, message-window-hide. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 570 (CVS log) message-window? Returns #t if MWN is a msgwindow object, otherwise #f. (message-window? mwn) Description Returns #t if mwn is a msgwindow object, otherwise #f. Implementation Notes Module: Built-in Primitive Defined in src/message-window.c at line 90 (CVS log) midpoint No documentation supplied. (midpoint x1 x2) Description No documentation supplied. Implementation Notes Module: (app scwm smart-push) Defined in scheme/smart-push2.scm at line 8 (CVS log) mod-desk-size! Modify the current desktop size by the given parameter. (mod-desk-size! dx dy) Description Modify the current desktop size by the given parameter. Implementation Notes Module: (app scwm prefs-menu) Defined in scheme/prefs-menu.scm at line 71 (CVS log) mod-mask-alt Return the bit-mask for the Alt modifier key, or #f. (mod-mask-alt) Description Return the bit-mask for the Alt modifier key, or #f. Returns #f if and only if there is no key bound to act as Alt, otherwise returns a power of two corresponding to the bit-mask of the modifier Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1468 (CVS log) mod-mask-control Return the bit-mask for the Control modifier key, or #f. (mod-mask-control) Description Return the bit-mask for the Control modifier key, or #f. Returns #f if and only if there is no key bound to act as Control, otherwise returns a power of two corresponding to the bit-mask of the modifier Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1452 (CVS log) mod-mask-hyper Return the bit-mask for the Hyper modifier key, or #f. (mod-mask-hyper) Description Return the bit-mask for the Hyper modifier key, or #f. Returns #f if and only if there is no key bound to act as Hyper, otherwise returns a power of two corresponding to the bit-mask of the modifier Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1476 (CVS log) mod-mask-meta Return the bit-mask for the Meta modifier key, or #f. (mod-mask-meta) Description Return the bit-mask for the Meta modifier key, or #f. Returns #f if and only if there is no key bound to act as Meta, otherwise returns a power of two corresponding to the bit-mask of the modifier Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1460 (CVS log) mod-mask-numlock Return the bit-mask for the NumLock modifier key, or #f. (mod-mask-numlock) Description Return the bit-mask for the NumLock modifier key, or #f. Returns #f if and only if there is no key bound to act as NumLock, otherwise returns a power of two corresponding to the bit-mask of the modifier Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1494 (CVS log) mod-mask-scrolllock Return the bit-mask for the ScrollLock modifier key, or #f. (mod-mask-scrolllock) Description Return the bit-mask for the ScrollLock modifier key, or #f. Returns #f if and only if there is no key bound to act as ScrollLock, otherwise returns a power of two corresponding to the bit-mask of the modifier Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1503 (CVS log) mod-mask-shift Return the bit-mask for the Shift modifier key, or #f. (mod-mask-shift) Description Return the bit-mask for the Shift modifier key, or #f. Returns #f if and only if there is no key bound to act as Shift, otherwise returns a power of two corresponding to the bit-mask of the modifier Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1444 (CVS log) mod-mask-super Return the bit-mask for the Super modifier key, or #f. (mod-mask-super) Description Return the bit-mask for the Super modifier key, or #f. Returns #f if and only if there is no key bound to act as Super, otherwise returns a power of two corresponding to the bit-mask of the modifier Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1485 (CVS log) module-and-proc-names->proc Return the procedure named PROC-NAME from module named MODULE-NAME. (module-and-proc-names->proc module-name proc-name) Description Return the procedure named PROC-NAME from module named MODULE-NAME. PROC-NAME and MODULE-NAME are both strings. Note that module name must be a full name such as "app scwm base". Implementation Notes Module: Defined in scheme/prompt-proc.scm at line 236 (CVS log) module-event-name-from-number Return the string module event name for event number NUM. (module-event-name-from-number num) Description Return the string module event name for event number NUM. Implementation Notes Module: Defined in scheme/module-types.scm at line 64 (CVS log) mouse-event-type Return a symbol corresponding to the type of the most recent mouse event. (mouse-event-type) Description Return a symbol corresponding to the type of the most recent mouse event. Return value is one of 'motion, 'click, 'one-and-a-half-clicks, 'double-click. You can case on this symbol in a procedure bound to a mouse event to determine, e.g., whether the user single clicked or double clicked. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1424 (CVS log) mouse-focus-click-raises? Returns a boolean value indicating whether a mouse-focus-click will raise the window. (mouse-focus-click-raises?) Description Returns a boolean value indicating whether a mouse-focus-click will raise the window. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 368 (CVS log) move-after-deleting-constraints Move WIN after deleting all constraints that involve it. (move-after-deleting-constraints #&optional (win (get-window))) Description Move WIN after deleting all constraints that involve it. See also delete-ui-constraints-involving-window!. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 746 (CVS log) move-after-deleting-inferred-constraints Move WIN after deleting all inferred constraints that involve it. (move-after-deleting-inferred-constraints #&optional (win (get-window))) Description Move WIN after deleting all inferred constraints that involve it. See also delete-inferred-ui-constraints-involving-window!. Implementation Notes Module: Defined in scheme/ui-constraints.scm at line 753 (CVS log) move-group Move GROUP to virtual coordinates X, Y. (move-group x y #&optional (group (get-window))) Description Move GROUP to virtual coordinates X, Y. Move the window GROUP represents to X, Y, and keep the other windows in GROUP in the same relative positions to this window. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 108 (CVS log) move-group-relative Move all members of GROUP by DX, DY pixels. (move-group-relative dx dy #&optional (group (get-window))) Description Move all members of GROUP by DX, DY pixels. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 103 (CVS log) move-group-to-desk Move all members of GROUP to DESK. (move-group-to-desk desk #&optional (group (get-window))) Description Move all members of GROUP to DESK. See move-window-to-desk. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 115 (CVS log) move-inside-aligned-viewport Ensure that WIN is entirely inside the XX, YY viewport if possible. (move-inside-aligned-viewport win xx yy) Description Ensure that WIN is entirely inside the XX, YY viewport if possible. XX and YY are given in units of the display size. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 122 (CVS log) move-inside-current-viewport Ensure that WIN is entirely inside the current viewport, if possible. (move-inside-current-viewport win) Description Ensure that WIN is entirely inside the current viewport, if possible. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 127 (CVS log) move-inside-own-viewport Ensure that WIN is entirely inside the closest viewport to its center. (move-inside-own-viewport win) Description Ensure that WIN is entirely inside the closest viewport to its center. The viewport selected will be an integral multiple of the desk size. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 131 (CVS log) move-inside-viewport Ensure that WIN is entirely inside the X, Y viewport if possible. (move-inside-viewport win x y) Description Ensure that WIN is entirely inside the X, Y viewport if possible. X and Y are given in pixels. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 110 (CVS log) move-nonsticky-windows-relative Move all windows right X, down Y pixels. (move-nonsticky-windows-relative x y) Description Move all windows right X, down Y pixels. See `move-window-relative.' Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 355 (CVS log) move-pointer Move the X11 pointer X pixels to the right, and Y pixels down. (move-pointer x y) Description Move the X11 pointer X pixels to the right, and Y pixels down. If X is negative, moves to the left. If Y is negative moves up. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 320 (CVS log) move-pointer-to Move the mouse pointer to viewport coordinates SX, SY. (move-pointer-to sx sy) Description Move the mouse pointer to viewport coordinates sx, sy. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 253 (CVS log) move-to Move WIN to viewport position X, Y. (move-to x y #&optional (win (get-window))) Description Move WIN to viewport position X, Y. If X or Y is #f, then do not move along that axis (use existing value for that coordinate). See move-window if you wish to move a window to a virtual position. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 328 (CVS log) move-to-viewport Move to the viewport numbered (XX,YY). (move-to-viewport xx yy) Description Move to the viewport numbered (XX,YY). The (0,0) viewport is the starting viewport. XX and YY are full display-size increments (e.g., (1,0) is the viewport just to the right of the home (0,0) viewport). Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 147 (CVS log) move-viewport Move the viewport onto the virtual desktop relatively. (move-viewport x y) Description Move the viewport onto the virtual desktop relatively. Moves X pixels horizontally, to the right if positive, to the left if negative, and Y pixels vertically, down if positive, up if negative. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 395 (CVS log) move-window Move WIN to virtual coordinates X, Y. (move-window x y #&optional win) Description Move win to virtual coordinates x, y. If x is #f, then x defaults to the current x position of win. If y is #f, then y defaults to the current y position of win. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2376 (CVS log) move-window-relative Move WIN X, Y pixels from where it is currently. (move-window-relative x y #&optional (win (get-window))) Description Move WIN X, Y pixels from where it is currently. Positive X moves right, negative moves left. Positive Y moves down, negative moves up. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 351 (CVS log) move-window-to-desk Move WIN to DESK. (move-window-to-desk desk #&optional win) Description Move win to desk. desk is an integer desk identifier. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2504 (CVS log) move-window-to-viewport Move WIN to the viewport numbered (XX,YY). (move-window-to-viewport xx yy #&optional (win (get-window))) Description Move WIN to the viewport numbered (XX,YY). The (0,0) viewport is the starting viewport. XX and YY are full display-size increments (e.g., (1,0) is the viewport just to the right of the home (0,0) viewport). Uses window-position-in-viewport to select the position within the viewport. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 101 (CVS log) msec->usec Convert MSEC milliseconds into an equivalent number of microseconds. (msec->usec msec) Description Convert MSEC milliseconds into an equivalent number of microseconds. Especially useful for usleep and other timing related procedures that take microseconds. Implementation Notes Module: (app scwm time-convert) Defined in scheme/time-convert.scm at line 30 (CVS log) mwm-decorations->string Converts the MWM decoration flags into a readable form. (mwm-decorations->string decor) Description Converts the MWM decoration flags into a readable form. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 179 (CVS log) mwm-functions->string Converts the MWM function flags into a readable form. (mwm-functions->string func) Description Converts the MWM function flags into a readable form. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 158 (CVS log) near-window-placement Return a procedure that places a window near the window returned by WINDOW-GETTER. (near-window-placement window-getter #&key (offset '(0 0)) (proportional-offset '(-0.5 -0.5)) (relative-to 'center) (auto-focus #f)) Description Return a procedure that places a window near the window returned by WINDOW-GETTER. If RELATIVE-TO is specified, it gives a symbolic location in the existing window returned by WINDOW-GETTER to use as the control point for the window placement. RELATIVE-TO may be any of northwest north northeast west center east southwest south southeast. If OFFSET is specified, it is interpreted as a list of x and y offsets to add to the control point. If PROPORTIONAL-OFFSET is specified, it is interpreted as a list of numbers to multiply by the being-placed window's width and height, and is treated as an extra offset added to the control point. The defaults are (0 0) for OFFSET and (-0.5 -0.5) for PROPORTIONAL-OFFSET, with the result that by default the window is centered at the control point of the existing window. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 169 (CVS log) nearest-aligned-viewport Compute the nearest valid integral viewport position to POS. (nearest-aligned-viewport pos) Description Compute the nearest valid integral viewport position to POS. POS is a list of x and y virtual coordinates in that order. The viewport coordinates returned will be in the same format and will be a integral multiples of the desk size. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 47 (CVS log) netpbm-loader Tries to load an arbitrary image using the netpbm packge. (netpbm-loader fname) Description Tries to load an arbitrary image using the netpbm packge. Uses anytoppm and ppmtoxpm to try to convert the file to an xpm, then attempts to load it as such. Implementation Notes Module: (app scwm image-loaders) Defined in scheme/image-loaders.scm at line 38 (CVS log) netscape-application-menu No documentation supplied. (netscape-application-menu win) Description No documentation supplied. Implementation Notes Module: Defined in scheme/netscape.scm at line 234 (CVS log) netscape-av-search Use Netscape to do an AltaVista search for WORD. (netscape-av-search word) Description Use Netscape to do an AltaVista search for WORD. Just go to the AltaVista home page if WORD is #f. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 201 (CVS log) netscape-av-search-selection-url Use Netscape to do a AltaVista search of the selection, SELECTION. (netscape-av-search-selection-url #&optional (selection "PRIMARY")) Description Use Netscape to do a AltaVista search of the selection, SELECTION. SELECTION defaults to "PRIMARY" if not specified. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 225 (CVS log) netscape-bookmark-search Prompt for a string, and popup a list of matching netscape bookmarks. (netscape-bookmark-search) Description Prompt for a string, and popup a list of matching netscape bookmarks. Implementation Notes Module: Defined in scheme/flux-gtk.scm at line 59 (CVS log) netscape-download-closed-action Execute the closed action for WIN, a netscape download window. (netscape-download-closed-action win) Description Execute the closed action for WIN, a netscape download window. This plays `*netscape-download-closed-wav*' iff WIN has been up from at least `*netscape-download-closed-threshold-seconds*'. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 149 (CVS log) netscape-google-search Use Netscape to do a google search for WORD. (netscape-google-search word) Description Use Netscape to do a google search for WORD. Just go to the google home page if WORD is #f. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 194 (CVS log) netscape-google-search-cut-buffer Use Netscape to do a Google search of the X-cut-buffer-string. (netscape-google-search-cut-buffer) Description Use Netscape to do a Google search of the X-cut-buffer-string. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 209 (CVS log) netscape-google-search-selection-url Use Netscape to do a Google search of the selection, SELECTION. (netscape-google-search-selection-url #&optional (selection "PRIMARY")) Description Use Netscape to do a Google search of the selection, SELECTION. SELECTION defaults to "PRIMARY" if not specified. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 216 (CVS log) netscape-goto-cut-buffer-url Goto the url that is held in the X11 cut buffer. (netscape-goto-cut-buffer-url #&optional (new *netscape-new-window*)) Description Goto the url that is held in the X11 cut buffer. See X-cut-buffer and netscape-goto-url. NEW can be #f to not open a new netscape frame. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 141 (CVS log) netscape-goto-selection-url Goto the url that is held in the X11 selection, SELECTION. (netscape-goto-selection-url #&optional (new *netscape-new-window*) (selection "PRIMARY")) Description Goto the url that is held in the X11 selection, SELECTION. Uses the cut buffer instead if no selection exists. See X-handle-selection-string and netscape-goto-url. NEW can be #f to not open a new netscape frame. SELECTION defaults to "PRIMARY" if not given. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 128 (CVS log) netscape-goto-url Make netscape go to the location URL. (netscape-goto-url url #&optional (completion #f) (new *netscape-new-window*) #&key (start-netscape-as-needed #f)) Description Make netscape go to the location URL. Calls COMPLETION when done. The optional argument specifies whether a new window should be opened. It defaults to `*netscape-new-window*'. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 107 (CVS log) netscape-win Return a netscape window, prefer a visible netscape window. (netscape-win) Description Return a netscape window, prefer a visible netscape window. Should return the window containing the pointer if that is a Netscape window. May error if no netscape windows are present. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 44 (CVS log) next-visible-non-iconified-window Switch focus to the next visible and not iconified window. (next-visible-non-iconified-window) Description Switch focus to the next visible and not iconified window. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 321 (CVS log) next-window Switch to the next matching window. (next-window #&key (window (get-window #f #f)) (only '()) (except '()) (proc window-list-proc)) Description Switch to the next matching window. If WINDOW is given, switch to that window. ONLY and EXCEPT control which windows match --- see list-windows for details. PROC is a procedure of one argument which does the work after the window list is re-ordered. PROC defaults to window-list-proc. By specifiying, e.g., "#:proc focus-change-warp-pointer" the new window will be raised, focussed, and the pointer will be warped to the window. See also prev-window. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 172 (CVS log) nonant->dirvector No documentation supplied. (nonant->dirvector nonant) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-classes) Defined in scheme/ui-constraints-classes.scm at line 221 (CVS log) nonant->gravity Return a gravity symbol given NONANT in [0,8]. (nonant->gravity nonant) Description Return a gravity symbol given NONANT in [0,8]. 0 is northwest, 1 is north, 2 is northeast, etc. See also get-window-nonant. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 376 (CVS log) nonant->string Return the brief string name for NONANT, an integer. (nonant->string nonant) Description Return the brief string name for NONANT, an integer. E.g., an argument of 1 returns N. Implementation Notes Module: Defined in scheme/nonants.scm at line 198 (CVS log) nonant-decoration Return the window id numbers of the decoration for WIN corresponding to NONANT. (nonant-decoration win nonant) Description Return the window id numbers of the decoration for WIN corresponding to NONANT. E.g., NONANT == 0 will answer the id of the northwest corner window. Implementation Notes Module: (app scwm nonants) Defined in scheme/nonants.scm at line 71 (CVS log) nonant-highlight-color Return the color used for highlighting nonants. (nonant-highlight-color) Description Return the color used for highlighting nonants. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3662 (CVS log) normal-border Cause WIN to be decorated with a normal border. (normal-border #&optional win) Description Cause win to be decorated with a normal border. This means that there will be resize handles in the corners. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3239 (CVS log) not-focussed-for? No documentation supplied. (not-focussed-for? seconds #&optional (win (get-window))) Description No documentation supplied. Implementation Notes Module: (app scwm auto-shrink) Defined in scheme/auto-shrink.scm at line 37 (CVS log) not-menu-background Return the default background color for icons, window frames, etc. (not-menu-background) Description Return the default background color for icons, window frames, etc. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 952 (CVS log) not-menu-foreground Return the default foreground color for icons, titlebars, etc. (not-menu-foreground) Description Return the default foreground color for icons, titlebars, etc. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 917 (CVS log) null-place-window This is simplest, fallback placement procedure for windows. (null-place-window win) Description This is simplest, fallback placement procedure for windows. It simply leaves the window win in place, exactly as requested. Implementation Notes Module: Built-in Primitive Defined in src/placement.c at line 655 (CVS log) number->hex-string A convenience wrapper around `number->string' that returns N in base-16. (number->hex-string n) Description A convenience wrapper around `number->string' that returns N in base-16. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 40 (CVS log) number-in-base Return the integer that corresponds to string NUMBER in base BASE. (number-in-base number base #&optional value) Description Return the integer that corresponds to string NUMBER in base BASE. VALUE is the optional value of any prefix to NUMBER. Implementation Notes Module: (app scwm number-convert) Defined in scheme/number-convert.scm at line 38 (CVS log) number-of-mouse-buttons Return the number of mouse buttons of the current mouse. (number-of-mouse-buttons) Description Return the number of mouse buttons of the current mouse. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1437 (CVS log) object-documentation Return documentation attached to SYM or to (eval SYM). (object-documentation sym) Description Return documentation attached to SYM or to (eval SYM). Implementation Notes Module: (app scwm doc) Defined in scheme/doc.scm at line 75 (CVS log) oct Return the integer that corresponds to string NUMBER as an octal value. (oct number) Description Return the integer that corresponds to string NUMBER as an octal value. Implementation Notes Module: (app scwm number-convert) Defined in scheme/number-convert.scm at line 58 (CVS log) on-current-desk? Return #t if WIN is on the current desk. (on-current-desk? #&optional (win (get-window))) Description Return #t if WIN is on the current desk. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 42 (CVS log) on-desk-n? Returns a function which takes WIN and returns #t if WIN is on desk N, else #f. ((on-desk-n? n) #&optional (win (get-window))) Description Returns a function which takes WIN and returns #t if WIN is on desk N, else #f. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 38 (CVS log) on-desk-placement Return a procedure that takes a window and places it on DESK. (on-desk-placement desk) Description Return a procedure that takes a window and places it on DESK. The procedure will act just like calling place-on-desk on the window with the same DESK argument. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 109 (CVS log) on-desk? Return #t if WIN is on desk N, else #f. (on-desk? n #&optional (win (get-window))) Description Return #t if WIN is on desk N, else #f. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 34 (CVS log) one-window-prompter No documentation supplied. (one-window-prompter name #&optional (p1 "select window")) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-classes) Defined in scheme/ui-constraints-classes.scm at line 135 (CVS log) opaque-move Move WIN interactively, opaquely. (opaque-move #&optional win) Description Move win interactively, opaquely. Returns a list '(X Y) which is the new viewport position of win. This allows the user to drag the window itself around the screen. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/move.c at line 576 (CVS log) opaque-resize Resize WIN interactively, opaquely. (opaque-resize #&optional win) Description Resize win interactively, opaquely. Returns a list '(width height) that is the new size of win. This allows the user to drag the boundaries of the window to set its size. win defaults to the window context in the usual way if not specified. The window is updated immediately as the size changes take place. Implementation Notes Module: Built-in Primitive Defined in src/resize.c at line 723 (CVS log) option-menu No documentation supplied. (option-menu sym) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 197 (CVS log) option-widget-and-getter No documentation supplied. (option-widget-and-getter sym) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 155 (CVS log) or-map Apply PROC repeatedly, returning the first true value. (or-map proc first . rest) Description Apply PROC repeatedly, returning the first true value. PROC is applied to elements of FIRST and the lists comprising REST much as map would do it. If PROC never returns a true value, return #f instead. If all the lists are empty, return #f. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 128 (CVS log) output-of-system-cmd Return the output of command shell execution of CMD. (output-of-system-cmd cmd) Description Return the output of command shell execution of CMD. CMD is run synchronously and its output is piped into the return value of this function, as a string. Implementation Notes Module: (app scwm file) Defined in scheme/file.scm at line 102 (CVS log) pair-virtual->viewport Convert a pair point from virtual to viewport coordinates. (pair-virtual->viewport pt) Description Convert a pair point from virtual to viewport coordinates. Return value is (viewport-x . viewport-y). Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 10 (CVS log) paste-window-title-from-cut-buffer Set the window title of WINDOW to be the string in the X cut buffer. (paste-window-title-from-cut-buffer #&optional (window (get-window))) Description Set the window title of WINDOW to be the string in the X cut buffer. Do nothing if the cut buffer does not contain a string. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 34 (CVS log) path-list->string-with-colons Convert L, a list of string directory names, to a single colon-separated string. (path-list->string-with-colons l) Description Convert L, a list of string directory names, to a single colon-separated string. Returns that string. Implementation Notes Module: (app scwm file) Defined in scheme/file.scm at line 67 (CVS log) percent-visible Return the percent of WIN currently in the viewport as a real in [0,100]. (percent-visible #&optional (win (get-window))) Description Return the percent of WIN currently in the viewport as a real in [0,100]. Note that this does not consider other windows which may obscure WIN; it only checks what fraction of WIN would be visible if it were on top (unobscured). Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 126 (CVS log) pix->%x Return the percent of the display width that PIX is. (pix->%x pix) Description Return the percent of the display width that PIX is. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 159 (CVS log) pix->%y Return the percent of the display height that PIX is. (pix->%y pix) Description Return the percent of the display height that PIX is. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 163 (CVS log) place-at-center Place window in the center of the current viewport. (place-at-center win) Description Place window in the center of the current viewport. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 77 (CVS log) place-at-point Place WIN at the pointer position. (place-at-point win #&key (offset '(0 0)) (proportional-offset '(-0.5 -0.5))) Description Place WIN at the pointer position. If the keyword argument OFFSET is specified, it is interpreted as a list of x and y offsets to add to the pointer position. If the keyword argument PROPORTIONAL-OFFSET is specified, it is interpreted as a list of numbers to multiply by the window's width and height, and is treated as an extra offset. The defaults are (0 0) for OFFSET and (-0.5 -0.5) for PROPORTIONAL-OFFSET, with the result that by default the window is centered at the mouse pointer position. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 60 (CVS log) place-in-viewport Move WIN to the (XX, YY) viewport. (place-in-viewport win xx yy) Description Move WIN to the (XX, YY) viewport. XX and YY are full display-size increments (e.g., (1,0) is the viewport just to the right of the home (0,0) viewport). This is equivalent to move-window-to-viewport, just named differently for clarity and convenience. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 37 (CVS log) place-interactively Place WIN interactively. (place-interactively win #&key (resize #f)) Description Place WIN interactively. Firts WIN is moved interactively with a rubber-band style move, then, if the optional RESIZE argument is provided, it is resized interactively immediately after it is placed. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 51 (CVS log) place-nonant-marker Place a nonant marker on W. (place-nonant-marker #&optional (w (get-window-with-nonant))) Description Place a nonant marker on W. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 172 (CVS log) place-on-default-desk Place WIN on a desk according to the default algorithm. (place-on-default-desk win) Description Place win on a desk according to the default algorithm. Place a window with it's window group, with a window it is transient for, on the desk it was on previous to a restart, on the desk specified with the starts-on-desk flag, This is called as part of default-placement-proc. It could also be used in user-defined placement procedures (see set-window-placement-proc!). Implementation Notes Module: Built-in Primitive Defined in src/placement.c at line 424 (CVS log) place-on-desk Move window WIN to desk DESK. (place-on-desk win desk) Description Move window WIN to desk DESK. This is equivalent to move-window-to-desk, just named differently for clarity and convenience. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 45 (CVS log) plain-border Cause WIN to be decorated with a plain border. (plain-border #&optional win) Description Cause win to be decorated with a plain border. This means that there will be no resize handles in the corners. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3268 (CVS log) pointer-position Return the current position of the mouse pointer in pixels. (pointer-position) Description Return the current position of the mouse pointer in pixels. The return value is a two-element list of the x and y coordinates. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 238 (CVS log) pop-focus-window Restore the focus to the window on the top of the focus-stack (pop-focus-window) Description Restore the focus to the window on the top of the focus-stack Implementation Notes Module: (app scwm focus-stack) Defined in scheme/focus-stack.scm at line 37 (CVS log) pop-window-configuration Restore the last configuration of WIN that was saved on its stack of previous configurations. (pop-window-configuration #&optional (win (get-window))) Description Restore the last configuration of WIN that was saved on its stack of previous configurations. Implementation Notes Module: (app scwm window-configuration) Defined in scheme/window-configuration.scm at line 122 (CVS log) popup-docs-for No documentation supplied. (popup-docs-for var) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 80 (CVS log) popup-menu Popup MENU, a menu object, and warp to the item WARP-TO-INDEX if it is a number. (popup-menu menu #&optional warp-to-index x-pos y-pos left-side? permit-alt-release-selection?) Description Popup menu, a menu object, and warp to the item warp-to-index if it is a number. x-pos, y-pos specify a desired position for the menu, and left-side? should be #t if the menu should be left justified against x-pos, or #f if it should be right justified against x-pos. If permit-alt-release-selection? is #t, then releasing the Alt/Meta modifier select a menu item. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 1648 (CVS log) popup-menu-from-decoration Popup MENU from WIN's decoration numbered BUTTON-NUMBER. (popup-menu-from-decoration menu win button-number) Description Popup MENU from WIN's decoration numbered BUTTON-NUMBER. This positions the popup menu appropriately. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 575 (CVS log) popup-option-menu No documentation supplied. (popup-option-menu sym) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 222 (CVS log) popup-ui-constraints-toggle-menu Popup a menu that can be used to turn added constraints on and off. (popup-ui-constraints-toggle-menu) Description Popup a menu that can be used to turn added constraints on and off. See also constraint-toggle-menu. Implementation Notes Module: Defined in scheme/ui-constraints-toggle-menu.scm at line 68 (CVS log) popup-window-group-menu Popup the window group menu. (popup-window-group-menu) Description Popup the window group menu. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 243 (CVS log) popup-window-group-menu-no-warp Popup the window group menu without warping to the first menu item. (popup-window-group-menu-no-warp) Description Popup the window group menu without warping to the first menu item. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 248 (CVS log) position-message-window! Move the move/resize message window's GRAVITY point to (X,Y). (position-message-window! msgwin x y gravity) Description Move the move/resize message window's GRAVITY point to (X,Y). GRAVITY can be one of 'nw, 'n, 'ne, 'w, 'center, 'e, 'sw, 's, 'se or spelled-out versions of these. See also `gravity->alignments'. Implementation Notes Module: (app scwm message-window) Defined in scheme/message-window.scm at line 40 (CVS log) prev-visible-non-iconified-window Switch focus to the previous visible and not iconified window. (prev-visible-non-iconified-window) Description Switch focus to the previous visible and not iconified window. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 330 (CVS log) prev-window Circulate to the previous matching window. (prev-window #&key (window (get-window #f #f)) (only '()) (except '()) (proc window-list-proc)) Description Circulate to the previous matching window. If WINDOW is given, circulate to that window. ONLY and EXCEPT control which windows match --- see list-windows for details. PROC is a procedure of one argument which does the work after the windows are circulated. PROC defaults to window-list-proc. See also next-window. Implementation Notes Module: Defined in scheme/winlist.scm at line 187 (CVS log) printable-char->keysym-string Return the keysym string corresponding to a printable character. (printable-char->keysym-string char) Description Return the keysym string corresponding to a printable character. CHAR is a scheme character. The return value is appropriate for use by send-key. See also X-synthetic-send-string. Implementation Notes Module: (app scwm send-string) Defined in scheme/send-string.scm at line 12 (CVS log) proc-doc Return documentation for PROC. (proc-doc proc) Description Return documentation for PROC. Implementation Notes Module: Defined in scheme/doc.scm at line 97 (CVS log) procedure->bindings-description No documentation supplied. (procedure->bindings-description proc) Description No documentation supplied. Implementation Notes Module: Defined in scheme/reflection.scm at line 262 (CVS log) procedure->string No documentation supplied. (procedure->string proc) Description No documentation supplied. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 27 (CVS log) procedure-apropos Returns a list of procedures that match RGX. (procedure-apropos rgx) Description Returns a list of procedures that match RGX. This returns a simple list of procedure objects. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 202 (CVS log) procedure-apropos-with-modules Returns a list of procedures that match RGX along with defined-in modules. (procedure-apropos-with-modules rgx) Description Returns a list of procedures that match RGX along with defined-in modules. The returned list contains pairs (modulesym . procsym) Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 194 (CVS log) procedure-arity Return the arity values for PROC. (procedure-arity proc) Description Return the arity values for PROC. Three values are returned in a list: (num-required num-optional rest-argument-p). Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 51 (CVS log) procedure-formals Return a list of the formal arguments for PROC. (procedure-formals proc) Description Return a list of the formal arguments for PROC. Works for both primitives and procedures. If PROC was created using an optargs *-format macro, this procedure will not provide much useful information. See instead procedure-keyword-arguments and procedure-optional-arguments. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 72 (CVS log) procedure-interactive-spec No documentation supplied. (procedure-interactive-spec proc) Description No documentation supplied. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 186 (CVS log) procedure-is-interactive? Return #t iff PROC is interactive. (procedure-is-interactive? proc) Description Return #t iff PROC is interactive. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 189 (CVS log) procedure-keyword-formals Returns an a-list of the optargs keyword arguments and default values for PROC. (procedure-keyword-formals proc) Description Returns an a-list of the optargs keyword arguments and default values for PROC. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 117 (CVS log) procedure-num-optional-args Return the number of optional arguments for PROC. (procedure-num-optional-args proc) Description Return the number of optional arguments for PROC. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 62 (CVS log) procedure-num-required-args Return the number of required arguments for PROC. (procedure-num-required-args proc) Description Return the number of required arguments for PROC. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 57 (CVS log) procedure-optargs-arglist Return a list of the optargs keyword arguments for PROC. (procedure-optargs-arglist proc) Description Return a list of the optargs keyword arguments for PROC. Returns #f if PROC was not defined using keyword or optional arguments (this includes procedures defined using standard . rest syntax). Otherwise returns a list such as '(foo #&optional bar). Note that these currently do not display in their expected format Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 107 (CVS log) procedure-optional-formals Returns a list of the optional arguments for PROC. (procedure-optional-formals proc) Description Returns a list of the optional arguments for PROC. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 129 (CVS log) procedure-required-formals Return a list of the required formal arguments for PROC. (procedure-required-formals proc) Description Return a list of the required formal arguments for PROC. Returns #f if PROC is a primitive. This will not include any "lambda*" formals generated using optargs. See also procedure-keyword-arguments and procedure-optional-arguments. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 90 (CVS log) procedure-string->procedure Return a procedure given its name. (procedure-string->procedure proc-name) Description Return a procedure given its name. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 47 (CVS log) procedure-takes-rest-arg? Return #t iff PROC take a rest argument. (procedure-takes-rest-arg? proc) Description Return #t iff PROC take a rest argument. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 67 (CVS log) process-use-scwm-modules Returns a list of all the modules loaded in successfully. (process-use-scwm-modules module-list) Description Returns a list of all the modules loaded in successfully. Modules that failed to load have #f in their place in the list instead of the module. Implementation Notes Module: Defined in scheme/minimal.scm at line 191 (CVS log) program-exists? Return #t iff PROGRAM-NAME is in the current $PATH. (program-exists? program-name) Description Return #t iff PROGRAM-NAME is in the current $PATH. Implementation Notes Module: (app scwm path-cache) Defined in scheme/path-cache.scm at line 16 (CVS log) prompt-binding No documentation supplied. (prompt-binding #&optional (title "Scwm Bindings")) Description No documentation supplied. Implementation Notes Module: Defined in scheme/prompt-binding.scm at line 531 (CVS log) prompt-binding-vbox No documentation supplied. (prompt-binding-vbox) Description No documentation supplied. Implementation Notes Module: (app scwm prompt-binding) Defined in scheme/prompt-binding.scm at line 256 (CVS log) prompt-bool Prompt with PROMPT for a boolean value, and call PROC with result if Ok button is clicked. (prompt-bool prompt proc #&key (initval #f) (title "prompt-bool")) Description Prompt with PROMPT for a boolean value, and call PROC with result if Ok button is clicked. Implementation Notes Module: (app scwm prompt-bool) Defined in scheme/prompt-bool.scm at line 43 (CVS log) prompt-bool-hbox Create and return a boolean-prompting hbox and button. (prompt-bool-hbox prompt initval) Description Create and return a boolean-prompting hbox and button. hbox is the gtk container widget, selected-proc?? is a proc that when invoked returns #t or #f depending on the state of the boolean displayed in hbox. The returned value is a list: (hbox getter). See also prompt-bool. Implementation Notes Module: Defined in scheme/prompt-bool.scm at line 52 (CVS log) prompt-color Prompt using PROMPT for a color and call PROC with value if Ok is clicked. (prompt-color prompt proc #&key (initval #f) (title "prompt-color") (favorites #f)) Description Prompt using PROMPT for a color and call PROC with value if Ok is clicked. INITVAL is a default initial color as a color object or string. TITLE is a window title. Implementation Notes Module: (app scwm prompt-color) Defined in scheme/prompt-color.scm at line 45 (CVS log) prompt-color-hbox Create and return a color-prompting hbox, complete with link to full color dialog. (prompt-color-hbox prompt initval #&optional favorites) Description Create and return a color-prompting hbox, complete with link to full color dialog. PROMPT is the prompt, INITVAL is the initial color as a color object or a string. The returned value is a list: (hbox getter). See also prompt-color. Implementation Notes Module: Defined in scheme/prompt-color.scm at line 70 (CVS log) prompt-enum Prompt with PROMPT for one of CHOICES, and call PROC with result. (prompt-enum prompt choices proc #&key (initval #f) (title "prompt-enum")) Description Prompt with PROMPT for one of CHOICES, and call PROC with result. CHOICES is an a-list of symbols and strings. Implementation Notes Module: (app scwm prompt-enum) Defined in scheme/prompt-enum.scm at line 33 (CVS log) prompt-enum-hbox Create and return an enum-prompting hbox and button. (prompt-enum-hbox prompt choices initval) Description Create and return an enum-prompting hbox and button. hbox is the gtk container widget, selected-proc?? is a proc that when invoked returns #t or #f depending on the state of the boolean displayed in hbox. The returned value is a list: (hbox getter). PROMPT is the prompt to display, CHOICES is an a-list of symbols and strings. INITVAL is a symbol in the CHOICES a-list. See also prompt-enum. Implementation Notes Module: Defined in scheme/prompt-enum.scm at line 43 (CVS log) prompt-file Prompt using PROMPT for a file and call PROC with value if Ok is clicked. (prompt-file prompt proc #&key (initval #f) (title #f) (favorites #f)) Description Prompt using PROMPT for a file and call PROC with value if Ok is clicked. INITVAL is a default initial file as a string. TITLE is a window title. Implementation Notes Module: (app scwm prompt-file) Defined in scheme/prompt-file.scm at line 31 (CVS log) prompt-file-hbox Create and return a file-prompting hbox, complete with link to full file dialog. (prompt-file-hbox prompt initval #&optional favorites) Description Create and return a file-prompting hbox, complete with link to full file dialog. PROMPT is the prompt, INITVAL is the initial file as a string. The returned value is a list: (hbox getter). See also prompt-file. Implementation Notes Module: Defined in scheme/prompt-file.scm at line 64 (CVS log) prompt-font Prompt using PROMPT for a font and call PROC with value if Ok is clicked. (prompt-font prompt proc #&key (initval #f) (title #f)) Description Prompt using PROMPT for a font and call PROC with value if Ok is clicked. INITVAL is a default initial font as a font object or string. TITLE is a window title. Implementation Notes Module: (app scwm prompt-font) Defined in scheme/prompt-font.scm at line 43 (CVS log) prompt-font-hbox Create and return a font-prompting hbox, complete with link to full font dialog. (prompt-font-hbox prompt initval) Description Create and return a font-prompting hbox, complete with link to full font dialog. PROMPT is the prompt, INITVAL is the initial font as a font object or a string. The returned value is a list: (hbox getter). See also prompt-font. Implementation Notes Module: Defined in scheme/prompt-font.scm at line 54 (CVS log) prompt-from-symbol Return a string prompt that is appropriate for the option symbol SYM. (prompt-from-symbol sym) Description Return a string prompt that is appropriate for the option symbol SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 148 (CVS log) prompt-integer-range Prompt using PROMPT for an integer value in RANGE, and call PROC with value if Ok is clicked. (prompt-integer-range prompt range proc #&key (initval #f) (title #f)) Description Prompt using PROMPT for an integer value in RANGE, and call PROC with value if Ok is clicked. RANGE is a cons cell (low . high); ranges are inclusive. INITVAL is a default initial value. TITLE is a window title. Implementation Notes Module: (app scwm prompt-range) Defined in scheme/prompt-range.scm at line 59 (CVS log) prompt-integer-range-hbox Create and return an integer-range-prompting hbox and scale, label. (prompt-integer-range-hbox prompt range initval) Description Create and return an integer-range-prompting hbox and scale, label. PROMPT is the prompt, RANGE is the allowed rane, and INITVAL is the initial string. The returned value is a list: (hbox getter). See also prompt-range, prompt-integer-range, prompt-range-hbox. Implementation Notes Module: Defined in scheme/prompt-range.scm at line 97 (CVS log) prompt-path-hbox Create and return a path-prompting hbox and entry. (prompt-path-hbox prompt initval) Description Create and return a path-prompting hbox and entry. PROMPT is the prompt, and INITVAL is the initial path (a list of strings). The returned value is a list: (hbox getter entry). See also prompt-string. Implementation Notes Module: (app scwm prompt-string) Defined in scheme/prompt-string.scm at line 75 (CVS log) prompt-proc Prompt using PROMPT for a proc and call PROC with value if Ok is clicked. (prompt-proc prompt proc #&key (initval #f) (title #f) (favorites #f)) Description Prompt using PROMPT for a proc and call PROC with value if Ok is clicked. INITVAL is a default initial proc as a string. TITLE is a window title. Implementation Notes Module: (app scwm prompt-proc) Defined in scheme/prompt-proc.scm at line 40 (CVS log) prompt-proc-hbox Create and return a proc-prompting hbox, complete with link to full proc dialog. (prompt-proc-hbox prompt initval #&optional favorites) Description Create and return a proc-prompting hbox, complete with link to full proc dialog. PROMPT is the prompt, INITVAL is the initial proc as a string. The returned value is a list: (hbox getter entry). See also prompt-proc. Implementation Notes Module: (app scwm prompt-proc) Defined in scheme/prompt-proc.scm at line 80 (CVS log) prompt-range Prompt using PROMPT for a numeric value in RANGE, and call PROC with value if Ok is clicked. (prompt-range prompt range proc #&key (initval #f) (title #f) (digits 1)) Description Prompt using PROMPT for a numeric value in RANGE, and call PROC with value if Ok is clicked. RANGE is a cons cell (low . hight); ranges are inclusive. INITVAL is a default initial value. TITLE is a window title. Implementation Notes Module: (app scwm prompt-range) Defined in scheme/prompt-range.scm at line 46 (CVS log) prompt-range-hbox Create and return a range-prompting hbox and scale, label. (prompt-range-hbox prompt range initval #&optional (digits 1)) Description Create and return a range-prompting hbox and scale, label. PROMPT is the prompt, RANGE is the allowed rane, and INITVAL is the initial string. The returned value is a list: (hbox getter). See also prompt-range. Implementation Notes Module: (app scwm prompt-range) Defined in scheme/prompt-range.scm at line 72 (CVS log) prompt-string Use PROMPT as prompt in text entry widget and call PROC with the entered string. (prompt-string prompt proc #&key (initval #f) (title "prompt-string")) Description Use PROMPT as prompt in text entry widget and call PROC with the entered string. E.g., (prompt-string "Enter new name" (lambda (nm) (set-window-title! w nm))) Implementation Notes Module: (app scwm prompt-string) Defined in scheme/prompt-string.scm at line 35 (CVS log) prompt-string-hbox Create and return a string-prompting hbox and entry. (prompt-string-hbox prompt initval) Description Create and return a string-prompting hbox and entry. PROMPT is the prompt, and INITVAL is the initial string. The returned value is a list: (hbox getter entry). See also prompt-string. Implementation Notes Module: (app scwm prompt-string) Defined in scheme/prompt-string.scm at line 59 (CVS log) prompting-shell Create a GTk+ shell window and return a procedure that closes it. (prompting-shell proc title hbox getter) Description Create a GTk+ shell window and return a procedure that closes it. PROC is the procedure to run when the okay button is clicked, and it is called with a single argument, the result of applying GETTER to no arguments. TITLE is the title of the window, and HBOX is a Gtk HBox widget that the shell should contain. Implementation Notes Module: Defined in scheme/prompting-shell.scm at line 28 (CVS log) propagate-selection-to-cut-buffer Make the cut-buffer contain the current selection. (propagate-selection-to-cut-buffer #&optional (selection "PRIMARY")) Description Make the cut-buffer contain the current selection. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 40 (CVS log) property-changed-debug Print debugging information about the property change of PROP on WIN. (property-changed-debug prop win) Description Print debugging information about the property change of PROP on WIN. See also X-PropertyNotify-hook. Implementation Notes Module: (app scwm property-respond) Defined in scheme/property-respond.scm at line 51 (CVS log) property-changed-respond Handle various property changes of PROP on WIN. (property-changed-respond prop win) Description Handle various property changes of PROP on WIN. See also X-PropertyNotify-hook. Currently handles "flashing" and "flash". Implementation Notes Module: (app scwm property-respond) Defined in scheme/property-respond.scm at line 90 (CVS log) proplist-append-array-element Return the PL-ARRAY after appending ITEM to the end. (proplist-append-array-element pl-array item) Description Return the pl-array after appending item to the end. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 289 (CVS log) proplist-deep-copy Return a deep copy of property list PL. (proplist-deep-copy pl) Description Return a deep copy of property list pl. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 360 (CVS log) proplist-delete-domain Delete domain PL-DOMAIN-NAME. (proplist-delete-domain pl-domain-name kick-me?) Description Delete domain pl-domain-name. If kick-me? is #f, any callback registered for the domain will not be called. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 719 (CVS log) proplist-get-all-dictionary-keys Return a proplist array object that contains all the keys of PL-DICT. (proplist-get-all-dictionary-keys pl-dict) Description Return a proplist array object that contains all the keys of pl-dict. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 485 (CVS log) proplist-get-array-element Return the element at INDEX offset of PL. (proplist-get-array-element pl index) Description Return the element at index offset of pl. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 456 (CVS log) proplist-get-container Return the array or dictionary of which PL is an element. (proplist-get-container pl) Description Return the array or dictionary of which pl is an element. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 444 (CVS log) proplist-get-data Returns the raw data from PL (a data proplist object) as a string. (proplist-get-data pl) Description Returns the raw data from pl (a data proplist object) as a string. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 558 (CVS log) proplist-get-data-description Returns a description of PL (a data proplist object) in GNUstep format. (proplist-get-data-description pl) Description Returns a description of pl (a data proplist object) in GNUstep format. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 536 (CVS log) proplist-get-dictionary-entry Return the proplist dictionary entry associated with entry KEY in PL-DICT. (proplist-get-dictionary-entry pl-dict key) Description Return the proplist dictionary entry associated with entry key in pl-dict. Returns #f if key is not in pl-dict. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 498 (CVS log) proplist-get-domain Return a property list represeting the domain PL-DOMAIN-NAME. (proplist-get-domain pl-domain-name) Description Return a property list represeting the domain pl-domain-name. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 735 (CVS log) proplist-get-domainnames Return a array proplist containing all registered domain names. (proplist-get-domainnames) Description Return a array proplist containing all registered domain names. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 747 (CVS log) proplist-get-filename Return the filename of PL. (proplist-get-filename pl) Description Return the filename of pl. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 758 (CVS log) proplist-get-number-of-elements Return the number of elements in PL. (proplist-get-number-of-elements pl) Description Return the number of elements in pl. If pl is a string or data objects, this returns 0. If it is an array or dictionary, it is the number of elements or pairs. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 471 (CVS log) proplist-get-string Returns the string from PL (a string proplist object). (proplist-get-string pl) Description Returns the string from pl (a string proplist object). Note that numerous procedures automatically convert string proplist objects into Guile strings, so this may not often be necessary. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 583 (CVS log) proplist-get-string-description Retuns a description of PL (a string proplist object) in GNUstep format. (proplist-get-string-description pl) Description Retuns a description of pl (a string proplist object) in GNUstep format. If the string contains whitespace or special characters, the string returned will be enclosed in quotes. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 513 (CVS log) proplist-insert-array-element Return the PL-ARRAY after inserting ITEM at offset INDEX. (proplist-insert-array-element pl-array item index) Description Return the pl-array after inserting item at offset index. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 272 (CVS log) proplist-insert-dictionary-entry Return PL-DICT after inserting (KEY,VALUE) into it. (proplist-insert-dictionary-entry pl-dict key Value) Description Return pl-dict after inserting (key,value) into it. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 304 (CVS log) proplist-is-array Return #t iff PL is an array proplist object, #f otherwise. (proplist-is-array pl) Description Return #t iff pl is an array proplist object, #f otherwise. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 626 (CVS log) proplist-is-compound Return #t iff PL is a dictionary or array proplist object, #f otherwise. (proplist-is-compound pl) Description Return #t iff pl is a dictionary or array proplist object, #f otherwise. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 659 (CVS log) proplist-is-data Return #t iff PL is a data proplist object, #f otherwise. (proplist-is-data pl) Description Return #t iff pl is a data proplist object, #f otherwise. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 615 (CVS log) proplist-is-dictionary Return #t iff PL is a dictionary proplist object, #f otherwise. (proplist-is-dictionary pl) Description Return #t iff pl is a dictionary proplist object, #f otherwise. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 637 (CVS log) proplist-is-equal Return #t iff PLA is equal to PLB. (proplist-is-equal plA plB) Description Return #t iff pla is equal to plb. This does a case sensitive comparison by default. See proplist-set-string-cmp-hook for changing the behaviour. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 372 (CVS log) proplist-is-simple Return #t iff PL is a string or data proplist object, #f otherwise. (proplist-is-simple pl) Description Return #t iff pl is a string or data proplist object, #f otherwise. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 648 (CVS log) proplist-is-string Return #t iff PL is a string proplist object, #f otherwise. (proplist-is-string pl) Description Return #t iff pl is a string proplist object, #f otherwise. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 604 (CVS log) proplist-make-array-from-elements Return a newly created array object populated with elements ITEMS. (proplist-make-array-from-elements . items) Description Return a newly created array object populated with elements items. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 185 (CVS log) proplist-make-data Return a proplist argument containing arbitrary data from DATA. (proplist-make-data data) Description Return a proplist argument containing arbitrary data from data. This is often unnecessary as the proplist procedures will permit Guile strings to be used anywhere a string proplist object is expected. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 424 (CVS log) proplist-make-dictionary-from-entries Return a newly created dictionary object with elements ITEMS. (proplist-make-dictionary-from-entries . items) Description Return a newly created dictionary object with elements items. The elements in items should be a flat list (key1 value1 key2 value2 ...). Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 216 (CVS log) proplist-merge-dictionaries Return PL-DICT-DEST after merging in all entries from PL-DICT-SOURCE. (proplist-merge-dictionaries pl-dict-dest pl-dict-source) Description Return pl-dict-dest after merging in all entries from pl-dict-source. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 334 (CVS log) proplist-register Register thunk CALLBACK to be called when PL-DOMAIN-NAME changes. (proplist-register pl-domain-name callback) Description Register thunk callback to be called when pl-domain-name changes. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 682 (CVS log) proplist-remove-array-element Return PL-ARRAY after deleting the element at position INDEX. (proplist-remove-array-element pl-array index) Description Return pl-array after deleting the element at position index. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 257 (CVS log) proplist-remove-dictionary-entry Return PL-DICT after removing KEY and its corresponding value from it. (proplist-remove-dictionary-entry pl-dict key) Description Return pl-dict after removing key and its corresponding value from it. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 320 (CVS log) proplist-save Save PL, atomically if ATOMICALLY? is #t. (proplist-save pl atomically?) Description Save pl, atomically if atomically? is #t. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 800 (CVS log) proplist-set-domain Set PL-DOMAIN-NAME to have VALUE. (proplist-set-domain pl-domain-name value kick-me?) Description Set pl-domain-name to have value. If kick-me? is #f, any callback registered for the domain will not be called. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 701 (CVS log) proplist-set-filename! Set the filename for PL to be FILENAME. (proplist-set-filename! pl filename) Description Set the filename for pl to be filename. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 770 (CVS log) proplist-set-string-cmp-hook Use PRED as a predicate for doing proplist string comparisons. (proplist-set-string-cmp-hook pred) Description Use pred as a predicate for doing proplist string comparisons. pred should take two proplist objects and return #t or #f to answer whether they are equal in whatever sense it chooses. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 387 (CVS log) proplist-shallow-copy Return a shallow copy of property list PL. (proplist-shallow-copy pl) Description Return a shallow copy of property list pl. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 348 (CVS log) proplist-synchronize Synchronize the in-memory proplist PL with the disk contents. (proplist-synchronize pl) Description Synchronize the in-memory proplist pl with the disk contents. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 814 (CVS log) proplist-unregister No longer invoke callback when domain associated with PL-DOMAIN-NAME is changed. (proplist-unregister pl-domain-name) Description No longer invoke callback when domain associated with pl-domain-name is changed. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 670 (CVS log) publish-scwm-evaluator-servant Publish the scwm-evaluator-servant by putting its IOR as a property on the root window. (publish-scwm-evaluator-servant) Description Publish the scwm-evaluator-servant by putting its IOR as a property on the root window. The "SCWM_EVALUATOR_IOR" property of the root window will contain a printable string for Corba clients to use to access the scwm-scheme-evaluator interface. Implementation Notes Module: Defined in scheme/corba.scm at line 30 (CVS log) push-focus-window Save the current focus window on a stack. (push-focus-window) Description Save the current focus window on a stack. See pop-focus-window. Implementation Notes Module: (app scwm focus-stack) Defined in scheme/focus-stack.scm at line 29 (CVS log) push-undo-global Push the global state onto the undo list. (push-undo-global) Description Push the global state onto the undo list. See also insert-undo-global which honours the current position in the undo-list, undo-index. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 61 (CVS log) push-undo-state Push STATE onto the undo list. (push-undo-state state) Description Push STATE onto the undo list. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 74 (CVS log) push-window-configuration Save the configuration of WIN on its stack of previous configurations. (push-window-configuration #&optional (win (get-window))) Description Save the configuration of WIN on its stack of previous configurations. Implementation Notes Module: (app scwm window-configuration) Defined in scheme/window-configuration.scm at line 112 (CVS log) put-string-in-palm-clipboard No documentation supplied. (put-string-in-palm-clipboard str) Description No documentation supplied. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 328 (CVS log) quote-key-event Quote the next key event and let it pass to the application. (quote-key-event) Description Quote the next key event and let it pass to the application. Implementation Notes Module: (app scwm quote) Defined in scheme/quote.scm at line 34 (CVS log) quote-key-events? Return #t iff key events are being qutoed. (quote-key-events?) Description Return #t iff key events are being qutoed. See also set-quote-key-events!. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 868 (CVS log) quote-mouse-event Quote the next mouse event and let it pass to the application. (quote-mouse-event) Description Quote the next mouse event and let it pass to the application. Implementation Notes Module: (app scwm quote) Defined in scheme/quote.scm at line 43 (CVS log) quote-next-event Quote the next mouse or keyboard event and let it pass to the application. (quote-next-event) Description Quote the next mouse or keyboard event and let it pass to the application. Implementation Notes Module: (app scwm quote) Defined in scheme/quote.scm at line 52 (CVS log) quotify-single-quotes Return a string that has single quote characters backslashified. (quotify-single-quotes str) Description Return a string that has single quote characters backslashified. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 99 (CVS log) raise-and-stop-flashing Turn off window flashing of WIN and raise it. (raise-and-stop-flashing #&optional (win (get-window))) Description Turn off window flashing of WIN and raise it. Also return #f so that this can be used as an bound IMMEDIATE-PROC. Implementation Notes Module: Defined in scheme/flash-window.scm at line 82 (CVS log) raise-by-one Raise window W above the next window up that overlaps it. (raise-by-one #&optional (w (get-window))) Description Raise window W above the next window up that overlaps it. W defaults to the window context in the usual way. Implementation Notes Module: Defined in scheme/stacking.scm at line 77 (CVS log) raise-easyraise-windows (raise-easyraise-windows) Description Implementation Notes Module: (app scwm easyraise) Defined in scheme/easyraise.scm at line 31 (CVS log) raise-fvwm2-pager Raise a fvwm2 pager window in the stacking order. (raise-fvwm2-pager) Description Raise a fvwm2 pager window in the stacking order. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 599 (CVS log) raise-group Raise members of GROUP above all other windows. (raise-group #&optional (group (get-window))) Description Raise members of GROUP above all other windows. Keeps the relative stacking order of the members intact. Implementation Notes Module: (app scwm group) Defined in scheme/group.scm at line 87 (CVS log) raise-window Raise WIN to the top of the window stack. (raise-window #&optional win) Description Raise win to the top of the window stack. Stays-on-top windows still take priority. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1866 (CVS log) raise-window-above Restack window W immediately above W2. (raise-window-above w w2) Description Restack window W immediately above W2. Implementation Notes Module: (app scwm stacking) Defined in scheme/stacking.scm at line 62 (CVS log) raised? Return #t if WIN is currently raised, #f if not. (raised? #&optional win) Description Return #t if win is currently raised, #f if not. win defaults to the window context in the usual way if not specified. A window is considered to be raised if the application window (not the frame) is unobscured (or if this was the last window you called raise-window on). Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1995 (CVS log) random-place-window Places WIN just as if being placed by fvwm2's RandomPlacement. (random-place-window win #&optional no-move x-sugg y-sugg) Description Places win just as if being placed by fvwm2's RandomPlacement. This placement is not truly random; it is based on two state variables which are incremented for the x and y coordinates, and which wrap around once a window would be forced off the screen. The placement is fairly arbitrary, but always succeeds, and so avoids user interaction. #t is always returned. If no-move is #t, then just return the new position but do not move win. x-sugg and y-sugg are ignored. Implementation Notes Module: Built-in Primitive Defined in src/placement.c at line 538 (CVS log) raw-binding->key-descriptor No documentation supplied. (raw-binding->key-descriptor binding) Description No documentation supplied. Implementation Notes Module: (app scwm prompt-binding) Defined in scheme/prompt-binding.scm at line 102 (CVS log) raw-binding->string No documentation supplied. (raw-binding->string raw-binding) Description No documentation supplied. Implementation Notes Module: (app scwm reflection) Defined in scheme/reflection.scm at line 242 (CVS log) read-and-append-to Read in the lines from port P and return them. (read-and-append-to p #&optional (l '())) Description Read in the lines from port P and return them. L is a the tail of the accumulating list. Implementation Notes Module: (app scwm rgb-database) Defined in scheme/rgb-database.scm at line 26 (CVS log) read-until-eof Return all the text from input port IN until eof. (read-until-eof in) Description Return all the text from input port IN until eof. IN should be a newline-terminated Ascii input port. Implementation Notes Module: (app scwm file) Defined in scheme/file.scm at line 92 (CVS log) recapture Recapture all the windows. (recapture) Description Recapture all the windows. This destroys all the current frame windows and recreate them from scratch. This is hopefully not necessary during normal operation. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 269 (CVS log) rectangle-overlap? Returns #t iff the two specified rectangles overlap. (rectangle-overlap? x1 y1 w1 h1 x2 y2 w2 h2) Description Returns #t iff the two specified rectangles overlap. X1,Y1 and W1 x H1 are the position and size of the first rectangle. X2,Y2 and W2 x H2 are the position and size of the second rectangle. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 46 (CVS log) redo Redo the last undone operation. (redo) Description Redo the last undone operation. This re-applyiesthe state at undo-index - 1. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 111 (CVS log) redo-all-passive-grabs Re-instate all passive grabs of keys and buttons of bindings. (redo-all-passive-grabs) Description Re-instate all passive grabs of keys and buttons of bindings. See undo-all-passive-grabs for temporarily removing those bindings. This procedure might be useful for re-establishing bindings after quoting numerous keystrokes or mouse events. Beware that it can take several seconds to execute. This procedure considers the state of ignore-dubious-modifiers? Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1579 (CVS log) redo-passive-grab Re-instate the passive grab of KEYCODE-OR-BUTNUM with MODMASK on all windows. (redo-passive-grab modmask keycode-or-butnum #&optional mouse?) Description Re-instate the passive grab of keycode-or-butnum with modmask on all windows. If mouse? is #t, then treat keycode-or-butnum as a button number and remove a grabe of a mouse binding. Otherwise remove a keyboard passive grab. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1616 (CVS log) reduce Repeatedly apply PROC to a current value and a member of L. (reduce proc init l) Description Repeatedly apply PROC to a current value and a member of L. The initial current value is the first member of the list. The list is processed from left to right. The final result is returned, unless the list is empty, in which case INIT is returned. Compare to accumulate. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 61 (CVS log) refresh Make sure all windows and their decorations are up to date. (refresh) Description Make sure all windows and their decorations are up to date. This forces a redraw of the entire current viewport. Should not be necessary during normal operation. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 163 (CVS log) refresh-window Refresh the decorations on window WIN. (refresh-window #&optional win) Description Refresh the decorations on window win. Refreshing ensuring that everything, including the decorations is up to date. refresh does this in a more efficient way for all windows, as well as the root. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2473 (CVS log) register-fvwm2-module-config No documentation supplied. (register-fvwm2-module-config module-type . args) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 413 (CVS log) register-image-loader Register PROC as the loader to use for images ending in EXTENSION. (register-image-loader extension proc) Description Register proc as the loader to use for images ending in extension. extension must be a string beginning with a period, the empty string (for files with no extension), or the string "default" (for files that no other image loader succeeds in loading). proc will be called with the full pathname of the image and should return an image object, or #f if it succeeds. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 407 (CVS log) remove-input-hook! Remove an input hook identified by HANDLE. (remove-input-hook! handle) Description Remove an input hook identified by handle. handle should be an object that was returned by add-input-hook!. An input hook may safely remove itself. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 730 (CVS log) remove-motion-handler! No longer call PROC on XMotionEvents. (remove-motion-handler! proc) Description No longer call proc on XMotionEvents. Handling motion events can considerably slow Scwm down so use it only when necessary. See add-motion-handler and reset-motion-handlers. Implementation Notes Module: Built-in Primitive Defined in src/events.c at line 2193 (CVS log) remove-nonant-marker Remove a nonant marker from W. (remove-nonant-marker #&optional (w (get-window))) Description Remove a nonant marker from W. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 184 (CVS log) remove-suffix Return STR with trailing SUFFIX removed if it exists. (remove-suffix str suffix) Description Return STR with trailing SUFFIX removed if it exists. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 94 (CVS log) remove-timer-hook! Remove a timer hook identified by HANDLE. (remove-timer-hook! handle) Description Remove a timer hook identified by handle. The handle should be an object that was returned by add-timer-hook!. No warning or error will occur if handle is for a timer hook that has already been triggered. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 587 (CVS log) rename-window-interactively Prompt for a new name for WIN and change its title. (rename-window-interactively #&optional (win (get-window))) Description Prompt for a new name for WIN and change its title. WIN defaults as usual to the current window context. Implementation Notes Module: (app scwm flux-gtk) Defined in scheme/flux-gtk.scm at line 29 (CVS log) repeat Builds a list of repeating values. (repeat . args) Description Builds a list of repeating values. ARGS must contain NUMBERs followed by VALUEs. Each VALUE is repeated NUMBER times in the resulting list. E.g. (repeat 3 'a 2 'b 1 'c) => (a a a b b c) Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 240 (CVS log) replace-proxies-with-windows No documentation supplied. (replace-proxies-with-windows alist wlist) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-composition) Defined in scheme/ui-constraints-composition.scm at line 165 (CVS log) report-scwm-usage Log your usage of scwm to a central host. (report-scwm-usage) Description Log your usage of scwm to a central host. The data sent includes the version of scwm you are running and your hostname. If the environment variable SCWM_DO_NOT_LOG_USAGE is set, however, no message will be sent even if this function is called. Implementation Notes Module: Defined in scheme/report-usage.scm at line 42 (CVS log) reset-background! Resets the root window to the default "weave". (reset-background!) Description Resets the root window to the default "weave". Implementation Notes Module: Primitive from (app scwm background) Defined in modules/background/background.c at line 198 (CVS log) reset-buttons! Resets button numbers. (reset-buttons!) Description Resets button numbers. This makes add-left-button and add-right-button start from the edges again. Implementation Notes Module: (app scwm titlebar-buttons) Defined in scheme/titlebar-buttons.scm at line 26 (CVS log) reset-constraints Reset the constraint solving system. (reset-constraints) Description Reset the constraint solving system. This switches to a fresh new master solver object, and resets the global list of ui-constraint instances (so the menu of constraints is reset to empty). Implementation Notes Module: (app scwm constraints) Defined in scheme/constraints.scm at line 22 (CVS log) reset-input-hook! Remove all procedures from the input hook. (reset-input-hook!) Description Remove all procedures from the input hook. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 747 (CVS log) reset-motion-handlers! Call no procedures on XMotionEvents. (reset-motion-handlers!) Description Call no procedures on XMotionEvents. Handling motion events can considerably slow Scwm down so use it only when necessary. See add-motion-handler and remove-motion-handler. Implementation Notes Module: Built-in Primitive Defined in src/events.c at line 2209 (CVS log) reset-on-segv Return the number of segv signals Scwm will reset on. (reset-on-segv) Description Return the number of segv signals Scwm will reset on. See set-reset-on-segv!. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 655 (CVS log) reset-scwmexec-protocol Reset the scwmexec protocol. (reset-scwmexec-protocol) Description Reset the scwmexec protocol. This procedure removes the "XA_SCWMEXEC_REQUEST" property on the root window. It should not be necessary but may be useful in case your X server goes awry (and otherwise you would have to restart your X server). Use if scwmexec or scwmrepl are not returning (e.g., if your Emacs hangs when you try evaluating a scwm expression). Implementation Notes Module: Built-in Primitive Defined in src/events.c at line 639 (CVS log) reset-timer-hook! Remove all timer-hook procedures. (reset-timer-hook!) Description Remove all timer-hook procedures. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 601 (CVS log) reset-ui-constraint-classes! Empty the global list of ui-constraint-classes. (reset-ui-constraint-classes!) Description Empty the global list of ui-constraint-classes. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 139 (CVS log) reset-undo! Reset the undo system. (reset-undo!) Description Reset the undo system. Clears the list of states. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 33 (CVS log) resize-frame Resize WIN to a size of W by H in pixels. (resize-frame w h #&optional win x y) Description Resize win to a size of w by h in pixels. Also moves win to virtual coordinates x, y if both of them are specified. The size includes the window decorations. win defaults to the window context in the usual way if not specified. The resulting size of the frame may not be w by h due to rounding to the nearest acceptable size for the client window (e.g., Emacs windows can only be sizes that are multiples of the basic character size) Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2403 (CVS log) resize-fullscreen Resize the current window with the pointer to 90% of the full screen size. (resize-fullscreen) Description Resize the current window with the pointer to 90% of the full screen size. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 350 (CVS log) resize-halfscreen Resize the current window with the pointer to full height and half the screen size in width. (resize-halfscreen) Description Resize the current window with the pointer to full height and half the screen size in width. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 344 (CVS log) resize-quarterscreen Resize the current window with the pointer to 1/4 of the screen. (resize-quarterscreen) Description Resize the current window with the pointer to 1/4 of the screen. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 338 (CVS log) resize-window Resize WIN's client area to a size of W by H in pixels. (resize-window w h #&optional (win (get-window)) x y) Description Resize WIN's client area to a size of W by H in pixels. The size does not include the window decorations -- only the client application size. WIN defaults to the window context in the usual way if not specified. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 289 (CVS log) resize-xdvi-full-page-100% Resize an Xdvi window to be full-page, 100%. (resize-xdvi-full-page-100% #&optional (win (get-window))) Description Resize an Xdvi window to be full-page, 100%. Then you must use various mouse bindings to pan the page around. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 467 (CVS log) resource-match?? Return a predicate that tests a window's resource instance. (resource-match?? STRING TYPE CASE-SENSITIVE?) Description Return a predicate that tests a window's resource instance. When applied to a window, this predicate will return true if the resource instance matches STRING in the manner specified by the optional argument TYPE, which may be 'exact, 'regexp, or 'wildcard. The optional CASE-SENSITIVE argument determines whether the matching is case-sensitive or not. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 321 (CVS log) restack-windows Restack the windows in WINLIST from front to back. (restack-windows winlist) Description Restack the windows in winlist from front to back. The first element of winlist will be kept in its current stacking order, the remainder will be stacked immediately below it in the order given. (Note: This will currently confuse the heck out of the pager and possibly other legacy fvwm2 modules). winlist should contain only window objects; invalid (i.e., closed) window objects will be ignored without signalling an error. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1905 (CVS log) restart Restart the window manager. (restart #&optional command) Description Restart the window manager. If command is specified, use that, as the new window manager to run. If command is not specified or is exactly equal to "scwm", restart scwm with the same command-line arguments as given previously. Implementation Notes Module: Built-in Primitive Defined in src/shutdown.c at line 179 (CVS log) restarted? Returns true if scwm is being restarted by itself. (restarted?) Description Returns true if scwm is being restarted by itself. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 140 (CVS log) restore-global-window-configuration Restore the states of all windows from GLOBAL-CONFIGURATION. (restore-global-window-configuration global-configuration) Description Restore the states of all windows from GLOBAL-CONFIGURATION. Implementation Notes Module: (app scwm window-configuration) Defined in scheme/window-configuration.scm at line 100 (CVS log) restore-scwm-handlers Restore the scwm behavior for signals and for X errors. (restore-scwm-handlers) Description Restore the scwm behavior for signals and for X errors. This is automatically called when (app scwm gtk) is loaded, to clean up after the (gtk gtk) module. Implementation Notes Module: Primitive from (app scwm scwmgtkhelper) Defined in modules/scwmgtkhelper/scwmgtkhelper.c at line 74 (CVS log) restore-window-configuration Restore the state of WIN from GLOBAL-CONFIGURATION. (restore-window-configuration global-configuration #&optional (win (get-window))) Description Restore the state of WIN from GLOBAL-CONFIGURATION. Implementation Notes Module: (app scwm window-configuration) Defined in scheme/window-configuration.scm at line 61 (CVS log) reverse-iota Generate a list of the integers from N-1 to 0 in order. (reverse-iota n) Description Generate a list of the integers from N-1 to 0 in order. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 49 (CVS log) rgb-colors Read in the rgb-colors database. (rgb-colors) Description Read in the rgb-colors database. Requires uniq, awk, /usr/X11R6/lib/X11/rgb.txt. Implementation Notes Module: Defined in scheme/rgb-database.scm at line 34 (CVS log) round/ Return the closest integer to X divided by Y. (round/ x y) Description Return the closest integer to X divided by Y. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 61 (CVS log) rubber-band-move Move WIN interactively, using a rubber band frame. (rubber-band-move #&optional win) Description Move win interactively, using a rubber band frame. Returns a list '(X Y) which is the new viewport position of win. This allows the user to drag a rubber band frame around the screen. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/move.c at line 557 (CVS log) rubber-band-resize Resize WIN interactively, using a rubber band frame. (rubber-band-resize #&optional win) Description Resize win interactively, using a rubber band frame. Returns a list '(width height) that is the new size of win. This allows the user to drag a rubber band frame to set the size of the window. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/resize.c at line 691 (CVS log) run-dot-xclients-at-startup After done reading your startup file, run your ~/. (run-dot-xclients-at-startup) Description After done reading your startup file, run your ~/.xclients script. Uses the startup-hook and run-dot-xclients-script to do so. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 848 (CVS log) run-dot-xclients-script Runs the ~/. (run-dot-xclients-script) Description Runs the ~/.xclients script. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 844 (CVS log) run-fvwm2-module No documentation supplied. (run-fvwm2-module module-name #&optional (other-args '()) (config-file "~/.fvwm2rc") (config-info (append (aux-config-info) (get-fvwm2-module-config (basename module-name))))) Description No documentation supplied. Implementation Notes Module: (app scwm fvwm-module) Defined in scheme/fvwm-module.scm at line 431 (CVS log) run-in-netscape Runs COMMAND in a Netscape window, calling COMPLETION when done, if set. (run-in-netscape command completion #&optional (netwin (netscape-win))) Description Runs COMMAND in a Netscape window, calling COMPLETION when done, if set. Uses Netscape window NETWIN if specifies, or one found by (netscape-win) otherwise; it is an error if NETWIN refers to a non-Netscape window. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 62 (CVS log) run-in-xterm Return a procedure that runs CMD in an xterm. (run-in-xterm cmd . opts) Description Return a procedure that runs CMD in an xterm. Uses the variable `*xterm-command*' to determine how to run an xterm. CMD may include options to the command. The rest of the arguments are passed as options to the xterm command. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 644 (CVS log) run-ScwmButtons Start a ScwmButtons window giving a simple toolbar button/action interface. (run-ScwmButtons button-item-list #&key (orientation 'horizontal) (name "ScwmButtons") (auto-orient #t) (auto-orient-margin 100)) Description Start a ScwmButtons window giving a simple toolbar button/action interface. ORIENTATION can be either 'horizontal or 'vertical; NAME is the name of the window. AUTO-ORIENT is #t if you wish the window to switch orientations when the window approaches an edge of the viewport, and AUTO-ORIENT-MARGIN determines how wide the "edge" of a viewport is (in pixels). Implementation Notes Module: (app scwm ScwmButtons) Defined in scheme/ScwmButtons.scm at line 86 (CVS log) run-ScwmClock Start a ScwmClock window display. (run-ScwmClock #&key (24-hour #t) (show-timezone #t) (update-interval 1) (parent #f)) Description Start a ScwmClock window display. 24-HOUR is #t if you want to use military time, #f for am/pm display. SHOW-TIMEZONE is #t to display the timezeon. UPDATE-INTERVAL is how often (in seconds) that the clock should be updated. PARENT is a parent window to use for the clock. Implementation Notes Module: (app scwm ScwmClock) Defined in scheme/ScwmClock.scm at line 33 (CVS log) run-ScwmDeskButtons Start a ScwmDeskButtons toolbar interface. (run-ScwmDeskButtons desks #&key desk-names) Description Start a ScwmDeskButtons toolbar interface. DESKS is the number of desktops, and DESK-NAMES can be given to specify names for each of the desks. Answers an object that is used in close-ScwmDeskButtons to close the window. Implementation Notes Module: (app scwm ScwmDeskButtons) Defined in scheme/ScwmDeskButtons.scm at line 39 (CVS log) safe-load Load file FNAME while trapping and displaying errors. (safe-load fname) Description Load file fname while trapping and displaying errors. Each individual top-level-expression is evaluated separately and all errors are trapped and displayed. You should use this procedure if you need to make sure most of a file loads, even if it may contain errors. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 505 (CVS log) save-preferences Save the current Scwm preferences to FILENAME. (save-preferences #&optional (filename (string-append (getenv "HOME") "/.scwm-options"))) Description Save the current Scwm preferences to FILENAME. FILENAME defaults to $HOME/.scwm-options if not specified. The string written is generated by scwm-options-string. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 508 (CVS log) save-settings No documentation supplied. (save-settings) Description No documentation supplied. Implementation Notes Module: (app scwm prefs-menu) Defined in scheme/prefs-menu.scm at line 50 (CVS log) scwm-gdk-X-fdes Return the integer connection number of the gdk_display. (scwm-gdk-X-fdes) Description Return the integer connection number of the gdk_display. Returns -1 if gdk_display is not initialized. Implementation Notes Module: Primitive from (app scwm scwmgtkhelper) Defined in modules/scwmgtkhelper/scwmgtkhelper.c at line 35 (CVS log) scwm-group-docstring Return the prettified name for group SYM. (scwm-group-docstring sym) Description Return the prettified name for group SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 94 (CVS log) scwm-group-icon Return the icon for group SYM. (scwm-group-icon sym) Description Return the icon for group SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 99 (CVS log) scwm-group-name Return the prettified name for group SYM. (scwm-group-name sym) Description Return the prettified name for group SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 89 (CVS log) scwm-group-properties Return the group properties for group SYM. (scwm-group-properties sym) Description Return the group properties for group SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 85 (CVS log) scwm-gtk-menu No documentation supplied. (scwm-gtk-menu list-of-menuitems #&key (image-side 'menu-side-image) (image-align 'top) (color-bg-image-side 'menu-side-bg-color) (image-bg 'menu-bg-image) (color-text 'menu-text-color) (color-bg 'menu-bg-color) (color-stipple 'menu-stipple-color) (hl-color-fg 'menu-hl-fg-color) (hl-color-bg 'menu-hl-bg-color) (hl-relief? #t) (font 'menu-font) (look 'menu-look) popup-delay hover-delay (extra #f)) Description No documentation supplied. Implementation Notes Module: (app scwm gtk-menu) Defined in scheme/gtk-menu.scm at line 70 (CVS log) scwm-gtk-menu-title No documentation supplied. (scwm-gtk-menu-title label #&key image-left) Description No documentation supplied. Implementation Notes Module: (app scwm gtk-menu) Defined in scheme/gtk-menu.scm at line 11 (CVS log) scwm-gtk-menuitem No documentation supplied. (scwm-gtk-menuitem label #&key image-above image-left (fg #f) (bg #f) (font #f) extra-label action submenu hover-action unhover-action hotkey-prefs) Description No documentation supplied. Implementation Notes Module: (app scwm gtk-menu) Defined in scheme/gtk-menu.scm at line 18 (CVS log) scwm-gtk-popup-menu No documentation supplied. (scwm-gtk-popup-menu menu #&optional warp-to-index x-pos y-pos left-side? permit-alt-release-selection?) Description No documentation supplied. Implementation Notes Module: (app scwm gtk-menu) Defined in scheme/gtk-menu.scm at line 96 (CVS log) scwm-gtk-sync Dispatch all pending gtk-events. (scwm-gtk-sync) Description Dispatch all pending gtk-events. This ought to be called from inside Scwm-controlled loops that do not return to the main event loop Implementation Notes Module: (app scwm gtk) Defined in scheme/gtk.scm at line 43 (CVS log) scwm-is-constraint-enabled? Return #t if scwm has the constraint solver primitives, #f otherwise. (scwm-is-constraint-enabled?) Description Return #t if scwm has the constraint solver primitives, #f otherwise. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 730 (CVS log) scwm-last-timestamp Return the timestamp of the last event Scwm handled. (scwm-last-timestamp) Description Return the timestamp of the last event Scwm handled. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 429 (CVS log) scwm-module-loaded? Return #t iff MODULE has been loaded. (scwm-module-loaded? module) Description Return #t iff MODULE has been loaded. Implementation Notes Module: Defined in scheme/minimal.scm at line 139 (CVS log) scwm-option-documentation Return the documentation for SYM. (scwm-option-documentation sym) Description Return the documentation for SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 198 (CVS log) scwm-option-favorites Return the favorites for SYM. (scwm-option-favorites sym) Description Return the favorites for SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 218 (CVS log) scwm-option-getter Return the getter for SYM. (scwm-option-getter sym) Description Return the getter for SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 208 (CVS log) scwm-option-group Return the group for SYM. (scwm-option-group sym) Description Return the group for SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 223 (CVS log) scwm-option-layout-hint Return the permit-disable flag for SYM. (scwm-option-layout-hint sym) Description Return the permit-disable flag for SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 233 (CVS log) scwm-option-module Return the module in which option SYM was defined. (scwm-option-module sym) Description Return the module in which option SYM was defined. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 188 (CVS log) scwm-option-name Return the name of SYM. (scwm-option-name sym) Description Return the name of SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 193 (CVS log) scwm-option-permit-disable Return the permit-disable flag for SYM. (scwm-option-permit-disable sym) Description Return the permit-disable flag for SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 228 (CVS log) scwm-option-range Return the range for SYM. (scwm-option-range sym) Description Return the range for SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 213 (CVS log) scwm-option-setter Return the setter for SYM. (scwm-option-setter sym) Description Return the setter for SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 203 (CVS log) scwm-option-short-documentation No documentation supplied. (scwm-option-short-documentation sym) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 67 (CVS log) scwm-option-symget Get option SYM's value. (scwm-option-symget sym) Description Get option SYM's value. Implementation Notes Module: Defined in scheme/defoption.scm at line 272 (CVS log) scwm-option-symset! Set option SYM to VALUE. (scwm-option-symset! sym value) Description Set option SYM to VALUE. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 263 (CVS log) scwm-option-type Return the type for SYM. (scwm-option-type sym) Description Return the type for SYM. Implementation Notes Module: (app scwm defoption) Defined in scheme/defoption.scm at line 238 (CVS log) scwm-options-dialog Popup a scwm options dialog box. (scwm-options-dialog) Description Popup a scwm options dialog box. You may need to use-modules all the modules that contain scwm-options to have this work for now. Put "(load-preferences)" in your .scwmrc where you want the saved preferences to take effect. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 268 (CVS log) scwm-options-listbook No documentation supplied. (scwm-options-listbook done-action cancel-action) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 327 (CVS log) scwm-options-menu No documentation supplied. (scwm-options-menu) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 239 (CVS log) scwm-options-notebook No documentation supplied. (scwm-options-notebook done-action cancel-action) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 307 (CVS log) scwm-options-string Return a string that, when evalled, resets preferences to current values. (scwm-options-string #&optional (syms scwm-options)) Description Return a string that, when evalled, resets preferences to current values. SYMS is a list of all the preference settings you wish to be included in the string. It defaults to the value of scwm-options, the list of all the options in the current session. At present this means that if some modules are not loaded, those options will not be included. The returned string will contain multiple S-expressions, one for each Scwm preference value. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 478 (CVS log) scwm-options-vbox-page Popup a scwm options dialog box. (scwm-options-vbox-page parent done-action cancel-action title syms) Description Popup a scwm options dialog box. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 368 (CVS log) scwm-path-exec-prefix Return the $EXEC_PREFIX directory path that scwm was installed with. (scwm-path-exec-prefix) Description Return the $EXEC_PREFIX directory path that scwm was installed with. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 471 (CVS log) scwm-path-prefix Return the $PREFIX directory path that scwm was installed with. (scwm-path-prefix) Description Return the $PREFIX directory path that scwm was installed with. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 461 (CVS log) scwm-quit Exit scwm cleanly. (scwm-quit) Description Exit scwm cleanly. quit is redefined as this within scwm. Implementation Notes Module: Built-in Primitive Defined in src/shutdown.c at line 200 (CVS log) scwm-run-test-hook-0 Invoke scwm-test-hook-0 COUNT times. (scwm-run-test-hook-0 count) Description Invoke scwm-test-hook-0 count times. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 701 (CVS log) scwm-run-test-hook-1 Invoke scwm-test-hook-1 COUNT times with ARG as the single argument. (scwm-run-test-hook-1 count arg) Description Invoke scwm-test-hook-1 count times with arg as the single argument. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 715 (CVS log) scwm-system Run CMD using /bin/sh -c CMD and return a list: (exit-status child-pid). (scwm-system cmd) Description Run CMD using /bin/sh -c CMD and return a list: (exit-status child-pid). Note that the child pid is of the executed sh, not CMD. The CMD is run synchronously, and Bourne-shell meta characters are interpreted by /bin/sh. E.g., to start CMD in the background, use a trailing "&" character. See also guile's system, but note that it may permit signals on the controlling tty to be seen by children (observed on Linux, Free/NetBSD, but not on Solaris or HP/UX. This may be a bug (not meeting POSIX.2 specifications). Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 734 (CVS log) scwm-version Return the version of scwm running. (scwm-version) Description Return the version of scwm running. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 440 (CVS log) scwm-version-date Return the date that the running scwm was last changed as a string. (scwm-version-date) Description Return the date that the running scwm was last changed as a string. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 450 (CVS log) sec->msec Convert SEC seconds into an equivalent number of milliseconds. (sec->msec sec) Description Convert SEC seconds into an equivalent number of milliseconds. Especially useful for add-timer-hook! and other timing related procedures that take milliseconds. Implementation Notes Module: (app scwm time-convert) Defined in scheme/time-convert.scm at line 24 (CVS log) sec->usec Convert SEC seconds into an equivalent number of microseconds. (sec->usec sec) Description Convert SEC seconds into an equivalent number of microseconds. Especially useful for usleep and other timing related procedures that take microseconds. See also sleep. Implementation Notes Module: Defined in scheme/time-convert.scm at line 36 (CVS log) segment-ray-intersects-segment Return the point of intersection for a edge moving to ENDX,ENDY and a SEGMENT. (segment-ray-intersects-segment center size endx endy segment) Description Return the point of intersection for a edge moving to ENDX,ENDY and a SEGMENT. ENDX should be the left x coordinate of the destination for the start-segment edge. Implementation Notes Module: (app scwm smart-push) Defined in scheme/smart-push2.scm at line 65 (CVS log) select-matching-windows Select windows for which predicate PROC returns #t. (select-matching-windows proc) Description Select windows for which predicate PROC returns #t. PROC might be one of resource-match??, class-match??, etc. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 93 (CVS log) select-multiple-windows-interactively Return a list of user-selected windows, up to MAX. (select-multiple-windows-interactively #&optional (max 32000) (proc-when-selected #f)) Description Return a list of user-selected windows, up to MAX. The list is in the reverse order from the way by which they were selected. PROC-WHEN-SELECTED will be run on each window as it is selected. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 130 (CVS log) select-viewport-position Select a viewport position and return the window there. (select-viewport-position #&optional cursor release?) Description Select a viewport position and return the window there. Use a special cursor and let the user click to select a viewport position Returns a list of three items: (selected-window viewport-x viewport-y). selected-window is either the window object corresponding to the selected window, a window id as an integer, or #f if no window was selected. viewport-x and viewport-y give the position in the viewport that the cursor was located when the selection was finalized. release? indicates whether to whether to wait for a mouse release or act immediately on the click. cursor is the cursor object to use, or #t for the "skull and cross-bones" kill cursor (recommended for destructive operations like delete-window and destroy-window), or #f or omitted for the standard circle cursor. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 988 (CVS log) select-window Select a window interactively, and return the specified window. (select-window #&optional (cursor #f) (release? #f)) Description Select a window interactively, and return the specified window. Use a special cursor and let the user click to select the window. The optional CURSOR argument can be either a cursor object or #t to indicate to use the "skull and cross-bones" kill cursor (recommended for destructive operations like delete-window and destroy-window). The optional argument RELEASE? indicates whether to wait for a mouse release or act immediately on the click. Returns #f if no window was selected. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 801 (CVS log) select-window-add Select a single window, highlight it, and add it to the selected-windows-list. (select-window-add #&optional (w (get-window-with-nonant))) Description Select a single window, highlight it, and add it to the selected-windows-list. The selected window is returned and will remain highlighted until unflash-window is called on that window. The selected window is also added to a selected-windows list that can be accessed via selected-windows-list. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 62 (CVS log) select-window-from-window-list Permit selecting a window from a window list. (select-window-from-window-list #&key (only '()) (except '()) (ignore-winlist-skip #f)) Description Permit selecting a window from a window list. Return the selected window object, or #f if none was selected Implementation Notes Module: (app scwm winlist-menu) Defined in scheme/winlist-menu.scm at line 143 (CVS log) select-window-group Prompt for multiple windows and return the list of selected windows. (select-window-group) Description Prompt for multiple windows and return the list of selected windows. Windows are highlighted (see flash-window) as they are selected. The returned list can be used to un-highlight the windows: (let ((winlist (select-window-group))) (for-each (lambda (w) (unflash-window w)) winlist)) Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 197 (CVS log) select-window-interactively Return an interactively-selected window after prompting (optionally) with MSG. (select-window-interactively #&optional (msg #f) (message-window #f)) Description Return an interactively-selected window after prompting (optionally) with MSG. If given, use message window MESSAGE-WINDOW to display the message, otherwise create a new message window. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 828 (CVS log) select-window-remove Unselect a single window, de-highlight it, and remove it from the selected-windows-list. (select-window-remove #&optional (w (get-window-with-nonant))) Description Unselect a single window, de-highlight it, and remove it from the selected-windows-list. The selected window is removed from the selected-windows list that can be accessed via selected-windows-list. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 78 (CVS log) select-window-toggle Toggle the selectedness of W. (select-window-toggle #&optional (w (get-window-with-nonant))) Description Toggle the selectedness of W. See select-window-add and select-window-remove. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 53 (CVS log) selected-windows-list Returns the list of windows selected by select-window-interactively-and-highlight. (selected-windows-list) Description Returns the list of windows selected by select-window-interactively-and-highlight. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 45 (CVS log) selected-windows-to-register Save the current set of selected windows to REGISTER. (selected-windows-to-register #&optional (register (get-register-name "Selected-windows-to-"))) Description Save the current set of selected windows to REGISTER. Implementation Notes Module: (app scwm register) Defined in scheme/register.scm at line 80 (CVS log) send-button Send a synthetic mouse button/release event. (send-button button #&optional win kind propagate? dx dy) Description Send a synthetic mouse button/release event. Create a synthetic event of a press of mouse button button. The usual mouse button specification format (with modifiers) is used. Send the event to window win if specified; otherwise the window to be used defaults to the window context in the usual way. By default, both a press and a release are sent---a click. kind can be one of 'press, 'release, 'click, 'desk-press, 'desk-release, or 'desk-click. If dx or dy is set, that value is used as the offset within win for the button events to occur. If one is not specified or #f, then the pointer offset of that coordinate is used instead. propagate? indicates whether the propagate flag is set on the event; the default is #f. You should not have to worry about this unless you know what it means. Implementation Notes Module: Built-in Primitive Defined in src/events.c at line 2272 (CVS log) send-button-1 Send a mouse-1 button press and release event. (send-button-1) Description Send a mouse-1 button press and release event. Implementation Notes Module: (app scwm synth-events) Defined in scheme/synth-events.scm at line 7 (CVS log) send-button-2 Send a mouse-2 button press and release event. (send-button-2) Description Send a mouse-2 button press and release event. Implementation Notes Module: (app scwm synth-events) Defined in scheme/synth-events.scm at line 12 (CVS log) send-button-3 Send a mouse-3 button press and release event. (send-button-3) Description Send a mouse-3 button press and release event. Implementation Notes Module: Defined in scheme/synth-events.scm at line 17 (CVS log) send-client-message Send WIN the message "ATOM DATA". (send-client-message win atom . data) Description Send win the message "atom data". win can be 'root-window or an X window identification number. Useful for supporting other WMs module communication protocols. atom is the X11 atom representing the message type (e.g., "XA_WM_PROTOCOLS") and data is up to 4 32-bit integers of data. for the message. data will be the used to create the message data, and the lastTimestamp will be appended as the last integer in the data message. Implementation Notes Module: Built-in Primitive Defined in src/ICCCM.c at line 68 (CVS log) send-key Send a synthetic press/release of KEY. (send-key key #&optional win key-press? key-release? propagate?) Description Send a synthetic press/release of key. The usual key specification format (with modifiers) is used. The event is sent to window win if specified; otherwise the window to be used defaults to the window context in the usual way. By default, both a press and a release are sent. However, the boolean parameters key-press? and key-release? allow you to specify which are sent individually. propagate? indicates whether the propagate flag is set on the event; the default is #f. You should not have to worry about this unless you know what it means. Implementation Notes Module: Built-in Primitive Defined in src/events.c at line 2225 (CVS log) send-key-press-down Send a synthetic "Down" keypress. (send-key-press-down) Description Send a synthetic "Down" keypress. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 395 (CVS log) send-key-press-next Send a synthetic "Next" keypress. (send-key-press-next) Description Send a synthetic "Next" keypress. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 403 (CVS log) send-key-press-prior Send a synthetic "Prior" keypress. (send-key-press-prior) Description Send a synthetic "Prior" keypress. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 399 (CVS log) send-key-press-up Send a synthetic "Up" keypress. (send-key-press-up) Description Send a synthetic "Up" keypress. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 391 (CVS log) set-*-procedure-properties Add the ARGLIST and INTERACTIVE-SPEC properties to procedure PROC. (set-*-procedure-properties proc arglist interactive-spec) Description Add the ARGLIST and INTERACTIVE-SPEC properties to procedure PROC. This is used internally by the optargs macro system. Implementation Notes Module: (app scwm optargs) Defined in scheme/optargs.scm at line 284 (CVS log) set-animation! Set the animation parameters to VECTOR. (set-animation! vector) Description Set the animation parameters to vector. vector is a vector of floats which give the fractions of the final position that the window should appear at. For instance, #(0.0 0.25 0.5 0.75 1.0 1.1 1.0) would make the window appear at the initial position, 1/4 of the way, 1/2 of the way, 3/4 of the way, overshoot the final position slightly, and finally slide back into place. This parameter is used for both animated window shades and animated moves. Implementation Notes Module: Primitive from (app scwm c-animation) Defined in modules/c-animation/c-animation.c at line 304 (CVS log) set-auto-raise! Turn auto-raise on (#t) or off (#f) for WIN. (set-auto-raise! auto-raise? #&optional (win (get-window))) Description Turn auto-raise on (#t) or off (#f) for WIN. Auto-raise makes a window automatically raise when the mouse pointer enters the window frame. See set-auto-raise-delay! for controlling the delay before the window raises. Implementation Notes Module: (app scwm auto-raise) Defined in scheme/auto-raise.scm at line 103 (CVS log) set-auto-raise-delay! Set the auto-raise delay to DELAY (in ms) for WIN. (set-auto-raise-delay! delay #&optional (win (get-window))) Description Set the auto-raise delay to DELAY (in ms) for WIN. DELAY is the number of milliseconds after the pointer enters WIN that WIN will be raised. See set-auto-raise! to turn auto-raise on or off for a given window. Implementation Notes Module: (app scwm auto-raise) Defined in scheme/auto-raise.scm at line 110 (CVS log) set-auto-raise-focus-proc! Set the auto-raise-focus-proc for WIN. (set-auto-raise-focus-proc! fproc #&optional (win (get-window))) Description Set the auto-raise-focus-proc for WIN. The auto-raise-focus-proc is the procedure which is invoked after the auto-raise-delay after the pointer enters WIN's frame. Implementation Notes Module: (app scwm auto-raise) Defined in scheme/auto-raise.scm at line 124 (CVS log) set-auto-raise-unfocus-delay! Set the timeout to DELAY (in ms) for the unfocus-proc of WIN. (set-auto-raise-unfocus-delay! delay #&optional (win (get-window))) Description Set the timeout to DELAY (in ms) for the unfocus-proc of WIN. After DELAY milliseconds after the pointer leaves WIN's frame, the auto-raise-unfocus-proc will be called. Implementation Notes Module: (app scwm auto-raise) Defined in scheme/auto-raise.scm at line 117 (CVS log) set-auto-raise-unfocus-proc! Set the auto-raise-unfocus-proc for WIN. (set-auto-raise-unfocus-proc! ufproc #&optional (win (get-window))) Description Set the auto-raise-unfocus-proc for WIN. The auto-raise-unfocus-proc is the procedure which is invoked after the auto-raise-unfocus-delay after the pointer leaves WIN's frame. Implementation Notes Module: (app scwm auto-raise) Defined in scheme/auto-raise.scm at line 130 (CVS log) set-auto-unobscure! Turn auto-unobscure on (#t) or off (#f) for WIN. (set-auto-unobscure! auto-unobscure? #&optional (win (get-window))) Description Turn auto-unobscure on (#t) or off (#f) for WIN. Auto-unobscure makes a window automatically move when it becomes fully obscured. Implementation Notes Module: (app scwm auto-unobscure) Defined in scheme/auto-unobscure.scm at line 37 (CVS log) set-auto-unobscure-proc! Set the auto-unobscure-proc for WIN. (set-auto-unobscure-proc! fproc #&optional (win (get-window))) Description Set the auto-unobscure-proc for WIN. The auto-unobscure-proc is the procedure which is invoked when WIN is fully obscured if auto-unobscuring is set for the window. Implementation Notes Module: (app scwm auto-unobscure) Defined in scheme/auto-unobscure.scm at line 43 (CVS log) set-background-color! Sets the color of the root window to COLOR. (set-background-color! color) Description Sets the color of the root window to color. Implementation Notes Module: Primitive from (app scwm background) Defined in modules/background/background.c at line 49 (CVS log) set-background-image! Sets the background of the root window to be IMAGE. (set-background-image! image #&optional style) Description Sets the background of the root window to be image. style can be either 'centered or 'tiled. Implementation Notes Module: Primitive from (app scwm background) Defined in modules/background/background.c at line 156 (CVS log) set-border-face! Set the face for the border In the current decor. (set-border-face! active #&optional inactive) Description Set the face for the border In the current decor. Use active as the face for the border when the window is active. Use inactive when the window is inactive. inactive defaults to the same as active when not specified. Implementation Notes Module: Built-in Primitive Defined in src/face.c at line 957 (CVS log) set-border-width! Set the border width of WIN's border to WIDTH pixels. (set-border-width! width #&optional win) Description Set the border width of win's border to width pixels. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3308 (CVS log) set-button-face! Set the button faces for the various window states. (set-button-face! button active-up #&optional active-down inactive) Description Set the button faces for the various window states. See set-left-button-face! and set-right-button-face! for a more natural interface for this. In the current decor, use active-up as the face for the button specified by the integer button when active and not pressed in. Use active-down when button is active and pressed in, and inactive when the window is inactive. Both inactive and active-down default to active-up when not specified. Note that active-down will magically reverse the sense of the relief flag, so if the button is raised in the active-up state, it will be sunk in the active-down state by default. Implementation Notes Module: Built-in Primitive Defined in src/face.c at line 884 (CVS log) set-button-mwm-flag! Specify the Mwm flag for BUTTON. (set-button-mwm-flag! button flag) Description Specify the Mwm flag for button. If flag is #t, the button's relief pattern (if any) will appear to reverse in depth sense (i.e., flip from sunken in to extruding out) when the window is maximized (has a non-#f "maximized" window property). Implementation Notes Module: Built-in Primitive Defined in src/face.c at line 930 (CVS log) set-click-delay! Set the delay used in identifying mouse clicks and drags. (set-click-delay! msec) Description Set the delay used in identifying mouse clicks and drags. msec is specified in milliseconds. After msec milliseconds, a mouse-down without a mouse-up is considered a drag. Also, after msec milliseconds, a single click is definitively identified as not a double click. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 176 (CVS log) set-click-to-focus-passes-click! Determine whether a click-to-focus window receives the click. (set-click-to-focus-passes-click! flag) Description Determine whether a click-to-focus window receives the click. If flag is #t, the window will receive the event, if #f, scwm will not pass the event on to the client. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 299 (CVS log) set-click-to-focus-raises! Determine whether a click to focus raises the clicked-on window. (set-click-to-focus-raises! flag) Description Determine whether a click to focus raises the clicked-on window. If flag is #t, clicks which transfer focus will also raise the target window. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 323 (CVS log) set-colormap-focus! Set the colormap focus policy to FTYPE. (set-colormap-focus! ftype) Description Set the colormap focus policy to ftype. ftype can either be 'mouse, indicating that the window under the mouse pointer should always have its colormap installed, or 'focus to indicate that the window with the input focus should also get the colormap focus. This makes a difference only when using focus policies other than 'mouse. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 201 (CVS log) set-current-decor! Set the current decor to DECOR. (set-current-decor! decor) Description Set the current decor to decor. Operations described as setting options "in the current decor" will now operate on this one. Implementation Notes Module: Built-in Primitive Defined in src/decor.c at line 240 (CVS log) set-current-desk! Change the current desk to DESK. (set-current-desk! desk) Description Change the current desk to desk. desk should be an integer small enough to fit in one machine word. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 67 (CVS log) set-decorate-transient! Set decoration of transients property on WIN. (set-decorate-transient! flag #&optional win) Description Set decoration of transients property on win. If flag is #t, then if win is transient it will be fully decorated. Transient windows that are not fully decorated will be given only a border and no titlebar regardless of other settings. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4062 (CVS log) set-default-menu-background! Set the default background for menus to BG. (set-default-menu-background! bg) Description Set the default background for menus to BG. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 264 (CVS log) set-default-menu-bg-image! Set the default menu background image to IMAGE. (set-default-menu-bg-image! image) Description Set the default menu background image to IMAGE. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 288 (CVS log) set-default-menu-font! Set the default font for menu text to FONT. (set-default-menu-font! font) Description Set the default font for menu text to FONT. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 271 (CVS log) set-default-menu-foreground! Set the default color for menu text to FG. (set-default-menu-foreground! fg) Description Set the default color for menu text to FG. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 261 (CVS log) set-default-menu-hl-bg-color! Set the default menu highlight background color to BG. (set-default-menu-hl-bg-color! bg) Description Set the default menu highlight background color to BG. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 297 (CVS log) set-default-menu-hl-fg-color! Set the default menu highlight foreground color to FG. (set-default-menu-hl-fg-color! fg) Description Set the default menu highlight foreground color to FG. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 294 (CVS log) set-default-menu-look! Set the default menu look to LOOK. (set-default-menu-look! look) Description Set the default menu look to LOOK. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 291 (CVS log) set-default-menu-side-background! Set the default background for the menu side image to BG. (set-default-menu-side-background! bg) Description Set the default background for the menu side image to BG. If BG is #f, use the default menu background Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 280 (CVS log) set-default-menu-side-image! Set the default menu side image to IMAGE. (set-default-menu-side-image! image) Description Set the default menu side image to IMAGE. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 277 (CVS log) set-default-menu-stipple! Set the default color for stippled (inactive) menu text to STIPPLE. (set-default-menu-stipple! stipple) Description Set the default color for stippled (inactive) menu text to STIPPLE. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 268 (CVS log) set-default-menu-title-font! Set the default font for menu title text to FONT. (set-default-menu-title-font! font) Description Set the default font for menu title text to FONT. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 274 (CVS log) set-desk-size! Sets the desk size to WIDTH, HEIGHT. (set-desk-size! width height) Description Sets the desk size to width, height. Both numbers are given in units of the physical screen size. For example (set-desk-size! 3 3) creates a virtual world 9 times the size of the physical display. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 294 (CVS log) set-easyraise-window! (set-easyraise-window! easyraise? #&optional (win (get-window))) Description Implementation Notes Module: (app scwm easyraise) Defined in scheme/easyraise.scm at line 17 (CVS log) set-edge-move-threshold! Set the edge move threshold to PIXELS. (set-edge-move-threshold! pixels) Description Set the edge move threshold to pixels. Attempts to move a window so that it is off the edge of the screen by fewer than pixels pixels will leave the window entirely onscreen. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 267 (CVS log) set-edge-resistance! Set the edge scroll delay to S, and the edge move threshold to M. (set-edge-resistance! s m) Description Set the edge scroll delay to S, and the edge move threshold to M. See also set-edge-scroll-delay! and set-edge-move-threshold!. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 702 (CVS log) set-edge-scroll! Set the edge scroll values to X and Y, respectively. (set-edge-scroll! x y) Description Set the edge scroll values to X and Y, respectively. These values are the number of pixels that the viewport moves when the pointer hits the edge of the screen. Use %x and %y to convert from a percentage of a screen dimension to a number of pixels. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 716 (CVS log) set-edge-scroll-delay! Set the edge scroll delay to MS milliseconds. (set-edge-scroll-delay! ms) Description Set the edge scroll delay to ms milliseconds. When the mouse pointer hits the edge of the screen, it must stay there for at least the edge scroll delay amount before the desktop will be scrolled. If this parameter is #f, the viewport will not scroll at all at the screen edge. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 235 (CVS log) set-edge-wrap! Set the edge x and y wrap values to X and Y, respectively. (set-edge-wrap! x y) Description Set the edge x and y wrap values to X and Y, respectively. These values should be #t to mean that the pointer should wrap in the given direction, or #f to not wrap around. See also set-edge-x-wrap! and set-edge-y-wrap!. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 708 (CVS log) set-edge-x-scroll! Set the horizontal edge scroll increment to PIXELS. (set-edge-x-scroll! pixels) Description Set the horizontal edge scroll increment to pixels. The horizontal edge scroll setting is the amount by which the viewport will scroll when the mouse hits the left or right edge. Use %x to convert from a percent of screen size to pixels. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 130 (CVS log) set-edge-x-wrap! Set whether to wrap pointer around horizontal edges. (set-edge-x-wrap! flag) Description Set whether to wrap pointer around horizontal edges. If the boolean value flag is #t, the pointer will wrap from the right edge of the desktop to the left of the display as it moves off the right edge, and vice-versa. See also set-edge-y-wrap! Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 186 (CVS log) set-edge-y-scroll! Set the vertical edge scroll increment to PIXELS. (set-edge-y-scroll! pixels) Description Set the vertical edge scroll increment to pixels. The vertical edge scroll setting is the amount by which the viewport will scroll when the mouse hits the top or bottom edge. Use %y to convert from a percent of screen size to pixels. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 157 (CVS log) set-edge-y-wrap! Set whether to wrap pointer around vertical edges. (set-edge-y-wrap! flag) Description Set whether to wrap pointer around vertical edges. If the boolean value flag is #t, the pointer will wrap from the bottom edge of the desktop to the top of the display as it moves off the very bottom edge, and vice-versa. See also set-edge-x-wrap! Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 210 (CVS log) set-face-flag! Set the given FLAG to the given FLAGVAL for face FACE. (set-face-flag! face flag flagval) Description Set the given flag to the given flagval for face face. See the section on the `Face Flags' concept. Implementation Notes Module: Built-in Primitive Defined in src/face.c at line 345 (CVS log) set-force-icon! Set the window-manager-overriding property for WIN to boolean FLAG. (set-force-icon! flag #&optional win) Description Set the window-manager-overriding property for win to boolean flag. If #t, the icon specified for win by the user through scwm will override an application-provided icon. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3894 (CVS log) set-handle-segv! If FLAG, tell Scwm to catch segv signals. (set-handle-segv! flag) Description If flag, tell Scwm to catch segv signals. This is the default, but if you catch a segv and really need it to dump right away to figure out what is wrong then use this. No cleanup is done if handling segv is #f. Be sure to have an extra terminal handy on a console or separate X server. For developers and hackers only. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 668 (CVS log) set-highlight-background! Use BG as the background color for a window with the input focus. (set-highlight-background! bg) Description Use bg as the background color for a window with the input focus. Applies to the current decor. This is used only for windows that don't have their own background color. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 828 (CVS log) set-highlight-colors! Set the highlight window's background color to BG, foreground color to FG. (set-highlight-colors! #&optional (bg #f) (fg #f)) Description Set the highlight window's background color to BG, foreground color to FG. The "highlight window" is the window with the current input focus. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 307 (CVS log) set-highlight-factor! Use FACTOR to generate highlight colors for the current decor. (set-highlight-factor! factor) Description Use factor to generate highlight colors for the current decor. factor is a positive floating point number. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 654 (CVS log) set-highlight-foreground! Use FG for the foreground color of a window with the input focus. (set-highlight-foreground! fg) Description Use fg for the foreground color of a window with the input focus. Applies to the current decor. This is used only for windows that don't have their own foreground color. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 783 (CVS log) set-hint-override! Set whether or not Mwm and Open Look function hints are used. (set-hint-override! flag #&optional win) Description Set whether or not Mwm and Open Look function hints are used. If flag is #t, the hints, which indicate what operations should be allowed on a window, will be ignored for win. If flag is #f, the hints will be honoured. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4044 (CVS log) set-hover-focus! Turn hover-focus on (#t) or off (#f) for WIN. (set-hover-focus! hover-focus? #&optional (win (get-window))) Description Turn hover-focus on (#t) or off (#f) for WIN. hover-focus makes a window automatically get focus when the mouse pointer remains in a window frame. See set-hover-focus-delay! for controlling the delay before the window gets focus. Implementation Notes Module: (app scwm hover-focus) Defined in scheme/hover-focus.scm at line 77 (CVS log) set-hover-focus-delay! Set the hover-focus delay to DELAY (in ms) for WIN. (set-hover-focus-delay! delay #&optional (win (get-window))) Description Set the hover-focus delay to DELAY (in ms) for WIN. DELAY is the number of milliseconds after the pointer enters WIN that WIN will be focused. See set-hover-focus! to turn hover-focus on or off for a given window. Implementation Notes Module: (app scwm hover-focus) Defined in scheme/hover-focus.scm at line 66 (CVS log) set-icon! Set the image to use for the icon of WIN to IMAGE. (set-icon! image #&optional win) Description Set the image to use for the icon of win to image. As usual, an image object or a filename string may be given. #f May also be specified, indicating no icon image. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3931 (CVS log) set-icon-box! Set the icon box in which WIN's icon will be placed. (set-icon-box! x y w h #&optional win) Description Set the icon box in which win's icon will be placed. This set the box to the rectangle at coordinates x, y with width w and height h. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3402 (CVS log) set-icon-font! Set the font used for drawing icon titles to FONT. (set-icon-font! font) Description Set the font used for drawing icon titles to font. Implementation Notes Module: Built-in Primitive Defined in src/font.c at line 246 (CVS log) set-icon-title! Set the visibility of WIN's icon title according to FLAG. (set-icon-title! flag #&optional win) Description Set the visibility of win's icon title according to flag. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3878 (CVS log) set-ignore-dubious-modifiers! If FLAG is #t, ignore scoll/num/lock modifiers on all bindings made. (set-ignore-dubious-modifiers! flag) Description If flag is #t, ignore scoll/num/lock modifiers on all bindings made. Otherwise do not. If dubious locks are being ignored, multiple XGrabKey invocations must occur for each binding made; this can result in a noticeable delay when, e.g., a new window is created. If this bothers you, call this procedure with flag set to #f. The default is #t. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1538 (CVS log) set-left-button-face! Set the button face for the left-button numbered BUTTON. (set-left-button-face! button active-up #&optional (active-down #f) (inactive #f)) Description Set the button face for the left-button numbered BUTTON. E.g., if BUTTON is 1, this will set the leftmost button of your titlebar. See set-button-face! for a description of ACTIVE-UP, ACTIVE-DOWN, and INACTIVE. Implementation Notes Module: (app scwm face) Defined in scheme/face.scm at line 85 (CVS log) set-lenience! Set or reset the input focus lenience flag. (set-lenience! flag #&optional win) Description Set or reset the input focus lenience flag. Determine whether or not to try to give win the input focus when asked, even if the window claims according to hints that it cannot receive the input focus, according to the boolean value flag. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4175 (CVS log) set-load-processing-frequency! Invoke hooks on load-processing-hook every NUM-LINES lines. (set-load-processing-frequency! num-lines) Description Invoke hooks on load-processing-hook every num-lines lines. Returns the old value. Implementation Notes Module: Built-in Primitive Defined in src/callbacks.c at line 530 (CVS log) set-markwin-offset! No documentation supplied. (set-markwin-offset! win nonant markwin) Description No documentation supplied. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 159 (CVS log) set-menu-background-picture! Use PICTURE as the background image for MENU. (set-menu-background-picture! menu picture) Description Use picture as the background image for menu. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 533 (CVS log) set-menu-colors! Use TEXT-COLOR and BG-COLOR as the colors for MENU. (set-menu-colors! menu text-color bg-color #&optional stipple-color) Description Use text-color and bg-color as the colors for menu. stipple-color is optional, and if given will be used for the stipple color for the menu. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 399 (CVS log) set-menu-extra-options! Set MENU's extra options to OPTIONS. (set-menu-extra-options! menu options) Description Set menu's extra options to options. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 549 (CVS log) set-menu-font! Use FONT as the font for MENU. (set-menu-font! menu font) Description Use font as the font for menu. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 483 (CVS log) set-menu-highlight-colors! Use TEXT-COLOR and BG-COLOR as the highlight colors for MENU. (set-menu-highlight-colors! menu text-color bg-color) Description Use text-color and bg-color as the highlight colors for menu. These colors will be used for the selected item. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 425 (CVS log) set-menu-highlight-factor! Use FACTOR to generate highlight colors for menus. (set-menu-highlight-factor! factor) Description Use factor to generate highlight colors for menus. factor is a positive floating point number Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 726 (CVS log) set-menu-highlight-relief! If HIGHLIGHT-RELIEF? is #t, then draw a relief on selected items in MENU. (set-menu-highlight-relief! menu highlight-relief?) Description If highlight-relief? is #t, then draw a relief on selected items in menu. Otherwise, do not. See also set-menu-highlight-colors!. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 446 (CVS log) set-menu-hotkeys-activate-item! If ACTIVATE? is #t, let menu hotkeys invoke the item. (set-menu-hotkeys-activate-item! activate?) Description If activate? is #t, let menu hotkeys invoke the item. If #f, a menuitem hotkey just makes that item selected and still requires a Return or Space keypress to activate the item. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 1626 (CVS log) set-menu-hover-delay! Set MENU's hover delay to HOVER-DELAY. (set-menu-hover-delay! menu hover-delay) Description Set menu's hover delay to hover-delay. hover-delay is the number of ms to wait before invoking the hover action. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 347 (CVS log) set-menu-look! Use MENU-LOOK as the menu-look for MENU. (set-menu-look! menu menu-look) Description Use menu-look as the menu-look for menu. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 371 (CVS log) set-menu-popup-delay! Set MENU's submenu popup delay to POPUP-DELAY. (set-menu-popup-delay! menu popup-delay) Description Set menu's submenu popup delay to popup-delay. popup-delay is the number of ms to wait before popping up submenus. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 321 (CVS log) set-menu-shadow-factor! Use FACTOR to generate shadow colors for menus. (set-menu-shadow-factor! factor) Description Use factor to generate shadow colors for menus. factor is a positive floating point number Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 749 (CVS log) set-menu-side-picture! Use PICTURE as the side picture for MENU. (set-menu-side-picture! menu picture #&optional align bg-color) Description Use picture as the side picture for menu. Set its alignment to align, and its background color to bg-color. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 499 (CVS log) set-menu-title! Use MENU-TITLE as the title for MENU. (set-menu-title! menu menu-title) Description Use menu-title as the title for menu. Implementation Notes Module: Built-in Primitive Defined in src/menu.c at line 385 (CVS log) set-menuitem-colors! Sets the fg and bg colors of MENUITEM to FG and BG respectively. (set-menuitem-colors! menuitem fg bg) Description Sets the fg and bg colors of menuitem to fg and bg respectively. Use #f for either/both component to have menuitem inherit that color from the menu in which it is embedded. Implementation Notes Module: Built-in Primitive Defined in src/menuitem.c at line 205 (CVS log) set-menuitem-font! Sets the font of MENUITEM to FONT. (set-menuitem-font! menuitem font) Description Sets the font of menuitem to font. Use #f to have menuitem inherit its font from the menu in which it is embedded. Implementation Notes Module: Built-in Primitive Defined in src/menuitem.c at line 239 (CVS log) set-mini-icon! Set the image to use for the mini-icon of WIN to IMAGE. (set-mini-icon! image #&optional win) Description Set the image to use for the mini-icon of win to image. As usual, an image object or a filename string may be given. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3975 (CVS log) set-mod-mask-numlock! Set the bit-mask for the NumLock modifier key. (set-mod-mask-numlock! mask) Description Set the bit-mask for the NumLock modifier key. mask must be a power of 2. The NumLock modifier mask is set automatically, but you can use this procedure if you need to override the built-in algorithm. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1511 (CVS log) set-mod-mask-scrolllock! Set the bit-mask for the ScrollLock modifier key. (set-mod-mask-scrolllock! mask) Description Set the bit-mask for the ScrollLock modifier key. mask must be a power of 2. The ScrollLock modifier mask is set automatically, but you can use this procedure if you need to override the built-in algorithm. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1524 (CVS log) set-mouse-focus-click-raises! Determine whether a mouse-focus-click will raise the window. (set-mouse-focus-click-raises! flag) Description Determine whether a mouse-focus-click will raise the window. If flag is #t it will raise the window. Not sure if this function makes sense any more. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 355 (CVS log) set-mwm-border! Set the mwm-border style flag of WIN to boolean FLAG. (set-mwm-border! flag #&optional win) Description Set the mwm-border style flag of win to boolean flag. The Mwm style has shallower bevels than the default scwm/fvwm2 style. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3834 (CVS log) set-mwm-buttons! Set the mwm-buttons flag of WIN to boolean FLAG. (set-mwm-buttons! flag #&optional win) Description Set the mwm-buttons flag of win to boolean flag. The mwm-buttons flag controls whether any of this window's flags obey their mwm-flags. See set-button-mwm-flag!. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3818 (CVS log) set-mwm-decor-hint! Set whether or not Motif decoration hints are used for WIN. (set-mwm-decor-hint! flag #&optional win) Description Set whether or not Motif decoration hints are used for win. If flag is #t, the Mwm decor hint will be given for win. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4078 (CVS log) set-mwm-func-hint! Set whether or not Motif function hints are used for WIN. (set-mwm-func-hint! flag #&optional win) Description Set whether or not Motif function hints are used for win. If flag is #t, the Motif function hints are respected for win. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4092 (CVS log) set-nonant-highlight-color! Use COLOR for highlighting nonants. (set-nonant-highlight-color! color) Description Use color for highlighting nonants. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3650 (CVS log) set-not-menu-background! Use BG as the default background color for icons, window frames, etc. (set-not-menu-background! bg) Description Use bg as the default background color for icons, window frames, etc. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 926 (CVS log) set-not-menu-foreground! Use FG as the default foreground color for icons, titlebars, etc. (set-not-menu-foreground! fg) Description Use fg as the default foreground color for icons, titlebars, etc. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 898 (CVS log) set-OL-decor-hint! Determine whether or not to respect Open Look decoration hints. (set-OL-decor-hint! flag #&optional win) Description Determine whether or not to respect Open Look decoration hints. If flag is #t, the decoration hints will be respected for win. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4124 (CVS log) set-PPosition-hint! Set or reset the program-specified position hint for WIN. (set-PPosition-hint! flag #&optional win) Description Set or reset the program-specified position hint for win. If flag is #t, the hint will be set, otherwise reset. This only matters when using the default placement procedure. Some programs allegedly set this hint to a useless value like (0,0) always, so ignoring it is recommended. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4107 (CVS log) set-quote-key-events! Set key event quoting to QUOTING-ON?. (set-quote-key-events! quoting-on?) Description Set key event quoting to quoting-on?. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 857 (CVS log) set-register Set contents of Scwm register named REGISTER to VALUE. (set-register register value) Description Set contents of Scwm register named REGISTER to VALUE. Returns VALUE. Implementation Notes Module: (app scwm register) Defined in scheme/register.scm at line 34 (CVS log) set-reset-on-segv! Reset Scwm to the main event loop on the next NUMBER-TO-RESET segv signals. (set-reset-on-segv! number-to-reset) Description Reset Scwm to the main event loop on the next number-to-reset segv signals. The default is 100, but if you catch a segv and and are willing to track it or send in a bug report, use this to permit a C-level backtrace by setting it to 0. See also set-handle-segv!. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 641 (CVS log) set-right-button-face! Set the button face for the right-button numbered BUTTON. (set-right-button-face! button active-up #&optional (active-down #f) (inactive #f)) Description Set the button face for the right-button numbered BUTTON. E.g., if BUTTON is 1, this will set the rightmost button of your titlebar. See set-button-face! for a description of ACTIVE-UP, ACTIVE-DOWN, and INACTIVE. Implementation Notes Module: (app scwm face) Defined in scheme/face.scm at line 94 (CVS log) set-rubber-band-mask! Set the rubber band mask used when dragging or resizing. (set-rubber-band-mask! value) Description Set the rubber band mask used when dragging or resizing. value is XORed with the background when dragging non-opaque move or resize frames. value should be an integer. Implementation Notes Module: Built-in Primitive Defined in src/resize.c at line 334 (CVS log) set-selected-windows-list! Make LIST be the set of selected windows. (set-selected-windows-list! list-of-windows) Description Make LIST be the set of selected windows. Implementation Notes Module: Defined in scheme/window-selection.scm at line 248 (CVS log) set-shadow-factor! Use FACTOR to generate shadow colors in the current decor. (set-shadow-factor! factor) Description Use factor to generate shadow colors in the current decor. factor is a positive floating point number Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 690 (CVS log) set-show-icon! Set whether or not the icon of WIN will be visible. (set-show-icon! flag #&optional win) Description Set whether or not the icon of win will be visible. If flag is #t, the icon will be displayed, if #f, it will not appear when the window is iconified (it will still be in the window list, of course). win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3912 (CVS log) set-skip-mapping! Set or reset whether scwm should not change desktops on a map. (set-skip-mapping! flag #&optional win) Description Set or reset whether scwm should not change desktops on a map. This only affect the behaviour upon initial mapping of win. If flag is #t, the virtual desktop will not be changed when win is mapped. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4160 (CVS log) set-start-on-desk! Make WIN start on DESK when first mapped. (set-start-on-desk! desk #&optional win) Description Make win start on desk when first mapped. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4138 (CVS log) set-title-face! Set the titlebar faces for the various window states. (set-title-face! active-up #&optional active-down inactive) Description Set the titlebar faces for the various window states. In the current decor, use active-up as the face for the title bar when active and not pressed in. Use active-down when the title bar is active and pressed in, and inactive when the window is inactive. Both inactive and active-down default to active-up when not specified. Note that active-down will magically reverse the sense of the relief flag, so if your titlebar bar is raised in the active-up state, it will be sunk in the active-down state by default. Implementation Notes Module: Built-in Primitive Defined in src/face.c at line 856 (CVS log) set-title-font! Set the font for window titles In the current decor to FONT. (set-title-font! font) Description Set the font for window titles In the current decor to font. Implementation Notes Module: Built-in Primitive Defined in src/font.c at line 271 (CVS log) set-title-height! Set the height of the titlebar in pixels to HEIGHT. (set-title-height! height) Description Set the height of the titlebar in pixels to height. Applies to the current decor. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 99 (CVS log) set-title-justify! Set the justification for the title to JUST. (set-title-justify! just) Description Set the justification for the title to just. just should be one of 'right, 'left, or 'center. Applies to the current decor. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 51 (CVS log) set-viewport-position! Position the upper left corner of the viewport at coordinates X, Y. (set-viewport-position! x y) Description Position the upper left corner of the viewport at coordinates x, y. x and y are given in pixels. Does not affect the current desk. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 102 (CVS log) set-window-application-menu! Set the application menu for WIN to MENU. (set-window-application-menu! menu #&optional (win (get-window))) Description Set the application menu for WIN to MENU. Implementation Notes Module: (app scwm winops-menu) Defined in scheme/winops-menu.scm at line 29 (CVS log) set-window-background! Set the background color of WIN to BG. (set-window-background! bg #&optional win) Description Set the background color of win to bg. This color is used to draw most of the window decorations, along with the relief colors generated from it, which are used to draw the window's 3-D bevels. win defaults to the window context in the usual way if not specified. See also get-window-colors. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3694 (CVS log) set-window-button! Set the visibility of button number N on window WIN. (set-window-button! n flag #&optional win) Description Set the visibility of button number n on window win. If flag is #t, the button will be visible, otherwise it won't be drawn. win defaults to the window context in the usual way if not specified. (note: the titlebar will not expand if you disable a button via this procedure -- the decoration code is still far from perfect.) Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3782 (CVS log) set-window-colors! Set WIN's background color to BG, foreground color to FG. (set-window-colors! #&optional (bg #f) (fg #f) (win (get-window))) Description Set WIN's background color to BG, foreground color to FG. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 313 (CVS log) set-window-context! Set the current window context to WIN and return the old context. (set-window-context! win) Description Set the current window context to win and return the old context. win can be either a window, or #f, to reset the current window-context. See also with-window and get-window. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1110 (CVS log) set-window-cursor! Set the default cursor for WIN to CURSOR. (set-window-cursor! win cursor) Description Set the default cursor for win to cursor. If cursor is #f, this undefines the cursor for win and makes that window use its parent window's cursor. See get-x-cursor, and create-pixmap-cursor for ways to create cursor objects. Implementation Notes Module: Built-in Primitive Defined in src/cursor.c at line 222 (CVS log) set-window-decor! Set WIN's decor to DECOR, updating its decorations appropriately. (set-window-decor! win decor) Description Set win's decor to decor, updating its decorations appropriately. Implementation Notes Module: Built-in Primitive Defined in src/decor.c at line 273 (CVS log) set-window-focus! Set the focus style of WIN to SYM. (set-window-focus! sym #&optional win) Description Set the focus style of win to sym. sym may be 'click, 'mouse, 'sloppy or 'none. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3450 (CVS log) set-window-foreground! Set the foreground color of WIN to FG. (set-window-foreground! fg #&optional win) Description Set the foreground color of win to fg. This color is used to draw the title text currently. In the future, it may have other uses as well. win defaults to the window context in the usual way if not specified. See also get-window-colors Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3672 (CVS log) set-window-gravity! Sets the gravity for WIN to GRAVITY. (set-window-gravity! gravity #&optional win) Description Sets the gravity for win to gravity. gravity must be one of the following: 'forget, 'northwest, 'north, 'northeast, 'west, 'center, 'east, 'southwest 'south, 'southeast, 'static. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2570 (CVS log) set-window-highlight-background! Set the highlighted background color of WIN to BG. (set-window-highlight-background! bg #&optional win) Description Set the highlighted background color of win to bg. This color is used when win has the focus to draw most of the window decorations, along with the relief colors generated from it, which are used to draw the window's 3-D bevels. win defaults to the window context in the usual way if not specified. If bg is #f, then lets the decor highlight background color be used (turns off a special highlight color for win). See also get-window-highlight-colors. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3747 (CVS log) set-window-highlight-foreground! Set the highlighted foreground color of WIN to FG. (set-window-highlight-foreground! fg #&optional win) Description Set the highlighted foreground color of win to fg. This color is used to draw the title text when win has the focus. In the future, it may have other uses as well. win defaults to the window context in the usual way if not specified. If fg is #f, then lets the decor highlight foreground color be used (turns off a special highlight color for win). See also get-window-highlight-colors. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3723 (CVS log) set-window-highlighted-nonant! Highlight NONANT for WIN. (set-window-highlighted-nonant! nonant #&optional win) Description Highlight nonant for win. nonant is a number between 0 and 8, inclusive, or #f to unhighlight. Also, nonant can be 'left, 'hcenter, 'right, 'top, 'vmiddle, 'bottom to highlight each of those window regions. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3608 (CVS log) set-window-id-background! Set the background color of X11 window with id WINID to BG. (set-window-id-background! bg #&optional winid) Description Set the background color of X11 window with id winid to bg. This is not necessarily persistent. In particular, if you set the background color of a window decoration, that decoration will revert to its usual color. See also window-decoration-ids. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3564 (CVS log) set-window-placement-proc! Set the 'placement-proc property of WIN to PROC. (set-window-placement-proc! proc win) Description Set the 'placement-proc property of WIN to PROC. When the window manager tries to place WIN, it will call PROC to actually set its position. This function must be called before the window is placed (i.e., from before-new-window-hook); see window-style for a way to make sure this function is called at the correct time. Implementation Notes Module: (app scwm style) Defined in scheme/style.scm at line 259 (CVS log) set-window-property! Set window property PROP of WIN to VAL. (set-window-property! win prop val) Description Set window property prop of win to val. prop should be a symbol. val may be any Scheme object. This name/value pair will be associated with the window, and may be retrieved with window-property. Passing #f as the value will delete the property instead. Soon, some properties will have magical meanings, altering particular fields in the window structure. Also, a window-property-change-hook mechanism will soon be implemented for notification of all window property changes. This is not yet done. The window property primitives should be considered in flux. Implementation Notes Module: Built-in Primitive Defined in src/winprop.c at line 84 (CVS log) set-window-title! Change the window title X-Property of WIN to TITLE. (set-window-title! win title) Description Change the window title X-Property of WIN to TITLE. WIN is a Scwm window object, TITLE is a string. This procedure alters the window title by changing the WM_NAME X-Property. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 13 (CVS log) set-window-transient-placement-proc! Like set-window-placement-proc!, but for transient windows. (set-window-transient-placement-proc! proc win) Description Like set-window-placement-proc!, but for transient windows. Implementation Notes Module: (app scwm style) Defined in scheme/style.scm at line 267 (CVS log) set-X-server-synchronize! Set X server sychronization flag to FLAG. (set-X-server-synchronize! flag) Description Set X server sychronization flag to flag. If flag is #t, then Scwm will turn on synchronous X behaviour; if flag is #f, Scwm will turn off synchronous behaviour. Scwm is slower in synchronous mode, but can be easier to debug. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 481 (CVS log) shade-window Cause WIN to become "window-shaded". (shade-window #&optional win) Description Cause win to become "window-shaded". That is, to roll up into just a titlebar. By default, the change takes place instantaneously. win defaults to the window context in the usual way if not specified. See also window-unshade. A shaded window has the "WM_STATE" hint set to WithdrawnState, since the client application window is not visible. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2226 (CVS log) shaded-window? Return #t if WIN is shaded. (shaded-window? #&optional win) Description Return #t if win is shaded. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2304 (CVS log) shadow-factor Return the current shadow factor. (shadow-factor) Description Return the current shadow factor. Implementation Notes Module: Built-in Primitive Defined in src/color.c at line 712 (CVS log) should-circulate-skip? Return #t if WIN should now be skipped when circulating, #f otherwise. (should-circulate-skip? #&optional (win (get-window))) Description Return #t if WIN should now be skipped when circulating, #f otherwise. Uses the current state of WIN (whether it is iconified or not) in determining the result. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 126 (CVS log) shove-window-prefix Display prompt to shove the current window to an edge or center. (shove-window-prefix) Description Display prompt to shove the current window to an edge or center. Implementation Notes Module: (app scwm shove-window) Defined in scheme/shove-window.scm at line 14 (CVS log) show-com Return a lambda to show the stdout generated by the COM shell pipeline. (show-com com) Description Return a lambda to show the stdout generated by the COM shell pipeline. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 120 (CVS log) show-file Return a lambda to display the contents of filename in a window. (show-file filename) Description Return a lambda to display the contents of filename in a window. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 116 (CVS log) show-icon-list-menu Show a window list of only iconfied programs. (show-icon-list-menu) Description Show a window list of only iconfied programs. The selection procedure deiconifies the window and gives it focus. Implementation Notes Module: (app scwm winlist-menu) Defined in scheme/winlist-menu.scm at line 164 (CVS log) show-mesg Return a lambda to display the string arguments STR in a message window. (show-mesg . str) Description Return a lambda to display the string arguments STR in a message window. See also message. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 111 (CVS log) show-netscape-window-list-menu Show a window list of only Netscape windows. (show-netscape-window-list-menu) Description Show a window list of only Netscape windows. The selection procedure deiconifies the window and gives it focus. Implementation Notes Module: Defined in scheme/winlist-menu.scm at line 183 (CVS log) show-selected-nonants Show nonant markers on window when they are selected. (show-selected-nonants) Description Show nonant markers on window when they are selected. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 234 (CVS log) show-side-decorations Display the sidebar decorations for WIN. (show-side-decorations #&optional (win (get-window))) Description Display the sidebar decorations for WIN. See also hide-side-decorations. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 108 (CVS log) show-system-info Display the system-info-string system details in a window. (show-system-info) Description Display the system-info-string system details in a window. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 150 (CVS log) show-titlebar Cause WIN to be decorated with a titlebar. (show-titlebar #&optional win in-place?) Description Cause win to be decorated with a titlebar. Keeps the client window at its current location if in-place? is #t. See also hide-titlebar. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3171 (CVS log) show-titlebar-in-place Turn on display of the titlebar for WIN without moving the client window. (show-titlebar-in-place #&optional (win (get-window))) Description Turn on display of the titlebar for WIN without moving the client window. This may move the frame to keep the application client window area in the same position as before the call. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 94 (CVS log) show-window-list-matching-interactively Prompt for a wildcard, and popup a list of matching windows (by title). (show-window-list-matching-interactively) Description Prompt for a wildcard, and popup a list of matching windows (by title). Stars are added to either end of the entered string so the default is a substring search. Implementation Notes Module: (app scwm flux-gtk) Defined in scheme/flux-gtk.scm at line 40 (CVS log) show-window-list-menu Popup a window list menu. (show-window-list-menu warp-to-index permit-alt-release-selection? #&rest rest) Description Popup a window list menu. Warps the pointer to the WARP-TO-INDEX menu item iff it is an integer. If PERMIT-ALT-RELEASE-SELECTION? is #t, then the release of the Alt/Meta modifier will select the item (this is a bit of a hack to make a nicer task-switching menu). Accepts all keyword arguments that make-window-list-menu takes. Implementation Notes Module: (app scwm winlist-menu) Defined in scheme/winlist-menu.scm at line 133 (CVS log) show-X-properties Displays the X properties of WIN in a message window. (show-X-properties #&optional (win (get-window))) Description Displays the X properties of WIN in a message window. WIN is a window object, an X window id, or 'root-window. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 365 (CVS log) show-xterm-window-list-menu Show a window list of only xterms. (show-xterm-window-list-menu) Description Show a window list of only xterms. The selection procedure deiconifies the window and gives it focus. Implementation Notes Module: (app scwm winlist-menu) Defined in scheme/winlist-menu.scm at line 172 (CVS log) shrink-inactive-windows No documentation supplied. (shrink-inactive-windows delay-seconds) Description No documentation supplied. Implementation Notes Module: (app scwm auto-shrink) Defined in scheme/auto-shrink.scm at line 42 (CVS log) shrink-window Shrink the window WIN to FRAC * its old size. (shrink-window #&key (frac .99) (min-width 30) (min-height 45) (win (get-window))) Description Shrink the window WIN to FRAC * its old size. Never let it get smaller than MIN-WIDTH by MIN-HEIGHT. Implementation Notes Module: (app scwm auto-shrink) Defined in scheme/auto-shrink.scm at line 22 (CVS log) shutdown-options Configure shutdown preferences. (shutdown-options #&key switch-to-home-viewport move-windows-to-current-viewport) Description Configure shutdown preferences. Both SWITCH-TO-HOME-VIEWPORT and MOVE-WINDOWS-TO-CURRENT-VIEWPORT may be be any of #f, #t, 'shutdown-only or 'restart-only. These options indicate when scwm should switch to the (0 0) viewport on shutdown, and whether all windows are moved to to the current viewport on shutdown, respectively. The possible settings mean never, always, only when shutting down or only when restarting, respectively. Any window movement is done after any viewport switching. Implementation Notes Module: (app scwm shutdown-opts) Defined in scheme/shutdown-opts.scm at line 32 (CVS log) simple-prompt-proc-hbox Create and return a procedure-prompting hbox and entry. (simple-prompt-proc-hbox prompt initval) Description Create and return a procedure-prompting hbox and entry. PROMPT is the prompt, and INITVAL is the initial path (a procedure). The returned value is a list: (hbox getter entry). See also prompt-string. Implementation Notes Module: Defined in scheme/prompt-string.scm at line 87 (CVS log) simple-title-style Set the style for titlebars. (simple-title-style #&key font height justify) Description Set the style for titlebars. FONT is a font object or a string, HEIGHT is a number of points, JUSTIFY is a legal argument to set-title-justify! such as 'left, 'right, or 'center. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 439 (CVS log) simplebiff Run a simple xbiff-like notification system. (simplebiff #&key (mail-spool-dir "/var/spool/mail") (username (getenv "USER")) (activate-proc beep) (deactivate-proc noop) (check-interval 10)) Description Run a simple xbiff-like notification system. MAIL-SPOOL-DIR tells where the mail files live, USERNAME is the username of the file to watch (defaults to environement variable "USER". ACTIVATE-PROC is the procedure to apply when the file grows, DEACTIVATE-PROC is the procedure to apply when the file changes without growing (by shrinking or staying the same size). CHECK-INTERVAL is the number of seconds between checks. Returns an object to pass to stop-simplebiff to turn off the notifier. Implementation Notes Module: (app scwm simplebiff) Defined in scheme/simplebiff.scm at line 46 (CVS log) size->string Convert a two-element list to a string. (size->string sz #&optional (sep "x")) Description Convert a two-element list to a string. Use the optional second argument as the separator. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 35 (CVS log) sleep-ms Delay for MS milliseconds. (sleep-ms ms) Description Delay for MS milliseconds. Note that timer-hooks are much more useful in nearly all cases. See add-timer-hook!. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 69 (CVS log) SM-error-message Return a string, describing why session management is not available. (SM-error-message) Description Return a string, describing why session management is not available. Only valid, if SM-register returned #f. Implementation Notes Module: Built-in Primitive Defined in src/session-manager.c at line 477 (CVS log) SM-register Register Scwm with the session manager, and return the client id. (SM-register) Description Register Scwm with the session manager, and return the client id. The return value is either an id string, or #f if the session manager could not be initialized - SM-error-message can be used to get more information in this case. If Scwm is already registered, this function just returns the client id. Implementation Notes Module: Built-in Primitive Defined in src/session-manager.c at line 487 (CVS log) smart-place-window Places WIN using fvwm2's SmartPlacement algorithm. (smart-place-window win #&optional no-move x-sugg y-sugg) Description Places win using fvwm2's SmartPlacement algorithm. The placement is just as if SmartPlacementIsReallySmart were not in effect. That is, it tries to place the window so that it does not overlap any other. If it fails to do so, it returns #f; otherwise it returns #t. If no-move is #t, then the position is returned instead of actually moving the window to that position. This can be useful for finding a new location for an existing window. x-sugg and y-sugg are suggested coordinates that clever-place-window may try to use as a preferred location for win. Implementation Notes Module: Built-in Primitive Defined in src/placement.c at line 444 (CVS log) snap-initialize Turn on auto-snapping during interactive moves. (snap-initialize #&optional (sw 25)) Description Turn on auto-snapping during interactive moves. Implementation Notes Module: Defined in scheme/snap.scm at line 179 (CVS log) snap-reset Turn off auto-snapping during interactive moves. (snap-reset) Description Turn off auto-snapping during interactive moves. Implementation Notes Module: (app scwm snap) Defined in scheme/snap.scm at line 170 (CVS log) sort Returned LS sorted according to COMPARE (defaults to ascending numerical order). (sort ls #&optional (compare <)) Description Returned LS sorted according to COMPARE (defaults to ascending numerical order). Implementation Notes Module: Defined in scheme/sort.scm at line 41 (CVS log) sort-options-by-type No documentation supplied. (sort-options-by-type symlist) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 301 (CVS log) sort-windows-by-middle-pos Sort WINLIST (a list of windows) by their middle positioins. (sort-windows-by-middle-pos winlist #&key (horiz #t) (ascending #t)) Description Sort WINLIST (a list of windows) by their middle positioins. Sort on horizontal position (x coordinate) if HORIZ is #t, otherwise sort on vertical position (y coordiate) otherwise. Sort in ascending order if ASCENDING is #t, otherwise descending. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 304 (CVS log) sorted-by-car-string Sort the elements of list L based on the string value of their car. (sorted-by-car-string l) Description Sort the elements of list L based on the string value of their car. Implementation Notes Module: (app scwm menus-extras) Defined in scheme/menus-extras.scm at line 38 (CVS log) sound-load Load sound from FILE, tagging it with NAME. (sound-load file #&optional name) Description Load sound from file, tagging it with name. If name is not given, "scwm" is used. Returns a sound object usable with the other sound functions. Implementation Notes Module: Primitive from (app scwm esdsound) Defined in modules/esdsound/sound.c at line 34 (CVS log) sound-play Play SOUND. (sound-play sound) Description Play sound. sound must be an object returned by sound-load. Implementation Notes Module: Primitive from (app scwm esdsound) Defined in modules/esdsound/sound.c at line 91 (CVS log) sound-unload Unload SOUND, freeing any resources it occupies. (sound-unload sound) Description Unload sound, freeing any resources it occupies. sound must be an object returned by sound-load. Implementation Notes Module: Primitive from (app scwm esdsound) Defined in modules/esdsound/sound.c at line 70 (CVS log) split-list-by-group Split the a-list LS into groups according to the car of each of its cells. (split-list-by-group ls #&optional (rest #f)) Description Split the a-list LS into groups according to the car of each of its cells. Implementation Notes Module: (app scwm menus-extras) Defined in scheme/menus-extras.scm at line 68 (CVS log) standard-place-window Do an ordinary placement of a window. (standard-place-window win) Description Do an ordinary placement of a window. First try smart-place-window, then clever-place-window, then random-place-window, and finally interactive-place-window. Implementation Notes Module: Defined in scheme/minimal.scm at line 203 (CVS log) start-animating-scwm-resolves Turn on animating windows to new positions following re-solves. (start-animating-scwm-resolves) Description Turn on animating windows to new positions following re-solves. Implementation Notes Module: (app scwm constraint-animation) Defined in scheme/constraint-animation.scm at line 20 (CVS log) start-constraint-investigator Start the GTk+-based constraint investigator window. (start-constraint-investigator) Description Start the GTk+-based constraint investigator window. Implementation Notes Module: Defined in scheme/constraint-investigator.scm at line 208 (CVS log) start-constraints Start using the constraint solver. (start-constraints #&key (draw-constraints-with-focus #f) (draw-disabled-constraints #t)) Description Start using the constraint solver. DRAW-CONSTRAINTS-WITH-FOCUS is used to specify whether you'd like all constraints drawn or just the ones which are associated with the current focus window. Implementation Notes Module: (app scwm constraints) Defined in scheme/constraints.scm at line 33 (CVS log) start-handling-gtk-events No documentation supplied. (start-handling-gtk-events) Description No documentation supplied. Implementation Notes Module: (app scwm gtk) Defined in scheme/gtk.scm at line 57 (CVS log) start-highlighting-current-window Add appropriate hook procedures to make the window with the mouse be highlighted. (start-highlighting-current-window #&optional (win (window-context))) Description Add appropriate hook procedures to make the window with the mouse be highlighted. See also end-highlighting-current-window. Implementation Notes Module: (app scwm highlight-current-window) Defined in scheme/highlight-current-window.scm at line 51 (CVS log) start-highlighting-selected-window Highlight the current window during window selections. (start-highlighting-selected-window) Description Highlight the current window during window selections. Implementation Notes Module: (app scwm highlight-current-window) Defined in scheme/highlight-current-window.scm at line 39 (CVS log) start-program-in-xterm Return a string to be the arguments to xterm for starting PROGRAM in it. (start-program-in-xterm program title resource-name) Description Return a string to be the arguments to xterm for starting PROGRAM in it. TITLE is the desired title, and RESOURCE-NAME is the desired Xrdb resource property. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 166 (CVS log) start-property-respond Turn on property-change responses. (start-property-respond) Description Turn on property-change responses. See property-changed-respond and X-PropertyNotify-hook. Implementation Notes Module: (app scwm property-respond) Defined in scheme/property-respond.scm at line 99 (CVS log) start-ui-constraints-buttons No documentation supplied. (start-ui-constraints-buttons) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-buttons) Defined in scheme/ui-constraints-buttons.scm at line 193 (CVS log) start-xterm Start an xterm using `*xterm-command*' and `*xterm-user-shell-options*'. (start-xterm #&optional (opt (optget *xterm-user-shell-options*))) Description Start an xterm using `*xterm-command*' and `*xterm-user-shell-options*'. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 654 (CVS log) stick-icon Cause WIN's icon to become "sticky". (stick-icon #&optional win) Description Cause win's icon to become "sticky". A sticky window stays at its current viewport position no matter how where the viewport is in the virtual desktop. See stick-window. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3348 (CVS log) stick-window Make WIN "sticky" so that it stays stationary in the viewport. (stick-window #&optional win) Description Make win "sticky" so that it stays stationary in the viewport. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2123 (CVS log) sticky-window? Return #t if WIN is "sticky", #f otherwise. (sticky-window? #&optional win) Description Return #t if win is "sticky", #f otherwise. See stick-window for an explanation. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2191 (CVS log) stop-animating-scwm-resolves Turn off animating windows to new positions following re-solves. (stop-animating-scwm-resolves) Description Turn off animating windows to new positions following re-solves. Implementation Notes Module: Defined in scheme/constraint-animation.scm at line 24 (CVS log) stop-flashing-window Turn off window flashing of WIN. (stop-flashing-window #&optional (win (get-window))) Description Turn off window flashing of WIN. Has no effect if WIN is not flashing. N.B. flashing and highlight-selection of windows currently use the same mechanism, so turning off flashing will also visually un-select WIN. Implementation Notes Module: (app scwm flash-window) Defined in scheme/flash-window.scm at line 71 (CVS log) stop-property-respond Turn off property-change responses. (stop-property-respond) Description Turn off property-change responses. See property-changed-respond and X-PropertyNotify-hook. Implementation Notes Module: Defined in scheme/property-respond.scm at line 104 (CVS log) stop-simplebiff Call this with the object returned from simplebiff to turn off the notifier (stop-simplebiff sb) Description Call this with the object returned from simplebiff to turn off the notifier Implementation Notes Module: Defined in scheme/simplebiff.scm at line 86 (CVS log) string->proplist Return a proplist object containing STRING. (string->proplist string) Description Return a proplist object containing string. This is often unnecessary as the proplist procedures will permit Guile strings to be used anywhere a string proplist object is expected. Implementation Notes Module: Primitive from (app scwm proplist) Defined in modules/proplist/scwmproplist.c at line 406 (CVS log) string->scwm-module Return the module corresponding to the given string. (string->scwm-module module-name) Description Return the module corresponding to the given string. Format may be any of "base", "app scwm base", or "(app scwm base)". Implementation Notes Module: Defined in scheme/session.scm at line 18 (CVS log) string->X-atom Returns an X atom representing STRING. (string->X-atom string) Description Returns an X atom representing string. If string contains NULL-characters, the behaviour is undefined. Implementation Notes Module: Built-in Primitive Defined in src/xproperty.c at line 384 (CVS log) string-ci-has-prefix Return #t iff STRING starts with PREFIX ignoring case. (string-ci-has-prefix string prefix) Description Return #t iff STRING starts with PREFIX ignoring case. Implementation Notes Module: Defined in scheme/stringops.scm at line 113 (CVS log) string-has-prefix Return #t iff STRING starts with PREFIX. (string-has-prefix string prefix) Description Return #t iff STRING starts with PREFIX. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 109 (CVS log) string-join Concatenates the list STRINGS into a single string. (string-join delimit strings) Description Concatenates the list STRINGS into a single string. DELIMIT is put between every two elements of STRINGS. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 79 (CVS log) string-with-colons->path-list Convert S, a colon-separated directory pathlist, into a list of directory strings. (string-with-colons->path-list s) Description Convert S, a colon-separated directory pathlist, into a list of directory strings. Returns that list. Implementation Notes Module: (app scwm file) Defined in scheme/file.scm at line 86 (CVS log) style-one-window No documentation supplied. (style-one-window win . args) Description No documentation supplied. Implementation Notes Module: (app scwm style) Defined in scheme/style.scm at line 42 (CVS log) style-option:cumulative? No documentation supplied. (style-option:cumulative? window-style-options key) Description No documentation supplied. Implementation Notes Module: Defined in scheme/style-options.scm at line 87 (CVS log) style-option:handler No documentation supplied. (style-option:handler key) Description No documentation supplied. Implementation Notes Module: (app scwm style-options) Defined in scheme/style-options.scm at line 83 (CVS log) style-option:type No documentation supplied. (style-option:type key) Description No documentation supplied. Implementation Notes Module: (app scwm style-options) Defined in scheme/style-options.scm at line 85 (CVS log) support-image-conversion Set things up to try to load arbitrary images. (support-image-conversion) Description Set things up to try to load arbitrary images. Works by setting try-everything-loader as the image loader for unknown extensions. Generally not needed with ImLib. Implementation Notes Module: Defined in scheme/image-loaders.scm at line 55 (CVS log) switch-to-first-desk Switch to the first desktop. (switch-to-first-desk) Description Switch to the first desktop. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 198 (CVS log) switch-to-second-desk Switch to the second desktop. (switch-to-second-desk) Description Switch to the second desktop. Implementation Notes Module: Defined in scheme/virtual.scm at line 203 (CVS log) system-info-string Return a string with various system information. (system-info-string) Description Return a string with various system information. Use show-system-info to display it in a window. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 60 (CVS log) take-screenshot Take a snapshot of the whole screen. (take-screenshot #&optional (template (string-append (user-home) "/screenshot%y%m%d%H%M%S.xwd"))) Description Take a snapshot of the whole screen. The screenshot will be saved in xwd format in the filename constructed from TEMPLATE. %-escapes in TEMPLATE will be replaced by time-elements, according to strftime rules. TEMPLATE defaults to the file "screenshot%y%m%d%H%M%S.xwd" in the user's home directory. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 308 (CVS log) theme-names No documentation supplied. (theme-names) Description No documentation supplied. Implementation Notes Module: Defined in scheme/themes.scm at line 189 (CVS log) theme:background-style No documentation supplied. (theme:background-style theme) Description No documentation supplied. Implementation Notes Module: Defined in scheme/theme-impl.scm at line 73 (CVS log) theme:name No documentation supplied. (theme:name theme) Description No documentation supplied. Implementation Notes Module: (app scwm theme-impl) Defined in scheme/theme-impl.scm at line 67 (CVS log) theme:window-style No documentation supplied. (theme:window-style theme) Description No documentation supplied. Implementation Notes Module: (app scwm theme-impl) Defined in scheme/theme-impl.scm at line 70 (CVS log) there-exists? Return true if PRED is true for at least one elements of L, otherwise false. (there-exists? l pred) Description Return true if PRED is true for at least one elements of L, otherwise false. Implementation Notes Module: (app scwm listops) Defined in scheme/listops.scm at line 95 (CVS log) tile Tile the windows on the specified desk. (tile #&key (only ()) (except ()) (by-stacking #f) (by-focus #f) (reverse #f) (all-viewports #f) (desk (current-desk)) (ignore-default-exceptions #f) (start-pos '(0 0)) (end-pos (display-size)) (resize 'always) (raise 'restack-only) (max-windows #f) (order 'horizontal)) Description Tile the windows on the specified desk. The DESK option, defaulting to the current desk, specifies which desk; ALL-VIEWPORTS, when true indicates that the windows in all viewports of this desk should be tiled, otherwise only the current viewport is tiled. The options ONLY, EXCEPT, BY-STACKING, BY-FOCUS and REVERSE indicate the windows to use and the order to use them in, as with list-windows. However, unless IGNORE-DEFAULT-EXCEPTIONS is #t, transient, maximized, sticky and iconified windows will be always be excluded. START-POS, END-POS, RESIZE, RAISE, MAX-WINDOWS and ORDER control the tiling options as for tile-windows. Implementation Notes Module: (app scwm tile) Defined in scheme/tile.scm at line 127 (CVS log) tile-windows Tile WINDOWS according to several parameters. (tile-windows windows #&key (start-pos '(0 0)) (end-pos (display-size)) (resize 'always) (raise 'restack-only) (max-windows #f) (order 'horizontal)) Description Tile WINDOWS according to several parameters. Tiling places the windows according to a grid from START-POS, (0 0) by default, to END-POS, the size of the display by default. If MAX-WINDOWS is specified and not #f, at most MAX-WINDOWS elements of WINDOWS will be operated on. If ORDER is 'horizontal, the windows will be tiled in row-major order; if it is 'vertical they will be tiled in column-major oder. RESIZE may be #f, 'shrink-only or 'always, indicating that the windows should never be resized, that they should be resized to the max-size only if they are bigger, or that they should always be resized to the max size. The default is 'shrink-only. RAISE may be #f, #t, or 'restack-only, indicating that the windows should not be moved in the stacking order; that they should be raised on top of other windows and placed in the tile order with the upper left window lowest in the stacking order; or that they should be restacked as for #t but not raised above other windows, respectively. The default is 'restack-only. Implementation Notes Module: (app scwm tile) Defined in scheme/tile.scm at line 37 (CVS log) tile-windows-interactively Tile a set of selected windows either vertically or horizontally. (tile-windows-interactively #&optional (order 'vertical)) Description Tile a set of selected windows either vertically or horizontally. ORDER can be either 'horizontal or 'vertical. The windows used are selected either by selected-windows-list or select-window-group. If selected-windows-list is empty, then select-window-group is used. See also the undo module and insert-undo-global to save the window configuration before executing this in case the effect is not what you expected. Implementation Notes Module: Defined in scheme/tile.scm at line 169 (CVS log) time-t->seconds-ago Return the number of seconds that have passed since TIMET was the current time. (time-t->seconds-ago timet) Description Return the number of seconds that have passed since TIMET was the current time. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 166 (CVS log) title-font Return the font used for drawing window titles in the current decor. (title-font) Description Return the font used for drawing window titles in the current decor. Implementation Notes Module: Built-in Primitive Defined in src/font.c at line 293 (CVS log) title-height Return the height of the titlebar in pixels, as set by set-title-height!. (title-height) Description Return the height of the titlebar in pixels, as set by set-title-height!. Applies to the current decor. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 126 (CVS log) title-justify Return the current justification for the title, as set by set-title-justify!. (title-justify) Description Return the current justification for the title, as set by set-title-justify!. The return value will be one of 'right, 'left, or 'center. Applies to the current decor. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 77 (CVS log) title-match?? Return a predicate that tests a window's title. (title-match?? STRING TYPE CASE-SENSITIVE?) Description Return a predicate that tests a window's title. When applied to a window, this predicate will return true if the title matches STRING in the manner specified by the optional argument TYPE, which may be 'exact, 'regexp, or 'wildcard. The optional CASE-SENSITIVE argument determines whether the matching is case-sensitive or not. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 303 (CVS log) title-style Set the title style in the current decor. (title-style #&key font height justify (active-up '()) (active-down '()) (inactive '()) #&allow-other-keys #&rest rest) Description Set the title style in the current decor. FONT is the window title font, a font object or a string. HEIGHT is the height of the title bar, in points. JUSTIFY is one of 'left, 'right, or 'center. This function also takes the keyword arguments #:relief, #:solid, #:gradient, #:h-gradient, #:v-gradient, and #:pixmap, with effects as described under the `Face Flags' and `Face Specification Flags' concepts (except that #:pixmap is always tiled, and #:h-gradient and #:v-gradient are horizontal and vertical gradients). These extra keyword arguments can either be included in the main argument list, or lists of these arguments can be used as the ACTIVE-UP, ACTIVE-DOWN, or INACTIVE arguments. For instance: (title-style #:solid "red" #:inactive (list #:solid "green")) would set the title to be red in either active state, and green in the inactive state, leaving FONT, HEIGHT, and JUSTIFY in their current state, and returning everything else about the title to their default state. Implementation Notes Module: (app scwm face) Defined in scheme/face.scm at line 37 (CVS log) titlebar-shown? Return #t if WIN is decorated with a titlebar, #f otherwise. (titlebar-shown? #&optional win) Description Return #t if win is decorated with a titlebar, #f otherwise. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3225 (CVS log) to-string Dump all arguments into a string. (to-string . rest) Description Dump all arguments into a string. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 75 (CVS log) toggle-docs-for No documentation supplied. (toggle-docs-for var) Description No documentation supplied. Implementation Notes Module: (app scwm preferences) Defined in scheme/preferences.scm at line 85 (CVS log) toggle-easyraise-windows (toggle-easyraise-windows) Description Implementation Notes Module: Defined in scheme/easyraise.scm at line 50 (CVS log) toggle-focus Focus window that had the focus before the current one. (toggle-focus) Description Focus window that had the focus before the current one. Implementation Notes Module: Defined in scheme/winops.scm at line 480 (CVS log) toggle-maximize Maximize to width NW, height NH if not maximized, or unmaximize. (toggle-maximize nw nh #&optional (win (get-window))) Description Maximize to width NW, height NH if not maximized, or unmaximize. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 185 (CVS log) toggle-maximize-both Toggle the WIN's maximization (both vertically and horizontally). (toggle-maximize-both #&optional (win (get-window))) Description Toggle the WIN's maximization (both vertically and horizontally). Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 422 (CVS log) toggle-maximize-horizontal Toggle the WIN's maximized-horizontally state. (toggle-maximize-horizontal #&optional (win (get-window))) Description Toggle the WIN's maximized-horizontally state. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 417 (CVS log) toggle-maximize-vertical Toggle the current window's maximized-vertically state. (toggle-maximize-vertical #&optional (win (get-window))) Description Toggle the current window's maximized-vertically state. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 412 (CVS log) toggle-maximize-vertical-part Toggle the WIN's maximization-vertically to 95% of the screen height. (toggle-maximize-vertical-part #&optional (win (get-window))) Description Toggle the WIN's maximization-vertically to 95% of the screen height. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 427 (CVS log) transient? Return #t if WIN is transient, #f if not. (transient? #&optional win) Description Return #t if win is transient, #f if not. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2014 (CVS log) try-everything-loader Tries to load an arbitrary image, using any available loader. (try-everything-loader fname) Description Tries to load an arbitrary image, using any available loader. Implementation Notes Module: (app scwm image-loaders) Defined in scheme/image-loaders.scm at line 49 (CVS log) turn-off-only-focus-window-has-titlebar Do not display titlebars on only the focuessed window. (turn-off-only-focus-window-has-titlebar) Description Do not display titlebars on only the focuessed window. This forces titlebars on all other windows (ignoring window-style commands). Implementation Notes Module: (app scwm focus-titlebar) Defined in scheme/focus-titlebar.scm at line 38 (CVS log) turn-on-only-focus-window-has-titlebar Start displaying a titlebar only on the focussed window. (turn-on-only-focus-window-has-titlebar) Description Start displaying a titlebar only on the focussed window. This forces titlebars off all other windows (ignoring window-style commands). Implementation Notes Module: (app scwm focus-titlebar) Defined in scheme/focus-titlebar.scm at line 30 (CVS log) two-window-or-more-nonant-prompter No documentation supplied. (two-window-or-more-nonant-prompter name #&key (p1 "first window") (p2 "second window") (orientation #f)) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-classes) Defined in scheme/ui-constraints-classes.scm at line 146 (CVS log) two-window-or-more-prompter No documentation supplied. (two-window-or-more-prompter name p1 p2) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-classes) Defined in scheme/ui-constraints-classes.scm at line 120 (CVS log) two-window-prompter No documentation supplied. (two-window-prompter name p1 p2) Description No documentation supplied. Implementation Notes Module: (app scwm ui-constraints-classes) Defined in scheme/ui-constraints-classes.scm at line 102 (CVS log) ui-constraint-add-enable-hook Adds a HOOK proc which will be called when UI-CONSTRAINT enable state changes. (ui-constraint-add-enable-hook ui-constraint hook) Description Adds a HOOK proc which will be called when UI-CONSTRAINT enable state changes. HOOK should take one argument which is the new state of the UI-CONSTRAINT. Errors if UI-CONSTRAINT is not a ui-constraint object. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 720 (CVS log) ui-constraint-button Returns the a reference to panel representing the UI-CONSTRAINT in the toggle menu. (ui-constraint-button ui-constraint) Description Returns the a reference to panel representing the UI-CONSTRAINT in the toggle menu. Returns #f if the gtk toggle menu feature is not in use. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 447 (CVS log) ui-constraint-class Returns the UI-CONSTRAINT-CLASS from the ui-constraint object UI-CONSTRAINT. (ui-constraint-class ui-constraint) Description Returns the UI-CONSTRAINT-CLASS from the ui-constraint object UI-CONSTRAINT. errors if UI-CONSTRAINT is not an ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 412 (CVS log) ui-constraint-class-creator Return a list that contains a code snippet can create CLASS. (ui-constraint-class-creator class) Description Return a list that contains a code snippet can create CLASS. The resulting list can then be evaluated to create that constraint class. Be sure to (use-scwm-modules ui-constraints-classes ui-constraints-composition) before evaling the list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 106 (CVS log) ui-constraint-class-ctr Returns the constructor for instance of the constraint class. (ui-constraint-class-ctr ui-constraint-class) Description Returns the constructor for instance of the constraint class. errors if UI-CONSTRAINT-CLASS is not a ui-constraint-class. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 214 (CVS log) ui-constraint-class-description Returns the description for the constraint class. (ui-constraint-class-description ui-constraint-class) Description Returns the description for the constraint class. Erors if UI-CONSTRAINT-CLASS is not a ui-constraint-class. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 188 (CVS log) ui-constraint-class-draw-proc returns the drawing procedure for instances of the constraint class. (ui-constraint-class-draw-proc ui-constraint-class) Description returns the drawing procedure for instances of the constraint class. errors if UI-CONSTRAINT-CLASS is not a ui-constraint-class Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 240 (CVS log) ui-constraint-class-menuname-proc Return the proc for determining the name for the constraint in (ui-constraint-class-menuname-proc ui-constraint-class) Description Return the proc for determining the name for the constraint in the toggle menu. Errors if object is not a ui-constraint-class object. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 278 (CVS log) ui-constraint-class-name Returns the name of the constraint class. (ui-constraint-class-name ui-constraint-class) Description Returns the name of the constraint class. Errors if UI-CONSTRAINT-CLASS is not a ui-constraint-class. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 180 (CVS log) ui-constraint-class-num-windows Returns the number of windows constrainable by instances of the constraint (ui-constraint-class-num-windows ui-constraint-class) Description Returns the number of windows constrainable by instances of the constraint class. errors if UI-CONSTRAINT-CLASS is not a ui-constraint-class. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 201 (CVS log) ui-constraint-class-pixmap-name Return the pixmap-name of UI-CONSTRAINT-CLASS. (ui-constraint-class-pixmap-name ui-constraint-class) Description Return the pixmap-name of UI-CONSTRAINT-CLASS. Errors if object is not a ui-constraint-class object. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 262 (CVS log) ui-constraint-class-pixmap2-name Return the pixmap2-name of UI-CONSTRAINT-CLASS. (ui-constraint-class-pixmap2-name ui-constraint-class) Description Return the pixmap2-name of UI-CONSTRAINT-CLASS. Errors if object is not a ui-constraint-class object. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 269 (CVS log) ui-constraint-class-satisfied-proc Returns the satisfaction checking procedure for instances of the (ui-constraint-class-satisfied-proc ui-constraint-class) Description Returns the satisfaction checking procedure for instances of the constraint class. errors if UI-CONSTRAINT-CLASS is not a ui-constraint-class Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 253 (CVS log) ui-constraint-class-ui-ctr Returns the UI constructor for instances of the constraint class. (ui-constraint-class-ui-ctr ui-constraint-class) Description Returns the UI constructor for instances of the constraint class. errors if UI-CONSTRAINT-CLASS is not a ui-constraint-class Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 227 (CVS log) ui-constraint-class? Returns a boolean: true if UI-CONSTRAINT-CLASS is a vector and starts with the (ui-constraint-class? ui-constraint-class) Description Returns a boolean: true if UI-CONSTRAINT-CLASS is a vector and starts with the correct obid. False otherwise. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 152 (CVS log) ui-constraint-cn Returns the CN list from the ui-constraint object UI-CONSTRAINT. (ui-constraint-cn ui-constraint) Description Returns the CN list from the ui-constraint object UI-CONSTRAINT. errors if UI-CONSTRAINT is not a ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 387 (CVS log) ui-constraint-enable-hooks Returns a list of the enable-hook functions added to the UI-CONSTRAINT. (ui-constraint-enable-hooks ui-constraint) Description Returns a list of the enable-hook functions added to the UI-CONSTRAINT. Errors if UI-CONSTRAINT is not a ui-constraint object. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 737 (CVS log) ui-constraint-enabled? Returns the ENABLE from the ui-constraint object UI-CONSTRAINT. (ui-constraint-enabled? ui-constraint) Description Returns the ENABLE from the ui-constraint object UI-CONSTRAINT. errors if UI-CONSTRAINT is not an ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 400 (CVS log) ui-constraint-opts Returns the list of optional data that may be added by the constraint class. (ui-constraint-opts ui-constraint) Description Returns the list of optional data that may be added by the constraint class. Returns #f if no such data exists. errors if UI-CONSTRAINT is not a ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 437 (CVS log) ui-constraint-remove-enable-hook Removes a HOOK proc from the list in UI-CONSTRAINT. (ui-constraint-remove-enable-hook ui-constraint hook) Description Removes a HOOK proc from the list in UI-CONSTRAINT. Errors if UI-CONSTRAINT is not a ui-constraint object. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 729 (CVS log) ui-constraint-set-button! Sets the reference to the gtk button for this instance in the toggle menu. (ui-constraint-set-button! ui-constraint button) Description Sets the reference to the gtk button for this instance in the toggle menu. Errors if UI-CONSTRAINT is not a ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 457 (CVS log) ui-constraint-windows Returns the LIST-OF-WINDOWS from the ui-constraint object UI-CONSTRAINT. (ui-constraint-windows ui-constraint) Description Returns the LIST-OF-WINDOWS from the ui-constraint object UI-CONSTRAINT. errors if UI-CONSTRAINT is not an ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 425 (CVS log) ui-constraint? Returns #t if UI-CONSTRAINT is a ui-constraint. (ui-constraint? ui-constraint) Description Returns #t if UI-CONSTRAINT is a ui-constraint. returns #f otherwise. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 376 (CVS log) ui-constraints-composition-begin Begin recording the constraints used for the creation of a composition. (ui-constraints-composition-begin) Description Begin recording the constraints used for the creation of a composition. End this recording by calling 'ui-constraints-composition-end'. Implementation Notes Module: (app scwm ui-constraints-composition) Defined in scheme/ui-constraints-composition.scm at line 47 (CVS log) ui-constraints-composition-end End the recording of a constraint composition. (ui-constraints-composition-end #&optional (cancel? #f)) Description End the recording of a constraint composition. NAME is the name to be given to the new composition. Optionally, CANCEL may be specified to cancel the construction of a composition. Implementation Notes Module: (app scwm ui-constraints-composition) Defined in scheme/ui-constraints-composition.scm at line 87 (CVS log) ui-constraints-involving-two-windows Returns the list of ui-constraint objects that involve WIN1 and WIN2. (ui-constraints-involving-two-windows win1 win2) Description Returns the list of ui-constraint objects that involve WIN1 and WIN2. The entire global-constraint-instance-list is checked. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 565 (CVS log) ui-constraints-involving-window Returns the list of ui-constraint objects that involve WIN. (ui-constraints-involving-window win) Description Returns the list of ui-constraint objects that involve WIN. The entire global-constraint-instance-list is checked. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 555 (CVS log) ui-constraints-toggle-menu Return a menu of constraints that permits toggling their enabled? state. (ui-constraints-toggle-menu) Description Return a menu of constraints that permits toggling their enabled? state. Implementation Notes Module: (app scwm ui-constraints-toggle-menu) Defined in scheme/ui-constraints-toggle-menu.scm at line 30 (CVS log) un-keep-on-top Remove the on-top property from WIN, if it has it. (un-keep-on-top #&optional win) Description Remove the on-top property from win, if it has it. See keep-on-top. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3088 (CVS log) unbind-four-modifier-key-events Unbind events attached to a multi-modifier key event. (unbind-four-modifier-key-events modkey1 modkey2 modkey3 modkey4 #&optional ignore1 ignore2 ) Description Unbind events attached to a multi-modifier key event. MODKEY1, MODKEY2, MODKEY3, MODKEY4 are the four modifiers that are having the binding eliminated for. IGNORE1 and IGNORE2 can be anything, and are provided to conveniently allow an unbinding invocation to have the same arguments as the analagous binding operation. Implementation Notes Module: (app scwm modifier-key-bindings) Defined in scheme/modifier-key-bindings.scm at line 117 (CVS log) unbind-key Remove any bindings attached to KEY in given CONTEXTS. (unbind-key contexts key #&optional ignored-proc1 ignored-proc2) Description Remove any bindings attached to key in given contexts. contexts is a list of event-contexts (e.g., '(left-button-1 frame-sides)) key is a string giving the key-specifier (e.g., M-Delete for Meta+Delete). The return value is #t if the binding was removed successfully, #f otherwise. ignored-proc1 and ignored-proc2 can both be given, but are ignored; they permit the identical arguments to be used as for bind-mouse. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 928 (CVS log) unbind-keycode Unbind the given KEYCODE within the CONTEXTS. (unbind-keycode contexts keycode modifier-mask #&optional ignored-proc1 ignored-proc2) Description Unbind the given keycode within the contexts. keycode is an X/11 key code, modifier-mask is the bitmask of modifiers. ignored-proc1 and ignored-proc2 can both be given, but are ignored; they permit the identical arguments to be used as for bind-keycode. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1136 (CVS log) unbind-mouse Remove any bindings attached to mouse BUTTON in given CONTEXTS. (unbind-mouse contexts button #&optional ignored-proc1 ignored-proc2) Description Remove any bindings attached to mouse button in given contexts. contexts is a list of event-contexts (e.g., '(left-button-1 frame-sides)) button is a string or integer giving the mouse button number. ignored-proc1 and ignored-proc2 can both be given, but are ignored; they permit the identical arguments to be used as for bind-mouse. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1001 (CVS log) unbind-three-modifier-key-events Unbind events attached to a multi-modifier key event. (unbind-three-modifier-key-events modkey1 modkey2 modkey3 #&optional ignore1 ignore2) Description Unbind events attached to a multi-modifier key event. MODKEY1, MODKEY2, MODKEY3 are the three modifiers that are having the binding eliminated for. IGNORE1 and IGNORE2 can be anything, and are provided to conveniently allow an unbinding invocation to have the same arguments as the analagous binding operation. Implementation Notes Module: (app scwm modifier-key-bindings) Defined in scheme/modifier-key-bindings.scm at line 71 (CVS log) unbind-two-modifier-key-events Unbind events attached to a multi-modifier key event. (unbind-two-modifier-key-events modkey1 modkey2) Description Unbind events attached to a multi-modifier key event. Implementation Notes Module: (app scwm modifier-key-bindings) Defined in scheme/modifier-key-bindings.scm at line 33 (CVS log) undo Undo the last operation that was undoable. (undo) Description Undo the last operation that was undoable. Undoable operations save changed state using insert-undo-global before they perform their action. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 96 (CVS log) undo-all-passive-grabs Remove all passive grabs of keys and buttons of bindings. (undo-all-passive-grabs) Description Remove all passive grabs of keys and buttons of bindings. See redo-all-passive-grabs for re-establishing those bindings. This procedure can be useful for quoting numerous keystrokes or mouse events. Beware that it can take several seconds to execute. This procedure considers the state of ignore-dubious-modifiers? Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1564 (CVS log) undo-passive-grab Remove the passive grabs of KEYCODE-OR-BUTNUM with MODMASK on all windows. (undo-passive-grab modmask keycode-or-butnum #&optional mouse?) Description Remove the passive grabs of keycode-or-butnum with modmask on all windows. If mouse? is #t, then treat keycode-or-butnum as a button number and remove a grabe of a mouse binding. Otherwise remove a keyboard passive grab. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1595 (CVS log) undo-state-at-index Return the state from undo-list at INDEX, or #f if bad index. (undo-state-at-index index) Description Return the state from undo-list at INDEX, or #f if bad index. Implementation Notes Module: (app scwm undo) Defined in scheme/undo.scm at line 88 (CVS log) undo-use Apply the state from the undo-list contained at INDEX. (undo-use index) Description Apply the state from the undo-list contained at INDEX. Implementation Notes Module: Defined in scheme/undo.scm at line 124 (CVS log) undraw-all-constraints Undraw all constraints in the global instance list. (undraw-all-constraints #&key (draw-disabled #t)) Description Undraw all constraints in the global instance list. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 658 (CVS log) undraw-constraint Undraw the UI-CONSTRAINT. (undraw-constraint ui-constraint) Description Undraw the UI-CONSTRAINT. error if UI-CONSTRAINT is not an ui-constraint. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 615 (CVS log) undraw-constraints-of-window Undraw all constraints associated with WIN. (undraw-constraints-of-window win #&key (draw-disabled #t)) Description Undraw all constraints associated with WIN. If WIN is not specified, the user is prompted to select a window. Implementation Notes Module: (app scwm ui-constraints) Defined in scheme/ui-constraints.scm at line 643 (CVS log) unflash-window Revert WIN's titlebar and boundary color to state before a flash-window. (unflash-window #&optional (win (get-window))) Description Revert WIN's titlebar and boundary color to state before a flash-window. Return the window changed. Implementation Notes Module: (app scwm flash-window) Defined in scheme/flash-window.scm at line 56 (CVS log) unfocus Remove the input focus from any window that may have it. (unfocus) Description Remove the input focus from any window that may have it. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1832 (CVS log) uninstall-hover-focus Remove the hover-focus procedures from the Scwm hooks. (uninstall-hover-focus) Description Remove the hover-focus procedures from the Scwm hooks. This will turn off hover focus for any windows that it was on for. Implementation Notes Module: Defined in scheme/hover-focus.scm at line 140 (CVS log) uninstall-visibility-reporter Uninstall procedures that print debugging messages on window visibility change events. (uninstall-visibility-reporter) Description Uninstall procedures that print debugging messages on window visibility change events. Implementation Notes Module: Defined in scheme/visibility-reporter.scm at line 17 (CVS log) unmaximize Unmaximize WIN so it returns to its size/position before maximization. (unmaximize #&optional (win (get-window))) Description Unmaximize WIN so it returns to its size/position before maximization. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 170 (CVS log) unregister-image-loader Unregister the loader, if any, for images ending in EXTENSION. (unregister-image-loader extension) Description Unregister the loader, if any, for images ending in extension. extension must be a string beginning with a period, the empty string (for files with no extension), or the string "default" (for files that no other image loader succeeds in loading). Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 428 (CVS log) unselect-all-windows Unselect all windows selected via select-window-add. (unselect-all-windows) Description Unselect all windows selected via select-window-add. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 110 (CVS log) unselect-matching-windows Unselect windows for which predicate PROC returns #t. (unselect-matching-windows proc) Description Unselect windows for which predicate PROC returns #t. PROC might be one of resource-match??, class-match??, etc. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 99 (CVS log) unset-message-window-position! Move the message window back to the default screen-center position. (unset-message-window-position!) Description Move the message window back to the default screen-center position. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 725 (CVS log) unshade-window Reverse the effect of shade-window on WIN. (unshade-window #&optional win) Description Reverse the effect of shade-window on win. The change takes place instantaneously. win defaults to the window context in the usual way if not specified. A shaded window has the "WM_STATE" hint set to WithdrawnState, since the client application window is not visible. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2269 (CVS log) unstick-icon Cause WIN's icon to no longer be "sticky". (unstick-icon #&optional win) Description Cause win's icon to no longer be "sticky". A sticky window stays at its current viewport position no matter how where the viewport is in the virtual desktop. See stick-icon and stick-window. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3368 (CVS log) unstick-window Cause a window to no longer be "sticky", if it is. (unstick-window #&optional win) Description Cause a window to no longer be "sticky", if it is. See stick-window for an explanation. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2157 (CVS log) uri-escapify-comma Replace commas in URI with the %2C escape code. (uri-escapify-comma uri) Description Replace commas in URI with the %2C escape code. This is useful since netscape's remote command invocation does a stupid syntactic scan of the passed url and treats commas as argument command separators, so the url gets chopped off at the first literal comma. Implementation Notes Module: (app scwm netscape) Defined in scheme/netscape.scm at line 93 (CVS log) use-change-desk-commands Execute one of the VECTOR-OF-COMMANDS shell commands when the desk changes. (use-change-desk-commands vector-of-commands) Description Execute one of the VECTOR-OF-COMMANDS shell commands when the desk changes. The 0th element of the vector is used for changes to desk 0, the first element for changes to desk 1, etc. Changes to desks which are "off the end" of the vector do nothing. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 280 (CVS log) use-gtk-error-window-for-scwm No documentation supplied. (use-gtk-error-window-for-scwm #&optional (on #t)) Description No documentation supplied. Implementation Notes Module: (app scwm gtk) Defined in scheme/gtk.scm at line 90 (CVS log) use-placement-hint Do nothing when placing WIN, just let it be where hinted to be. (use-placement-hint win) Description Do nothing when placing WIN, just let it be where hinted to be. This is useful for, e.g., external programs such as the GNOME desktop gmc which expect their windows to go where asked (like the desktop icons in gmc). Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 402 (CVS log) use-theme Use settings from THEME to set up the window manager. (use-theme theme #&key (for-windows #t) (for-menus #t) (for-icons #t) (for-background #t) (for-global-settings #t)) Description Use settings from THEME to set up the window manager. THEME can be either a theme object (as returned by load-theme) or a string naming a theme, in which case that theme will be loaded and used. By default, window styles, menus, icons, backgrounds, and global settings are all affected; if the FOR-WINDOWS, FOR-MENUS, FOR-ICONS, FOR-BACKGROUND, or FOR-GLOBAL-SETTINGS arguments are #f, the corresponding areas are not affected. (Note: at this time, only windows and backgrounds are affected; the other components of themes have yet to be implemented.) Implementation Notes Module: (app scwm themes) Defined in scheme/themes.scm at line 56 (CVS log) user-home Return the current user's home directory. (user-home) Description Return the current user's home directory. This is set to one of the following (in order of relevance): $HOME, the directory field of the current uid's entry in the password file, the constant string "/tmp". Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 601 (CVS log) user-name Return the current user's name. (user-name) Description Return the current user's name. This is set to one of the following (in order of relevance): $USER, $LOGNAME, the name field of the current uid's entry in the password file, the constant string "nobody". Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 588 (CVS log) viewport->virtual Return the virtual coordinates for viewport X,Y. (viewport->virtual x y) Description Return the virtual coordinates for viewport X,Y. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 191 (CVS log) viewport-center-x Return the x coordinate of the center of the current viewport. (viewport-center-x) Description Return the x coordinate of the center of the current viewport. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 183 (CVS log) viewport-center-y Return the y coordinate of the center of the current viewport. (viewport-center-y) Description Return the y coordinate of the center of the current viewport. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 187 (CVS log) viewport-position Returns the current position of the viewport in pixels. (viewport-position) Description Returns the current position of the viewport in pixels. The returned value is a list of the x and y positions. Implementation Notes Module: Built-in Primitive Defined in src/deskpage.c at line 117 (CVS log) viewport-x-position Return the x coordinate of the current viewport. (viewport-x-position) Description Return the x coordinate of the current viewport. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 175 (CVS log) viewport-y-position Return the y coordinate of the current viewport. (viewport-y-position) Description Return the y coordinate of the current viewport. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 179 (CVS log) virtual->viewport Return the viewport coordinates for virtual X,Y. (virtual->viewport x y) Description Return the viewport coordinates for virtual X,Y. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 195 (CVS log) virtual-size Return the size of the virtual screen in pixels. (virtual-size) Description Return the size of the virtual screen in pixels. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 227 (CVS log) virtual-switch-placement Wrap placement procedure PROC with virtual switching code. (virtual-switch-placement proc #&key (switch #t) (return #f)) Description Wrap placement procedure PROC with virtual switching code. PROC is a procedure that takes a single window argument. The return value is also a procedure of one one window argument which has the same effect, except that it may switch to the desk and viewport of the passed window before executing PROC, and may return to the previous desk and viewport, depending on the values of SWITCH and RETURN respectively. Implementation Notes Module: (app scwm placement) Defined in scheme/placement.scm at line 207 (CVS log) visible? Return #t if any of WIN is currently potentially visible, else #f. (visible? #&optional (win (get-window))) Description Return #t if any of WIN is currently potentially visible, else #f. Note that this just checks if WIN is in the current viewport and on the current desk. It may still return #t if WIN is completely obscured by other windows. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 117 (CVS log) vpx->vx Convert from a viewport to a virtual X coordinate. (vpx->vx x) Description Convert from a viewport to a virtual X coordinate. If X is #f, just return #f. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 199 (CVS log) vpy->vy Convert from a viewport to a virtual Y coordinate. (vpy->vy y) Description Convert from a viewport to a virtual Y coordinate. If Y is #f, just return #f. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 206 (CVS log) vv-close Close connect to the ViaVoice speech recognizer. (vv-close) Description Close connect to the ViaVoice speech recognizer. Implementation Notes Module: Primitive from (app scwm viavoice) Defined in modules/viavoice/scwmviavoice.c at line 561 (CVS log) vv-connect Connect to the ViaVoice speech recognizer, calling PROC after connected. (vv-connect #&optional proc) Description Connect to the ViaVoice speech recognizer, calling proc after connected. See modules/viavoice/README for details. See also vv-initialize. Implementation Notes Module: Primitive from (app scwm viavoice) Defined in modules/viavoice/scwmviavoice.c at line 535 (CVS log) vv-connected? Return #t if we are connected to the ViaVoice speech recognizer. (vv-connected?) Description Return #t if we are connected to the ViaVoice speech recognizer. Returns #f if we are not connected. Implementation Notes Module: Primitive from (app scwm viavoice) Defined in modules/viavoice/scwmviavoice.c at line 573 (CVS log) vv-define-grammar Use GRAMMAR-FILE as the ViaVoice grammar and give it name NAME. (vv-define-grammar name grammar-file #&optional proc) Description Use grammar-file as the ViaVoice grammar and give it name name. Returns #f if not connected, otherwise returns the return code from DoSimpleGrammar. proc is invoked with the response code when the asynchronous procedure completes. Implementation Notes Module: Primitive from (app scwm viavoice) Defined in modules/viavoice/scwmviavoice.c at line 584 (CVS log) vv-disconnect Disconnect from the ViaVoice speech recognizer, calling PROC after disconnected. (vv-disconnect #&optional proc) Description Disconnect from the ViaVoice speech recognizer, calling proc after disconnected. Implementation Notes Module: Primitive from (app scwm viavoice) Defined in modules/viavoice/scwmviavoice.c at line 549 (CVS log) vv-enable-vocab Enable vocabulary/grammar NAME. (vv-enable-vocab name #&optional proc) Description Enable vocabulary/grammar name. proc is invoked with the response code when the asynchronous procedure completes. Implementation Notes Module: Primitive from (app scwm viavoice) Defined in modules/viavoice/scwmviavoice.c at line 613 (CVS log) vv-initialize Use this to start ViaVoice recognition. (vv-initialize) Description Use this to start ViaVoice recognition. Implementation Notes Module: (app scwm viavoice) Defined in scheme/viavoice.scm at line 104 (CVS log) vv-initialize-environment No documentation supplied. (vv-initialize-environment) Description No documentation supplied. Implementation Notes Module: (app scwm viavoice) Defined in scheme/viavoice.scm at line 47 (CVS log) vv-recognition-actions No documentation supplied. (vv-recognition-actions accepted? command annotations) Description No documentation supplied. Implementation Notes Module: (app scwm viavoice) Defined in scheme/viavoice.scm at line 112 (CVS log) vv-recognition-debug No documentation supplied. (vv-recognition-debug accepted? word annotation) Description No documentation supplied. Implementation Notes Module: (app scwm viavoice) Defined in scheme/viavoice.scm at line 173 (CVS log) vv-setup-recognition-hook No documentation supplied. (vv-setup-recognition-hook) Description No documentation supplied. Implementation Notes Module: (app scwm viavoice) Defined in scheme/viavoice.scm at line 84 (CVS log) vv-smrc->error No documentation supplied. (vv-smrc->error value) Description No documentation supplied. Implementation Notes Module: (app scwm viavoice) Defined in scheme/viavoice.scm at line 43 (CVS log) vv-terminate Use this to terminate ViaVoice recognition. (vv-terminate) Description Use this to terminate ViaVoice recognition. This will release /dev/dsp for other uses. Use vv-initialize to restart (when /dev/dsp is no longer in use by another process. Implementation Notes Module: (app scwm viavoice) Defined in scheme/viavoice.scm at line 89 (CVS log) vv-turn-microphone-off Turn the microphone off to stop recognizing commands. (vv-turn-microphone-off #&optional proc) Description Turn the microphone off to stop recognizing commands. proc is invoked with the response code when the asynchronous procedure completes. Implementation Notes Module: Primitive from (app scwm viavoice) Defined in modules/viavoice/scwmviavoice.c at line 646 (CVS log) vv-turn-microphone-on Turn the microphone on to start recognizing commands. (vv-turn-microphone-on #&optional proc) Description Turn the microphone on to start recognizing commands. See also vv-initialize. proc is invoked with the response code when the asynchronous procedure completes. Implementation Notes Module: Primitive from (app scwm viavoice) Defined in modules/viavoice/scwmviavoice.c at line 629 (CVS log) vv-use-grammar No documentation supplied. (vv-use-grammar #&optional (name "scwmgrammar") (file (string-append (scwm-path-prefix) "/share/scwm/ViaVoice/scwmgrammar.fsg"))) Description No documentation supplied. Implementation Notes Module: (app scwm viavoice) Defined in scheme/viavoice.scm at line 66 (CVS log) vx- Return the virtual coordinate X pixels left of the right virtual edge. (vx- x) Description Return the virtual coordinate X pixels left of the right virtual edge. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 231 (CVS log) vx->vpx Convert from a virtual to a viewport X coordinate. (vx->vpx x) Description Convert from a virtual to a viewport X coordinate. If X is #f, just return #f. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 213 (CVS log) vy- Return the virtual coordinate Y pixels up from the bottom virtual edge. (vy- y) Description Return the virtual coordinate Y pixels up from the bottom virtual edge. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 235 (CVS log) vy->vpy Convert from a virtual to a viewport Y coordinate. (vy->vpy y) Description Convert from a virtual to a viewport Y coordinate. If Y is #f, just return #f. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 220 (CVS log) w%x Return a pixel width X percent of the width of window W. (w%x x #&optional (w (get-window))) Description Return a pixel width X percent of the width of window W. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 247 (CVS log) w%y Return a pixel height Y percent of the height of window W. (w%y y #&optional (w (get-window))) Description Return a pixel height Y percent of the height of window W. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 251 (CVS log) warp-placement Return a list, (%x %y), for the desired pointer placement for WIN. (warp-placement win) Description Return a list, (%x %y), for the desired pointer placement for WIN. The percentages are of the window size, and are gotten by using the 'warp-placement object-property of WIN; they default to (20 20) if no such property is set. To change the default for all your windows you can do something like: (add-hook! after-new-window-hook (lambda (win) (set-object-property! win 'warp-placement '(80 20)))) Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 464 (CVS log) warp-to-window Move the mouse pointer to the upper left corner of WIN. (warp-to-window #&optional win x-offset y-offset) Description Move the mouse pointer to the upper left corner of win. x-offset, y-offset are pixel offsets from the top left corner; they each default to 2 pixels. If win is on a different desk or in a different viewport, these will be changed appropriately so that the window is visible. Note that the target window is not raised, so if the target window's upper left corner is under another window, that other window may end up with the keyboard focus. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1843 (CVS log) warp-to-window-viewport Change to the desk and viewport of WIN. (warp-to-window-viewport win) Description Change to the desk and viewport of WIN. The viewport selected is an integral multiple of the viewport size which contains the center of the window, or the closest possible if none does. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 159 (CVS log) where-is Show bindings that invoke PROC. (where-is #&optional (proc #f)) Description Show bindings that invoke PROC. Pops up a procedure selection window if PROC is omitted or #f. PROC can be the procedure object, a symbol, or a string; see interpret-as-procedure. Implementation Notes Module: Defined in scheme/where-is.scm at line 25 (CVS log) wiggle-window Animatedly window shade and then unshade WIN. (wiggle-window #&optional (win (get-window))) Description Animatedly window shade and then unshade WIN. Just a toy--- perhaps could be useful to call attention to a window. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 54 (CVS log) wildcard->regexp Return the regular expresision string corresponding to WILDCARD. (wildcard->regexp wildcard) Description Return the regular expresision string corresponding to WILDCARD. This involves quoting meta characters and replacing the wildcard meta-characters "*" with ".*" and "?" with ".". Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 179 (CVS log) wildcard-match? Returns #t if WILDCARD matches WIN (in the sense of wildcard-matcher). (wildcard-match? wildcard #&optional (win (get-window)) #&key (full-regexp #f) (regexp-options `(,regexp/icase))) Description Returns #t if WILDCARD matches WIN (in the sense of wildcard-matcher). See wildcard-matcher for the meanings of FULL-REGEXP and REGEXP-OPTIONS. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 229 (CVS log) wildcard-matcher Return a procedure that matches WILDCARD against a window. (wildcard-matcher wildcard #&key (full-regexp #f) (regexp-options `(,regexp/icase))) Description Return a procedure that matches WILDCARD against a window. REGEXP-OPTIONS is passed to make-regexp. If FULL-REGEXP is #t, the WILDCARD is considered to be a regular-expression instead of a shell-like wildcard. The returned procedure takes a window and returns #t if WILDCARD matches the title, class, or resource of the window. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 202 (CVS log) window->image Return an image with the contents of window WIN. (window->image win #&optional x-offset y-offset width height) Description Return an image with the contents of window win. win can be a window id (as a long), a window object, or the symbol 'root-window. Captures the rectangle of the window at x-offset, y-offset with width width and height height. Implementation Notes Module: Built-in Primitive Defined in src/image.c at line 650 (CVS log) window-aligned-viewport Return the viewport that contains the center of WIN. (window-aligned-viewport win) Description Return the viewport that contains the center of WIN. The return value is an integral multiple of the viewport size which contains the center of the window, or the closest possible if none does. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 60 (CVS log) window-and-offsets->nonant Return a nonant number in [0,8] from a window position and an offset. (window-and-offsets->nonant win dx dy) Description Return a nonant number in [0,8] from a window position and an offset. WIN is the window, DX and DY are positions relative to the top-left of WIN. Implementation Notes Module: (app scwm nonants) Defined in scheme/nonants.scm at line 171 (CVS log) window-application-menu Return the application menu for WIN, or #f if there is none. (window-application-menu win) Description Return the application menu for WIN, or #f if there is none. Implementation Notes Module: (app scwm winops-menu) Defined in scheme/winops-menu.scm at line 25 (CVS log) window-background-color No documentation supplied. (window-background-color #&optional (win (get-window))) Description No documentation supplied. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 408 (CVS log) window-center-bottom Return a pair (X . (window-center-bottom win) Description Return a pair (X . Y) that is the pixel position of the center, bottom of WIN relative to the current viewport. Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 38 (CVS log) window-center-middle Return pair (viewport-x . (window-center-middle win) Description Return pair (viewport-x . viewport-y) that is the middle of WIN. Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 18 (CVS log) window-center-position Return the virtual coordinates of the center of WIN as a list of the X and Y coordinate. (window-center-position win) Description Return the virtual coordinates of the center of WIN as a list of the X and Y coordinate. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 144 (CVS log) window-center-top Return a pair (X . (window-center-top win) Description Return a pair (X . Y) that is the pixel position of the center, top of WIN relative to current viewport. Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 28 (CVS log) window-class Return the window resources class of WIN. (window-class #&optional (win (get-window))) Description Return the window resources class of WIN. WIN defaults to the window context in the usual way if not specified. Returns "NoClass" if the window has not set its class. See also window-class-hint. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 857 (CVS log) window-class-hint DEPRECATED. (window-class-hint #&optional win) Description DEPRECATED. Return the window resource class of win. win defaults to the window context in the usual way if not specified. You should prefer window-class. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2877 (CVS log) window-client-machine-name Return the name of the client machine on which WIN is running. (window-client-machine-name #&optional (win (get-window))) Description Return the name of the client machine on which WIN is running. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 195 (CVS log) window-configuration Return a list containing the state of WIN. (window-configuration #&optional (win (get-window))) Description Return a list containing the state of WIN. Implementation Notes Module: (app scwm window-configuration) Defined in scheme/window-configuration.scm at line 32 (CVS log) window-configuration->xform-to-it Create a transformation element for going from the current state to CFG. (window-configuration->xform-to-it cfg) Description Create a transformation element for going from the current state to CFG. CFG should be a window configuration object. See also animate-windows. Implementation Notes Module: (app scwm window-configuration) Defined in scheme/window-configuration.scm at line 76 (CVS log) window-configuration-to-register Save the configuration of WIN to REGISTER. (window-configuration-to-register #&optional (win (or (window-with-focus) (get-window))) (register (get-register-name "Window-configuration-to-"))) Description Save the configuration of WIN to REGISTER. Implementation Notes Module: (app scwm register) Defined in scheme/register.scm at line 72 (CVS log) window-configuration? Return #t if WCFG is a window configuration. (window-configuration? wcfg) Description Return #t if WCFG is a window configuration. Implementation Notes Module: (app scwm window-configuration) Defined in scheme/window-configuration.scm at line 43 (CVS log) window-context Returns the current window context, or #f if there is none. (window-context) Description Returns the current window context, or #f if there is none. See also with-window and set-window-context! Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1126 (CVS log) window-corners Return the four coordinates of the corners of the location of WIN. (window-corners win) Description Return the four coordinates of the corners of the location of WIN. Return value's car is the top left, cdr is the bottom right. That is, the returned list is: ((nw-x nw-y) se-x se-y). Use rect-nw-x, rect-nw-y, rect-se-x, rect-se-y to take apart the returned list. Implementation Notes Module: (app scwm rectangle) Defined in scheme/rectangle.scm at line 12 (CVS log) window-creation-time Return the time that WIN was created in seconds since 1/1/70. (window-creation-time #&optional win) Description Return the time that win was created in seconds since 1/1/70. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2929 (CVS log) window-decor Return WIN's decor. (window-decor win) Description Return win's decor. Implementation Notes Module: Built-in Primitive Defined in src/decor.c at line 302 (CVS log) window-decoration-ids Returns a list of long integer window ids of the decoration windows for WIN. (window-decoration-ids #&optional win) Description Returns a list of long integer window ids of the decoration windows for win. Returned list is ( frame title_w (side-n side-e side-s side-w) (corner-nw corner-ne corner-se corner-sw) ). Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3537 (CVS log) window-decoration-size Return (decor-width decor-height) for WIN. (window-decoration-size win) Description Return (decor-width decor-height) for win. These are the extra width/height (in pixels) of the frame beyond that of the client window width/height. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2361 (CVS log) window-deletable? Return #t if WIN is able to be deleted, #f otherwise. (window-deletable? #&optional win) Description Return #t if win is able to be deleted, #f otherwise. If this procedure returns #f, then a call to delete-window on win will do nothing. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1799 (CVS log) window-desk Return the desk that WIN is currently on. (window-desk #&optional win) Description Return the desk that win is currently on. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2842 (CVS log) window-flashing? Return #t iff WIN is currently flashing, #f otherwise. (window-flashing? #&optional (win (get-window))) Description Return #t iff WIN is currently flashing, #f otherwise. Implementation Notes Module: (app scwm flash-window) Defined in scheme/flash-window.scm at line 52 (CVS log) window-focus-style Get the focus style of WIN. (window-focus-style #&optional win) Description Get the focus style of win. Returns one of 'mouse, 'click, 'sloppy, or 'none. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3483 (CVS log) window-frame-area Return the area of WIN's frame in square pixels. (window-frame-area win) Description Return the area of WIN's frame in square pixels. Implementation Notes Module: (app scwm winops) Defined in scheme/winops.scm at line 213 (CVS log) window-frame-border-width Return the width of WIN's frame's border. (window-frame-border-width #&optional win) Description Return the width of win's frame's border. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2745 (CVS log) window-frame-id Return the X window id for the outermost frame window of WIN. (window-frame-id #&optional win) Description Return the X window id for the outermost frame window of win. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2775 (CVS log) window-frame-size Return the size of the frame of WIN. (window-frame-size #&optional win) Description Return the size of the frame of win. The position is returned as a list of the width and the height in pixels. win defaults to the window context in the usual way if not specified. See window-size if you want the size of the application (client) window. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2657 (CVS log) window-fully-constructed? Returns #t if WIN is a fully-constructed window, otherwise #f. (window-fully-constructed? win) Description Returns #t if win is a fully-constructed window, otherwise #f. In the before-new-window-hook windows are not yet fully constructed, and only a subset of procedures can be successfully called on them. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 950 (CVS log) window-geometry-string Return a string corresponding to the geometry specifications for WIN. (window-geometry-string #&optional (win (get-window))) Description Return a string corresponding to the geometry specifications for WIN. The virtual position and the frame size are used. The resulting string looks like "157x133+200+306". If WIN is iconified, the string returned is in parentheses. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 151 (CVS log) window-gravity Return the gravity for WIN as a symbol. (window-gravity #&optional win) Description Return the gravity for win as a symbol. Return value is one of the following: 'forget, 'northwest, 'north, 'northeast, 'west, 'center, 'east, 'southwest 'south, 'southeast, 'static. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2551 (CVS log) window-highlighted-nonant Returnt the highlighted nonant for WIN, or #f if none highlighted. (window-highlighted-nonant #&optional win) Description Returnt the highlighted nonant for win, or #f if none highlighted. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3634 (CVS log) window-icon Get the icon image being used for WIN. (window-icon #&optional win) Description Get the icon image being used for win. Returns #f if none is being used. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 3961 (CVS log) window-icon-shaped? Return #t if WIN has shaped icon, #f otherwise. (window-icon-shaped? win) Description Return #t if win has shaped icon, #f otherwise. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4030 (CVS log) window-icon-title Return the icon window title of WIN. (window-icon-title #&optional win) Description Return the icon window title of win. This is the title as requested by the application. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2865 (CVS log) window-id Return the X window id for WIN. (window-id #&optional win) Description Return the X window id for win. This is the X id for the actual application window. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2759 (CVS log) window-info Display information about WIN in a message window. (window-info #&optional (win (get-window))) Description Display information about WIN in a message window. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 124 (CVS log) window-is-selected? Return #t if W is in the selected window list, else #f. (window-is-selected? #&optional (w (get-window))) Description Return #t if W is in the selected window list, else #f. See also select-window-add, select-window-remove, and selected-windows-list. Implementation Notes Module: (app scwm window-selection) Defined in scheme/window-selection.scm at line 40 (CVS log) window-last-focus-time Return the time that WIN was last focussed in seconds since 1/1/70. (window-last-focus-time #&optional win) Description Return the time that win was last focussed in seconds since 1/1/70. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2906 (CVS log) window-last-focus-time-string Return a string corresponding to the last focus time for WIN. (window-last-focus-time-string #&optional (win (get-window))) Description Return a string corresponding to the last focus time for WIN. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 170 (CVS log) window-last-focus-x-time Return the X11 time that WIN was last focussed. (window-last-focus-x-time #&optional win) Description Return the X11 time that win was last focussed. These are not reliable to compare over long times since they wrap too frequenly. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2916 (CVS log) window-left-bottom Return a pair (X . (window-left-bottom win) Description Return a pair (X . Y) that is the pixel position of the left, bottom of WIN relative to the current viewport. Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 76 (CVS log) window-left-middle Return a pair (X . (window-left-middle win) Description Return a pair (X . Y) that is the pixel position of the left, middle of WIN relative to the current viewport. Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 49 (CVS log) window-left-top Return a pair (X . (window-left-top win) Description Return a pair (X . Y) that is the pixel position of the left, top of WIN relative to the current viewport. Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 70 (CVS log) window-map-pending? Returns #t if the mapping of WIN is pending, otherwise returns #f. (window-map-pending? win) Description Returns #t if the mapping of win is pending, otherwise returns #f. The map is pending from the moment the MapRequest is entered until the map is actually performed. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 974 (CVS log) window-mapped? Returns #t if WIN is mapped, otherwise returns #f. (window-mapped? win) Description Returns #t if win is mapped, otherwise returns #f. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 963 (CVS log) window-mini-icon Get the mini-icon image being used for WIN. (window-mini-icon #&optional win) Description Get the mini-icon image being used for win. Returns #f if none is being used. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4003 (CVS log) window-other-id Returns the other id string given to the process that created WIN. (window-other-id win) Description Returns the other id string given to the process that created WIN. Requires using the LD_PRELOAD environment variable for the started process: SCWM_OTHER_ID="answer" LD_PRELOAD=/path/to/scwm_set_pid_property.so Returns #f if the property does not exist on WIN (most likely because you did not use the LD_PRELOAD variable and the SCWM_OTHER_ID environment variable). See also window-client-machine-name to get the machine name, and window-pid to get the process id. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 114 (CVS log) window-overlaps-window? Return a function that takes WIN2 and returns #t if it overlaps WIN. ((window-overlaps-window? #&optional (win (get-window))) #&optional (win2 (get-window))) Description Return a function that takes WIN2 and returns #t if it overlaps WIN. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 98 (CVS log) window-pid Returns the process id of the process that created WIN. (window-pid win) Description Returns the process id of the process that created WIN. Requires using the LD_PRELOAD environment variable for the started process: LD_PRELOAD=/path/to/scwm_set_pid_property.so Returns #f if the property does not exist on WIN (most likely because you did not use the LD_PRELOAD variable). See also window-client-machine-name to get the machine name on which the returned process id is valid, and window-other-id to get the string in environment variable SCWM_OTHER_ID. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 96 (CVS log) window-position Return the position of WIN in pixels. (window-position #&optional win) Description Return the position of win in pixels. The position is returned as a list of the x coordinate and the y coordinate in pixels. If the window is sticky, the position will always be in the 0,0 viewport. win defaults to the window context in the usual way if not specified. See also window-viewport-position. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2594 (CVS log) window-position-in-viewport Return a virtual position for WIN that is in viewport (XX,YY). (window-position-in-viewport xx yy #&optional win) Description Return a virtual position for WIN that is in viewport (XX,YY). The (0,0) viewport is the starting viewport. XX and YY are full display-size increments (e.g., (1,0) is the viewport just to the right of the home (0,0) viewport). This returns the position that move-window-to-viewport moves the window to. Implementation Notes Module: (app scwm virtual) Defined in scheme/virtual.scm at line 82 (CVS log) window-property Retrieve window property PROP of WIN. (window-property win prop) Description Retrieve window property prop of win. prop should be a symbol. #f will be returned if the property does not exist (whether set by set-window-property! or otherwise). Soon, some properties will have magical meanings, accessing particular fields in the window structure. Also, a window-property-change-hook mechanism will soon be implemented for notification of all window property changes. This is not yet done. The window property primitives should be considered in flux. Implementation Notes Module: Built-in Primitive Defined in src/winprop.c at line 127 (CVS log) window-resource Return the window resource instance of WIN. (window-resource #&optional (win (get-window))) Description Return the window resource instance of WIN. WIN defaults to the window context in the usual way if not specified. Returns "NoResource" if the window has not set its resource name. See also window-resource-hint. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 865 (CVS log) window-resource-hint DEPRECATED. (window-resource-hint #&optional win) Description DEPRECATED. Return the window resource instance of win. win defaults to the window context in the usual way if not specified. You should prefer window-resource. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2890 (CVS log) window-right-bottom Return a pair (X . (window-right-bottom win) Description Return a pair (X . Y) that is the pixel position of the right, bottom of WIN relative to the current viewport. Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 96 (CVS log) window-right-middle Return a pair (X . (window-right-middle win) Description Return a pair (X . Y) that is the pixel position of the right, middle of WIN relative to the current viewport. Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 59 (CVS log) window-right-top Return a pair (X . (window-right-top win) Description Return a pair (X . Y) that is the pixel position of the right, top of WIN relative to the current viewport. Implementation Notes Module: (app scwm window-locations) Defined in scheme/window-locations.scm at line 86 (CVS log) window-segment No documentation supplied. (window-segment segment win) Description No documentation supplied. Implementation Notes Module: (app scwm smart-push) Defined in scheme/smart-push2.scm at line 34 (CVS log) window-shaped? Return #t if WIN is a shaped window, #f otherwise. (window-shaped? #&optional win) Description Return #t if win is a shaped window, #f otherwise. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 4017 (CVS log) window-size Return the size of the application window of WIN. (window-size #&optional win) Description Return the size of the application window of win. win defaults to the window context in the usual way if not specified. The position is returned as a list of four numbers. The first two are the width and the height in pixels, the third and fourth are the width and height in resize units (e.g., characters for an xterm). See window-frame-size if you want the size of the frame window. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2699 (CVS log) window-size-hints Return a list of the window size hints associated with WIN. (window-size-hints win) Description Return a list of the window size hints associated with win. The list returned contains 4 cons pairs containing: '((min-width . max-width) (min-height . max-height) (width-inc . height-inc) (base-width . base-height)) Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2444 (CVS log) window-state->string Returns a string representation of the numerical WIN-STATE. (window-state->string win-state) Description Returns a string representation of the numerical WIN-STATE. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 46 (CVS log) window-style Specify various properties for windows matching CONDITION. (window-style condition . args) Description Specify various properties for windows matching CONDITION. See the `Face Specification Flags' and `Window Style' sections for details. CONDITION can be a string in which case default-style-condition-handler is used, or it can be a list of two elements in which case the first is the X class name to match and the second is the X resource name to match (both must match). CONDITION can also be an arbitrary predicate that takes a window and returns #t iff that window is to be considered a match. Implementation Notes Module: (app scwm style) Defined in scheme/style.scm at line 46 (CVS log) window-task-switcher-menu Popup a task-switcher window list. (window-task-switcher-menu #&optional (last? #f) #&rest rest) Description Popup a task-switcher window list. Start out on the window that last had the focus. Implementation Notes Module: (app scwm task-switcher) Defined in scheme/task-switcher.scm at line 10 (CVS log) window-task-switcher-menu-backwards Popup a task-switcher window list. (window-task-switcher-menu-backwards . rest) Description Popup a task-switcher window list. Start out on the window that had the focus longest ago. Implementation Notes Module: Defined in scheme/task-switcher.scm at line 24 (CVS log) window-title Return the window title of WIN, as requested by the application. (window-title #&optional win) Description Return the window title of win, as requested by the application. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2854 (CVS log) window-title-height Return WIN's titlebar's height. (window-title-height #&optional (win (get-window))) Description Return WIN's titlebar's height. See also window-title-size, window-title-width. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 359 (CVS log) window-title-size Return a list with the width and height of WIN's titlebar. (window-title-size #&optional win) Description Return a list with the width and height of win's titlebar. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2730 (CVS log) window-title-width Return WIN's titlebar's width. (window-title-width #&optional (win (get-window))) Description Return WIN's titlebar's width. See also window-title-size, window-title-height. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 364 (CVS log) window-transient-for Return the window for which WIN is transient. (window-transient-for #&optional win) Description Return the window for which win is transient. If win is transient, and the window it is transient for is not the root window and is being managed by scwm, this returns the window object of the window that win is transient for, otherwise return #f. win defaults to the window context in the usual way if not specified. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2029 (CVS log) window-unstyle Remove STYLE definition from list of window styles. (window-unstyle . style) Description Remove STYLE definition from list of window styles. STYLE must be given exactly the same way as on invocation of window-style. Implementation Notes Module: (app scwm style) Defined in scheme/style.scm at line 60 (CVS log) window-valid? Returns #t if OBJ is window object and is still valid, otherwise returns #f. (window-valid? obj) Description Returns #t if obj is window object and is still valid, otherwise returns #f. A window is no longer valid when it is destroyed or closed. An iconified window that can be deiconified is still represented by a valid window object. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 939 (CVS log) window-viewport-position Return the position of WIN in pixels within the viewport. (window-viewport-position #&optional (win (get-window))) Description Return the position of WIN in pixels within the viewport. The position is returned as a list of the x coordinate and the y coordinate in pixels. WIN defaults to the window context in the usual way if not specified. See also window-position. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 369 (CVS log) window-viewport-position-of Return a list (X Y) that is the viewport position of the SYM part of WIN. (window-viewport-position-of sym win) Description Return a list (X Y) that is the viewport position of the SYM part of WIN. SYM is one of northwest north northeast west center east southwest south southeast. Implementation Notes Module: Defined in scheme/window-locations.scm at line 108 (CVS log) window-virtual-position Return the virtual position of WIN in pixels. (window-virtual-position #&optional (win (get-window))) Description Return the virtual position of WIN in pixels. If WIN is sticky, this returns the position of the window in the current viewport. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 378 (CVS log) window-visibility Return the visibility state for WIN. (window-visibility #&optional win) Description Return the visibility state for win. Returns either 'partially-obscured, 'fully-obscured, or 'unobscured. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 2939 (CVS log) window-visible-frame-size Return the visible frame size of WIN. (window-visible-frame-size win) Description Return the visible frame size of WIN. This is just the window-frame-size unless WIN is shaded in which case the height is just the titlebar height. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 873 (CVS log) window-with-focus Return the window that currently has the input focus. (window-with-focus) Description Return the window that currently has the input focus. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1140 (CVS log) window-with-pointer Return the window that currently contains the mouse pointer. (window-with-pointer) Description Return the window that currently contains the mouse pointer. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 1150 (CVS log) window? Returns #t if OBJ is a window object, otherwise returns #f. (window? obj) Description Returns #t if obj is a window object, otherwise returns #f. Implementation Notes Module: Built-in Primitive Defined in src/window.c at line 930 (CVS log) windows-overlap? Return #t if WIN and WIN2 overlap at all, else #f. (windows-overlap? win win2) Description Return #t if WIN and WIN2 overlap at all, else #f. I.e., returns #t if the intersection of the windows' areas is non-empty. If either WIN or WIN2 is iconified this will definitely return #f. Also will return #f if WIN and WIN2 are bound to the same window. Implementation Notes Module: (app scwm wininfo) Defined in scheme/wininfo.scm at line 83 (CVS log) winlist-hit Permit WIN to be displayed in the window list by default. (winlist-hit #&optional (win (get-window))) Description Permit WIN to be displayed in the window list by default. This resets the 'winlist-skip property of WIN. See also winlist-skip. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 74 (CVS log) winlist-skip Do not show WIN in the window list by default. (winlist-skip #&optional (win (get-window))) Description Do not show WIN in the window list by default. This sets the 'winlist-skip property of WIN. See also winlist-hit. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 79 (CVS log) winlist-skip? Return #t if WIN is skipped in the window list, #f otherwise. (winlist-skip? #&optional (win (get-window))) Description Return #t if WIN is skipped in the window list, #f otherwise. Implementation Notes Module: (app scwm winlist) Defined in scheme/winlist.scm at line 84 (CVS log) with-frozen-root-window Execute THUNK with a frozen root window. (with-frozen-root-window thunk) Description Execute THUNK with a frozen root window. Creates an image containing the root window, and displays that image in a message window covering the entire screen. Executes THUNK, then removes the message window. Implementation Notes Module: Defined in scheme/message-window.scm at line 298 (CVS log) write-all Write all arguments into the port. (write-all port . lst) Description Write all arguments into the port. #t means current-output-port. Implementation Notes Module: (app scwm stringops) Defined in scheme/stringops.scm at line 69 (CVS log) x- Return the viewport pixel coordinate X pixels left of the right display edge. (x- x) Description Return the viewport pixel coordinate X pixels left of the right display edge. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 167 (CVS log) X-atom->string Returns the string represented by ATOM. (X-atom->string atom) Description Returns the string represented by atom. Returns #f, if the X atom was not known. Implementation Notes Module: Built-in Primitive Defined in src/xproperty.c at line 400 (CVS log) X-atomic-property-set-if-unset! Set property NAME on WINDOW to VALUE, if it's currently unset. (X-atomic-property-set-if-unset! window name value #&optional (type "STRING") (format 8)) Description Set property NAME on WINDOW to VALUE, if it's currently unset. Returns #f if the property is already set, #t otherwise. TYPE and FORMAT are as in X-property-set! Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 80 (CVS log) x-connection-number Return the X connection file descriptor number. (x-connection-number) Description Return the X connection file descriptor number. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 689 (CVS log) X-convert-selection Ask the owner of selection SELECTION to provide its value. (X-convert-selection selection target property requestor-window) Description Ask the owner of selection selection to provide its value. The owner should convert the selection to type target and put set the X property property on requestor-window when it is transferred. selection, target, and property are each atoms. requestor-window is a window object or 'root-window. Implementation Notes Module: Built-in Primitive Defined in src/xproperty.c at line 444 (CVS log) X-cut-buffer->palm-clipboard No documentation supplied. (X-cut-buffer->palm-clipboard) Description No documentation supplied. Implementation Notes Module: (app scwm flux) Defined in scheme/flux.scm at line 333 (CVS log) X-cut-buffer-string Return the text of the primary cut buffer. (X-cut-buffer-string) Description Return the text of the primary cut buffer. This is the cut text selected by X clients. Returns #f if the cut buffer is empty or is not a string. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 19 (CVS log) X-display-information Return some information about the screen. (X-display-information) Description Return some information about the screen. In particular, return a list of the horizontal resolution, the vertical resolution, the number of planes on the current screen (i.e. the bit depth), the bits per color supported by the hardware, the visual class (one of "StaticGray", "GrayScale", "StaticColor", "PseudoColor", "DirectColor" or "TrueColor") and a boolean indicating whether the display is color. The resolutions mentioned above should in theory be pixels per centimeter, rounded to the nearest integer. These parameters can be used for various workarounds or conditional decisions in a scwmrc to be shared among multiple machines. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 518 (CVS log) X-fetch-bytes Returns a string representing the value of the cut buffer. (X-fetch-bytes) Description Returns a string representing the value of the cut buffer. XFetchBytes is called. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 952 (CVS log) X-get-selection-owner Return the window that owns the selection denoted by ATOM. (X-get-selection-owner atom) Description Return the window that owns the selection denoted by atom. atom is likely one of the atoms: "PRIMARY" or "SECONDARY". See also `string->X-atom'. Return value is either a window object, 'root-window, or an integer window Id. Implementation Notes Module: Built-in Primitive Defined in src/xproperty.c at line 420 (CVS log) X-grab-server Grab the X server. (X-grab-server) Description Grab the X server. This is very risky; you should almost definitely use with-grabbed-server instead. This must be paired with X-ungrab-server. This primitive is undefined at startup to make it hard to access directly. See also X-server-grabs Implementation Notes Module: Built-in Primitive Defined in src/Grab.c at line 70 (CVS log) X-handle-selection-string Run VALUE-HANDLER on the selection SELECTION after retrieving it. (X-handle-selection-string selection value-handler) Description Run VALUE-HANDLER on the selection SELECTION after retrieving it. The VALUE-HANDLER should take a single argument, the string value of the selection retrieved. The X11 protocol for selections is asynchronous, so so must this procedure be. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 46 (CVS log) X-pointer-mapping Return the mapping of physical->logical pointer buttons as a list. (X-pointer-mapping) Description Return the mapping of physical->logical pointer buttons as a list. The length of the returned list is the number of buttons available. Each element in the list is an integer. E.g., '(1 2 3) is a normally mapped 3-button mouse, whereas '(3 2 1) is a 3-button mouse where the rightmost physical button acts as logical button 1, and the leftmost acts as button 3. Implementation Notes Module: Built-in Primitive Defined in src/binding.c at line 1639 (CVS log) X-properties Returns a list of WIN's X property names. (X-properties win) Description Returns a list of win's X property names. win is the window to query, an X window id, or 'root-window. Implementation Notes Module: Built-in Primitive Defined in src/xproperty.c at line 348 (CVS log) X-properties->string Prints the X properties of WIN into a string. (X-properties->string #&optional (win (get-window)) (recurse #t)) Description Prints the X properties of WIN into a string. WIN is a window object, an X window id, or 'root-window. If RECURSE is non-#f, also list properties of referenced windows. Implementation Notes Module: Defined in scheme/xprop-extras.scm at line 192 (CVS log) X-property-delete! Delete X property NAME of window WIN. (X-property-delete! win name) Description Delete X property name of window win. win is the window to check, an X window id, or 'root-window. name is a string. The return value is unspecified. Implementation Notes Module: Built-in Primitive Defined in src/xproperty.c at line 330 (CVS log) X-property-get Get X property NAME of window WIN. (X-property-get win name #&optional consume?) Description Get X property name of window win. win is the window to check, an X window id, or 'root-window. name is a string or an X/11 atom (long). If consume? is #t, the X property is deleted after getting it. Default is not to delete. If the X property could not be found, #f is returned. If the X property could be found, a list '(value type format) is returned. "type" is a string. "format" is either 8, 16, or 32, giving the size of the elements of "value". "value" is a string, if "format" is 8, or a vector of integers otherwise. Implementation Notes Module: Built-in Primitive Defined in src/xproperty.c at line 263 (CVS log) X-property-set! Set X property NAME on window WIN to VALUE. (X-property-set! win name value #&optional type format action) Description Set X property name on window win to value. win is the window to set the X property on, an X window id, or 'root-window. name and type are strings or X/11 atoms (longs). type defaults to "STRING". format may be one of the integers 8, 16, and 32, defining the element size of the value. It is 8 by default. If format is 8, value may be a string or a list of null-terminated strings. Otherwise it will be a vector of format-bit integers. action may be one of the symbols 'replace, 'prepend, or 'append signifying how the new value should be merged (if at all) with the existing value. Implementation Notes Module: Built-in Primitive Defined in src/xproperty.c at line 112 (CVS log) X-resource-database-save Save the Scwm resource database to FILENAME. (X-resource-database-save filename) Description Save the Scwm resource database to filename. Only the settings set or changed via X-resource-put go into the file. Implementation Notes Module: Built-in Primitive Defined in src/xrm.c at line 90 (CVS log) X-resource-get Get X resource specified by NAME and XCLASS from Xrm database. (X-resource-get name #&optional xclass) Description Get X resource specified by name and xclass from Xrm database. Both name and xclass are strings, as is the returned value. If xclass is omitted, it defaults to the same string as name. If there is no resource under the given key, #f is returned. Implementation Notes Module: Built-in Primitive Defined in src/xrm.c at line 61 (CVS log) X-resource-put Stores string VALUE as X resource RESOURCE (also a string). (X-resource-put resource value) Description Stores string value as X resource resource (also a string). Later, the value can be retrieved using X-resource-get. Implementation Notes Module: Built-in Primitive Defined in src/xrm.c at line 42 (CVS log) X-rotate-cut-buffers Rotate the X cut buffers by N positions. (X-rotate-cut-buffers n) Description Rotate the X cut buffers by n positions. This means buffer 0 becomes buffer n, buffer 1 becomes n + 1 mod 8, and so on. This cut buffer numbering is global to the display. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 379 (CVS log) X-server-grabs Return the number of nested server grabs. (X-server-grabs) Description Return the number of nested server grabs. Nonzero means the server is currently grabbed. See also with-grabbed-server, X-grab-server and X-ungrab-server Implementation Notes Module: Built-in Primitive Defined in src/Grab.c at line 99 (CVS log) X-server-synchronize Handle all pending events. (X-server-synchronize) Description Handle all pending events. Implementation Notes Module: Defined in scheme/base.scm at line 902 (CVS log) X-set-cut-buffer-string! Set the text of the primary cut buffer. (X-set-cut-buffer-string! string) Description Set the text of the primary cut buffer. This is the cut text selected by X clients. Implementation Notes Module: (app scwm xprop-extras) Defined in scheme/xprop-extras.scm at line 25 (CVS log) X-store-bytes Set the cut buffer to STRING by calling XStoreBytes. (X-store-bytes string) Description Set the cut buffer to string by calling XStoreBytes. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 973 (CVS log) X-synthetic-send-string Send string STR to WIN via synthetic X events. (X-synthetic-send-string str #&optional (win (get-window))) Description Send string STR to WIN via synthetic X events. See also send-key. Note that some programs (e.g., xterm) by default do not honour synthetic key events as they are a security hole. Implementation Notes Module: Defined in scheme/send-string.scm at line 71 (CVS log) X-ungrab-server Ungrab the X server. (X-ungrab-server) Description Ungrab the X server. Using X-grab-server and X-ungrab-server directly is risky; you should almost definitely use with-grabbed-server instead. This primitive is undefined at startup to make it hard to access directly. See also X-server-grabs Implementation Notes Module: Built-in Primitive Defined in src/Grab.c at line 84 (CVS log) X-version-information Return some information about the version of the running X server. (X-version-information) Description Return some information about the version of the running X server. Return value is a list of the X protocol version, the X protocol revision, the X server vendor, and the vendor release number. Implementation Notes Module: Built-in Primitive Defined in src/miscprocs.c at line 498 (CVS log) xlib-draw-arc! Draws a arc to the screen using the Xlib call XDrawArc. (xlib-draw-arc! top-left width height angle1 angle2) Description Draws a arc to the screen using the Xlib call XDrawArc. The arc is specified in terms of a rectangle, in which it is wholly enclosed. top-left is a point pair for the upper left corner of the rectangle. The rectangle is of size width by height. The arc is drawn from angle1 to angle2. Angles are specified in degrees (0.0 to 360.0). Implementation Notes Module: Primitive from (app scwm xlib-drawing) Defined in modules/xlib-drawing/drawing.c at line 125 (CVS log) xlib-draw-line! Draws a line using the Xlib call XDrawLine. (xlib-draw-line! p1 p2) Description Draws a line using the Xlib call XDrawLine. The line is drawn from p1 to p2. Both p1 and p2 are pairs (X . Y) representing points. Implementation Notes Module: Primitive from (app scwm xlib-drawing) Defined in modules/xlib-drawing/drawing.c at line 107 (CVS log) xlib-draw-rectangle! Draws a rectangle to the screen using the Xlib call XDrawRectangle. (xlib-draw-rectangle! top-left width height) Description Draws a rectangle to the screen using the Xlib call XDrawRectangle. top-left is the upper left point of the rectangle. The rectangle is of size width by height. top-left is a point pair: (X . Y). Implementation Notes Module: Primitive from (app scwm xlib-drawing) Defined in modules/xlib-drawing/drawing.c at line 87 (CVS log) xlib-set-drawing-mask! Set the drawing mask used by the xlib-* primitives. (xlib-set-drawing-mask! value) Description Set the drawing mask used by the xlib-* primitives. value is XORed with the background when dragging non-opaque move or resize frames. value should be an integer. Implementation Notes Module: Primitive from (app scwm xlib-drawing) Defined in modules/xlib-drawing/drawing.c at line 64 (CVS log) xlib-set-fill-style! Sets the fill style of the DrawingGC to STYLE. (xlib-set-fill-style! style) Description Sets the fill style of the DrawingGC to style. One of FillSolid (0), FillTiled (1), FillStippled (2), or FillOpaqueStippled (3) should be given as style. Implementation Notes Module: Primitive from (app scwm xlib-drawing) Defined in modules/xlib-drawing/drawing.c at line 177 (CVS log) xlib-set-line-attributes! Sets the line width of the DrawingGC to WIDTH and style to STYLE. (xlib-set-line-attributes! width #&optional style) Description Sets the line width of the DrawingGC to width and style to style. One of 'solid (default), 'on-off-dash, or 'double-dash should be given as style. Implementation Notes Module: Primitive from (app scwm xlib-drawing) Defined in modules/xlib-drawing/drawing.c at line 154 (CVS log) xlock-query-modes Returns a list of mode names queried from the given XLOCK program. (xlock-query-modes #&optional (xlock *xlock-query-program*)) Description Returns a list of mode names queried from the given XLOCK program. Special modes "random", "bomb", and "blank" are not included in this list. Use *xlock-query-program* to specify what program's output we should read to compute the list of modes. See also make-xlock-menu. Implementation Notes Module: (app scwm xlock-menus) Defined in scheme/xlock-menus.scm at line 49 (CVS log) xterm-other-host Run an xterm on machine HOSTNAME. (xterm-other-host hostname) Description Run an xterm on machine HOSTNAME. Starts the XTerm with resource "remotexterm" and uses `*xterm-command*' to determine which terminal program to use and `*remote-shell-command*' to determine how to start the shell remotely. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 659 (CVS log) xtest-fake-button-event Fake an X event of button number BUTTON after a delay of MS-DELAY. (xtest-fake-button-event button is-press? #&optional ms-delay) Description Fake an X event of button number button after a delay of ms-delay. The event is a mouse press if is-press? is #t, or a release otherwise. If ms-delay is ommitted or is not a number, no delay is used Implementation Notes Module: Primitive from (app scwm xtest) Defined in modules/xtest/scwmxtest.c at line 47 (CVS log) xtest-fake-key-event Fake an X event of key KEYCODE after a delay of MS-DELAY. (xtest-fake-key-event keycode is-press? #&optional ms-delay) Description Fake an X event of key keycode after a delay of ms-delay. The event is a key press if is-press? is #t, or a release otherwise. If ms-delay is ommitted or is not a number, no delay is used. Implementation Notes Module: Primitive from (app scwm xtest) Defined in modules/xtest/scwmxtest.c at line 71 (CVS log) xtest-fake-modmask No documentation supplied. (xtest-fake-modmask mask delay press?) Description No documentation supplied. Implementation Notes Module: (app scwm quote) Defined in scheme/quote.scm at line 95 (CVS log) xtest-fake-modmask-button No documentation supplied. (xtest-fake-modmask-button mask button #&optional (delay #f)) Description No documentation supplied. Implementation Notes Module: Defined in scheme/quote.scm at line 109 (CVS log) xtest-fake-modmask-key No documentation supplied. (xtest-fake-modmask-key mask keycode #&optional (delay #f)) Description No documentation supplied. Implementation Notes Module: (app scwm quote) Defined in scheme/quote.scm at line 101 (CVS log) xtest-fake-motion-event Fake an X motion event to X,Y after a delay of MS-DELAY on SCREEN. (xtest-fake-motion-event x y #&optional screen ms-delay) Description Fake an x motion event to x,y after a delay of ms-delay on screen. If screen is ommitted, 0 is used. If ms-delay is ommitted or is not a number, no delay is used. Implementation Notes Module: Primitive from (app scwm xtest) Defined in modules/xtest/scwmxtest.c at line 95 (CVS log) xtest-fake-relative-motion-event Fake an X motion relative event of a move DX, DY after a delay of MS-DELAY. (xtest-fake-relative-motion-event dx dy #&optional ms-delay) Description Fake an X motion relative event of a move dx, dy after a delay of ms-delay. If ms-delay is ommitted or is #f or 0, no delay is used Implementation Notes Module: Primitive from (app scwm xtest) Defined in modules/xtest/scwmxtest.c at line 121 (CVS log) xtest-supported? Returns #t iff the XTest extension is supported on this server. (xtest-supported?) Description Returns #t iff the XTest extension is supported on this server. Implementation Notes Module: Primitive from (app scwm xtest) Defined in modules/xtest/scwmxtest.c at line 37 (CVS log) y- Return the viewport pixel coordinate Y pixels up from the bottom display edge. (y- y) Description Return the viewport pixel coordinate Y pixels up from the bottom display edge. Implementation Notes Module: (app scwm base) Defined in scheme/base.scm at line 171 (CVS log)