aboutsummaryrefslogtreecommitdiffstats
path: root/Xlibscm.info
diff options
context:
space:
mode:
Diffstat (limited to 'Xlibscm.info')
-rw-r--r--Xlibscm.info1113
1 files changed, 648 insertions, 465 deletions
diff --git a/Xlibscm.info b/Xlibscm.info
index 4c57ced..1052cba 100644
--- a/Xlibscm.info
+++ b/Xlibscm.info
@@ -1,5 +1,5 @@
-This is Info file Xlibscm.info, produced by Makeinfo version 1.68 from
-the input file Xlibscm.texi.
+This is Xlibscm.info, produced by makeinfo version 4.0 from
+Xlibscm.texi.
INFO-DIR-SECTION The Algorithmic Language Scheme
START-INFO-DIR-ENTRY
@@ -12,7 +12,7 @@ File: Xlibscm.info, Node: Top, Next: Xlibscm, Prev: (dir), Up: (dir)
This manual documents the X - SCM Language X Interface. The most recent
information about SCM can be found on SCM's "WWW" home page:
- `http://swissnet.ai.mit.edu/~jaffer/SCM.html'
+ <http://swissnet.ai.mit.edu/~jaffer/SCM.html>
Copyright (C) 1990-1999 Free Software Foundation
@@ -33,19 +33,18 @@ approved by the author.
* Menu:
* Xlibscm::
-* Display::
-* Screen::
-* Window::
-* Window Visibility::
+* Display and Screens::
+* Drawables::
* Graphics Context::
* Cursor::
* Colormap::
* Rendering::
+* Images::
* Event::
* Index::

-File: Xlibscm.info, Node: Xlibscm, Next: Display, Prev: Top, Up: Top
+File: Xlibscm.info, Node: Xlibscm, Next: Display and Screens, Prev: Top, Up: Top
Xlibscm
*******
@@ -111,12 +110,12 @@ the suitability of this documentation for any purpose. It is provided
"as is" without express or implied warranty.

-File: Xlibscm.info, Node: Display, Next: Screen, Prev: Xlibscm, Up: Top
+File: Xlibscm.info, Node: Display and Screens, Next: Drawables, Prev: Xlibscm, Up: Top
-Display
-*******
+Display and Screens
+*******************
- - Function: x:open-display DISPLAY-NAME
+ - Function: x:open-display display-name
DISPLAY-NAME Specifies the hardware display name, which determines
the display and communications domain to be used. On a
POSIX-conformant system, if the display-name is #f, it defaults to
@@ -142,7 +141,7 @@ Display
SCREEN-NUMBER sets an internal variable that can be accessed
by using the x:default-screen procedure.
- - Function: x:close DISPLAY
+ - Function: x:close display
DISPLAY specifies the connection to the X server.
The `x:close' function closes the connection to the X server for
@@ -155,39 +154,32 @@ Display
generated. Before exiting, you should call X:CLOSE-DISPLAY or
X:FLUSH explicitly so that any pending errors are reported.
- - Function: x:protocol-version DISPLAY
+ - Function: x:protocol-version display
Returns cons of the major version number (11) of the X protocol
associated with the connected DISPLAY and the minor protocol
revision number of the X server.
- - Function: x:server-vendor DISPLAY
+ - Function: x:server-vendor display
Returns a string that provides some identification of the owner of
the X server implementation. The contents of the string are
implementation-dependent.
- - Function: x:vendor-release DISPLAY
+ - Function: x:vendor-release display
Returns a number related to a vendor's release of the X server.
-
-File: Xlibscm.info, Node: Screen, Next: Window, Prev: Display, Up: Top
-
-Screen
-******
-
A display consists of one or more "Screen"s. Each screen has a
-"root-window", "default-graphics-context", "default-visual", and
-"colormap".
+"root-window", "default-graphics-context", and "colormap".
- - Function: x:screen-count DISPLAY
+ - Function: x:screen-count display
Returns the number of available screens.
- - Function: x:default-screen DISPLAY
+ - Function: x:default-screen display
Returns the default screen number specified by the `x:open-display'
function. Use this screen number in applications which will use
only a single screen.
- - Function: x:root-window DISPLAY SCREEN-NUMBER
- - Function: x:root-window DISPLAY
+ - Function: x:root-window display screen-number
+ - Function: x:root-window display
SCREEN-NUMBER, if givien, specifies the appropriate screen number
on the host server. Otherwise the default-screen for DISPLAY is
used.
@@ -196,34 +188,40 @@ A display consists of one or more "Screen"s. Each screen has a
`x:root-window' for functions that need a drawable of a particular
screen or for creating top-level windows.
- - Function: x:root-window WINDOW
+ - Function: x:root-window window
Returns the root window for the specified WINDOW's screen.
- - Function: x:default-colormap DISPLAY SCREEN-NUMBER
- - Function: x:default-colormap DISPLAY
- - Function: x:default-colormap WINDOW
+ - Function: x:default-colormap display screen-number
+ - Function: x:default-colormap display
+ - Function: x:default-colormap window
Returns the default colormap of the specified screen.
- - Function: x:default-gc DISPLAY SCREEN-NUMBER
- - Function: x:default-gc DISPLAY
- - Function: x:default-gc WINDOW
+ - Function: x:default-ccc display screen-number
+ - Function: x:default-ccc display
+ - Function: x:default-ccc window
+ Returns the default Color-Conversion-Context (ccc) of the specified
+ screen.
+
+ - Function: x:default-gc display screen-number
+ - Function: x:default-gc display
+ - Function: x:default-gc window
Returns the default graphics-context of the specified screen.
- - Function: x:default-depths DISPLAY SCREEN-NUMBER
- - Function: x:default-depths DISPLAY
- - Function: x:default-depths WINDOW
- Returns a vector of depths supported by the specified screen.
+ - Function: x:screen-depths display screen-number
+ - Function: x:screen-depths display
+ - Function: x:screen-depths window
+ Returns an array of depths supported by the specified screen.
The "Visual" type describes possible colormap depths and arrangements.
- - Function: x:default-visual DISPLAY SCREEN-NUMBER
- - Function: x:default-visual DISPLAY
- - Function: x:default-visual WINDOW
+ - Function: x:default-visual display screen-number
+ - Function: x:default-visual display
+ - Function: x:default-visual window
Returns the default Visual type for the specified screen.
- - Function: x:make-visual DISPLAY DEPTH CLASS
- - Function: x:make-visual WINDOW DEPTH CLASS
+ - Function: x:make-visual display depth class
+ - Function: x:make-visual window depth class
The integer DEPTH specifies the number of bits per pixel. The
CLASS argument specifies one of the possible visual classes for a
screen:
@@ -242,52 +240,83 @@ The "Visual" type describes possible colormap depths and arrangements.
`X:make-visual' returns a visual type for the screen specified by
DISPLAY or WINDOW if successful; #f if not.
+ - Function: x:visual-class visual
+ - Function: x:visual-class screen
+ - Function: x:visual-class display
+ Returns the (integer) visual class of its argument.
+
+ - Function: x:visual-geometry visual
+ - Function: x:visual-geometry screen
+ - Function: x:visual-geometry display
+ Returns a list of the:
+ * red_mask
+
+ * green_mask
- - Function: x:screen-cells DISPLAY SCREEN-NUMBER
- - Function: x:screen-cells DISPLAY
- - Function: x:screen-cells WINDOW
+ * blue_mask
+
+ * colormap_size
+
+ - Function: x:screen-cells display screen-number
+ - Function: x:screen-cells display
+ - Function: x:screen-cells window
Returns the number of entries in the default colormap.
- - Function: x:screen-depth DISPLAY SCREEN-NUMBER
- - Function: x:screen-depth DISPLAY
- - Function: x:screen-depth WINDOW
+ - Function: x:screen-depth display screen-number
Returns the depth of the root window of the specified screen.
+ - Function: x:screen-depth display
+ - Function: x:screen-depth window
+ - Function: x:screen-depth visual
+ Returns the depth of argument.
+
The "depth" of a window or pixmap is the number of bits per pixel
it has. The "depth" of a graphics context is the depth of the
drawables it can be used in conjunction with graphics output.
- - Function: x:screen-size DISPLAY SCREEN-NUMBER
- - Function: x:screen-size DISPLAY
- - Function: x:screen-size WINDOW
+ - Function: x:screen-size display screen-number
+ - Function: x:screen-size display
+ - Function: x:screen-size window
Returns a list of integer height and width of the screen in pixels.
- - Function: x:screen-dimensions DISPLAY SCREEN-NUMBER
- - Function: x:screen-dimensions DISPLAY
- - Function: x:screen-dimensions WINDOW
+ - Function: x:screen-dimensions display screen-number
+ - Function: x:screen-dimensions display
+ - Function: x:screen-dimensions window
Returns a list of integer height and width of the screen in
millimeters.
- - Function: x:screen-white DISPLAY SCREEN-NUMBER
- - Function: x:screen-white DISPLAY
- - Function: x:screen-white WINDOW
+ - Function: x:screen-white display screen-number
+ - Function: x:screen-white display
+ - Function: x:screen-white window
Returns the white pixel value of the specified screen.
- - Function: x:screen-black DISPLAY SCREEN-NUMBER
- - Function: x:screen-black DISPLAY
- - Function: x:screen-black WINDOW
+ - Function: x:screen-black display screen-number
+ - Function: x:screen-black display
+ - Function: x:screen-black window
Returns the black pixel value of the specified screen.

-File: Xlibscm.info, Node: Window, Next: Window Visibility, Prev: Screen, Up: Top
+File: Xlibscm.info, Node: Drawables, Next: Graphics Context, Prev: Display and Screens, Up: Top
-Window
-******
+Drawables
+*********
A "Drawable" is either a window or pixmap.
- - Function: x:create-window WINDOW POSITION SIZE BORDER-WIDTH DEPTH
- CLASS VISUAL FIELD-NAME VALUE ...
+* Menu:
+
+* Windows and Pixmaps::
+* Window Attributes::
+* Window Properties and Visibility::
+
+
+File: Xlibscm.info, Node: Windows and Pixmaps, Next: Window Attributes, Prev: Drawables, Up: Drawables
+
+Windows and Pixmaps
+===================
+
+ - Function: x:create-window window position size border-width depth
+ class visual field-name value ...
Creates and returns an unmapped Input-Output subwindow for a
specified parent WINDOW and causes the X server to generate a
CreateNotify event. The created window is placed on top in the
@@ -312,14 +341,14 @@ A "Drawable" is either a window or pixmap.
The returned window will have the attributes specified by
FIELD-NAMEs and VALUE.
- - Function: x:create-window WINDOW POSITION SIZE BORDER-WIDTH BORDER
- BACKGROUND
+ - Function: x:create-window window position size border-width border
+ background
The returned window inherits its depth, class, and visual from its
parent. All other window attributes, except BACKGROUND and
BORDER, have their default values.
- - Function: x:create-pixmap DRAWABLE SIZE DEPTH
- - Function: x:create-pixmap DISPLAY SIZE DEPTH
+ - Function: x:create-pixmap drawable size depth
+ - Function: x:create-pixmap display size depth
SIZE is a list, vector, or pair of nonzero integers specifying the
width and height desired in the new pixmap.
@@ -328,7 +357,7 @@ A "Drawable" is either a window or pixmap.
drawable argument. The DEPTH argument must be one of the depths
supported by the screen of the specified DRAWABLE.
- - Function: x:close WINDOW
+ - Function: x:close window
Destroys the specified WINDOW as well as all of its subwindows and
causes the X server to generate a DestroyNotify event for each
window. The window should not be used again. If the window
@@ -342,21 +371,21 @@ A "Drawable" is either a window or pixmap.
mapped WINDOW will generate x:Expose events on other windows that
were obscured by the window being destroyed.
- - Function: x:close PIXMAP
+ - Function: x:close pixmap
Deletes the association between the PIXMAP and its storage. The X
server frees the pixmap storage when there are no references to it.
- - Function: x:window-geometry DRAWABLE
+ - Function: x:window-geometry drawable
Returns a list of:
coordinates
- `cons' of x and y coordinates that define the location of the
+ `list' of x and y coordinates that define the location of the
DRAWABLE. For a window, these coordinates specify the
upper-left outer corner relative to its parent's origin. For
pixmaps, these coordinates are always zero.
size
- `cons' of the DRAWABLE's dimensions (width and height). For
+ `list' of the DRAWABLE's dimensions (width and height). For
a window, these dimensions specify the inside size, not
including the border.
@@ -367,16 +396,103 @@ A "Drawable" is either a window or pixmap.
depth
The depth of the DRAWABLE (bits per pixel for the object).
- - Function: x:window-set! WINDOW FIELD-NAME VALUE ...
+ - Function: x:window-geometry-set! window field-name value ...
+ Changes the "Configuration" components specified by FIELD-NAMEs
+ for the specified WINDOW.
+
+These are the attributes settable by `x:window-geometry-set!'. That
+these attributes are encoded by small integers - just like those of the
+next section. Be warned therefore that confusion of attribute names
+will likely not signal errors, just cause mysterious behavior.
+
+ - Attribute: x:CWX
+ - Attribute: x:CWY
+ - Attribute: x:CW-Width
+ - Attribute: x:CW-Height
+ The x:CWX and x:CYY members are used to set the window's x and y
+ coordinates, which are relative to the parent's origin and
+ indicate the position of the upper-left outer corner of the
+ window. The x:CW-Width and x:CW-Height members are used to set
+ the inside size of the window, not including the border, and must
+ be nonzero. Attempts to configure a root window have no effect.
+
+ If a window's size actually changes, the window's subwindows move
+ according to their window gravity. Depending on the window's bit
+ gravity, the contents of the window also may be moved
+
+ - Attribute: x:CW-Border-Width
+ The integer x:CW-Border-Width is used to set the width of the
+ border in pixels. Note that setting just the border width leaves
+ the outer-left corner of the window in a fixed position but moves
+ the absolute position of the window's origin. It is an error to
+ set the border-width attribute of an InputOnly window nonzero.
+
+ - Attribute: x:CW-Sibling
+ The sibling member is used to set the sibling window for stacking
+ operations.
+
+ - Attribute: x:CW-Stack-Mode
+ The x:CW-Stack-Mode member is used to set how the window is to be
+ restacked and can be set to x:Above, x:Below, x:Top-If,
+ x:Bottom-If, or x:Opposite.
+
+If a sibling and a stack-mode are specified, the window is restacked as
+follows:
+
+`x:Above'
+ The window is placed just above the sibling.
+
+`x:Below'
+ The window is placed just below the sibling.
+
+`x:Top-If'
+ If the sibling occludes the window, the window is placed at the
+ top of the stack.
+
+`x:Bottom-If'
+ If the window occludes the sibling, the window is placed at the
+ bottom of the stack.
+
+`x:Opposite'
+ If the sibling occludes the window, the window is placed at the
+ top of the stack. If the window occludes the sibling, the window
+ is placed at the bottom of the stack.
+
+If a stack-mode is specified but no sibling is specified, the window is
+restacked as follows:
+
+`x:Above'
+ The window is placed at the top of the stack.
+
+`x:Below'
+ The window is placed at the bottom of the stack.
+
+`x:Top-If'
+ If any sibling occludes the window, the window is placed at the
+ top of the stack.
+
+`x:Bottom-If'
+ If the window occludes any sibling, the window is placed at the
+ bottom of the stack.
+
+`x:Opposite'
+ If any sibling occludes the window, the window is placed at the
+ top of the stack. If the window occludes any sibling, the window
+ is placed at the bottom of the stack.
+
+
+File: Xlibscm.info, Node: Window Attributes, Next: Window Properties and Visibility, Prev: Windows and Pixmaps, Up: Drawables
+
+Window Attributes
+=================
+
+ - Function: x:window-set! window field-name value ...
Changes the components specified by FIELD-NAMEs for the specified
WINDOW. The restrictions are the same as for `x:create-window'.
The order in which components are verified and altered is server
dependent. If an error occurs, a subset of the components may
have been altered.
-Window Attributes
-=================
-
The `x:create-window' and `x:window-set!' procedures take five and one
argument (respectively) followed by pairs of arguments, where the first
is one of the property-name symbols (or its top-level value) listed
@@ -427,16 +543,16 @@ below; and the second is the value to associate with that property.
children to be reconfigured (depending on their win-gravity). For
a change of width and height, the (x, y) pairs are defined:
- Gravity Direction Coordinates
- x:North-West-Gravity (0, 0)
- x:North-Gravity (Width/2, 0)
- x:North-East-Gravity (Width, 0)
- x:West-Gravity (0, Height/2)
- x:Center-Gravity (Width/2, Height/2)
- x:East-Gravity (Width, Height/2)
- x:South-West-Gravity (0, Height)
- x:South-Gravity (Width/2, Height)
- x:South-East-Gravity (Width, Height)
+ Gravity Direction Coordinates
+ x:North-West-Gravity (0, 0)
+ x:North-Gravity (Width/2, 0)
+ x:North-East-Gravity (Width, 0)
+ x:West-Gravity (0, Height/2)
+ x:Center-Gravity (Width/2, Height/2)
+ x:East-Gravity (Width, Height/2)
+ x:South-West-Gravity (0, Height)
+ x:South-Gravity (Width/2, Height)
+ x:South-East-Gravity (Width, Height)
When a window with one of these bit-gravity values is resized, the
corresponding pair defines the change in position of each pixel in
@@ -557,50 +673,51 @@ below; and the second is the value to associate with that property.
the event-mask argument and the circumstances in which you would
want to specify the event mask:
- Event Mask Circumstances
- x:No-Event-Mask No events wanted
- x:Key-Press-Mask Keyboard down events wanted
- x:Key-Release-Mask Keyboard up events wanted
- x:Button-Press-Mask Pointer button down events wanted
- x:Button-Release-Mask Pointer button up events wanted
- x:Enter-Window-Mask Pointer window entry events wanted
- x:Leave-Window-Mask Pointer window leave events wanted
- x:Pointer-Motion-Mask Pointer motion events wanted
- x:Pointer-Motion-Hint-Mask If x:Pointer-Motion-Hint-Mask is
- selected in combination with one or
- more motion-masks, the X server is
- free to send only one x:Motion-Notify
- event (with the is_hint member of
- the X:Pointer-Moved-Event structure
- set to x:Notify-Hint) to the client
- for the event window, until either
- the key or button state changes, the
- pointer leaves the event window, or
- the client calls X:Query-Pointer or
- X:Get-Motion-Events. The server
- still may send x:Motion-Notify
- events without is_hint set to
- x:Notify-Hint.
- x:Button1-Motion-Mask Pointer motion while button 1 down
- x:Button2-Motion-Mask Pointer motion while button 2 down
- x:Button3-Motion-Mask Pointer motion while button 3 down
- x:Button4-Motion-Mask Pointer motion while button 4 down
- x:Button5-Motion-Mask Pointer motion while button 5 down
- x:Button-Motion-Mask Pointer motion while any button down
- x:Keymap-State-Mask Keyboard state wanted at window
- entry and focus in
- x:Exposure-Mask Any exposure wanted
- x:Visibility-Change-Mask Any change in visibility wanted
- x:Structure-Notify-Mask Any change in window structure wanted
- x:Resize-Redirect-Mask Redirect resize of this window
- x:Substructure-Notify-Mask Substructure notification wanted
- x:Substructure-Redirect-Mask Redirect structure requests on
- children
- x:Focus-Change-Mask Any change in input focus wanted
- x:Property-Change-Mask Any change in property wanted
- x:Colormap-Change-Mask Any change in colormap wanted
- x:Owner-Grab-Button-Mask Automatic grabs should activate with
- owner_events set to True
+ Event Mask Circumstances
+ x:No-Event-Mask No events wanted
+ x:Key-Press-Mask Keyboard down events wanted
+ x:Key-Release-Mask Keyboard up events wanted
+ x:Button-Press-Mask Pointer button down events wanted
+ x:Button-Release-Mask Pointer button up events wanted
+ x:Enter-Window-Mask Pointer window entry events wanted
+ x:Leave-Window-Mask Pointer window leave events wanted
+ x:Pointer-Motion-Mask Pointer motion events wanted
+ x:Pointer-Motion-Hint-Mask If x:Pointer-Motion-Hint-Mask is
+ selected in combination with one or
+ more motion-masks, the X server is
+ free to send only one x:Motion-Notify
+ event (with the is_hint member of
+ the X:Pointer-Moved-Event structure
+ set to x:Notify-Hint) to the client
+ for the event window, until either
+ the key or button state changes, the
+ pointer leaves the event window, or
+ the client calls X:Query-Pointer or
+ X:Get-Motion-Events. The server
+ still may send x:Motion-Notify
+ events without is_hint set to
+ x:Notify-Hint.
+ x:Button1-Motion-Mask Pointer motion while button 1 down
+ x:Button2-Motion-Mask Pointer motion while button 2 down
+ x:Button3-Motion-Mask Pointer motion while button 3 down
+ x:Button4-Motion-Mask Pointer motion while button 4 down
+ x:Button5-Motion-Mask Pointer motion while button 5 down
+ x:Button-Motion-Mask Pointer motion while any button down
+ x:Keymap-State-Mask Keyboard state wanted at window
+ entry and focus in
+ x:Exposure-Mask Any exposure wanted
+ x:Visibility-Change-Mask Any change in visibility wanted
+ x:Structure-Notify-Mask Any change in window structure wanted
+ x:Resize-Redirect-Mask Redirect resize of this window
+ x:Substructure-Notify-Mask Substructure notification wanted
+ x:Substructure-Redirect-Mask Redirect structure requests on
+ children
+ x:Focus-Change-Mask Any change in input focus wanted
+ x:Property-Change-Mask Any change in property wanted
+ x:Colormap-Change-Mask Any change in colormap wanted
+ x:Owner-Grab-Button-Mask Automatic grabs should activate with
+ owner_events set to True
+
- Attribute: x:CW-Dont-Propagate
The do-not-propagate-mask attribute defines which events should
@@ -642,18 +759,56 @@ below; and the second is the value to associate with that property.
in the displayed cursor. On the root window, the default cursor
is restored.
+ - Function: x:window-ref window field-name ...
+ Returns a list of the components specified by FIELD-NAMEs for the
+ specified WINDOW. Allowable FIELD-NAMEs are a subset of those for
+ `x:window-set!':
+
+ * x:CW-Back-Pixel
+
+ * x:CW-Bit-Gravity
+
+ * x:CW-Win-Gravity
+
+ * x:CW-Backing-Store
+
+ * x:CW-Backing-Planes
+
+ * x:CW-Backing-Pixel
+
+ * x:CW-Override-Redirect
+
+ * x:CW-Save-Under
+
+ * x:CW-Event-Mask
+
+ * x:CW-Dont-Propagate
+
+ * x:CW-Colormap
+

-File: Xlibscm.info, Node: Window Visibility, Next: Graphics Context, Prev: Window, Up: Top
+File: Xlibscm.info, Node: Window Properties and Visibility, Prev: Window Attributes, Up: Drawables
+
+Window Properties and Visibility
+================================
+
+ - Function: x:get-window-property window property
+ Returns the (string or list of numbers) value of PROPERTY of
+ WINDOW.
-Window Visibility
-*****************
+ - Function: x:get-window-property window property #t
+ Removes and returns the (string or list of numbers) value of
+ PROPERTY of WINDOW.
+
+ - Function: x:list-properties window
+ Returns a list of the properties (strings) defined for WINDOW.
In X parlance, a window which is hidden even when not obscured by other
windows is "unmapped"; one which shows is "mapped". It is an
unfortunate name-collision with Scheme, and is ingrained in the
attribute names.
- - Function: x:map-window WINDOW
+ - Function: x:map-window window
Maps the WINDOW and all of its subwindows that have had map
requests. Mapping a window that has an unmapped ancestor does not
display the window but marks it as eligible for display when the
@@ -690,13 +845,7 @@ attribute names.
be to repaint the window. This method usually leads to simpler
programs and to proper interaction with window managers.
- - Function: x:map-raised WINDOW
- This procedure is similar to `x:map-window' in that it maps the
- WINDOW and all of its subwindows that have had map requests.
- However, it also raises the specified WINDOW to the top of the
- stack.
-
- - Function: x:map-subwindows WINDOW
+ - Function: x:map-subwindows window
Maps all subwindows of a specified WINDOW in top-to-bottom
stacking order. The X server generates x:Expose events on each
newly displayed window. This may be much more efficient than
@@ -704,7 +853,7 @@ attribute names.
perform much of the work only once, for all of the windows, rather
than for each window.
- - Function: x:unmap-window WINDOW
+ - Function: x:unmap-window window
Unmaps the specified WINDOW and causes the X server to generate an
UnmapNotify event. If the specified WINDOW is already unmapped,
`x:unmap-window' has no effect. Normal exposure processing on
@@ -715,7 +864,7 @@ attribute names.
generate x:Expose events on windows that were formerly obscured by
it.
- - Function: x:unmap-subwindows WINDOW
+ - Function: x:unmap-subwindows window
Unmaps all subwindows for the specified WINDOW in bottom-to-top
stacking order. It causes the X server to generate an UnmapNotify
event on each subwindow and x:Expose events on formerly obscured
@@ -725,7 +874,7 @@ attribute names.
rather than for each window.

-File: Xlibscm.info, Node: Graphics Context, Next: Cursor, Prev: Window Visibility, Up: Top
+File: Xlibscm.info, Node: Graphics Context, Next: Cursor, Prev: Drawables, Up: Top
Graphics Context
****************
@@ -736,24 +885,24 @@ tile, stipple, clipping region, end style, join style, and so on.
Graphics operations (for example, drawing lines) use these values to
determine the actual drawing operation.
- - Function: x:create-gc DRAWABLE FIELD-NAME VALUE ...
+ - Function: x:create-gc drawable field-name value ...
Creates and returns graphics context. The graphics context can be
used with any destination drawable having the same root and depth
as the specified DRAWABLE.
- - Function: x:gc-set! GRAPHICS-CONTEXT FIELD-NAME VALUE ...
+ - Function: x:gc-set! graphics-context field-name value ...
Changes the components specified by FIELD-NAMEs for the specified
GRAPHICS-CONTEXT. The restrictions are the same as for
`x:create-gc'. The order in which components are verified and
altered is server dependent. If an error occurs, a subset of the
components may have been altered.
- - Function: x:copy-gc-fields! GCONTEXT-SRC GCONTEXT-DST FIELD-NAME ...
+ - Function: x:copy-gc-fields! gcontext-src gcontext-dst field-name ...
Copies the components specified by FIELD-NAMEs from GCONTEXT-SRC
to GCONTEXT-DST. GCONTEXT-SRC and GCONTEXT-DST must have the same
root and depth.
- - Function: x:gc-ref GRAPHICS-CONTEXT FIELD-NAME ...
+ - Function: x:gc-ref graphics-context field-name ...
Returns a list of the components specified by FIELD-NAMEs ...
from the specified GRAPHICS-CONTEXT.
@@ -1086,7 +1235,7 @@ File: Xlibscm.info, Node: Cursor, Next: Colormap, Prev: Graphics Context, Up
Cursor
******
- - Function: x:create-cursor DISPLAY SHAPE
+ - Function: x:create-cursor display shape
X provides a set of standard cursor shapes in a special font named
"cursor". Applications are encouraged to use this interface for
their cursors because the font can be customized for the individual
@@ -1098,8 +1247,8 @@ Cursor
background (see X:Recolor-Cursor). The names of all cursor shapes
are defined with the prefix XC: in `x11.scm'.
- - Function: x:create-cursor SOURCE-FONT SOURCE-CHAR MASK-FONT
- MASK-CHAR FGC BGC
+ - Function: x:create-cursor source-font source-char mask-font
+ mask-char fgc bgc
Creates a cursor from the source and mask bitmaps obtained from the
specified font glyphs. The integer SOURCE-CHAR must be a defined
glyph in SOURCE-FONT. The integer MASK-CHAR must be a defined
@@ -1109,11 +1258,11 @@ Cursor
metrics, and there is no restriction on the placement of the
hotspot relative to the bounding boxes.
- - Function: x:create-cursor SOURCE-FONT SOURCE-CHAR #F #F FGC BGC
+ - Function: x:create-cursor source-font source-char #f #f fgc bgc
If MASK-FONT and MASK-CHAR are #f, all pixels of the source are
displayed.
- - Function: x:create-cursor SOURCE-PIXMAP MASK-PIXMAP FGC BGC ORIGIN
+ - Function: x:create-cursor source-pixmap mask-pixmap fgc bgc origin
MASK-PIXMAP must be the same size as the pixmap defined by the
SOURCE-PIXMAP argument. The foreground and background RGB values
must be specified using FOREGROUND-COLOR and BACKGROUND-COLOR,
@@ -1128,7 +1277,7 @@ Cursor
in MASK-PIXMAP define which source pixels are displayed, and the
pixels set to 0 define which pixels are ignored.
- - Function: x:create-cursor SOURCE-PIXMAP #F FGC BGC ORIGIN
+ - Function: x:create-cursor source-pixmap #f fgc bgc origin
If MASK-PIXMAP is #f, all pixels of the source are displayed.

@@ -1139,7 +1288,7 @@ Colormap
A "colormap" maps pixel values to "RGB" color space values.
- - Function: x:create-colormap WINDOW VISUAL ALLOC-POLICY
+ - Function: x:create-colormap window visual alloc-policy
WINDOW specifies the window on whose screen you want to create a
colormap. VISUAL specifies a visual type supported on the screen.
ALLOC-POLICY Specifies the colormap entries to be allocated. You
@@ -1150,12 +1299,16 @@ A "colormap" maps pixel values to "RGB" color space values.
Note that WINDOW is used only to determine the screen.
`X:Gray-Scale'
+
`X:Pseudo-Color'
+
`X:Direct-Color'
The initial values of the colormap entries are undefined.
`X:Static-Gray'
+
`X:Static-Color'
+
`X:True-Color'
The entries have defined values, but those values are
specific to VISUAL and are not defined by X. The
@@ -1170,6 +1323,7 @@ A "colormap" maps pixel values to "RGB" color space values.
undefined.
`X:Gray-Scale'
+
`X:Pseudo-Color'
The effect is as if an `XAllocColorCells' call returned all
pixel values from zero to N - 1, where N is the colormap
@@ -1185,7 +1339,7 @@ A "colormap" maps pixel values to "RGB" color space values.
To create a new colormap when the allocation out of a previously shared
colormap has failed because of resource exhaustion, use:
- - Function: x:copy-colormap-and-free COLORMAP
+ - Function: x:copy-colormap-and-free colormap
Creates and returns a colormap of the same visual type and for the
same screen as the specified COLORMAP. It also moves all of the
client's existing allocation from the specified COLORMAP to the
@@ -1207,8 +1361,8 @@ A "colormap" maps pixel values to elements of the "RGB" datatype. An
RGB is a list or vector of 3 integers, describing the red, green, and
blue intensities respectively. The integers are in the range 0 - 65535.
- - Function: x:alloc-colormap-cells COLORMAP NCOLORS NPLANES
- - Function: x:alloc-colormap-cells COLORMAP NCOLORS NPLANES CONTIGUOUS?
+ - Function: x:alloc-colormap-cells colormap ncolors nplanes
+ - Function: x:alloc-colormap-cells colormap ncolors nplanes contiguous?
The `X:Alloc-Color-Cells' function allocates read/write color
cells. The number of colors, NCOLORS must be positive and the
number of planes, NPLANES nonnegative. If NCOLORS and nplanes are
@@ -1220,6 +1374,7 @@ blue intensities respectively. The integers are in the range 0 - 65535.
request.
`x:Gray-Scale'
+
`x:Pseudo-Color'
Each mask has exactly one bit set to 1. If CONTIGUOUS? is
non-false and if all masks are ORed together, a single
@@ -1236,8 +1391,8 @@ blue intensities respectively. The integers are in the range 0 - 65535.
succeeded or #f if it failed. The first array has the pixels
allocated and the second has the plane-masks.
- - Function: x:alloc-colormap-cells COLORMAP NCOLORS RGB
- - Function: x:alloc-colormap-cells COLORMAP NCOLORS RGB CONTIGUOUS?
+ - Function: x:alloc-colormap-cells colormap ncolors rgb
+ - Function: x:alloc-colormap-cells colormap ncolors rgb contiguous?
The specified NCOLORS must be positive; and RGB a list or vector
of 3 nonnegative integers. If NCOLORS colors, NREDS reds, NGREENS
greens, and NBLUES blues are requested, NCOLORS pixels are
@@ -1260,8 +1415,8 @@ blue intensities respectively. The integers are in the range 0 - 65535.
allocated. The second, third, and fourth elements are the red,
green, and blue plane-masks.
- - Function: x:free-colormap-cells COLORMAP PIXELS PLANES
- - Function: x:free-colormap-cells COLORMAP PIXELS
+ - Function: x:free-colormap-cells colormap pixels planes
+ - Function: x:free-colormap-cells colormap pixels
Frees the cells represented by pixels whose values are in the
PIXELS unsigned-integer uniform-vector. The PLANES argument
should not have any bits set to 1 in common with any of the
@@ -1284,12 +1439,12 @@ blue intensities respectively. The integers are in the range 0 - 65535.
passing `x:Alloc-All' to `X:Create-Colormap'). If more than one
pixel is in error, the one that gets reported is arbitrary.
- - Function: x:colormap-find-color COLORMAP RGB
+ - Function: x:colormap-find-color colormap rgb
RGB is a list or vector of 3 integers, describing the red, green,
and blue intensities respectively; or an integer `#xrrggbb',
packing red, green and blue intensities in the range 0 - 255.
- - Function: x:colormap-find-color COLORMAP COLOR-NAME
+ - Function: x:colormap-find-color colormap color-name
The case-insensitive string COLOR_NAME specifies the name of a
color (for example, `red')
@@ -1306,19 +1461,19 @@ blue intensities respectively. The integers are in the range 0 - 65535.
deallocated.
- - Function: x:color-ref COLORMAP PIXEL
+ - Function: x:color-ref colormap pixel
Returns a list of 3 integers, describing the red, green, and blue
intensities respectively of the COLORMAP entry of the cell indexed
by PIXEL.
The integer PIXEL must be a valid index into COLORMAP.
- - Function: X:Color-Set! COLORMAP PIXEL RGB
+ - Function: X:Color-Set! colormap pixel rgb
RGB is a list or vector of 3 integers, describing the red, green,
and blue intensities respectively; or an integer `#xrrggbb',
packing red, green and blue intensities in the range 0 - 255.
- - Function: X:Color-Set! COLORMAP PIXEL COLOR-NAME
+ - Function: X:Color-Set! colormap pixel color-name
The case-insensitive string COLOR_NAME specifies the name of a
color (for example, `red')
@@ -1329,7 +1484,7 @@ blue intensities respectively. The integers are in the range 0 - 65535.
screen, the changes are visible immediately.
- - Function: x:install-colormap COLORMAP
+ - Function: x:install-colormap colormap
Installs the specified COLORMAP for its associated screen. All
windows associated with COLORMAP immediately display with true
colors. A colormap is associated with a window when the window is
@@ -1340,21 +1495,24 @@ blue intensities respectively. The integers are in the range 0 - 65535.
has that colormap.
+ - Function: x:ccc colormap
+ Returns the Color-Conversion-Context of COLORMAP.
+

-File: Xlibscm.info, Node: Rendering, Next: Event, Prev: Colormap, Up: Top
+File: Xlibscm.info, Node: Rendering, Next: Images, Prev: Colormap, Up: Top
Rendering
*********
- - Function: x:flush DISPLAY
- - Function: x:flush WINDOW
+ - Function: x:flush display
+ - Function: x:flush window
Flushes the output buffer. Some client applications need not use
this function because the output buffer is automatically flushed
as needed by calls to X:Pending, X:Next-Event, and X:Window-Event.
Events generated by the server may be enqueued into the library's
event queue.
- - Function: x:flush GC
+ - Function: x:flush gc
Forces sending of GC component changes.
Xlib usually defers sending changes to the components of a GC to
@@ -1366,7 +1524,7 @@ Rendering
the GC indirectly, in such a way that the extension interface
cannot know what GC will be used.
- - Function: x:clear-area WINDOW (X-POS Y-POS) (WIDTH HEIGHT) EXPOSE?
+ - Function: x:clear-area window (x-pos y-pos) (width height) expose?
Paints a rectangular area in the specified WINDOW according to the
specified dimensions with the WINDOW's background pixel or pixmap.
The subwindow-mode effectively is `x:Clip-By-Children'. If width
@@ -1380,35 +1538,35 @@ Rendering
are either visible or are being retained in a backing store. If
you specify a WINDOW whose class is x:Input-Only, an error results.
- - Function: x:fill-rectangle WINDOW GCONTEXT POSITION SIZE
+ - Function: x:fill-rectangle window gcontext position size
Draw Strings
============
- - Function: x:draw-string DRAWABLE GC POSITION STRING
+ - Function: x:draw-string drawable gc position string
POSITION specifies coordinates relative to the origin of DRAWABLE
of the origin of the first character to be drawn.
`x:draw-string' draws the characters of STRING, starting at
POSITION.
- - Function: x:image-string DRAWABLE GC POSITION STRING
+ - Function: x:image-string drawable gc position string
POSITION specifies coordinates relative to the origin of DRAWABLE
of the origin of the first character to be drawn.
- `x:image-string' draws the characters *and background* of STRING,
+ `x:image-string' draws the characters _and background_ of STRING,
starting at POSITION.
Draw Shapes
===========
- - Function: x:draw-points DRAWABLE GC POSITION ...
+ - Function: x:draw-points drawable gc position ...
POSITION ... specifies coordinates of the point to be drawn.
- - Function: x:draw-points DRAWABLE GC X Y ...
+ - Function: x:draw-points drawable gc x y ...
(X, Y) ... specifies coordinates of the point to be drawn.
- - Function: x:draw-points DRAWABLE GC POINT-ARRAY
+ - Function: x:draw-points drawable gc point-array
POINT-ARRAY is a uniform short array of rank 2, whose rightmost
index spans a range of 2.
@@ -1420,14 +1578,14 @@ Draw Shapes
foreground, subwindow-mode, clip-x-origin, clip-y-origin, and
clip-mask.
- - Function: x:draw-segments DRAWABLE GC POS1 POS2 ...
+ - Function: x:draw-segments drawable gc pos1 pos2 ...
POS1, POS2, ... specify coordinates to be connected by segments.
- - Function: x:draw-segments DRAWABLE GC X1 Y1 X2 Y2 ...
+ - Function: x:draw-segments drawable gc x1 y1 x2 y2 ...
(X1, Y1), (X2, Y2) ... specify coordinates to be connected by
segments.
- - Function: x:draw-segments DRAWABLE GC POINT-ARRAY
+ - Function: x:draw-segments drawable gc point-array
POINT-ARRAY is a uniform short array of rank 2, whose rightmost
index spans a range of 2.
@@ -1450,14 +1608,14 @@ Draw Shapes
tile, stipple, tilestipple-x-origin, tile-stipple-y-origin,
dash-offset, and dash-list.
- - Function: x:draw-lines DRAWABLE GC POS1 POS2 ...
+ - Function: x:draw-lines drawable gc pos1 pos2 ...
POS1, POS2, ... specify coordinates to be connected by lines.
- - Function: x:draw-lines DRAWABLE GC X1 Y1 X2 Y2 ...
+ - Function: x:draw-lines drawable gc x1 y1 x2 y2 ...
(X1, Y1), (X2, Y2) ... specify coordinates to be connected by
lines.
- - Function: x:draw-lines DRAWABLE GC POINT-ARRAY
+ - Function: x:draw-lines drawable gc point-array
POINT-ARRAY is a uniform short array of rank 2, whose rightmost
index spans a range of 2.
@@ -1481,13 +1639,13 @@ Draw Shapes
tile, stipple, tilestipple-x-origin, tile-stipple-y-origin,
dash-offset, and dash-list.
- - Function: x:fill-polygon DRAWABLE GC POS1 POS2 ...
+ - Function: x:fill-polygon drawable gc pos1 pos2 ...
POS1, POS2, ... specify coordinates of the border path.
- - Function: x:fill-polygon DRAWABLE GC X1 Y1 X2 Y2 ...
+ - Function: x:fill-polygon drawable gc x1 y1 x2 y2 ...
(X1, Y1), (X2, Y2) ... specify coordinates of the border path.
- - Function: x:fill-polygon DRAWABLE GC POINT-ARRAY
+ - Function: x:fill-polygon drawable gc point-array
POINT-ARRAY is a uniform short array of rank 2, whose rightmost
index spans a range of 2.
@@ -1507,7 +1665,15 @@ Draw Shapes
tile-stipple-x-origin, and tile-stipple-y-origin.

-File: Xlibscm.info, Node: Event, Next: Index, Prev: Rendering, Up: Top
+File: Xlibscm.info, Node: Images, Next: Event, Prev: Rendering, Up: Top
+
+Images
+******
+
+ - Function: x:read-bitmap-file drawable file
+
+
+File: Xlibscm.info, Node: Event, Next: Index, Prev: Images, Up: Top
Event
*****
@@ -1515,16 +1681,16 @@ Event
These three status routines always return immediately if there are
events already in the queue.
- - Function: x:q-length DISPLAY
+ - Function: x:q-length display
Returns the length of the event queue for the connected DISPLAY.
Note that there may be more events that have not been read into the
queue yet (see X:Events-Queued).
- - Function: x:pending DISPLAY
+ - Function: x:pending display
Returns the number of events that have been received from the X
server but have not been removed from the event queue.
- - Function: x:events-queued DISPLAY
+ - Function: x:events-queued display
Returns the number of events already in the queue if the number is
nonzero. If there are no events in the queue, `X:Events-Queued'
attempts to read more events out of the application's connection
@@ -1532,12 +1698,12 @@ events already in the queue.
Both of these routines return an object of type "event".
- - Function: x:next-event DISPLAY
+ - Function: x:next-event display
Removes and returns the first event from the event queue. If the
event queue is empty, `X:Next-Event' flushes the output buffer and
blocks until an event is received.
- - Function: x:peek-event DISPLAY
+ - Function: x:peek-event display
Returns the first event from the event queue, but it does not
remove the event from the queue. If the queue is empty,
`X:Peek-Event' flushes the output buffer and blocks until an event
@@ -1545,206 +1711,206 @@ Both of these routines return an object of type "event".
Each event object has fields dependent on its sub-type.
- - Function: x:event-ref EVENT FIELD-NAME
- window The window on which EVENT was generated
- and is referred to as the event window.
- root is the event window's root window.
- subwindow If the source window is an inferior of
- the event window, the SUBWINDOW is the
- child of the event window that is the
- source window or the child of the event
- window that is an ancestor of the
- source window. Otherwise, `None'.
- X-event:type An integer: X:KEY-PRESS, X:KEY-RELEASE,
- X:BUTTON-PRESS, X:BUTTON-RELEASE,
- X:MOTION-NOTIFY, X:ENTER-NOTIFY,
- X:LEAVE-NOTIFY, X:FOCUS-IN,
- X:FOCUS-OUT, X:KEYMAP-NOTIFY, X:EXPOSE,
- X:GRAPHICS-EXPOSE, X:NO-EXPOSE,
- X:VISIBILITY-NOTIFY, X:CREATE-NOTIFY,
- X:DESTROY-NOTIFY, X:UNMAP-NOTIFY,
- X:MAP-NOTIFY, X:MAP-REQUEST,
- X:REPARENT-NOTIFY, X:CONFIGURE-NOTIFY,
- X:CONFIGURE-REQUEST, X:GRAVITY-NOTIFY,
- X:RESIZE-REQUEST, X:CIRCULATE-NOTIFY,
- X:CIRCULATE-REQUEST, X:PROPERTY-NOTIFY,
- X:SELECTION-CLEAR, X:SELECTION-REQUEST,
- X:SELECTION-NOTIFY, X:COLORMAP-NOTIFY,
- X:CLIENT-MESSAGE, or X:MAPPING-NOTIFY.
- X-event:serial The serial number of the protocol
- request that generated the EVENT.
- X-event:send-event Boolean that indicates whether the
- event was sent by a different client.
- X-event:time The time when the EVENT was generated
- expressed in milliseconds.
- X-event:x
- X-event:y For window entry/exit events the X and
- Y members are set to the coordinates of
- the pointer position in the event
- window. This position is always the
- pointer's final position, not its
- initial position. If the event window
- is on the same screen as the root
- window, X and Y are the pointer
- coordinates relative to the event
- window's origin. Otherwise, X and Y
- are set to zero.
-
- For expose events The X and Y members
- are set to the coordinates relative to
- the drawable's origin and indicate the
- upper-left corner of the rectangle.
-
- For configure, create, gravity, and
- reparent events the X and Y members are
- set to the window's coordinates
- relative to the parent window's origin
- and indicate the position of the
- upper-left outside corner of the
- created window.
- X-event:x-root
- X-event:y-root The pointer's coordinates relative to
- the root window's origin at the time of
- the EVENT.
- X-event:state For keyboard, pointer and window
- entry/exit events, the state member is
- set to indicate the logical state of
- the pointer buttons and modifier keys
- just prior to the EVENT, which is the
- bitwise inclusive OR of one or more of
- the button or modifier key masks:
- X:BUTTON1-MASK, X:BUTTON2-MASK,
- X:BUTTON3-MASK, X:BUTTON4-MASK,
- X:BUTTON5-MASK, X:SHIFT-MASK,
- X:LOCK-MASK, X:CONTROL-MASK,
- X:MOD1-MASK, X:MOD2-MASK, X:MOD3-MASK,
- X:MOD4-MASK, and X:MOD5-MASK.
-
- For visibility events, the state of the
- window's visibility:
- X:VISIBILITY-UNOBSCURED,
- X:VISIBILITY-PARTIALLY-OBSCURED, or
- X:VISIBILITY-FULLY-OBSCURED.
-
- For colormap events, indicates whether
- the colormap is installed or
- uninstalled: x:Colormap-Installed or
- x:Colormap-Uninstalled.
-
- For property events, indicates whether
- the property was changed to a new value
- or deleted: x:Property-New-Value or
- x:Property-Delete.
- X-event:keycode An integer that represents a physical
- key on the keyboard.
- X-event:same-screen Indicates whether the event window is
- on the same screen as the root window.
- If #t, the event and root windows are
- on the same screen. If #f, the event
- and root windows are not on the same
- screen.
- X-event:button The pointer button that changed state;
- can be the X:BUTTON1, X:BUTTON2,
- X:BUTTON3, X:BUTTON4, or X:BUTTON5
- value.
- X-event:is-hint Detail of motion-notify events:
- X:NOTIFY-NORMAL or X:NOTIFY-HINT.
- X-event:mode Indicates whether the EVENT is a normal
- event, pseudo-motion event when a grab
- activates, or a pseudo-motion event
- when a grab deactivates:
- X:NOTIFY-NORMAL, X:NOTIFY-GRAB, or
- X:NOTIFY-UNGRAB.
- X-event:detail Indicates the notification detail:
- X:NOTIFY-ANCESTOR, X:NOTIFY-VIRTUAL,
- X:NOTIFY-INFERIOR, X:NOTIFY-NONLINEAR,
- or X:NOTIFY-NONLINEAR-VIRTUAL.
- X-event:focus If the event window is the focus window
- or an inferior of the focus window, #t;
- otherwise #f.
- X-event:width
- X-event:height The size (extent) of the rectangle.
- X-event:count For mapping events is the number of
- keycodes altered.
-
- For expose events Is the number of
- Expose or GraphicsExpose events that
- are to follow. If count is zero, no
- more Expose events follow for this
- window. However, if count is nonzero,
- at least that number of Expose events
- (and possibly more) follow for this
- window. Simple applications that do
- not want to optimize redisplay by
- distinguishing between subareas of its
- window can just ignore all Expose
- events with nonzero counts and perform
- full redisplays on events with zero
- counts.
- X-event:major-code The major_code member is set to the
- graphics request initiated by the
- client and can be either X_CopyArea or
- X_CopyPlane. If it is X_CopyArea, a
- call to XCopyArea initiated the
- request. If it is X_CopyPlane, a call
- to XCopyPlane initiated the request.
- X-event:minor-code Not currently used.
- X-event:border-width For configure events, the width of the
- window's border, in pixels.
- X-event:override-redirect The override-redirect attribute of the
- window. Window manager clients
- normally should ignore this window if
- it is #t.
- X-event:from-configure True if the event was generated as a
- result of a resizing of the window's
- parent when the window itself had a
- win-gravity of x:Unmap-Gravity.
- X-event:value-mask Indicates which components were
- specified in the ConfigureWindow
- protocol request. The corresponding
- values are reported as given in the
- request. The remaining values are
- filled in from the current geometry of
- the window, except in the case of above
- (sibling) and detail (stack-mode),
- which are reported as None and Above,
- respectively, if they are not given in
- the request.
- X-event:place The window's position after the restack
- occurs and is either x:Place-On-Top or
- x:Place-On-Bottom. If it is
- x:Place-On-Top, the window is now on
- top of all siblings. If it is
- x:Place-On-Bottom, the window is now
- below all siblings.
- X-event:new indicate whether the colormap for the
- specified window was changed or
- installed or uninstalled and can be
- True or False. If it is True, the
- colormap was changed. If it is False,
- the colormap was installed or
- uninstalled.
- X-event:format Is 8, 16, or 32 and specifies whether
- the data should be viewed as a list of
- bytes, shorts, or longs
- X-event:request Indicates the kind of mapping change
- that occurred and can be
- X:MAPPING-MODIFIER, X:MAPPING-KEYBOARD,
- or X:MAPPING-POINTER. If it is
- X:MAPPING-MODIFIER, the modifier
- mapping was changed. If it is
- X:MAPPING-KEYBOARD, the keyboard
- mapping was changed. If it is
- X:MAPPING-POINTER, the pointer button
- mapping was changed.
- X-event:first-keycode The X-event:first-keycode is set only
- if the X-event:request was set to
- X:MAPPING-KEYBOARD. The number in
- X-event:first-keycode represents the
- first number in the range of the
- altered mapping, and X-event:count
- represents the number of keycodes
- altered.
+ - Function: x:event-ref event field-name
+ window The window on which EVENT was generated
+ and is referred to as the event window.
+ root is the event window's root window.
+ subwindow If the source window is an inferior of
+ the event window, the SUBWINDOW is the
+ child of the event window that is the
+ source window or the child of the event
+ window that is an ancestor of the
+ source window. Otherwise, `None'.
+ X-event:type An integer: X:KEY-PRESS, X:KEY-RELEASE,
+ X:BUTTON-PRESS, X:BUTTON-RELEASE,
+ X:MOTION-NOTIFY, X:ENTER-NOTIFY,
+ X:LEAVE-NOTIFY, X:FOCUS-IN,
+ X:FOCUS-OUT, X:KEYMAP-NOTIFY, X:EXPOSE,
+ X:GRAPHICS-EXPOSE, X:NO-EXPOSE,
+ X:VISIBILITY-NOTIFY, X:CREATE-NOTIFY,
+ X:DESTROY-NOTIFY, X:UNMAP-NOTIFY,
+ X:MAP-NOTIFY, X:MAP-REQUEST,
+ X:REPARENT-NOTIFY, X:CONFIGURE-NOTIFY,
+ X:CONFIGURE-REQUEST, X:GRAVITY-NOTIFY,
+ X:RESIZE-REQUEST, X:CIRCULATE-NOTIFY,
+ X:CIRCULATE-REQUEST, X:PROPERTY-NOTIFY,
+ X:SELECTION-CLEAR, X:SELECTION-REQUEST,
+ X:SELECTION-NOTIFY, X:COLORMAP-NOTIFY,
+ X:CLIENT-MESSAGE, or X:MAPPING-NOTIFY.
+ X-event:serial The serial number of the protocol
+ request that generated the EVENT.
+ X-event:send-event Boolean that indicates whether the
+ event was sent by a different client.
+ X-event:time The time when the EVENT was generated
+ expressed in milliseconds.
+ X-event:x
+ X-event:y For window entry/exit events the X and
+ Y members are set to the coordinates of
+ the pointer position in the event
+ window. This position is always the
+ pointer's final position, not its
+ initial position. If the event window
+ is on the same screen as the root
+ window, X and Y are the pointer
+ coordinates relative to the event
+ window's origin. Otherwise, X and Y
+ are set to zero.
+
+ For expose events The X and Y members
+ are set to the coordinates relative to
+ the drawable's origin and indicate the
+ upper-left corner of the rectangle.
+
+ For configure, create, gravity, and
+ reparent events the X and Y members are
+ set to the window's coordinates
+ relative to the parent window's origin
+ and indicate the position of the
+ upper-left outside corner of the
+ created window.
+ X-event:x-root
+ X-event:y-root The pointer's coordinates relative to
+ the root window's origin at the time of
+ the EVENT.
+ X-event:state For keyboard, pointer and window
+ entry/exit events, the state member is
+ set to indicate the logical state of
+ the pointer buttons and modifier keys
+ just prior to the EVENT, which is the
+ bitwise inclusive OR of one or more of
+ the button or modifier key masks:
+ X:BUTTON1-MASK, X:BUTTON2-MASK,
+ X:BUTTON3-MASK, X:BUTTON4-MASK,
+ X:BUTTON5-MASK, X:SHIFT-MASK,
+ X:LOCK-MASK, X:CONTROL-MASK,
+ X:MOD1-MASK, X:MOD2-MASK, X:MOD3-MASK,
+ X:MOD4-MASK, and X:MOD5-MASK.
+
+ For visibility events, the state of the
+ window's visibility:
+ X:VISIBILITY-UNOBSCURED,
+ X:VISIBILITY-PARTIALLY-OBSCURED, or
+ X:VISIBILITY-FULLY-OBSCURED.
+
+ For colormap events, indicates whether
+ the colormap is installed or
+ uninstalled: x:Colormap-Installed or
+ x:Colormap-Uninstalled.
+
+ For property events, indicates whether
+ the property was changed to a new value
+ or deleted: x:Property-New-Value or
+ x:Property-Delete.
+ X-event:keycode An integer that represents a physical
+ key on the keyboard.
+ X-event:same-screen Indicates whether the event window is
+ on the same screen as the root window.
+ If #t, the event and root windows are
+ on the same screen. If #f, the event
+ and root windows are not on the same
+ screen.
+ X-event:button The pointer button that changed state;
+ can be the X:BUTTON1, X:BUTTON2,
+ X:BUTTON3, X:BUTTON4, or X:BUTTON5
+ value.
+ X-event:is-hint Detail of motion-notify events:
+ X:NOTIFY-NORMAL or X:NOTIFY-HINT.
+ X-event:mode Indicates whether the EVENT is a normal
+ event, pseudo-motion event when a grab
+ activates, or a pseudo-motion event
+ when a grab deactivates:
+ X:NOTIFY-NORMAL, X:NOTIFY-GRAB, or
+ X:NOTIFY-UNGRAB.
+ X-event:detail Indicates the notification detail:
+ X:NOTIFY-ANCESTOR, X:NOTIFY-VIRTUAL,
+ X:NOTIFY-INFERIOR, X:NOTIFY-NONLINEAR,
+ or X:NOTIFY-NONLINEAR-VIRTUAL.
+ X-event:focus If the event window is the focus window
+ or an inferior of the focus window, #t;
+ otherwise #f.
+ X-event:width
+ X-event:height The size (extent) of the rectangle.
+ X-event:count For mapping events is the number of
+ keycodes altered.
+
+ For expose events Is the number of
+ Expose or GraphicsExpose events that
+ are to follow. If count is zero, no
+ more Expose events follow for this
+ window. However, if count is nonzero,
+ at least that number of Expose events
+ (and possibly more) follow for this
+ window. Simple applications that do
+ not want to optimize redisplay by
+ distinguishing between subareas of its
+ window can just ignore all Expose
+ events with nonzero counts and perform
+ full redisplays on events with zero
+ counts.
+ X-event:major-code The major_code member is set to the
+ graphics request initiated by the
+ client and can be either X_CopyArea or
+ X_CopyPlane. If it is X_CopyArea, a
+ call to XCopyArea initiated the
+ request. If it is X_CopyPlane, a call
+ to XCopyPlane initiated the request.
+ X-event:minor-code Not currently used.
+ X-event:border-width For configure events, the width of the
+ window's border, in pixels.
+ X-event:override-redirect The override-redirect attribute of the
+ window. Window manager clients
+ normally should ignore this window if
+ it is #t.
+ X-event:from-configure True if the event was generated as a
+ result of a resizing of the window's
+ parent when the window itself had a
+ win-gravity of x:Unmap-Gravity.
+ X-event:value-mask Indicates which components were
+ specified in the ConfigureWindow
+ protocol request. The corresponding
+ values are reported as given in the
+ request. The remaining values are
+ filled in from the current geometry of
+ the window, except in the case of above
+ (sibling) and detail (stack-mode),
+ which are reported as None and Above,
+ respectively, if they are not given in
+ the request.
+ X-event:place The window's position after the restack
+ occurs and is either x:Place-On-Top or
+ x:Place-On-Bottom. If it is
+ x:Place-On-Top, the window is now on
+ top of all siblings. If it is
+ x:Place-On-Bottom, the window is now
+ below all siblings.
+ X-event:new indicate whether the colormap for the
+ specified window was changed or
+ installed or uninstalled and can be
+ True or False. If it is True, the
+ colormap was changed. If it is False,
+ the colormap was installed or
+ uninstalled.
+ X-event:format Is 8, 16, or 32 and specifies whether
+ the data should be viewed as a list of
+ bytes, shorts, or longs
+ X-event:request Indicates the kind of mapping change
+ that occurred and can be
+ X:MAPPING-MODIFIER, X:MAPPING-KEYBOARD,
+ or X:MAPPING-POINTER. If it is
+ X:MAPPING-MODIFIER, the modifier
+ mapping was changed. If it is
+ X:MAPPING-KEYBOARD, the keyboard
+ mapping was changed. If it is
+ X:MAPPING-POINTER, the pointer button
+ mapping was changed.
+ X-event:first-keycode The X-event:first-keycode is set only
+ if the X-event:request was set to
+ X:MAPPING-KEYBOARD. The number in
+ X-event:first-keycode represents the
+ first number in the range of the
+ altered mapping, and X-event:count
+ represents the number of keycodes
+ altered.

File: Xlibscm.info, Node: Index, Prev: Event, Up: Top
@@ -1757,11 +1923,12 @@ Xlibscm.
* Menu:
-* hostname:number.screen-number: Display.
+* hostname:number.screen-number: Display and Screens.
* x:alloc-colormap-cells: Colormap.
+* x:ccc: Colormap.
* x:clear-area: Rendering.
-* x:close <1>: Window.
-* x:close: Display.
+* x:close <1>: Windows and Pixmaps.
+* x:close: Display and Screens.
* x:color-ref: Colormap.
* X:Color-Set!: Colormap.
* x:colormap-find-color: Colormap.
@@ -1770,13 +1937,13 @@ Xlibscm.
* x:create-colormap: Colormap.
* x:create-cursor: Cursor.
* x:create-gc: Graphics Context.
-* x:create-pixmap: Window.
-* x:create-window: Window.
-* x:default-colormap: Screen.
-* x:default-depths: Screen.
-* x:default-gc: Screen.
-* x:default-screen: Screen.
-* x:default-visual: Screen.
+* x:create-pixmap: Windows and Pixmaps.
+* x:create-window: Windows and Pixmaps.
+* x:default-ccc: Display and Screens.
+* x:default-colormap: Display and Screens.
+* x:default-gc: Display and Screens.
+* x:default-screen: Display and Screens.
+* x:default-visual: Display and Screens.
* x:draw-lines: Rendering.
* x:draw-points: Rendering.
* x:draw-segments: Rendering.
@@ -1789,32 +1956,39 @@ Xlibscm.
* x:free-colormap-cells: Colormap.
* x:gc-ref: Graphics Context.
* x:gc-set!: Graphics Context.
+* x:get-window-property: Window Properties and Visibility.
* x:image-string: Rendering.
* x:install-colormap: Colormap.
-* x:make-visual: Screen.
-* x:map-raised: Window Visibility.
-* x:map-subwindows: Window Visibility.
-* x:map-window: Window Visibility.
+* x:list-properties: Window Properties and Visibility.
+* x:make-visual: Display and Screens.
+* x:map-subwindows: Window Properties and Visibility.
+* x:map-window: Window Properties and Visibility.
* x:next-event: Event.
-* x:open-display: Display.
+* x:open-display: Display and Screens.
* x:peek-event: Event.
* x:pending: Event.
-* x:protocol-version: Display.
+* x:protocol-version: Display and Screens.
* x:q-length: Event.
-* x:root-window: Screen.
-* x:screen-black: Screen.
-* x:screen-cells: Screen.
-* x:screen-count: Screen.
-* x:screen-depth: Screen.
-* x:screen-dimensions: Screen.
-* x:screen-size: Screen.
-* x:screen-white: Screen.
-* x:server-vendor: Display.
-* x:unmap-subwindows: Window Visibility.
-* x:unmap-window: Window Visibility.
-* x:vendor-release: Display.
-* x:window-geometry: Window.
-* x:window-set!: Window.
+* x:read-bitmap-file: Images.
+* x:root-window: Display and Screens.
+* x:screen-black: Display and Screens.
+* x:screen-cells: Display and Screens.
+* x:screen-count: Display and Screens.
+* x:screen-depth: Display and Screens.
+* x:screen-depths: Display and Screens.
+* x:screen-dimensions: Display and Screens.
+* x:screen-size: Display and Screens.
+* x:screen-white: Display and Screens.
+* x:server-vendor: Display and Screens.
+* x:unmap-subwindows: Window Properties and Visibility.
+* x:unmap-window: Window Properties and Visibility.
+* x:vendor-release: Display and Screens.
+* x:visual-class: Display and Screens.
+* x:visual-geometry: Display and Screens.
+* x:window-geometry: Windows and Pixmaps.
+* x:window-geometry-set!: Windows and Pixmaps.
+* x:window-ref: Window Attributes.
+* x:window-set!: Window Attributes.
Variable Index
**************
@@ -1823,21 +1997,28 @@ This is an alphabetical list of all the global variables in Xlibscm.
* Menu:
-* x:CW-Back-Pixel: Window.
-* x:CW-Back-Pixmap: Window.
-* x:CW-Backing-Pixel: Window.
-* x:CW-Backing-Planes: Window.
-* x:CW-Backing-Store: Window.
-* x:CW-Bit-Gravity: Window.
-* x:CW-Border-Pixel: Window.
-* x:CW-Border-Pixmap: Window.
-* x:CW-Colormap: Window.
-* x:CW-Cursor: Window.
-* x:CW-Dont-Propagate: Window.
-* x:CW-Event-Mask: Window.
-* x:CW-Override-Redirect: Window.
-* x:CW-Save-Under: Window.
-* x:CW-Win-Gravity: Window.
+* x:CW-Back-Pixel: Window Attributes.
+* x:CW-Back-Pixmap: Window Attributes.
+* x:CW-Backing-Pixel: Window Attributes.
+* x:CW-Backing-Planes: Window Attributes.
+* x:CW-Backing-Store: Window Attributes.
+* x:CW-Bit-Gravity: Window Attributes.
+* x:CW-Border-Pixel: Window Attributes.
+* x:CW-Border-Pixmap: Window Attributes.
+* x:CW-Border-Width: Windows and Pixmaps.
+* x:CW-Colormap: Window Attributes.
+* x:CW-Cursor: Window Attributes.
+* x:CW-Dont-Propagate: Window Attributes.
+* x:CW-Event-Mask: Window Attributes.
+* x:CW-Height: Windows and Pixmaps.
+* x:CW-Override-Redirect: Window Attributes.
+* x:CW-Save-Under: Window Attributes.
+* x:CW-Sibling: Windows and Pixmaps.
+* x:CW-Stack-Mode: Windows and Pixmaps.
+* x:CW-Width: Windows and Pixmaps.
+* x:CW-Win-Gravity: Window Attributes.
+* x:CWX: Windows and Pixmaps.
+* x:CWY: Windows and Pixmaps.
* x:GC-Arc-Mode: Graphics Context.
* x:GC-Background: Graphics Context.
* x:GC-Cap-Style: Graphics Context.
@@ -1871,17 +2052,17 @@ Concept Index
* colormap: Colormap.
* cursor: Cursor.
-* depth: Screen.
-* drawable: Window.
-* Drawable: Window.
-* map: Window Visibility.
-* mapped: Window Visibility.
+* depth: Display and Screens.
+* drawable: Drawables.
+* Drawable: Drawables.
+* map: Window Properties and Visibility.
+* mapped: Window Properties and Visibility.
* none: Graphics Context.
* RGB: Colormap.
-* unmap: Window Visibility.
-* unmapped: Window Visibility.
-* Visual: Screen.
-* visual: Screen.
+* unmap: Window Properties and Visibility.
+* unmapped: Window Properties and Visibility.
+* Visual: Display and Screens.
+* visual: Display and Screens.
* X: Xlibscm.
* x:None: Graphics Context.
* Xlib: Xlibscm.
@@ -1889,17 +2070,19 @@ Concept Index

Tag Table:
-Node: Top241
-Node: Xlibscm1366
-Node: Display4144
-Node: Screen6776
-Node: Window10533
-Node: Window Visibility30412
-Node: Graphics Context34697
-Node: Cursor50412
-Node: Colormap52915
-Node: Rendering62691
-Node: Event70247
-Node: Index86684
+Node: Top215
+Node: Xlibscm1333
+Node: Display and Screens4123
+Node: Drawables11108
+Node: Windows and Pixmaps11369
+Node: Window Attributes18448
+Node: Window Properties and Visibility34428
+Node: Graphics Context38885
+Node: Cursor54592
+Node: Colormap57095
+Node: Rendering66961
+Node: Images74518
+Node: Event74659
+Node: Index89134

End Tag Table