procedure optwindow: open window with options
link optwindw
October 10, 1997; Gregg M. Townsend
Requires: Version 9 graphics
This file is in the public domain.
optwindow() opens a window, interpreting command options to
set various window attributes.
____________________________________________________________
optwindow(opttable, attribute...) -- open window based on option table
optwindow returns a new X-window configured according to a table of
options such as that returned by options(). If a window cannot be
opened, the program is aborted.
If any attribute arguments are supplied they are passed to the open call
ahead of anything generated from the option table.
In general, upper-case letters are used for generic window options, and
any letters not listed below are reserved for future use. This leaves
the lower-case letters for program-specific options.
The following options are recognized:
-B color background color default: "pale gray"
-F color foreground color default: "black"
-L label window label (title) default: &progname (trimmed)
-T font text font default: unspecified
-D display window device default: unspecified
-X xpos x position default: unspecified
-Y ypos y position default: unspecified
-W width window width default: 500
-H height window height default: 300
-M margin frame margin default: 0
-S width,height window size default: 500,300 + margins
-P xpos,ypos window position default: unspecified
-G [wxh][+x+y] geometry, in usual X terms (but NOTE: no negative x | y)
-! echo the window creation call on stderr (for debugging)
-G is translated into -X -Y -W -H and overrides those values.
-P and -S override values from -G, -X, -Y, -W, and -H.
Table values for {B,F,L,X,Y,W,H,M,P,S} are guaranteed to be set upon return.
The "margin" is the internal border between the actual window frame and the
area used for display; you don't usually want to write right up to the edge.
If a negative value is given for -M, a standard margin of 10 pixels is set.
-M is added twice (for two margins) to -W and -H when calculating the actual
window size so that -W and -H reflect the actual usable area. If -W and -H
are derived from -G, which specifies actual window sizes, -M is twice
subtracted so that -W and -H always reflect the usable dimensions.
winoptions() can be used to combine the above options with other options
for the options() call.
Example:
# get option table; allow standard options plus "-f filename"
opts := options(args, winoptions() || "f:")
# set defaults if not given explicitly
/opts["W"] := 400 # usable width
/opts["H"] := 400 # usable height
# open the window
win := optwindow(opts, "cursor=off")
# save actual values given by the window manager
h := opts["H"] # usable height
w := opts["W"] # usable width
m := opts["M"] # specified margin
(The usable area, then, is from (m,m) to (m+w, m+h).