Chapter 3. Methods


method: (activate inst)
method: (send inst activate)
returns: unspecified

Redisplays the button using the "active-foreground" color (so it looks as it would if the mouse were over the widget). At present it has no effect if the button has been disabled. (This seems to be of pretty limited usefulness).

classes: <button>, <checkbutton>, and <radiobutton>



method: (activate inst menu)
method: (send inst activate menu)
returns: unspecified

Activate menu.

classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, <radio-menu-item>, and <separator-menu-item>



method: (add-follower inst widget)
method: (send inst add-follower widget)
returns: unspecified

Adds the specified widget to the list of widgets following this widget. When the show, hide, or destroy message is sent to this instance, the message is also forwarded to each of the followers.

classes: <toplevel>



method: (add-offset inst pos disp)
method: (send inst add-offset pos disp)
returns: see below

Returns a new pair scheme(column . line) that refers to a new position whose character offset relative to pos is given by disp. Negative offsets are permitted. pos is either a pair or an instance of <fixed-mark> or <floating-mark>.

classes: <text>



method: (apply-markup inst txt index1 index2)
method: (send inst apply-markup txt index1 index2)
returns: unspecified

applies the given markup to the range of text beginning at index1 and ending at index2 within the text widget txt. Subsequent operations on the markup affect this region of text until the markup is removed, or that text is deleted from the widget.

classes: <markup>



method: (bounding-box inst)
method: (send inst bounding-box)
returns: list

Returns a list of the coordinates giving the bounding box of this figure on the canvas.

classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle>



method: (bounding-box inst pos)
method: (send inst bounding-box pos)
returns: see below

Returns a list of four values describing the bounding box of the character at the position pos, or #f if the character is not visible on screen. The first two values give the x- and y- coordinates of the top left corner of the area occupied by the character. The last two values describe the width and height of that area.

classes: <text>



method: (claim-selection inst selection notify-proc)
method: (send inst claim-selection selection notify-proc)
returns: unspecified

Make this widget the owner of the specified selection and notify the previous owner of that selection (if any) that it has lost ownership. When this widget loses the selection, invoke the given notify thunk. When a widget claims ownership of the primary selection, the currently (or subsequently) selected contents of the widget are then available via swl:get-selection. See also swl:clear-selection.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (clear-selection inst)
method: (send inst clear-selection)
returns: unspecified

clears the selection if anything in this widget is selected.

classes: <text> De-selects all items in the listbox. classes: <listbox> clears the selection if anything in this widget is selected. classes: <entry>



method: (clear-selection inst index)
method: (send inst clear-selection index)
returns: unspecified

De-selects the item at the given index

classes: <listbox>



method: (clear-selection inst index1 index2)
method: (send inst clear-selection index1 index2)
returns: unspecified

De-selects the items between index1 and index2 inclusive

classes: <listbox>



method: (configure inst width height)
method: (send inst configure width height)
returns: unspecified

When resized, a widget is notified of its width and height by this method.

classes: <arc>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <line>, <listbox>, <menu>, <option-button>, <oval>, <polygon>, <radiobutton>, <rectangle>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (cursor-bof? inst)
method: (send inst cursor-bof?)
returns: boolean

Returns true if the insertion cursor is at the beginning of the text buffer.

classes: <text>



method: (cursor-bol inst)
method: (send inst cursor-bol)
returns: unspecified

Moves the insertion cursor to the beginning of the line.

classes: <text> Moves the insertion cursor to the beginning of the entry. classes: <entry>



method: (cursor-bol? inst)
method: (send inst cursor-bol?)
returns: boolean

Returns true if the insertion cursor is at the beginning of a line.

classes: <text> Returns true if the insertion cursor is at the beginning of the string displayed in the entry. classes: <entry>



method: (cursor-eof? inst)
method: (send inst cursor-eof?)
returns: boolean

Returns true if the insertion cursor is at the end of the text buffer.

classes: <text> Returns true if the insertion cursor is at the end of the text buffer. classes: <entry>



method: (cursor-eol inst)
method: (send inst cursor-eol)
returns: unspecified

Moves the insertion cursor to the end of the line.

classes: <text> Moves the insertion cursor to the end of the entry. classes: <entry>



method: (cursor-eol? inst)
method: (send inst cursor-eol?)
returns: boolean

Returns true if the insertion cursor is at the end of a line.

classes: <text> Returns true if the insertion cursor is at the end of the string displayed in the entry. classes: <entry>



method: (deactivate inst)
method: (send inst deactivate)
returns: unspecified

Redisplays the button using the "normal-foreground" color (so it looks as it would if the mouse were not over the widget). At present it has no effect if the button has been disabled. (This seems to be of pretty limited usefulness).

classes: <button>, <checkbutton>, and <radiobutton>



method: (deactivate inst menu)
method: (send inst deactivate menu)
returns: unspecified

Deactivates the menu item.

classes: <cascade-menu-item> Deactivate menu. classes: <check-menu-item>, <command-menu-item>, <radio-menu-item>, and <separator-menu-item>



method: (delete inst index1)
method: (send inst delete index1)
returns: unspecified

Deletes the character at index1.

classes: <text> Deletes the item with index item. classes: <listbox> deletes the character if any at index first in the entry. classes: <entry>



method: (delete inst index1 index2)
method: (send inst delete index1 index2)
returns: unspecified

Deletes characters in the range specified by index1 and index2 (inclusive).

classes: <text> Deletes the elements in the range from first to last. classes: <listbox> deletes the characters in the range of first to last (inclusive). classes: <entry>



method: (delete-all inst)
method: (send inst delete-all)
returns: unspecified

Deletes all characters in the widget.

classes: <text> deletes all the items in the listbox. classes: <listbox> Deletes all characters in the widget. classes: <entry>



method: (delete-char inst disp)
method: (send inst delete-char disp)
returns: unspecified

Deletes the characters between the cursor position and the given displacement.

classes: <text> Deletes the character at the given offset in the <entry>. classes: <entry>



method: (delete-eol inst)
method: (send inst delete-eol)
returns: unspecified

Deletes characters from current cursor position to the end of the line.

classes: <text> Deletes characters from current insert position to end of line. classes: <entry>



method: (delete-selection-at-cursor inst)
method: (send inst delete-selection-at-cursor)
returns: unspecified

Deletes the selected text, if any, surrounding the cursor.

classes: <text> Deletes the selected text, if any, surrounding the cursor. classes: <entry>



method: (deselect inst)
method: (send inst deselect)
returns: unspecified

deselects the widget.

classes: <checkbutton> and <radiobutton>



method: (destroy inst)
method: (send inst destroy)
returns: unspecified

Destroys the menu and any sub-menus.

classes: <menu> Destroys this toplevel window if destroy-request-handler returns a non-false value. classes: <toplevel> Destroys the widget and its children. classes: <canvas> destroys the canvas figure classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle> Destroys the widget and its children. classes: <frame> Destroys the object. classes: <bitmap>, <button>, <cascade-menu-item>, <check-menu-item>, <checkbutton>, <command-menu-item>, <entry>, <fixed-mark>, <floating-mark>, <font>, <label>, <listbox>, <markup>, <option-button>, <photo>, <radio-menu-item>, <radiobutton>, <rgb>, <scale>, <scrollbar>, <separator-menu-item>, <tab-stop>, and <text>



method: (find-closest inst x y)
method: (send inst find-closest x y)
returns: see below

Returns the topmost canvas item closest to the canvas coordinates x and y or #f if none.

classes: <canvas>



method: (find-enclosed inst x1 y1 x2 y2)
method: (send inst find-enclosed x1 y1 x2 y2)
returns: see below

Returns a list of the items completely enclosed by the rectangular region defined by x1, y1, x2, and y2.

classes: <canvas>



method: (find-item inst relpos item)
method: (send inst find-item relpos item)
returns: see below

Returns the canvas item above or below item in the display list or #f if none. relpos is either above or below.

classes: <canvas>



method: (find-overlapping inst x1 y1 x2 y2)
method: (send inst find-overlapping x1 y1 x2 y2)
returns: see below

Returns a list of the items overlapped by the rectangular region defined by x1, y1, x2, and y2.

classes: <canvas>



method: (fixed-mark inst where)
method: (send inst fixed-mark where)
returns: an instance of <fixed-mark>

Returns a fixed mark for the position described by where. A fixed mark moves only when text is inserted or deleted somewhere before its current position. It remains fixed when text is inserted at its current position.

classes: <text>



method: (flash inst)
method: (send inst flash)
returns: unspecified

flashes the button briefly. expect this to go away.

classes: <button>, <checkbutton>, and <radiobutton>



method: (floating-mark inst where)
method: (send inst floating-mark where)
returns: an instance of <floating-mark>

Returns a floating mark for the position described by where. A floating mark moves when text is inserted or deleted before its current position and moves when text is inserted at its current position. For example, the insertion cursor behaves as a floating mark.

classes: <text>



method: (focus-next inst who)
method: (send inst focus-next who)
returns: unspecified

Set keyboard focus to the widget after who.

classes: <canvas>, <frame>, and <toplevel>



method: (focus-prev inst who)
method: (send inst focus-prev who)
returns: unspecified

Set keyboard focus to the widget before who.

classes: <canvas>, <frame>, and <toplevel>



method: (get-above-paragraph-space inst)
method: (send inst get-above-paragraph-space)
returns: see below

Returns in pixels the amount of extra space to insert above each paragraph in the text.

classes: <text> Returns in pixels the amount of extra space to insert above each paragraph in the text, or #f. classes: <markup>



method: (get-accept-focus inst)
method: (send inst get-accept-focus)
returns: boolean

Returns a boolean indicating whether or not this widget accepts focus when offered by the keyboard traversal mechanism. See the description of set-accept-focus!.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-action inst)
method: (send inst get-action)
returns: procedure

Returns the procedure that is called when the widget is manipulated by dragging or clicking the mouse, or pressing arrow keys when the widget has input focus. See set-action! for more details.

classes: <scale> and <scrollbar> Returns the procedure of no arguments to be invoked when the widget is clicked or pressed. classes: <button>, <checkbutton>, and <radiobutton> Returns a procedure of one argument (self) that is invoked when this menu item is chosen with the keyboard or mouse. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> returns a procedure of one argument (self) evaluated for effect when return or newline is pressed in an <entry>. classes: <entry>



method: (get-active-background-color inst)
method: (send inst get-active-background-color)
returns: see below

Returns the foreground color used when the mouse cursor is over the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <scale> and <scrollbar> Returns the background color used when the mouse cursor is over the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <button>, <checkbutton>, and <radiobutton> Returns the background color used when the mouse cursor is over the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Returns the background color used when the mouse cursor is over the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <menu> Returns the background color used when the mouse cursor is over the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <option-button>



method: (get-active-foreground-color inst)
method: (send inst get-active-foreground-color)
returns: see below

Returns the foreground color used when the mouse cursor is over the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <button>, <checkbutton>, and <radiobutton> Returns the foreground color used when the mouse cursor is over the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Returns the foreground color used when the mouse cursor is over the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <menu> Returns the foreground color used when the mouse cursor is over the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <option-button>



method: (get-actual-values inst)
method: (send inst get-actual-values)
returns: see below

Returns, as multiple values, the actual family, size, and style used by the display engine when rendering this font.

classes: <font>



method: (get-anchor inst)
method: (send inst get-anchor)
returns: symbol

Returns a symbol describing where information in the widget is displayed.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton> Returns a symbol describing where the figure is displayed relative to its coordinates. classes: <canvas-image>, <canvas-sub-window>, and <canvas-text>



method: (get-arrow-shape inst)
method: (send inst get-arrow-shape)
returns: see below

Returns a list of three numbers describing the shape of the arrowhead see set-arrow-shape! for details.

classes: <line>



method: (get-arrow-style inst)
method: (send inst get-arrow-style)
returns: see below

Returns a symbol describing where on the line the arrowheads should be drawn.

classes: <line>



method: (get-aspect-ratio-bounds inst)
method: (send inst get-aspect-ratio-bounds)
returns: see below

Returns the contraints on the aspect ratio for this toplevel as minumum and maximum ratios of width to height. The values returned are #f if no constraints are in effect.

classes: <toplevel>



method: (get-background-color inst)
method: (send inst get-background-color)
returns: see below

Returns the default background color for the instance. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Returns the default background color for the instance. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <separator-menu-item> Returns the background color for text with this markup. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt, an instance of <rgb>, or #f. classes: <markup> Returns the background color for the bitmap. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <bitmap> Returns the default background color for the instance. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-below-paragraph-space inst)
method: (send inst get-below-paragraph-space)
returns: see below

Returns in pixels the amount of extra space to insert below each paragraph in the text.

classes: <text> Returns in pixels the amount of extra space to insert below each paragraph in the text, or #f. classes: <markup>



method: (get-blank inst)
method: (send inst get-blank)
returns: see below

Returns #f if the entry displays its contents without translation else returns the character used in the translation. (see set-blank!)

classes: <entry>



method: (get-border-width inst)
method: (send inst get-border-width)
returns: see below

Returns the width in pixels of the border drawn around text with this markup, or #f if none.

classes: <markup> Returns the width in pixels of the border drawn around the instance. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-cap-style inst)
method: (send inst get-cap-style)
returns: see below

Returns a symbol describing how caps are drawn at the endpoints of the line.

classes: <line>



method: (get-char inst)
method: (send inst get-char)
returns: see below

Returns the character at cursor position or #f if none but does not advance the cursor.

classes: <text>



method: (get-char inst index)
method: (send inst get-char index)
returns: see below

Returns the character at index, #f if none.

classes: <text>



method: (get-close-enough inst)
method: (send inst get-close-enough)
returns: a floating point number

Returns a floating-point value indicating how close the mouse cursor must be before it is considered to be inside an item.

classes: <canvas>



method: (get-confine inst)
method: (send inst get-confine)
returns: boolean

Returns a boolean indicating whether or not the canvas is prevented from scrolling the view of the canvas outside the region defined by set-scroll-region!.

classes: <canvas>



method: (get-coords inst)
method: (send inst get-coords)
returns: list

Returns a list of the coordinates defining the canvas figure.

classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle>



method: (get-cursor-pos inst)
method: (send inst get-cursor-pos)
returns: integer

Returns the position of insertion cursor within the widget as a pair of character position and line number.

classes: <text> Returns the index of the item currently under the cursor. classes: <listbox> Returns the position of insertion cursor within the widget. classes: <entry>



method: (get-data inst)
method: (send inst get-data)
returns: see below

Returns a base64-encoded string representing the image data.

classes: <photo> No idea if this will really work reliably. classes: <bitmap>



method: (get-desired-height inst)
method: (send inst get-desired-height)
returns: integer

Returns the height, in pixels, that the widget requests from its window manager.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-desired-width inst)
method: (send inst get-desired-width)
returns: integer

Returns the width, in pixels, that the widget requests from its window manager.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-destroy-request-handler inst)
method: (send inst get-destroy-request-handler)
returns: procedure

Returns the destroy request handler for this toplevel window.

classes: <toplevel>



method: (get-digits inst)
method: (send inst get-digits)
returns: see below

Returns the number of significant digits in the value of the scale. If zero, then the scale chooses the smallest value that distinguishes each position of the slider.

classes: <scale>



method: (get-disabled-background-color inst)
method: (send inst get-disabled-background-color)
returns: see below

Returns the background color used when the widget is disabled. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <entry> and <text>



method: (get-disabled-foreground-color inst)
method: (send inst get-disabled-foreground-color)
returns: see below

Returns the foreground color used when the widget is disabled. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <button>, <checkbutton>, and <radiobutton> Returns the foreground color used when the widget is disabled. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <entry> and <text> Returns the foreground color used when the widget is disabled. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <menu> Returns the foreground color used when the widget is disabled. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <option-button>



method: (get-draw-indicator inst)
method: (send inst get-draw-indicator)
returns: see below

Returns a boolean value indicating whether or not the state of the widget is depicted by drawing a small square or diamond filled or not filled.

classes: <checkbutton> and <radiobutton> Returns a boolean value indicating whether or not the state of the item is depicted by drawing a small square or diamond filled or not filled. classes: <check-menu-item> and <radio-menu-item>



method: (get-draw-spline inst)
method: (send inst get-draw-spline)
returns: boolean

Returns a boolean that indicates whether or not the outline of the figure is drawn as a spline.

classes: <line> and <polygon>



method: (get-enabled inst)
method: (send inst get-enabled)
returns: boolean

Returns a boolean value indicating whether or not the widget is enabled and responsive to user interaction.

classes: <button>, <checkbutton>, and <radiobutton> Returns a boolean value indicating whether or not the widget is enabled and responsive to user interaction. classes: <entry> and <text> Always returns false. Always #f for separator-menu-items. classes: <separator-menu-item> Returns a boolean value indicating whether or not the widget is enabled and responsive to user interaction. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Returns a boolean value indicating whether or not the widget is enabled and responsive to user interaction. classes: <option-button>



method: (get-export-selection inst)
method: (send inst get-export-selection)
returns: boolean

Returns a boolean that indicates whether or not selection in the widget is also the X selection.

classes: <entry>, <listbox>, and <text>



method: (get-extent inst)
method: (send inst get-extent)
returns: see below

Returns the extent in degrees of the arc.

classes: <arc>



method: (get-family inst)
method: (send inst get-family)
returns: a symbol

Returns the family requested when the instance was created.

classes: <font>



method: (get-filename inst)
method: (send inst get-filename)
returns: string

Returns the name of the file associated with the <photo>.

classes: <photo> Returns the name of the file associated with the instance. classes: <bitmap>



method: (get-fill-color inst)
method: (send inst get-fill-color)
returns: see below

Returns the color with which the interior of the figure is filled. The value returned is either the symbol transparent, a symbol naming a color in rgb.txt, or an instance of <rgb>.

classes: <canvas-text> Returns the color with which the interior of the figure is filled. The value returned is either the symbol transparent, a symbol naming a color in rgb.txt, or an instance of <rgb>. classes: <line> and <polygon> Returns the color with which the interior of the figure is filled. The value returned is either the symbol transparent, a symbol naming a color in rgb.txt, or an instance of <rgb>. classes: <arc>, <oval>, and <rectangle>



method: (get-font inst)
method: (send inst get-font)
returns: see below

Returns an instance of <font> describing the default font for text displayed by the scale.

classes: <scale> Returns an instance of <font> describing the font for text displayed in the widget. classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text> Returns an instance of <font> describing the font for text displayed in the widget. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Returns an instance of <font> describing the font for text displayed in the widget. classes: <menu> Returns an instance of <font> describing the font for text with this markup or #f to indicate that this markup does not override the text font. classes: <markup> Returns an instance of <font> describing the font for text displayed by the figure. classes: <canvas-text>



method: (get-foreground-color inst)
method: (send inst get-foreground-color)
returns: see below

Returns the default foreground color for the scale. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <scale> Returns the foreground color for the instance. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text> Returns the foreground color for the instance. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Returns the foreground color for the instance. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <menu> Returns the foreground color for text with this markup. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt, an instance of <rgb>, or #f. classes: <markup> Returns the foreground color for the bitmap. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <bitmap>



method: (get-geometry inst)
method: (send inst get-geometry)
returns: string

Returns a string describing the current geometry of the toplevel.

classes: <toplevel>



method: (get-grid inst)
method: (send inst get-grid)
returns: boolean

Returns a boolean indicating whether or not the text widget should strive to keep its dimensions in even multiples of the dimensions of a character in its current font.

classes: <text> Returns a boolean indicating whether or not the listbox should strive to keep its dimensions in even multiples of the dimensions of a character in its current font. classes: <listbox>



method: (get-height inst)
method: (send inst get-height)
returns: integer

Returns the height, in pixels, of the given image.

classes: <bitmap> and <photo> Returns the height in pixels of the sub-window. classes: <canvas-sub-window> Returns the current height, in pixels, of the widget. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-height/char inst)
method: (send inst get-height/char)
returns: integer

Returns the height of the widget in lines of text. If zero then the widget is determining its own size.

classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text>



method: (get-horizontal-view inst)
method: (send inst get-horizontal-view)
returns: see below

Returns a list of two floating-point values describing what part of the widget's content is in view horizontally. The first number indicates what fraction of the widget's content is out of view to the left and the second number indicates what fraction of the widget's content is not out of view to the right.

classes: <entry>, <listbox>, and <text>



method: (get-hpad inst)
method: (send inst get-hpad)
returns: see below

Returns in pixels the extra horizontal distance to add around the widget.

classes: <text>



method: (get-hscroll-increment inst)
method: (send inst get-hscroll-increment)
returns: integer

Returns the value set by set-hscroll-increment!.

classes: <canvas>



method: (get-hscroll-notify inst)
method: (send inst get-hscroll-notify)
returns: see below

Returns the procedure (or #f if none) that is notified when the horizontal view or content of the widget is changed.

classes: <entry>, <listbox>, and <text> Returns the procedure (or #f if none) that is notified when the horizontal view or content of the widget is changed. classes: <canvas>



method: (get-icon-title inst)
method: (send inst get-icon-title)
returns: string

Returns the string displayed by the toplevel when it is iconified.

classes: <toplevel>



method: (get-image inst)
method: (send inst get-image)
returns: see below

Returns the image to displayed by this canvas item.

classes: <canvas-image>



method: (get-insert-border-width inst)
method: (send inst get-insert-border-width)
returns: integer

Returns the width in pixels of the 3-D border drawn around the insertion cursor for the widget.

classes: <entry> and <text>



method: (get-insert-color inst)
method: (send inst get-insert-color)
returns: see below

Returns the color for the insertion cursor of the widget The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <entry> and <text>



method: (get-insert-off-time inst)
method: (send inst get-insert-off-time)
returns: integer

Returns the number of milliseconds the insertion cursor for this widget will be hidden during each blink cycle.

classes: <entry> and <text>



method: (get-insert-on-time inst)
method: (send inst get-insert-on-time)
returns: integer

Returns the number of milliseconds the insertion cursor for this widget will be visible during each blink cycle.

classes: <entry> and <text>



method: (get-insert-width inst)
method: (send inst get-insert-width)
returns: integer

Returns the width in pixels of the insertion cursor for the widget.

classes: <entry> and <text>



method: (get-item inst index)
method: (send inst get-item index)
returns: see below

Returns the string in the listbox at the given index.

classes: <listbox>



method: (get-items inst)
method: (send inst get-items)
returns: list

Returns a list of canvas items contained in this canvas.

classes: <canvas>



method: (get-join-style inst)
method: (send inst get-join-style)
returns: see below

Returns a symbol describing how the joints between line segments are drawn.

classes: <line>



method: (get-jump-scroll inst)
method: (send inst get-jump-scroll)
returns: see below

Returns a boolean that indicates whether or not the scrollbar waits until it is released before notifying the associated widget.

classes: <scrollbar>



method: (get-justify inst)
method: (send inst get-justify)
returns: symbol

Returns a symbol describing how lines are to be justified when multiple lines are displayed.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton> Returns a symbol indicating where where the the insertion cursor begins and how the text is displayed when it all fits in the widget. classes: <entry> Returns a symbol describing how lines are to be justified when multiple lines are displayed. classes: <canvas-text>



method: (get-key-press-method inst)
method: (send inst get-key-press-method)
returns: see below

returns the method that is notified when a key is pressed while the mouse is over a range of text with this markup.

classes: <markup>



method: (get-key-release-method inst)
method: (send inst get-key-release-method)
returns: see below

returns the method that is notified when a key is released while the mouse is over a range of text with this markup.

classes: <markup>



method: (get-left-margin inst)
method: (send inst get-left-margin)
returns: see below

Returns the left margin in pixels for text with this markup, or #f if none.

classes: <markup>



method: (get-length inst)
method: (send inst get-length)
returns: see below

returns the length in pixels of the long dimension of the scale.

classes: <scale>



method: (get-line-space inst)
method: (send inst get-line-space)
returns: see below

Returns in pixels the amount of extra space to insert between each line in the text.

classes: <text> Returns in pixels the amount of extra space to insert between each line in the text, or #f. classes: <markup>



method: (get-line-thickness inst)
method: (send inst get-line-thickness)
returns: see below

Returns the thickness in pixels of the outline drawn around the figure.

classes: <line> and <polygon> Returns the thickness in pixels of the outline drawn around the figure. classes: <arc>, <oval>, and <rectangle>



method: (get-mask-data inst)
method: (send inst get-mask-data)
returns: see below

No idea if this will really work reliably.

classes: <bitmap>



method: (get-max inst)
method: (send inst get-max)
returns: see below

returns the high value of the range represented by the scale.

classes: <scale>



method: (get-max-size inst)
method: (send inst get-max-size)
returns: see below

returns multiple values corresponding to the arguments to set-max-size!

classes: <toplevel>



method: (get-menu inst)
method: (send inst get-menu)
returns: see below

Returns the menu to be posted when this item is chosen to menu which must be an instance of <menu>. Returns #f if none.

classes: <cascade-menu-item> Returns the menu instance associated with this toplevel, or #f if none. classes: <toplevel>



method: (get-menu-items inst)
method: (send inst get-menu-items)
returns: see below

Returns a copy of the list of menu items contained in this menu.

classes: <cascade-menu-item> Returns a copy of the list of menu items contained in this menu. classes: <menu>



method: (get-min inst)
method: (send inst get-min)
returns: see below

returns the low value of the range represented by the scale.

classes: <scale>



method: (get-min-size inst)
method: (send inst get-min-size)
returns: see below

returns multiple values corresponding to the arguments to set-min-size!

classes: <toplevel>



method: (get-mouse-cursor inst)
method: (send inst get-mouse-cursor)
returns: see below

Returns the mouse cursor displayed when the mouse pointer is in the widget. The return value is in one of the forms accepted by set-mouse-cursor!.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-mouse-enter-method inst)
method: (send inst get-mouse-enter-method)
returns: see below

returns the procedure that is notified when the mouse enters a range of text with this markup.

classes: <markup>



method: (get-mouse-leave-method inst)
method: (send inst get-mouse-leave-method)
returns: see below

returns the procedure that is notified when the mouse leaves a range of text with this markup.

classes: <markup>



method: (get-mouse-motion-method inst)
method: (send inst get-mouse-motion-method)
returns: see below

returns the procedure that is notified when the mouse moves over a range of text with this markup.

classes: <markup>



method: (get-mouse-press-method inst)
method: (send inst get-mouse-press-method)
returns: see below

returns the procedure that is notified when a mouse button is pressed over a range of text with this markup.

classes: <markup>



method: (get-mouse-release-method inst)
method: (send inst get-mouse-release-method)
returns: see below

returns the procedure that is notified when a mouse button is released over a range of text with this markup.

classes: <markup>



method: (get-options inst)
method: (send inst get-options)
returns: option list (see set-options!)

The behavior when the list is mutated is undefined.

classes: <option-button>



method: (get-orientation inst)
method: (send inst get-orientation)
returns: symbol

Returns the orientation of the widget, either horizontal or vertical.

classes: <scale> and <scrollbar>



method: (get-outline-color inst)
method: (send inst get-outline-color)
returns: see below

Returns the color in which the outline of the figure is drawn. The value returned is either a symbol naming a color in rgb.txt or an instance of <rgb>.

classes: <polygon> Returns the color in which the outline of the figure is drawn. The value returned is either a symbol naming a color in rgb.txt or an instance of <rgb>. classes: <arc>, <oval>, and <rectangle>



method: (get-override-redirect inst)
method: (send inst get-override-redirect)
returns: boolean

Indicates whether this toplevel window is to be ignored by the window manager (ie. displayed without decorative border, etc.).

classes: <toplevel>



method: (get-overstrike inst)
method: (send inst get-overstrike)
returns: see below

Returns a boolean indicating whether or not text with this markup is overstricken.

classes: <markup>



method: (get-paragraph-indent inst)
method: (send inst get-paragraph-indent)
returns: see below

Returns the number of pixels that the first line of a paragraph with this markup is indented, or #f if none.

classes: <markup>



method: (get-parent inst)
method: (send inst get-parent)
returns: see below

This method returns #f since a toplevel has no parent.

classes: <toplevel> Returns the canvas on which the figure is drawn. classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle> Returns the parent of the widget. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, and <text> Returns the parent of the widget or #f if the widget has no parent. classes: <bitmap>, <cascade-menu-item>, <check-menu-item>, <command-menu-item>, <fixed-mark>, <floating-mark>, <font>, <markup>, <menu>, <photo>, <radio-menu-item>, <rgb>, <separator-menu-item>, and <tab-stop>



method: (get-pos inst)
method: (send inst get-pos)
returns: see below

Returns a pair containing the current line and character position of the mark.

classes: <fixed-mark> and <floating-mark>



method: (get-pref inst key default)
method: (send inst get-pref key default)
returns: preference value associated with key, or default if none

A warning is signaled in the latter case.

classes: <arc>, <bitmap>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <cascade-menu-item>, <check-menu-item>, <checkbutton>, <command-menu-item>, <entry>, <fixed-mark>, <floating-mark>, <font>, <frame>, <label>, <line>, <listbox>, <markup>, <menu>, <option-button>, <oval>, <photo>, <polygon>, <radio-menu-item>, <radiobutton>, <rectangle>, <rgb>, <scale>, <scrollbar>, <separator-menu-item>, <tab-stop>, <text>, and <toplevel>



method: (get-prefs-key inst)
method: (send inst get-prefs-key)
returns: symbol or #f

Returns the preferences key for this menu item.

classes: <check-menu-item> and <radio-menu-item>



method: (get-relief inst)
method: (send inst get-relief)
returns: see below

Returns a symbol describing how the border of the widget is drawn, or #f.

classes: <markup> Returns a symbol describing how the border of the widget is drawn. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-repeat-delay inst)
method: (send inst get-repeat-delay)
returns: integer

Returns the number of milliseconds a button or key must be held down before it begins to autorepeat.

classes: <scale> and <scrollbar>



method: (get-repeat-interval inst)
method: (send inst get-repeat-interval)
returns: integer

Returns the number of milliseconds to delay between auto-repeats.

classes: <scale> and <scrollbar>



method: (get-resizable inst)
method: (send inst get-resizable)
returns: see below

returns multiple values corresponding to the arguments to set-resizable!

classes: <toplevel>



method: (get-resolution inst)
method: (send inst get-resolution)
returns: see below

returns the resolution of the scale's value.

classes: <scale>



method: (get-right-margin inst)
method: (send inst get-right-margin)
returns: see below

Returns the right margin in pixels for text with this markup, or #f if none.

classes: <markup>



method: (get-root-x inst)
method: (send inst get-root-x)
returns: integer

Returns the x-coordinate of the widget relative to the root window.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-root-y inst)
method: (send inst get-root-y)
returns: integer

Returns the y-coordinate of the widget relative to the root window.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-saved-text inst)
method: (send inst get-saved-text)
returns: string

returns, as a Scheme string, the text preserved by save-text! this is the yank operation.

classes: <entry> and <text>



method: (get-scroll-region inst)
method: (send inst get-scroll-region)
returns: list

Returns a list of the coordinates defining the boundary of the information on the canvas.

classes: <canvas>



method: (get-select-background-color inst)
method: (send inst get-select-background-color)
returns: see below

Returns the background color for selected items in the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <entry>, <listbox>, and <text>



method: (get-select-border-width inst)
method: (send inst get-select-border-width)
returns: integer

Returns the width in pixels of the raised 3-D border drawn around selected items.

classes: <entry>, <listbox>, and <text>



method: (get-select-color inst)
method: (send inst get-select-color)
returns: see below

Returns the color used to show when the widget is selected (see set-select-color!).

classes: <checkbutton> and <radiobutton> Returns the color used to show when the item is selected (see set-select-color!). classes: <check-menu-item> and <radio-menu-item> Returns the color used to show when the item is selected (see set-select-color!). classes: <menu>



method: (get-select-foreground-color inst)
method: (send inst get-select-foreground-color)
returns: see below

Returns the foreground color for selected items in the widget. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <entry>, <listbox>, and <text>



method: (get-select-image inst)
method: (send inst get-select-image)
returns: see below

Returns the image displayed when this item is selected.

classes: <checkbutton> and <radiobutton> Returns the image displayed when this item is selected. classes: <check-menu-item> and <radio-menu-item>



method: (get-select-mode inst)
method: (send inst get-select-mode)
returns: see below

Returns a symbol describing the current selection mode. See set-select-mode! for more details.

classes: <listbox>



method: (get-selected inst)
method: (send inst get-selected)
returns: boolean

Returns the selected status of the item.

classes: <check-menu-item> and <radio-menu-item>



method: (get-selected-items inst)
method: (send inst get-selected-items)
returns: see below

Returns the index of the item currently selected, a list of such indices if more than one is selected, or #f if none is selected.

classes: <listbox>



method: (get-selected-range inst)
method: (send inst get-selected-range)
returns: see below

Returns a pair of the start and end points of the selected region or #f if nothing is selected.

classes: <text> Returns a pair of the start and end points of the selected region or #f if nothing is selected. classes: <entry>



method: (get-selected-string inst)
method: (send inst get-selected-string)
returns: see below

Returns the string selected in the entry or #f if none. Very tempted to eliminate this

classes: <entry>



method: (get-show-value inst)
method: (send inst get-show-value)
returns: see below

returns a boolean indicating whether or not the scale shows its current value beside the slider.

classes: <scale>



method: (get-size inst)
method: (send inst get-size)
returns: an integer

Returns the size requested when the instance was created. Positive values indicate size in points; negative values indicate size in pixels.

classes: <font>



method: (get-skip-increment inst)
method: (send inst get-skip-increment)
returns: see below

returns the size of the skips made when the scale is clicked on in a way that jumps.

classes: <scale>



method: (get-slider-length inst)
method: (send inst get-slider-length)
returns: see below

returns the length in pixels of the slider along its long dimension.

classes: <scale>



method: (get-spline-steps inst)
method: (send inst get-spline-steps)
returns: integer

Returns the number of steps to be used when drawing the spline. If zero the figure is not drawn as a spline.

classes: <line> and <polygon>



method: (get-start inst)
method: (send inst get-start)
returns: see below

Returns the position in degrees where the arc begins.

classes: <arc>



method: (get-stipple inst)
method: (send inst get-stipple)
returns: see below

(unimplemented)

classes: <canvas-text> (currently unimplemented) classes: <line> and <polygon> (currently unimplemented) classes: <arc>, <oval>, and <rectangle>



method: (get-string inst)
method: (send inst get-string)
returns: string

returns the contents of the entry as a Scheme string.

classes: <entry>



method: (get-string inst index1 index2)
method: (send inst get-string index1 index2)
returns: see below

Returns the string defined by the range index1 index2.

classes: <text>



method: (get-style inst)
method: (send inst get-style)
returns: see below

Returns a list of the other properties ( normal, bold, roman, italic, underline, or overstrike) requested when the instance was created.

classes: <font> Returns a symbol describing how the arc is displayed. The value returns is either arc, chord, or pieslice. classes: <arc>



method: (get-tabs inst)
method: (send inst get-tabs)
returns: see below

Returns a list of the default tab stops in effect for this text widget.

classes: <text> Returns a list of the tab stops in effect for text with this markup or #f if none. classes: <markup>



method: (get-title inst)
method: (send inst get-title)
returns: see below

Returns the string, <bitmap>, or <photo> displayed by the widget.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton> Always the empty string for separator-menu-items. classes: <separator-menu-item> Returns the string displayed by the widget. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Returns the string displayed by the toplevel when it is not iconified. classes: <toplevel> Returns the string displayed by the figure. classes: <canvas-text>



method: (get-transient inst)
method: (send inst get-transient)
returns: see below

Returns the <toplevel> for which this <toplevel> is serving as a transient, or #f if none.

classes: <toplevel>



method: (get-traversal-background-color inst)
method: (send inst get-traversal-background-color)
returns: see below

Returns the color for the traversal highlight region when the widget does not have input focus. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-traversal-color inst)
method: (send inst get-traversal-color)
returns: see below

Returns the color for the traversal highlight region when the widget has input focus. The value returned is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-traversal-thickness inst)
method: (send inst get-traversal-thickness)
returns: integer

Returns the width in pixels of the traversal highlight region.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-trough-color inst)
method: (send inst get-trough-color)
returns: see below

Returns the color for the trough (in which the slider of the widget moves) to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <scale> and <scrollbar>



method: (get-underline inst)
method: (send inst get-underline)
returns: see below

Returns a boolean indicating whether or not text with this markup is underlined.

classes: <markup>



method: (get-underline-index inst)
method: (send inst get-underline-index)
returns: integer

Returns the zero-based index of a character to be underline when the string is displayed. If #f the underline is disabled.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton>



method: (get-value inst)
method: (send inst get-value)
returns: see below

returns the current value of the scale.

classes: <scale>



method: (get-values inst)
method: (send inst get-values)
returns: see below

Returns, as multiple values, the family, size, and style requested when the instance was created.

classes: <font>



method: (get-vertical-view inst)
method: (send inst get-vertical-view)
returns: list

Returns a list of two floating-point values describing what part of the widget's content is in view vertically. The first number indicates what fraction of the widget's content is out of view to the top and the second number indicates what fraction of the widget's content is not out of view to the bottom.

classes: <listbox> and <text> Because entries cannot be scrolled vertically, this always returns the list (0 1) to indicate that no part of the widget's content is out of view to the top, and all of the content is in view above the bottom. classes: <entry>



method: (get-view inst)
method: (send inst get-view)
returns: see below

Returns the values set in the most recent call to set-view!.

classes: <scrollbar>



method: (get-vpad inst)
method: (send inst get-vpad)
returns: see below

Returns in pixels the extra vertical distance to add around the widget.

classes: <text>



method: (get-vscroll-increment inst)
method: (send inst get-vscroll-increment)
returns: integer

Returns the value set by set-vscroll-increment!.

classes: <canvas>



method: (get-vscroll-notify inst)
method: (send inst get-vscroll-notify)
returns: see below

Returns the procedure (or #f if none) that is notified when the vertical view or content of the widget is changed.

classes: <entry>, <listbox>, and <text> Returns the procedure (or #f if none) that is notified when the vertical view or content of the widget is changed. classes: <canvas>



method: (get-width inst)
method: (send inst get-width)
returns: integer

Returns the width, in pixels, of the given image.

classes: <bitmap> and <photo> Returns the width in pixels of the sub-window. classes: <canvas-sub-window> Returns the width of the canvas text used in line breaking. classes: <canvas-text> Returns the current width, in pixels, of the widget. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (get-width/char inst)
method: (send inst get-width/char)
returns: integer

Returns the width of the widget in characters. If zero then the widget is determining its own size.

classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text>



method: (get-window inst)
method: (send inst get-window)
returns: see below

Returns the widget placed on the canvas in this sub-window.

classes: <canvas-sub-window>



method: (get-wrap inst)
method: (send inst get-wrap)
returns: see below

Returns a symbol indicating how long lines are wrapped.

classes: <text> Returns a symbol indicating how long lines are wrapped, or #f if none. classes: <markup>



method: (get-wrap-length inst)
method: (send inst get-wrap-length)
returns: integer

Returns the wrap limit for the widget. See set-wrap-length!.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton>



method: (get-x/char inst)
method: (send inst get-x/char)
returns: integer

Returns the offset of this mark (in character positions) from the start the line.

classes: <fixed-mark> and <floating-mark>



method: (get-y/char inst)
method: (send inst get-y/char)
returns: integer

Returns the distance of this mark (in lines) from the beginning of the text widget.

classes: <fixed-mark> and <floating-mark>



method: (hide inst)
method: (send inst hide)
returns: unspecified

Withdraws the window from the display so that it is completely hidden. If unreachable, a toplevel may be collected while hidden.

classes: <toplevel> Makes the canvas item invisible. classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle> Removes the widget from the screen. Due to the current order dependency of show the widget may not appear at the same place when subsequently redisplayed via show. This is soon to be changed. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, and <text>



method: (hscroll inst n qualifier)
method: (send inst hscroll n qualifier)
returns: unspecified

Scrolls the view in the widget horizontally. If qualifier is fraction, then n indicates what fraction of the widget contents should be moved out of view to the left. Otherwise, n is an integer indicating how many pages or units to scroll (negative values scroll left, positive scroll right), and qualifier is either pages, or units (characters).

classes: <entry>, <listbox>, and <text> Scrolls the view in the widget horizontally. If qualifier is fraction, then n indicates what fraction of the widget contents should be moved out of view to the left. Otherwise, n is an integer indicating how many pages or units to scroll (negative values scroll left, positive scroll right), and qualifier is either pages, or units (pixels). classes: <canvas>



method: (iconify inst)
method: (send inst iconify)
returns: unspecified

Removes the window from the display and shows it instead as an icon. The show method can be used to reverse the process. Note that iconify differs from hide in that the latter removes all traces of the window from the screen while the former leaves behind an icon.

classes: <toplevel>



method: (init inst p x1 y1 x2 y2 x3 y3 more ...)
method: (send inst init p x1 y1 x2 y2 x3 y3 more ...)
returns: unspecified

When creating a polygon, at least six numbers must be given defining the vertices of the polygon. Additional coordinates specify additional vertices.

classes: <polygon>



method: (init inst p x1 y1 x2 y2 more ...)
method: (send inst init p x1 y1 x2 y2 more ...)
returns: unspecified

When creating a line, at least four numbers must be given defining the endpoints of the line. Additional coordinates specify endpoints of connecting line segments.

classes: <line>



method: (init inst . ignore-args ...)
method: (send inst init . ignore-args ...)
returns: unspecified

Initializes the instance.

classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, <radio-menu-item>, and <separator-menu-item> To prevent widgets from being prematurely garbage-collected, this method must be called when a widget is first created. The create macro does this automatically. Classes derived from <tk-widget> can redefine init to add additional initialization code, but the subclass's init method should first call the base init method. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel> To prevent widgets from being prematurely garbage-collected, this method must be called when a widget is first created. The create macro does this automatically. Classes derived from <tk-widget> can redefine init to add additional initialization code, but the subclass's init method should first call the base init method. classes: <arc>, <bitmap>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <markup>, <menu>, <oval>, <photo>, <polygon>, and <rectangle>



method: (init inst parent)
method: (send inst init parent)
returns: unspecified

Initializes the instance.

classes: <text> Initializes the instance. classes: <fixed-mark> and <floating-mark> Initializes the instance. classes: <entry> Initializes the instance. classes: <canvas>



method: (init inst parent default)
method: (send inst init parent default)
returns: unspecified

Initializes the instance.

classes: <option-button>



method: (init inst p x1 y1)
method: (send inst init p x1 y1)
returns: unspecified

Initializes the instance.

classes: <font> Two numbers must be given when creating an instance of this class. classes: <canvas-image>, <canvas-sub-window>, and <canvas-text>



method: (init inst p x1 y1 x2 y2)
method: (send inst init p x1 y1 x2 y2)
returns: unspecified

When creating an instance of this class four numbers must be given defining the top-left and bottom-right coordinates of a rectangular region enclosing the figure.

classes: <arc>, <oval>, and <rectangle>



method: (insert inst index s more ...)
method: (send inst insert index s more ...)
returns: unspecified

Inserts the given strings just before the item at the position given by index.

classes: <listbox>



method: (insert inst x)
method: (send inst insert x)
returns: unspecified

Inserts the given character, string, or widget at the current cursor position, and ensures that the cursor is visible on-screen.

classes: <text> inserts the given character or string at the current position of the insertion cursor in the entry. classes: <entry>



method: (insert inst index s)
method: (send inst insert index s)
returns: unspecified

Inserts the string s just before the item at the position given by index.

classes: <listbox>



method: (insert-at inst index char/string)
method: (send inst insert-at index char/string)
returns: unspecified

Inserts given character, string, or widget just before index. (no attempt is made to ensure that the newly inserted text is visible)

classes: <text> inserts the given character or string at the position given by index. classes: <entry>



method: (insert-widget-at inst index widget)
method: (send inst insert-widget-at index widget)
returns: unspecified

Quick and dirty first stab at permitting embedded windows in a text widget. No idea yet how this will affect the event-case stuff.

classes: <text>



method: (invoke inst)
method: (send inst invoke)
returns: see below

Invokes the action bound to this widget.

classes: <checkbutton> and <radiobutton> Invokes the action (if any) associated with this widget by set-action! as if the widget had been pressed or clicked. (This also seems of limited use) classes: <button>



method: (invoke inst m)
method: (send inst invoke m)
returns: unspecified

Invokes the menu action.

classes: <check-menu-item> Invokes the menu action. classes: <radio-menu-item> Invokes the menu action. classes: <cascade-menu-item> and <command-menu-item>



method: (item-count inst)
method: (send inst item-count)
returns: integer

Returns the total number of elements in the listbox.

classes: <listbox>



method: (key-press inst key modifiers)
method: (send inst key-press key modifiers)
returns: unspecified

A button executes its action when space or return is pressed.

classes: <button>, <checkbutton>, and <radiobutton> Entries have the following default behaviors. When newline or return is pressed, the action specified by set-action! is performed. When shift-left or shift-right is pressed, the selection is extended in the direction indicated. classes: <entry> When a key is pressed, this method notifies the widget that has input focus with a description of the key and any modifiers in effect at the time. key is either a Scheme character or symbol. modifiers describes the states of mouse-buttons and special keys when the event happened. For more details see the description of event-case. classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <frame>, <label>, <line>, <listbox>, <menu>, <option-button>, <oval>, <polygon>, <rectangle>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (key-press inst text key mods)
method: (send inst key-press text key mods)
returns: unspecified

this method is called to notify the markup that the specified key has been pressed with the modifiers mods while the mouse is over a range of text with this markup

classes: <markup>



method: (key-release inst key modifiers)
method: (send inst key-release key modifiers)
returns: unspecified

This method notifies a widget that the given key has been released with modifiers in effect. (See key-press)

classes: <arc>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <line>, <listbox>, <menu>, <option-button>, <oval>, <polygon>, <radiobutton>, <rectangle>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (key-release inst text key mods)
method: (send inst key-release text key mods)
returns: unspecified

this method is called to notify the markup that the specified key has been released with the modifiers mods while the mouse is over a range of text with this markup

classes: <markup>



method: (line-end inst pos)
method: (send inst line-end pos)
returns: see below

Returns a new pair scheme(column . line) that refers to the end of the line containing position pos. pos is either a pair or an instance of <fixed-mark> or <floating-mark>.

classes: <text> Returns the index of the end of the widget contents. classes: <entry>



method: (line-start inst pos)
method: (send inst line-start pos)
returns: see below

Returns a new pair scheme(column . line) that refers to the beginning of the line containing position pos. pos is either a pair or an instance of <fixed-mark> or <floating-mark>.

classes: <text> Returns zero, the index of the start of the line within the widget. classes: <entry>



method: (list-all-markups inst)
method: (send inst list-all-markups)
returns: see below

returns a list of all markups applied in the text widget

classes: <text>



method: (load-prefs inst tag)
method: (send inst load-prefs tag)
returns: unspecified

load-prefs fetches the global preferences stored under this tag and installs the 'prefs property which indicates that this widget is the root of the preference tree. Children of this widget delegate to this widget to manage their preferences.

classes: <arc>, <bitmap>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <cascade-menu-item>, <check-menu-item>, <checkbutton>, <command-menu-item>, <entry>, <fixed-mark>, <floating-mark>, <font>, <frame>, <label>, <line>, <listbox>, <markup>, <menu>, <option-button>, <oval>, <photo>, <polygon>, <radio-menu-item>, <radiobutton>, <rectangle>, <rgb>, <scale>, <scrollbar>, <separator-menu-item>, <tab-stop>, <text>, and <toplevel>



method: (lower inst)
method: (send inst lower)
returns: unspecified

Lowers this figure in the display list of the canvas.

classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle> Lowers a widget to the bottom of the Z-order so that any widgets overlapping it now obscure it. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (lower inst below-this)
method: (send inst lower below-this)
returns: unspecified

Lowers this figure above the given figure in the display list of the canvas.

classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle>



method: (make-visible inst index)
method: (send inst make-visible index)
returns: unspecified

Ensures that the text at the given index is visible on screen

classes: <text> Scrolls the element given by index into view. classes: <listbox> Ensures that the text at the given index is visible on screen classes: <entry>



method: (marked-ranges inst txt)
method: (send inst marked-ranges txt)
returns: see below

Returns a list of positions describing ranges in the text where this markup is applied, or an empty list if none. If a non-empty list is returned, every pair of elements describes the start and end position of a range with this markup. The end positions indicate the place just after the last marked character in each range.

classes: <markup>



method: (markup-lower inst mkup)
method: (send inst markup-lower mkup)
returns: unspecified

Lowers the given markup to the bottom of the markup stacking order. Stacking order determines which characteristics of markups obscure those of other markups covering the same range.

classes: <text>



method: (markup-raise inst mkup)
method: (send inst markup-raise mkup)
returns: unspecified

Raises the given markup to the top of the markup stacking order. Stacking order determines which characteristics of markups obscure those of other markups covering the same range.

classes: <text>



method: (markups-at inst pos)
method: (send inst markups-at pos)
returns: see below

returns a list of the markups at a given position

classes: <text>



method: (mouse-enter inst x y modifiers)
method: (send inst mouse-enter x y modifiers)
returns: unspecified

When the mouse enters a widget, this method is invoked with the x- and y-coordinates within the widget and the set of modifiers describing the state of the mouse buttons and keys such as shift and control. For more details see the description of event-case.

classes: <arc>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <line>, <listbox>, <menu>, <option-button>, <oval>, <polygon>, <radiobutton>, <rectangle>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (mouse-enter inst text x y mods)
method: (send inst mouse-enter text x y mods)
returns: unspecified

this method is called to notify the markup that the mouse has entered a range of text with this markup in the widget text at coordinates x, y, with modifiers mods.

classes: <markup>



method: (mouse-leave inst x y modifiers)
method: (send inst mouse-leave x y modifiers)
returns: unspecified

This method is invoked with the x- and y-coordinates and the set of modifiers describing the state of the mouse-buttons and modifier keys when the mouse left the widget.

classes: <arc>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <line>, <listbox>, <menu>, <option-button>, <oval>, <polygon>, <radiobutton>, <rectangle>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (mouse-leave inst text x y mods)
method: (send inst mouse-leave text x y mods)
returns: unspecified

this method is called to notify the markup that the mouse has left a range of text with this markup in the widget text at coordinates x, y, with modifiers mods.

classes: <markup>



method: (mouse-motion inst x y modifiers)
method: (send inst mouse-motion x y modifiers)
returns: unspecified

This method is invoked with the x- and y-coordinates of the mouse and the state of the modifiers whenever the mouse is moved within a widget.

classes: <arc>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <line>, <listbox>, <menu>, <option-button>, <oval>, <polygon>, <radiobutton>, <rectangle>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (mouse-motion inst text x y mods)
method: (send inst mouse-motion text x y mods)
returns: unspecified

this method is called to notify the markup that the mouse has moved over a range of text with this markup in the widget text at coordinates x, y, with modifiers mods.

classes: <markup>



method: (mouse-press inst x y modifiers)
method: (send inst mouse-press x y modifiers)
returns: unspecified

Because the indicator provides visual feedback, we don't change the relief when a fancy button is pressed.

classes: <checkbutton> and <radiobutton> When a mouse button is pressed within a widget, this method is invoked with the x- and y-coordinates and the state of the modifier keys and mouse-buttons. (See event-case) classes: <arc>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <entry>, <frame>, <label>, <line>, <listbox>, <menu>, <option-button>, <oval>, <polygon>, <rectangle>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (mouse-press inst text x y mods)
method: (send inst mouse-press text x y mods)
returns: unspecified

this method is called to notify the markup that a mouse button has been clicked over a range of text with this markup in the widget text at coordinates x, y, with modifiers mods.

classes: <markup>



method: (mouse-release inst x y modifiers)
method: (send inst mouse-release x y modifiers)
returns: unspecified

When a mouse button is released in a widget, this method is invoked with the x- and y-coordinates and the state of the modifier keys and mouse-buttons. (See event-case)

classes: <arc>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <line>, <listbox>, <menu>, <option-button>, <oval>, <polygon>, <radiobutton>, <rectangle>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (mouse-release inst text x y mods)
method: (send inst mouse-release text x y mods)
returns: unspecified

this method is called to notify the markup that a mouse button has been released over a range of text with this markup in the widget text at coordinates x, y, with modifiers mods.

classes: <markup>



method: (move inst xamt yamt)
method: (send inst move xamt yamt)
returns: unspecified

move the figure by the specified x and y amounts (positive or negative).

classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle>



method: (move-char inst offset)
method: (send inst move-char offset)
returns: unspecified

Advances the cursor offset characters, going to the next line if there are not enough characters to satisfy offset on the current line. Negative offsets are allowed.

classes: <text> Advances the cursor offset characters. If there are not enough characters to satisfy offset then the cursor is left at one end of the entry. Negative offsets are allowed. classes: <entry>



method: (move-line inst disp)
method: (send inst move-line disp)
returns: unspecified

Advances the cursor offset lines. The resulting cursor position is the minimum of the current character (col) position and the length of the line we end up on. Negative offsets are allowed.

classes: <text> Moves the cursor by disp lines. Negative displacements allowed. classes: <listbox>



method: (move-to-left inst index)
method: (send inst move-to-left index)
returns: unspecified

scrolls the view in the widget horizontally so that the character at index is displayed at the left edge of the window.

classes: <text> scrolls the view in the widget horizontally so that the character at index is displayed at the left edge of the window. classes: <listbox> scrolls the view in the widget horizontally so that the character at index is displayed at the left edge of the window. classes: <entry>



method: (move-to-top inst index)
method: (send inst move-to-top index)
returns: unspecified

scrolls the view in the widget vertically so that the line containing index is displayed at the top edge of the window.

classes: <text> scrolls the view in the widget vertically so that the character at index is displayed at the top edge of the window. classes: <listbox>



method: (move-word inst offset)
method: (send inst move-word offset)
returns: unspecified

Intended to advance the cursor offset words. A word is currently a sequence of letters, digits or underscores. Negative offsets move to the start of the current word (to left of cursor). Positive offsets move to the end of the current word (to right of cursor).

classes: <text>



method: (on-destroy inst thunk)
method: (send inst on-destroy thunk)
returns: unspecified

Adds thunk to a list of procedures to be invoked when the widget is actually destroyed. In particular, these procedures are not invoked if the destroy-request-handler returns #f.

classes: <toplevel>



method: (pos<=? inst index1)
method: (send inst pos<=? index1)
returns: boolean

Returns #t if position of index1 is less than or equal to the position of the insertion cursor, else returns #f.

classes: <text> Returns #t if position of index1 is less than or equal to the position of the insertion cursor, else returns #f. classes: <entry>



method: (pos<=? inst index1 index2)
method: (send inst pos<=? index1 index2)
returns: boolean

Returns #t if position of index1 is less than or equal to index2, else returns #f.

classes: <text> Returns #t if position of index1 is less than or equal to index2, else returns #f. classes: <entry>



method: (pos<=? inst index1 index index2)
method: (send inst pos<=? index1 index index2)
returns: boolean

Returns #t if position of index is between index1 and index2 (inclusive), else returns #f.

classes: <text>



method: (pos<? inst index1)
method: (send inst pos<? index1)
returns: boolean

Returns #t if position of index1 is less than the position of the insertion cursor, else returns #f.

classes: <text> Returns #t if position of index1 is less than the position of the insertion cursor, else returns #f. classes: <entry>



method: (pos<? inst index1 index2)
method: (send inst pos<? index1 index2)
returns: boolean

Returns #t if position of index1 is less than index2, else returns #f.

classes: <text> Returns #t if position of index1 is less than index2, else returns #f. classes: <entry>



method: (pos=? inst index1)
method: (send inst pos=? index1)
returns: boolean

Returns #t if position of index1 is equal to the position of the insertion cursor, else returns #f.

classes: <text> Returns #t if position of index1 is equal to the position of the insertion cursor, else returns #f. classes: <entry>



method: (pos=? inst index1 index2)
method: (send inst pos=? index1 index2)
returns: boolean

Returns #t if position of index1 is equal to index2, else returns #f.

classes: <text> Returns #t if position of index1 is equal to index2, else returns #f. classes: <entry>



method: (pos>=? inst index1)
method: (send inst pos>=? index1)
returns: boolean

Returns #t if position of index1 is greater than or equal to the position of the insertion cursor, else returns #f.

classes: <text> Returns #t if position of index1 is greater than or equal to the position of the insertion cursor, else returns #f. classes: <entry>



method: (pos>=? inst index1 index2)
method: (send inst pos>=? index1 index2)
returns: boolean

Returns #t if position of index1 is greater than or equal to index2, else returns #f.

classes: <text> Returns #t if position of index1 is greater than or equal to index2, else returns #f. classes: <entry>



method: (pos>? inst index1)
method: (send inst pos>? index1)
returns: boolean

Returns #t if position of index1 is greater than the position of the insertion cursor, else returns #f.

classes: <text> Returns #t if position of index1 is greater than the position of the insertion cursor, else returns #f. classes: <entry>



method: (pos>? inst index1 index2)
method: (send inst pos>? index1 index2)
returns: boolean

Returns #t if position of index1 is greater than index2, else returns #f.

classes: <text> Returns #t if position of index1 is greater than index2, else returns #f. classes: <entry>



method: (postscript inst)
method: (send inst postscript)
returns: string

generate Encapsulated PostScript for the canvas

(This may be enriched in the future.)

classes: <canvas>



method: (print inst)
method: (send inst print)
returns: unspecified

Displays a printable representation of the instance to the current output port.

classes: <arc>, <bitmap>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <cascade-menu-item>, <check-menu-item>, <checkbutton>, <command-menu-item>, <entry>, <fixed-mark>, <floating-mark>, <font>, <frame>, <label>, <line>, <listbox>, <markup>, <menu>, <option-button>, <oval>, <photo>, <polygon>, <radio-menu-item>, <radiobutton>, <rectangle>, <rgb>, <scale>, <scrollbar>, <separator-menu-item>, <tab-stop>, <text>, and <toplevel>



method: (print inst op)
method: (send inst print op)
returns: unspecified

Displays a printable representation of the instance to the output port op.

classes: <arc>, <bitmap>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <cascade-menu-item>, <check-menu-item>, <checkbutton>, <command-menu-item>, <entry>, <fixed-mark>, <floating-mark>, <font>, <frame>, <label>, <line>, <listbox>, <markup>, <menu>, <option-button>, <oval>, <photo>, <polygon>, <radio-menu-item>, <radiobutton>, <rectangle>, <rgb>, <scale>, <scrollbar>, <separator-menu-item>, <tab-stop>, <text>, and <toplevel>



method: (raise inst)
method: (send inst raise)
returns: unspecified

Raises this figure in the display list of the canvas.

classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle> Raises a widget to the top of the Z-order so that it obscures any widgets it overlaps. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (raise inst above-this)
method: (send inst raise above-this)
returns: unspecified

Raises this figure above the given figure in the display list of the canvas.

classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle>



method: (remove-follower inst widget)
method: (send inst remove-follower widget)
returns: unspecified

Removes the specified widget from the list of follower widgets.

classes: <toplevel>



method: (remove-markup inst txt index1 index2)
method: (send inst remove-markup txt index1 index2)
returns: unspecified

removes the given markup from the range of text beginning at index1 and ending at index2 within the text widget txt.

classes: <markup>



method: (rgb-blue inst)
method: (send inst rgb-blue)
returns: an integer

Returns the blue component of the color.

classes: <rgb>



method: (rgb-green inst)
method: (send inst rgb-green)
returns: an integer

Returns the green component of the color.

classes: <rgb>



method: (rgb-red inst)
method: (send inst rgb-red)
returns: an integer

Returns the red component of the color.

classes: <rgb>



method: (rgb-values inst)
method: (send inst rgb-values)
returns: see below

Returns the red, green, and blue components of the color.

classes: <rgb>



method: (save-prefs! inst tag)
method: (send inst save-prefs! tag)
returns: unspecified

Saves the preferences associated with this tag.

classes: <arc>, <bitmap>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <cascade-menu-item>, <check-menu-item>, <checkbutton>, <command-menu-item>, <entry>, <fixed-mark>, <floating-mark>, <font>, <frame>, <label>, <line>, <listbox>, <markup>, <menu>, <option-button>, <oval>, <photo>, <polygon>, <radio-menu-item>, <radiobutton>, <rectangle>, <rgb>, <scale>, <scrollbar>, <separator-menu-item>, <tab-stop>, <text>, and <toplevel>



method: (screen->canvas-x inst screenx)
method: (send inst screen->canvas-x screenx)
returns: integer

Returns the canvas x-coordinate corresponding to the given screen x-coordinate.

classes: <canvas>



method: (screen->canvas-y inst screeny)
method: (send inst screen->canvas-y screeny)
returns: integer

Returns the canvas y-coordinate corresponding to the given screen y-coordinate.

classes: <canvas>



method: (search inst pattern index options)
method: (send inst search pattern index options)
returns: see below

Searches text for the given pattern starting at index. options is a possibly empty list of options modifying the search: regexp, forward, backward, case-insensitive. Returns the index of the position where pattern was found, otherwise #f.

classes: <text>



method: (search inst pattern index1 index2 options)
method: (send inst search pattern index1 index2 options)
returns: see below

Searches text for the given pattern between index1 and index2. options is a possibly empty list of options modifying the search: regexp, forward, backward, case-insensitive. Returns the index of the position where pattern was found, otherwise #f.

classes: <text>



method: (select inst)
method: (send inst select)
returns: unspecified

selects the widget.

classes: <checkbutton> and <radiobutton>



method: (select inst index)
method: (send inst select index)
returns: unspecified

Selects the item at the given index

classes: <listbox>



method: (select-range inst start end)
method: (send inst select-range start end)
returns: unspecified

selects only those characters in the text between start and end.

classes: <text> Selects the only items between index1 and index2 inclusive classes: <listbox> Selects the characters starting at start up to but not including the character before end. Characters already selected before this method was called remain selected only if they are in the new range. classes: <entry>



method: (selected? inst index)
method: (send inst selected? index)
returns: boolean

Returns true if the item at the given index is selected, false otherwise.

classes: <listbox>



method: (selection-exists? inst)
method: (send inst selection-exists?)
returns: boolean

returns true if anything in the entry is selected.

classes: <text> returns true if anything in the entry is selected. classes: <entry>



method: (set-above-paragraph-space! inst val)
method: (send inst set-above-paragraph-space! val)
returns: unspecified

Sets in pixels the amount of extra space to insert above each paragraph in the text.

classes: <text> Sets in pixels the amount of extra space to insert above each paragraph in the text. (#f cancels the extra space for this markup) classes: <markup>



method: (set-accept-focus! inst val)
method: (send inst set-accept-focus! val)
returns: unspecified

The boolean val determines wether or not this widget accepts focus when offered by the keyboard traversal mechanism. Keyboard traversal allows the user to move input focus between neighboring widgets by pressing Tab and Shift-Tab.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (set-action! inst proc)
method: (send inst set-action! proc)
returns: unspecified

val specifies a procedure to be called when the value of the scale is changed. The procedure is passed two arguments: the instance and the current value of the scale.

classes: <scale> val specifies a procedure to be called when the widget is activated by clicking or dragging the mouse or by pressing the arrow keys when the widget has keyboard focus.

For instances of <scale> the procedure is passed two arguments: the instance and the current value of the scale.

For instances of <scrollbar> the procedure is passed the instance and two additional arguments matching the arguments of the hscroll and vscroll methods of the various scrollable widgets.

classes: <scrollbar> val specifies a procedure of no arguments to be called when the widget is activated by clicking the mouse or by pressing Return or Space when the widget has keyboard focus. classes: <button>, <checkbutton>, and <radiobutton> val specifies a procedure of one argument (self) to be called when the left mouse button is released over this menu item or when Return or Space are pressed when this item has keyboard focus. Action procedures of toggles like radio-menu-items and check-menu-items should query the state of self, using the get-selected method, to determine how to proceed. The action procedure is invoked as notification that the state may have changed. The procedure should rely on the state within the menu item and not maintain its own state. This helps with the automatic preferences enabling code. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> val is a procedure of one argument (self) evaluated for effect when return or newline is pressed in an <entry>. classes: <entry>



method: (set-active-background-color! inst val)
method: (send inst set-active-background-color! val)
returns: unspecified

Sets the foreground color used when the mouse cursor is over the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <scale> and <scrollbar> Sets the background color used when the mouse cursor is over the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <button>, <checkbutton>, and <radiobutton> Sets the background color used when the mouse cursor is over the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Sets the background color used when the mouse cursor is over the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <menu> Sets the background color used when the mouse cursor is over the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <option-button>



method: (set-active-foreground-color! inst val)
method: (send inst set-active-foreground-color! val)
returns: unspecified

Sets the foreground color used when the mouse cursor is over the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <button>, <checkbutton>, and <radiobutton> Sets the foreground color used when the mouse cursor is over the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Sets the foreground color used when the mouse cursor is over the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <menu> Sets the foreground color used when the mouse cursor is over the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <option-button>



method: (set-anchor! inst val)
method: (send inst set-anchor! val)
returns: unspecified

Determines where information in the widget is displayed. Legal values are n, s, e, w, ne, se, sw, nw, and center.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton> Determines where the figure is displayed relative to its coordinates. Legal values are n, s, e, w, ne, se, sw, nw, and center. classes: <canvas-image>, <canvas-sub-window>, and <canvas-text>



method: (set-arrow-shape! inst inner-length outer-length flair)
method: (send inst set-arrow-shape! inner-length outer-length flair)
returns: unspecified

Sets the shape of the arrowheads drawn on the line. inner-length gives the distance along the line from the tip of the arrow head to its neck, outer-length gives the distance along the line to which the wide part of the arrowhead should extend, and flair describes how far out from the line the wide part of the arrowhead should extend.

classes: <line>



method: (set-arrow-style! inst val)
method: (send inst set-arrow-style! val)
returns: unspecified

Determines where the arrowheads are drawn. val is either none, first, last, or both.

classes: <line>



method: (set-aspect-ratio-bounds! inst min max)
method: (send inst set-aspect-ratio-bounds! min max)
returns: unspecified

Constrains the aspect ratio for this toplevel to lie between min and max which are both ratios of width to height. If min and max are both #f, then any existing contraint on the aspect ratios is cancelled.

classes: <toplevel>



method: (set-background-color! inst val)
method: (send inst set-background-color! val)
returns: unspecified

Sets the default background color for the instance to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Sets the default background color for the instance to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <separator-menu-item> Sets the background color for text with this markup to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt, an instance of <rgb>, or #f which cancels the effect of this markup on background color. classes: <markup> Sets the background color for the bitmap to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <bitmap> Sets the default background color for the instance to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (set-below-paragraph-space! inst val)
method: (send inst set-below-paragraph-space! val)
returns: unspecified

Sets in pixels the amount of extra space to insert below each paragraph in the text.

classes: <text> Sets in pixels the amount of extra space to insert below each paragraph in the text. (#f cancels the extra space for this markup) classes: <markup>



method: (set-blank! inst val)
method: (send inst set-blank! val)
returns: unspecified

If val is a character, then the contents of the widget are displayed using only that character (e.g. for passwords). The default is #f indicating that the contents should be displayed without translation.

classes: <entry>



method: (set-border-width! inst val)
method: (send inst set-border-width! val)
returns: unspecified

Sets the width in pixels of the border drawn around text with this markup, or cancels the border if #f.

classes: <markup> Sets the width in pixels of the border drawn around the instance. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (set-cap-style! inst val)
method: (send inst set-cap-style! val)
returns: unspecified

Determines how caps are drawn at the endpoints of the line. val is either butt, projecting, or round.

classes: <line>



method: (set-close-enough! inst val)
method: (send inst set-close-enough! val)
returns: unspecified

val determines how close the mouse cursor must be before it is considered to be inside an item.

classes: <canvas>



method: (set-confine! inst val)
method: (send inst set-confine! val)
returns: unspecified

val is a boolean that determines whether or not the canvas is prevented from scrolling the view of the canvas outside the region defined by set-scroll-region!.

classes: <canvas>



method: (set-coords! inst x1 y1 x2 y2 x3 y3 more ...)
method: (send inst set-coords! x1 y1 x2 y2 x3 y3 more ...)
returns: unspecified

Sets the coordinates of the polygon to x1, y1, x2, y2, x3, y3, etc.

classes: <polygon>



method: (set-coords! inst x1 y1 x2 y2 more ...)
method: (send inst set-coords! x1 y1 x2 y2 more ...)
returns: unspecified

Sets the coordinates for the line to x1, y1, x2, y2, etc.

classes: <line>



method: (set-coords! inst x1 y1)
method: (send inst set-coords! x1 y1)
returns: unspecified

Sets the coordinates of the anchor for this figure to x1, y1.

classes: <canvas-image>, <canvas-sub-window>, and <canvas-text>



method: (set-coords! inst x1 y1 x2 y2)
method: (send inst set-coords! x1 y1 x2 y2)
returns: unspecified

Sets the coordinates defining the figure to x1, y1, x2, y2.

classes: <arc>, <oval>, and <rectangle>



method: (set-cursor-pos! inst new)
method: (send inst set-cursor-pos! new)
returns: unspecified

Sets the insertion cursor position within the widget Note: the cursor position can't be set outside the bounds of the text in the widget. Attempts to do so place the cursor at the point in the text closest to the target index. For example, setting cursor position to line 7 char 4000 when line 7 doesn't have 4000 chars will put the cursor at line 8 char 0.

classes: <text> Positions the listbox cursor at the index pos (zero-based). classes: <listbox> sets the position of the insertion cursor within the widget. If index is outside the bounds of the text displayed in the widget, the cursor is placed at the point in the text closest to the target index. classes: <entry>



method: (set-data! inst string)
method: (send inst set-data! string)
returns: unspecified

Sets the bitmap data to be displayed by this <photo>. The string data should be base64-encoded GIF or PBM data. ( The swl:base64-encode procedure in the swl:base64 module can be used to encode the data for consumption by the underlying Tk library.)

classes: <photo> Sets the bitmap data to be displayed by this <bitmap>. The string data should be in the format of an X11 bitmap file (a stylized C program). classes: <bitmap>



method: (set-destroy-request-handler! inst proc)
method: (send inst set-destroy-request-handler! proc)
returns: unspecified

Installs a new destroy request handler for this toplevel window. When a destroy request is received, proc is invoked and passed this toplevel as an argument. If proc returns #f, then the destroy request is refused. Otherwise the toplevel is destroyed.

classes: <toplevel>



method: (set-digits! inst val)
method: (send inst set-digits! val)
returns: unspecified

Sets the number of significant digits in the value of the scale. If zero, then the scale chooses the smallest value that distinguishes each position of the slider.

classes: <scale>



method: (set-disabled-background-color! inst val)
method: (send inst set-disabled-background-color! val)
returns: unspecified

Sets the background color used when the widget is disabled to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <entry> and <text>



method: (set-disabled-foreground-color! inst val)
method: (send inst set-disabled-foreground-color! val)
returns: unspecified

Sets the foreground color used when the widget is disabled to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <button>, <checkbutton>, and <radiobutton> Sets the foreground color used when the widget is disabled to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <entry> and <text> Sets the foreground color used when the widget is disabled to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <menu> Sets the foreground color used when the widget is disabled to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <option-button>



method: (set-draw-indicator! inst val)
method: (send inst set-draw-indicator! val)
returns: unspecified

val is a boolean value determining whether or not the state of the widget is indicated by drawing a small square or diamond filled or not filled with the select color (see set-select-color!).

classes: <checkbutton> and <radiobutton> val is a boolean value determining whether or not the state of the item is indicated by drawing a small square or diamond filled or not filled with the select color (see set-select-color!). classes: <check-menu-item> and <radio-menu-item>



method: (set-draw-spline! inst val)
method: (send inst set-draw-spline! val)
returns: unspecified

val is a boolean that determines whether or not the outline of the figure is drawn as a spline.

classes: <line> and <polygon>



method: (set-enabled! inst val)
method: (send inst set-enabled! val)
returns: unspecified

val is a boolean value indicating whether or not the widget is enabled and responsive to user interaction.

classes: <button>, <checkbutton>, and <radiobutton> val is a boolean value indicating whether or not the widget is enabled and responsive to user interaction. classes: <entry> and <text> val is a boolean value indicating whether or not the widget is enabled and responsive to user interaction. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> val is a boolean value indicating whether or not the widget is enabled and responsive to user interaction. classes: <option-button>



method: (set-export-selection! inst val)
method: (send inst set-export-selection! val)
returns: unspecified

val is a boolean value that determines whether or not selection in the widget should also be the X selection. When #t selecting in the widget deselects the current X selection and vice versa.

classes: <entry>, <listbox>, and <text>



method: (set-extent! inst val)
method: (send inst set-extent! val)
returns: unspecified

Sets the extent in degrees of the arc.

classes: <arc>



method: (set-filename! inst fn)
method: (send inst set-filename! fn)
returns: unspecified

Unfortunately the Tk documentation is pretty sketchy about photo support, so it is only possible to specify image data via filename at present.

classes: <photo> Set the image filename. classes: <bitmap>



method: (set-fill-color! inst val)
method: (send inst set-fill-color! val)
returns: unspecified

Sets the color with which the interior of the figure is filled. val is either the symbol transparent, a symbol naming a color in rgb.txt, or an instance of <rgb>.

classes: <canvas-text> Sets the color with which the interior of the figure is filled. val is either the symbol transparent, a symbol naming a color in rgb.txt, or an instance of <rgb>. classes: <line> and <polygon> Sets the color with which the interior of the figure is filled. val is either the symbol transparent, a symbol naming a color in rgb.txt, or an instance of <rgb>. classes: <arc>, <oval>, and <rectangle>



method: (set-focus inst)
method: (send inst set-focus)
returns: unspecified

Gives this widget keyboard focus: all key-press / key-release events are directed to this widget until the focus is set to some other widget via the keyboard traversal mechanism or via the set-focus method.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (set-font! inst val)
method: (send inst set-font! val)
returns: unspecified

Sets the default font for text displayed by the scale. val is an instance of <font> (see the description of the make-font macro). This affects the display of the scale's value.

classes: <scale> Sets the font for text displayed in the widget. val is an instance of <font> (see the description of the make-font macro). classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text> Sets the font for text displayed in the widget. val is an instance of <font> (see the description of the make-font macro). classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Sets the font for text displayed in the widget. val is an instance of <font> (see the description of the make-font macro). classes: <menu> Sets the font for text with this markup. val is an instance of <font> (see the description of the make-font macro) or #f which cancels the effect of this markup on font. classes: <markup> Sets the font for the text displayed. val is an instance of <font> (see the description of the make-font macro). classes: <canvas-text>



method: (set-foreground-color! inst val)
method: (send inst set-foreground-color! val)
returns: unspecified

Sets the default foreground color for the scale to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <scale> Sets the foreground color for the instance to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text> Sets the foreground color for the instance to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Sets the foreground color for the instance to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <menu> Sets the foreground color for text with this markup to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt, an instance of <rgb>, or #f which cancels the effect of this markup on foreground color. classes: <markup> Sets the foreground color for the bitmap to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. classes: <bitmap>



method: (set-geometry! inst geom)
method: (send inst set-geometry! geom)
returns: unspecified

Sets the geometry for this toplevel to the width, height, and/or screen position specified by the string geom which has the general form "widthxheight+x+y". Either width and height or x and y may be omitted. A + before x (y) designates x (y) as a pixel offset from the left (top) of the screen to the left (top) edge of the window. If x (y) is preceded by - instead of +, it indicates a pixel offset from the right (bottom) of the screen to the right (bottom) edge of the window. If geom is #f instead of a string, the geometry of the window reverts to the size requested internally by the widgets it contains.

classes: <toplevel>



method: (set-grid! inst val)
method: (send inst set-grid! val)
returns: unspecified

val is a boolean determining whether or not the text widget should strive to keep its dimensions in even multiples of the dimensions of a character in its current font. The default is #f.

classes: <text> val is a boolean determining whether or not the listbox should strive to keep its dimensions in even multiples of the dimensions of a character in its current font. The default is #f. classes: <listbox>



method: (set-height! inst val)
method: (send inst set-height! val)
returns: unspecified

It is not presently possible to set the height of this widget in pixels. See set-height/char!.

classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text> Sets the height in pixels of the sub-window. classes: <canvas-sub-window> Sets the height in pixels of the widget. classes: <canvas>, <frame>, and <toplevel>



method: (set-height/char! inst val)
method: (send inst set-height/char! val)
returns: unspecified

Sets the height of the widget in lines of text. The default is zero indicating the widget should size itself.

classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text>



method: (set-hpad! inst val)
method: (send inst set-hpad! val)
returns: unspecified

Specifies in pixels the extra horizontal distance to add around the widget.

classes: <text>



method: (set-hscroll-increment! inst val)
method: (send inst set-hscroll-increment! val)
returns: unspecified

Constrains horizontal scrolling so that the x-coordinate at the left edge of the widget is an even multiple of val pixels. The hscroll method will scroll by val pixels when scrolling by units. If val is zero, scrolling is unconstrained.

classes: <canvas>



method: (set-hscroll-notify! inst val)
method: (send inst set-hscroll-notify! val)
returns: unspecified

Specifies a procedure to be invoked when the horizontal view or content of the widget changes. The procedure is passed two numbers between 0 and 1 indicating what fraction of the widget's content is to the left of the first position in the widget, and what fraction is to the left of the end position of the widget. Thus, the first number indicates what fraction of the widget's content is out of view to the left and the second number indicates what fraction of the widget's content is not out of view to the right.

If val is #f, then the existing notify action is cancelled.

classes: <entry>, <listbox>, and <text> Specifies a procedure to be invoked when the horizontal view or content of the widget changes. The procedure is passed two numbers between 0 and 1 indicating what fraction of the widget's content is to the left of the first position in the widget, and what fraction is to the left of the end position of the widget. Thus, the first number indicates what fraction of the widget's content is out of view to the left and the second number indicates what fraction of the widget's content is not out of view to the right.

If val is #f, then the existing notify action is cancelled.

classes: <canvas>



method: (set-icon-title! inst val)
method: (send inst set-icon-title! val)
returns: unspecified

Sets the text displayed by the toplevel when it is iconified to the string given by val.

classes: <toplevel>



method: (set-image! inst val)
method: (send inst set-image! val)
returns: unspecified

Sets the image to display in this canvas item to val which should be an instance of <bitmap> or <photo>.

classes: <canvas-image>



method: (set-insert-border-width! inst val)
method: (send inst set-insert-border-width! val)
returns: unspecified

Sets the width in pixels of the 3-D border drawn around the insertion cursor for the widget.

classes: <entry> and <text>



method: (set-insert-color! inst val)
method: (send inst set-insert-color! val)
returns: unspecified

Sets the color for the insertion cursor of the widget widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <entry> and <text>



method: (set-insert-off-time! inst val)
method: (send inst set-insert-off-time! val)
returns: unspecified

Specifies the number of milliseconds the insertion cursor for this widget will be hidden during each blink cycle.

classes: <entry> and <text>



method: (set-insert-on-time! inst val)
method: (send inst set-insert-on-time! val)
returns: unspecified

Specifies the number of milliseconds the insertion cursor for this widget will be visible during each blink cycle.

classes: <entry> and <text>



method: (set-insert-width! inst val)
method: (send inst set-insert-width! val)
returns: unspecified

Sets the width in pixels of the insertion cursor for the widget.

classes: <entry> and <text>



method: (set-join-style! inst val)
method: (send inst set-join-style! val)
returns: unspecified

Determines how the articulations between line segments are drawn. val is either bevel, miter, or round. The difference is only appreciable for thick lines.

classes: <line>



method: (set-jump-scroll! inst val)
method: (send inst set-jump-scroll! val)
returns: unspecified

val is a boolean that determines whether or not the scrollbar waits until it is released before notifying the associated widget. The default is #f meaning that controlled widgets are continuously notified as the scrollbar is dragged.

classes: <scrollbar>



method: (set-justify! inst val)
method: (send inst set-justify! val)
returns: unspecified

Determines how lines are to be justified when multiple lines are displayed. Legal values are left, right, and center.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton> val must be left, right, or center. This determines where the the insertion cursor begins and how the text is displayed when it all fits in the widget. classes: <entry> Determines how lines are to be justified when multiple lines are displayed. Legal values are left, right, and center. classes: <canvas-text>



method: (set-key-press-method! inst val)
method: (send inst set-key-press-method! val)
returns: unspecified

specifies a procedure to be called when a key is pressed while the mouse is over a range of text with this markup. val is a procedure of four arguments: self, text, key, and mods. The first two correspond to the markup and the particular text that generated the event, and the latter two are suitable for use with event-case. Note that the text widget is also notified of the key-press event.

classes: <markup>



method: (set-key-release-method! inst val)
method: (send inst set-key-release-method! val)
returns: unspecified

specifies a procedure to be called when a key is released while the mouse is over a range of text with this markup. val is a procedure of four arguments: self, text, key, and mods. The first two correspond to the markup and the particular text that generated the event, and the latter two are suitable for use with event-case. Note that the text widget is also notified of the key-release event.

classes: <markup>



method: (set-left-margin! inst val)
method: (send inst set-left-margin! val)
returns: unspecified

Determines the left margin in pixels for text other than the first line of a paragraph with this markup. If val is #f, this markup will have no effect on left margin.

classes: <markup>



method: (set-length! inst val)
method: (send inst set-length! val)
returns: unspecified

sets the length in pixels of the long dimension of the scale.

classes: <scale>



method: (set-line-space! inst val)
method: (send inst set-line-space! val)
returns: unspecified

Sets in pixels the amount of extra space to insert between each line in the text.

classes: <text> Sets in pixels the amount of extra space to insert between each line in the text. (#f cancels the extra space for this markup) classes: <markup>



method: (set-line-thickness! inst val)
method: (send inst set-line-thickness! val)
returns: unspecified

Sets the thickness in pixels of the outline drawn around the figure.

classes: <line> and <polygon> Sets the thickness in pixels of the outline drawn around the figure. classes: <arc>, <oval>, and <rectangle>



method: (set-mask-data! inst string)
method: (send inst set-mask-data! string)
returns: unspecified

Sets the mask bitmap for this <bitmap>. The string should be in the format of an X11 bitmap file (a stylized C program).

classes: <bitmap>



method: (set-max! inst val)
method: (send inst set-max! val)
returns: unspecified

sets the high value of the range represented by the scale to the integer or floating point number val.

classes: <scale>



method: (set-max-size! inst width height)
method: (send inst set-max-size! width height)
returns: unspecified

Sets the maximum size for this toplevel to width and height. See also 3.

classes: <toplevel>



method: (set-menu! inst m)
method: (send inst set-menu! m)
returns: unspecified

Sets the menu to be posted when this item is chosen to menu which must be an instance of <menu>.

classes: <cascade-menu-item> Sets the menu for this toplevel window. classes: <toplevel>



method: (set-menu-items! inst ls)
method: (send inst set-menu-items! ls)
returns: unspecified

Sets the list of menu items to ls. Menu contents can be manipulated with all the list-processing tools available in Scheme. It is undefined what happens when the list contains duplicates. The list must contain only menu items.

classes: <menu>



method: (set-min! inst val)
method: (send inst set-min! val)
returns: unspecified

sets the low value of the range represented by the scale to the integer or floating point number val.

classes: <scale>



method: (set-min-size! inst width height)
method: (send inst set-min-size! width height)
returns: unspecified

Sets the minimum size for this toplevel to width and height. See also 3.

classes: <toplevel>



method: (set-mouse-cursor! inst val)
method: (send inst set-mouse-cursor! val)
returns: unspecified

Sets the mouse cursor to be displayed when the mouse pointer is in the widget. val is either a symbol naming a standard X cursor in cursorfont.h or a list of two or three items where the first is a symbol as before and the other items are colors specifying the foreground and (if present) background color for the cursor.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (set-mouse-enter-method! inst val)
method: (send inst set-mouse-enter-method! val)
returns: unspecified

specifies a procedure to be called when the mouse enters a range of text with this markup. val is a procedure of five arguments: self, text, x, y, and mods. The first two correspond to the markup and the particular text that generated the event, x and y are the coordinates of the mouse within the text widget, and mods is suitable for use with event-case. Note that the text widget is also notified of the mouse-enter event. There seems to be an underlying Tk bug that makes the mouse button modifiers unavailable for mouse-enter and mouse-leave events. The keyboard modifiers are unaffected.

classes: <markup>



method: (set-mouse-leave-method! inst val)
method: (send inst set-mouse-leave-method! val)
returns: unspecified

specifies a procedure to be called when the mouse leaves a range of text with this markup. val is a procedure of five arguments: self, text, x, y, and mods. The first two correspond to the markup and the particular text that generated the event, x and y are the coordinates of the mouse within the text widget, and mods is suitable for use with event-case. Note that the text widget is also notified of the leave event. There seems to be an underlying Tk bug that makes the mouse button modifiers unavailable for mouse-enter and mouse-leave events. The keyboard modifiers are unaffected.

classes: <markup>



method: (set-mouse-motion-method! inst val)
method: (send inst set-mouse-motion-method! val)
returns: unspecified

specifies a procedure to be called when the mouse moves over a range of text with this markup. val is a procedure of five arguments: self, text, x, y, and mods. The first two correspond to the markup and the particular text that generated the event, x and y are the coordinates of the mouse within the text widget, and mods is suitable for use with event-case. Note that the text widget is also notified of the mouse-motion event.

classes: <markup>



method: (set-mouse-press-method! inst val)
method: (send inst set-mouse-press-method! val)
returns: unspecified

specifies a procedure to be called when a mouse button is pressed over a range of text with this markup. val is a procedure of five arguments: self, text, x, y, and mods. The first two correspond to the markup and the particular text that generated the event, x and y are the coordinates of the mouse within the text widget, and mods is suitable for use with event-case. Note that the text widget is also notified of the mouse-press event.

classes: <markup>



method: (set-mouse-release-method! inst val)
method: (send inst set-mouse-release-method! val)
returns: unspecified

specifies a procedure to be called when a mouse button is released over a range of text with this markup. val is a procedure of five arguments: self, text, x, y, and mods. The first two correspond to the markup and the particular text that generated the event, x and y are the coordinates of the mouse within the text widget, and mods is suitable for use with event-case. Note that the text widget is also notified of the mouse-release event.

classes: <markup>



method: (set-options! inst ls)
method: (send inst set-options! ls)
returns: unspecified

ls is a list of strings or pairs whose car is a string and whose cdr is a procedure of no arguments

classes: <option-button>



method: (set-orientation! inst val)
method: (send inst set-orientation! val)
returns: unspecified

Specifies the desired orientation of the widget. val is either horizontal or vertical.

classes: <scale> and <scrollbar>



method: (set-outline-color! inst val)
method: (send inst set-outline-color! val)
returns: unspecified

Sets the color in which the outline of the figure is drawn. val is either a symbol naming a color in rgb.txt or an instance of <rgb>.

classes: <polygon> Sets the color in which the outline of the figure is drawn. val is either a symbol naming a color in rgb.txt or an instance of <rgb>. classes: <arc>, <oval>, and <rectangle>



method: (set-override-redirect! inst bool)
method: (send inst set-override-redirect! bool)
returns: unspecified

If set to true, this toplevel will be ignored by the window manager (ie. no decorative border will be drawn, etc.). Changes in this setting may not take effect until with toplevel is hidden and shown.

classes: <toplevel>



method: (set-overstrike! inst val)
method: (send inst set-overstrike! val)
returns: unspecified

Determines whether or not text with this markup is overstricken.

classes: <markup>



method: (set-paragraph-indent! inst val)
method: (send inst set-paragraph-indent! val)
returns: unspecified

Determines the left margin in pixels for the first line of a paragraph with this markup. If val is #f, this markup will have no effect on indent.

classes: <markup>



method: (set-pref! inst key val)
method: (send inst set-pref! key val)
returns: unspecified

Associates the value val with preference key.

classes: <arc>, <bitmap>, <button>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <canvas>, <cascade-menu-item>, <check-menu-item>, <checkbutton>, <command-menu-item>, <entry>, <fixed-mark>, <floating-mark>, <font>, <frame>, <label>, <line>, <listbox>, <markup>, <menu>, <option-button>, <oval>, <photo>, <polygon>, <radio-menu-item>, <radiobutton>, <rectangle>, <rgb>, <scale>, <scrollbar>, <separator-menu-item>, <tab-stop>, <text>, and <toplevel>



method: (set-prefs-key! inst v)
method: (send inst set-prefs-key! v)
returns: unspecified

Sets the preferences key for this menu item. When set, the set-selected! method stores the current state in the preferences cache for the current application. When set, the applications preferences must already have been loaded (via load-prefs) before set-selected! is called. Saved preferences override settings installed by set-selected! until the menu item is actually installed in a menu that is attached to a window.

classes: <check-menu-item> and <radio-menu-item>



method: (set-prefs-tag! inst tag)
method: (send inst set-prefs-tag! tag)
returns: unspecified

Load preferences identified by the given tag. This simply enables us to use the (prefs-tag: ...) syntax with the create macro. This must be set before we set the menu: option.

classes: <toplevel>



method: (set-relief! inst val)
method: (send inst set-relief! val)
returns: unspecified

Determines how the border of the affected region of text is drawn. Legal values are flat, sunken, raised, ridge, groove, and #f which cancels the effect of this markup on relief. See also set-border-width!. Note: If the widget border width is set to zero, setting relief will have no visible effect.

classes: <markup> Determines how the border of the widget is drawn. Legal values are flat, sunken, raised, ridge, groove. See also set-border-width!. If the widget border width is set to zero, setting relief will have no visible effect. classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (set-repeat-delay! inst val)
method: (send inst set-repeat-delay! val)
returns: unspecified

Sets the number of milliseconds a button or key must be held down before it begins to autorepeat.

classes: <scale> and <scrollbar>



method: (set-repeat-interval! inst val)
method: (send inst set-repeat-interval! val)
returns: unspecified

Sets the number of milliseconds to delay between auto-repeats.

classes: <scale> and <scrollbar>



method: (set-resizable! inst width height)
method: (send inst set-resizable! width height)
returns: unspecified

width and height are boolean values that determine whether the toplevel can be resized interactively along those dimensions. set-min-size! and set-max-size! have no effect on dimensions for which resizing has been prohibited.

classes: <toplevel>



method: (set-resolution! inst val)
method: (send inst set-resolution! val)
returns: unspecified

sets the resolution of the scale's value to val. If greater than zero, the value of the scale will be rounded to an even multiple of val.

classes: <scale>



method: (set-right-margin! inst val)
method: (send inst set-right-margin! val)
returns: unspecified

Determines the right margin in pixels for text with this markup. If val is #f, this markup will have no effect on right margin.

classes: <markup>



method: (set-saved-text! inst s)
method: (send inst set-saved-text! s)
returns: unspecified

records the given string as the saved text to be restored by a yank.

classes: <entry> and <text>



method: (set-scroll-region! inst x1 y1 x2 y2)
method: (send inst set-scroll-region! x1 y1 x2 y2)
returns: unspecified

The region defined by x1, y1, x2, and y2 is taken to be the boundary of the information on the canvas.

classes: <canvas>



method: (set-select-background-color! inst val)
method: (send inst set-select-background-color! val)
returns: unspecified

Sets the background color for selected items in the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <entry>, <listbox>, and <text>



method: (set-select-border-width! inst val)
method: (send inst set-select-border-width! val)
returns: unspecified

Sets the width in pixels of the raised 3-D border drawn around selected items. Setting to zero effectively disables the 3-D effect.

classes: <entry>, <listbox>, and <text>



method: (set-select-color! inst val)
method: (send inst set-select-color! val)
returns: unspecified

Sets the color used to show when the widget is selected. If the indicator is drawn (see set-draw-indicator!) it is filled with this color when the widget is selected, otherwise this color is used as the background color for the widget when selected. val is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. The color is red.

classes: <checkbutton> and <radiobutton> Sets the color used to show when the item is selected. If the indicator is drawn (see set-draw-indicator!) it is filled with this color when the item is selected, otherwise this color is used as the background color for the item when selected. val is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. The color is red. classes: <check-menu-item> and <radio-menu-item> Sets the color used to show when the item is selected. If the indicator is drawn (see set-draw-indicator!) it is filled with this color when the item is selected, otherwise this color is used as the background color for the item when selected. val is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>. The color is red. classes: <menu>



method: (set-select-foreground-color! inst val)
method: (send inst set-select-foreground-color! val)
returns: unspecified

Sets the foreground color for selected items in the widget to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <entry>, <listbox>, and <text>



method: (set-select-image! inst val)
method: (send inst set-select-image! val)
returns: unspecified

Sets the image to be displayed when this item is selected.

classes: <checkbutton> and <radiobutton> Sets the image to be displayed when this item is selected. classes: <check-menu-item> and <radio-menu-item>



method: (set-select-mode! inst val)
method: (send inst set-select-mode! val)
returns: unspecified

val is either single, browse, multiple, or extended determining how items in the listbox can be selected. When the select mode is single or browse at most one item can be selected at a time. Multiple items can be selected when the select mode is multiple or extended. In multiple mode, the selected state of an item is toggled. The selection can be dragged in browse and extended modes.

classes: <listbox>



method: (set-selected! inst val)
method: (send inst set-selected! val)
returns: unspecified

Marks this item selected so that its selector is drawn.

classes: <check-menu-item> and <radio-menu-item>



method: (set-show-value! inst val)
method: (send inst set-show-value! val)
returns: unspecified

val is a boolean indicating whether or not the scale should show its current value beside the slider.

classes: <scale>



method: (set-skip-increment! inst val)
method: (send inst set-skip-increment! val)
returns: unspecified

sets the size of the skips made when the scale is clicked on in a way that jumps.

classes: <scale>



method: (set-slider-length! inst val)
method: (send inst set-slider-length! val)
returns: unspecified

sets the length of the slider along its long dimension to val pixels.

classes: <scale>



method: (set-spline-steps! inst val)
method: (send inst set-spline-steps! val)
returns: unspecified

Sets the number of steps to use when drawing the spline. If zero the figure is not drawn as a spline otherwise a spline is drawn for every pair of line segments using val segments for every pair

classes: <line> and <polygon>



method: (set-start! inst val)
method: (send inst set-start! val)
returns: unspecified

Sets the position in degrees where the arc begins.

classes: <arc>



method: (set-stipple! inst val)
method: (send inst set-stipple! val)
returns: unspecified

(unimplemented)

classes: <canvas-text> (currently unimplemented) classes: <line> and <polygon> (currently unimplemented) classes: <arc>, <oval>, and <rectangle>



method: (set-style! inst val)
method: (send inst set-style! val)
returns: unspecified

Determines how the arc is displayed. val is either arc, chord, or pieslice.

classes: <arc>



method: (set-tabs! inst val)
method: (send inst set-tabs! val)
returns: unspecified

This sets the default tab stops for this text widget to those supplied by the list of <tab-stop> instances. Four kinds of tabs are supported: left aligned, right aligned, centered, and numeric. (See the tab-stops macro.) Note that markups may be applied to alter tab stops within a particular region.

classes: <text> This sets the tab stops for regions of text bearing this markup to those supplied by the list of <tab-stop> instances, or cancels tab settings for this markup if #f. Four kinds of tabs are supported: left aligned, right aligned, centered, and numeric. (See the tab-stops macro.) classes: <markup>



method: (set-title! inst val)
method: (send inst set-title! val)
returns: unspecified

Sets the content displayed by the widget to the string, <bitmap>, or <photo> given by val.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton> Sets the text displayed by the menu item to the string or image supplied as val. If val is a pair, then the first element (a string or image) is displayed as the title and the second (a string) is displayed at the right side of the menu item (eg. to show a keyboard short-cut). If the title contains an underscore character, the following character is displayed with an underline. (There is no escape for this yet.) The underlined characters in the titles of menu items in a <toplevel> widget's menu bar indicate keys that can be pressed with the Alt key to post the corresponding menus. See the menu tutorial for an example. classes: <cascade-menu-item>, <check-menu-item>, <command-menu-item>, and <radio-menu-item> Sets the text displayed by the toplevel when it is not iconified to the string given by val. classes: <toplevel> Sets the string displayed by the figure. classes: <canvas-text>



method: (set-transient! inst master)
method: (send inst set-transient! master)
returns: unspecified

If master is another <toplevel>, then this toplevel becomes a transient serving master. Window managers often display transients with less decoration and manage them specially relative to the specified master. Setting master to #f cancels the transient status of the window.

classes: <toplevel>



method: (set-traversal-background-color! inst val)
method: (send inst set-traversal-background-color! val)
returns: unspecified

Sets the color for the traversal highlight region when the widget does not have input focus. val is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (set-traversal-color! inst val)
method: (send inst set-traversal-color! val)
returns: unspecified

Sets the color for the traversal highlight region when the widget has input focus. val is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (set-traversal-thickness! inst val)
method: (send inst set-traversal-thickness! val)
returns: unspecified

Sets the width in pixels of the traversal highlight region.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (set-trough-color! inst val)
method: (send inst set-trough-color! val)
returns: unspecified

Sets the color for the trough (in which the slider of the widget moves) to val, which is either a symbol naming a color in /usr/lib/X11/rgb.txt or an instance of <rgb>.

classes: <scale> and <scrollbar>



method: (set-underline! inst val)
method: (send inst set-underline! val)
returns: unspecified

Determines whether or not text with this markup is underlined.

classes: <markup>



method: (set-underline-index! inst val)
method: (send inst set-underline-index! val)
returns: unspecified

val specifies the zero-based index of a character to be underline when the string is displayed. Set to #f to disable the underline.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton>



method: (set-value! inst value)
method: (send inst set-value! value)
returns: unspecified

sets the current value of the scale to value. The action procedure, if any, is invoked with the instance and the new value.

classes: <scale>



method: (set-view! inst top bottom)
method: (send inst set-view! top bottom)
returns: unspecified

Sets the size and position of the scrollbar based on information from the controlled widget about what fraction of its content is out of view to the top (or left) and what fraction of its content is not out of view to the bottom or right.

classes: <scrollbar>



method: (set-vpad! inst val)
method: (send inst set-vpad! val)
returns: unspecified

Specifies in pixels the extra vertical distance to add around the widget.

classes: <text>



method: (set-vscroll-increment! inst val)
method: (send inst set-vscroll-increment! val)
returns: unspecified

Constrains vertical scrolling so that the y-coordinate at the top edge of the widget is an even multiple of val pixels. The vscroll method will scroll by val pixels when scrolling by units. If val is zero, scrolling is unconstrained.

classes: <canvas>



method: (set-vscroll-notify! inst val)
method: (send inst set-vscroll-notify! val)
returns: unspecified

Specifies a procedure to be invoked when the vertical view or content of the widget changes. The procedure is passed two numbers between 0 and 1 indicating what fraction of the widget's content is above the first position in the widget, and what fraction is above the end position of the widget. Thus, the first number indicates what fraction of the widget's content is out of view to the top and the second number indicates what fraction of the widget's content is not out of view to the bottom.

If val is #f, then the existing notify action is cancelled.

classes: <listbox> and <text> This method overrides the inherited method. The given value is not used for an <entry>, but is provided for compatibility with other scrollable widgets. classes: <entry> Specifies a procedure to be invoked when the vertical view or content of the widget changes. The procedure is passed two numbers between 0 and 1 indicating what fraction of the widget's content is above the first position in the widget, and what fraction is above the end position of the widget. Thus, the first number indicates what fraction of the widget's content is out of view to the top and the second number indicates what fraction of the widget's content is not out of view to the bottom.

If val is #f, then the existing notify action is cancelled.

classes: <canvas>



method: (set-width! inst val)
method: (send inst set-width! val)
returns: unspecified

Sets the width in pixels of the narrow dimension of the scrollbar or scale.

classes: <scale> and <scrollbar> It is not presently possible to set the width of this widget in pixels. See set-width/char!. classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text> Sets the width in pixels of the sub-window. classes: <canvas-sub-window> Lines longer than val characters will be wrapped onto the next line. If zero, lines break only where there are newline characters in the displayed string. classes: <canvas-text> Sets the width in pixels of the widget. classes: <canvas>, <frame>, and <toplevel>



method: (set-width/char! inst val)
method: (send inst set-width/char! val)
returns: unspecified

Sets the width of the widget in characters. The default is zero indicating the widget should size itself.

classes: <button>, <checkbutton>, <entry>, <label>, <listbox>, <option-button>, <radiobutton>, and <text>



method: (set-window! inst val)
method: (send inst set-window! val)
returns: unspecified

val is a widget to be placed on the canvas.

classes: <canvas-sub-window>



method: (set-wrap! inst val)
method: (send inst set-wrap! val)
returns: unspecified

Determines how lines that are too long to be displayed will be wrapped. val can be either char for wrapping lines at character boundaries, word for wrapping lines a word boundaries, or none which prevents lines from being wrapped.

classes: <text> Determines how lines that are too long to be displayed will be wrapped. val can be either char for wrapping lines at character boundaries, word for wrapping lines a word boundaries, none which prevents lines from being wrapped, or #f which cancels the effect of this markup on text wrapping. classes: <markup>



method: (set-wrap-length! inst val)
method: (send inst set-wrap-length! val)
returns: unspecified

Lines longer than val pixels will be wrapped onto the next line. If zero, lines break only where there are newline characters in the displayed string.

classes: <button>, <checkbutton>, <label>, <option-button>, and <radiobutton>



method: (show inst)
method: (send inst show)
returns: unspecified

Makes the toplevel visible in its usual size (deiconifies the window if necessary).

classes: <toplevel> Makes the canvas item visible again after it has been hidden. classes: <arc>, <canvas-image>, <canvas-sub-window>, <canvas-text>, <line>, <oval>, <polygon>, and <rectangle> Makes the widget visible in its parent. The order in which widgets are shown determines the order in which they appear in their parent.

Planned revisions include eliminating this order dependency.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <option-button>, <radiobutton>, <scale>, <scrollbar>, and <text>



method: (show inst content x y width height)
method: (send inst show content x y width height)
returns: unspecified



method: (tab-alignment inst)
method: (send inst tab-alignment)
returns: see below

Returns the alignment (left, right, center, or numeric) for this tab stop.

classes: <tab-stop>



method: (tab-position inst)
method: (send inst tab-position)
returns: an integer

Returns the position of this tab stop as an offset in pixels.

classes: <tab-stop>



method: (toggle inst)
method: (send inst toggle)
returns: unspecified

toggles the selection state of the button.

classes: <checkbutton>



method: (visible? inst)
method: (send inst visible?)
returns: boolean

Returns #t if the widget is visible, #f otherwise.

classes: <button>, <canvas>, <checkbutton>, <entry>, <frame>, <label>, <listbox>, <menu>, <option-button>, <radiobutton>, <scale>, <scrollbar>, <text>, and <toplevel>



method: (vscroll inst n qualifier)
method: (send inst vscroll n qualifier)
returns: unspecified

Scrolls the view in the widget vertically. If qualifier is fraction, then n indicates what fraction of the widget contents should be moved out of view to the top. Otherwise, n is an integer indicating how many pages or units to scroll (negative values scroll up, positive scroll down), and qualifier is either pages, or units (characters).

classes: <listbox> and <text> Vertical scroll requests are ignored by <entry> widgets. classes: <entry> Scrolls the view in the widget vertically. If qualifier is fraction, then n indicates what fraction of the widget contents should be moved out of view to the top. Otherwise, n is an integer indicating how many pages or units to scroll (negative values scroll up, positive scroll down), and qualifier is either pages, or units (pixels). classes: <canvas>



method: (word-end inst pos)
method: (send inst word-end pos)
returns: see below

Returns a new pair scheme(column . line) that refers to the position of the last character of the word at position pos. pos is either a pair or an instance of <fixed-mark> or <floating-mark>.

classes: <text> Returns the index of the last character of the word at position pos within the widget. classes: <entry>



method: (word-start inst pos)
method: (send inst word-start pos)
returns: see below

Returns a new pair scheme(column . line) that refers to the position of the first character of the word at position pos. pos is either a pair or an instance of <fixed-mark> or <floating-mark>.

classes: <text> Returns the index of the first character of the word at position pos within the widget. classes: <entry>



method: (x->index inst x)
method: (send inst x->index x)
returns: integer

Returns the character index in the entry closest to the x-coordinate given by x.

classes: <entry>



method: (xy->index inst x y)
method: (send inst xy->index x y)
returns: see below

Returns an index corresponding to the given x and y coordinate.

classes: <text>



method: (y->index inst y)
method: (send inst y->index y)
returns: integer

Returns the index of the listbox element displayed nearest to the given y-coordinate within the listbox window

classes: <listbox>



method: (y->item inst y)
method: (send inst y->item y)
returns: see below

Returns the menu item with this y-coordinate in the menu.

classes: <menu>