5.3 DUIM-Sheets Module
<sheet>
Open abstract class
Summary
The base object class for DUIM windows.
Superclasses
<object>
Init-keywords
region:- An instance of type
<region>. Default value$nowhere. transform:- An instance of type
<transform>. Default value$identity-transform. port:- An instance of type
false-or(<port>). Default value#f. style-descriptor:-
An instance of type
false-or(style-descriptor). Default value#f. help-context:- An instance of type
<object-table>. Default valuemake(<object-table>). help-source:- An instance of type
<object-table>. Default valuemake(<object-table>). parent:- An instance of type
false-or(<sheet>). Default value:#f. child:- An instance of type
false-or(<sheet>). Default value:#f. children:- An instance of type
limited(<sequence>, of: <sheet>). Default value:#[]. x:- An instance of type
<integer>. y:- An instance of type
<integer>. withdrawn?:- An instance of type
<boolean>. Default value:#f. accepts-focus?:-
An instance of type
<boolean>. Default value:#t. cursor:- An instance of type
<cursor>. caret:- An instance of type
type-union(<caret>, one-of(#f, #t)). Default value:#f. foreground:- An instance of type
<ink>. background:- An instance of type
<ink>. text-style:- An instance of type
<text-style>. fixed-width?:- An instance of type
<boolean>. fixed-height?:- An instance of type
<boolean>. resizable?:- An instance of type
<boolean>.
Library
duim-sheets
Module
duim-sheets
Description
The port: init-keyword is true if the pane (and its mirror, if it has one) has been mapped, #f otherwise. In this case, the term mapped means visible on the display, ignoring issues of occlusion.
The help-source: and help-context: keywords let you specify pointers to valid information available in any online help you supply with your application. The help-context: keyword should specify a context-ID present in the online help. This context-ID identifies the help topic that is applicable to the current pane. The help-source: init-keyword identifies the source file in which the help topic identified by help-context: can be found. A list of context-IDs should be provided by the author of the online help system.
The parent:, child:, and children: init-keywords let you specify a lineage for the sheet if you wish, specifying the parent of the sheet and as many children as you wish.
The x: and y: init-keywords specify the initial position of the sheet relative to its parent. When accepts-focus?: is true, the sheet will accept the pointer focus.
The init-keywords cursor:, foreground:, background:, and text-style: can be used to specify the appearance of elements in the sheet.
The caret: init-keyword is used to specify the caret to be used within the drawing pane, if one is to be used at all.
The fixed-width?: and fixed-height?: init-keywords are used to fix the width or height of a sheet to the size defined by other appropriate init-keywords. This is a useful way of ensuring that the default size defined for a sheet is fixed in either direction. The init-keywords force the space requirements for the sheet to make the minimum and maximum sizes equal to the size defined at the time of creation. These keywords are most useful when creating sheets of unknown size, when you want to ensure that any child of that sheet is fixed at that size, whatever it may be.
If resizable?: is #t then the sheet can be resized in either direction. If resizable?: is #f then it cannot be resized in either direction. If resizable?: is #t, but one of fixed-width?: or fixed-height?: is #t, then the sheet can only be resized in one direction as appropriate.
Operations
The following operations are exported from the DUIM-Sheets module.
add-child beep child-containing-position children-overlapping-region clear-box curve-to destroy-sheet display
do-children-containing-position do-children-overlapping-region do-sheet-children do-sheet-tree do-with-drawing-options do-with-pointer-grabbed do-with-sheet-medium do-with-text-style do-with-transform
get-default-background get-default-foreground get-default-text-style
medium-background medium-background-setter medium-brush medium-brush-setter medium-clipping-region medium-clipping-region-setter medium-default-text-style medium-default-text-style-setter medium-foreground medium-foreground-setter medium-pen medium-pen-setter medium-text-style medium-text-style-setter medium-transform medium-transform-setter port
raise-sheet remove-child repaint-sheet replace-child
set-sheet-edges set-sheet-position set-sheet-size sheet?
sheet-ancestor? sheet-child sheet-children sheet-children-setter sheet-child-setter sheet-edges sheet-frame sheet-mapped? sheet-mapped?-setter sheet-medium sheet-parent sheet-parent-setter sheet-position sheet-region sheet-region-setter sheet-size sheet-state sheet-transform sheet-transform-setter sheet-viewport sheet-viewport-region sheet-withdrawn?
synchronize-display text-size top-level-sheet
The following operations are exported from the DUIM-Gadgets module.
scroll-position set-scroll-position
The following operations are exported from the DUIM-Layouts module.
do-allocate-space do-compose-space
relayout-children relayout-parent
space-requirement-height space-requirement-max-height space-requirement-max-width space-requirement-min-height space-requirement-min-width space-requirement-width
The following operations are exported from the DUIM-Frames module.
The following operations are exported from the DUIM-Graphics module.
abort-path arc-to close-path copy-area curve-to do-with-output-to-pixmap draw-bezier-curve draw-ellipse draw-image draw-line draw-lines draw-pixmap draw-point draw-points draw-polygon draw-rectangle draw-text end-path fill-path line-to move-to restore-clipping-region start-path stroke-path
The following operations are exported from the DUIM-DCS module.
default-background default-foreground default-text-style
The following operations are exported from the DUIM-Geometry module.
The following operations are exported from the DUIM-Extended-Geometry module.
Examples
To make a text editor that is fixed at 10 lines high:
make(<text-editor>, lines: 10, fixed-height?: #t);