racket/collects/scribblings/gui/horizontal-panel-class.scrbl
Matthew Flatt 2bdcdbb197 racket/draw, racket/gui: modernize contracts, mostly in documentation
Use `or/c' instead of `one-of/c', `#f' instead of `false/c'.
2012-04-06 18:51:10 -06:00

45 lines
1.7 KiB
Racket

#lang scribble/doc
@(require "common.rkt")
@defclass/title[horizontal-panel% panel% ()]{
A horizontal panel arranges its subwindows in a single row. See also
@racket[panel%].
@defconstructor[([parent (or/c (is-a?/c frame%) (is-a?/c dialog%)
(is-a?/c panel%) (is-a?/c pane%))]
[style (listof (or/c 'border 'deleted
'hscroll 'auto-hscroll
'vscroll 'auto-vscroll)) null]
[enabled any/c #t]
[vert-margin (integer-in 0 1000) 0]
[horiz-margin (integer-in 0 1000) 0]
[border (integer-in 0 1000) 0]
[spacing (integer-in 0 1000) 0]
[alignment (list/c (or/c 'left 'center 'right)
(or/c 'top 'center 'bottom))
'(left center)]
[min-width (integer-in 0 10000) _graphical-minimum-width]
[min-height (integer-in 0 10000) _graphical-minimum-height]
[stretchable-width any/c #t]
[stretchable-height any/c #t])]{
The @racket[style] flags are the same as for @racket[panel%].
@WindowKWs[@racket[enabled]] @SubareaKWs[] @AreaContKWs[] @AreaKWs[]
}
@defmethod[(set-orientation [horizontal? boolean?]) void?]{
Sets the orientation of the panel, switching it between
the behavior of the @racket[vertical-panel%] and that of
the @racket[horizontal-panel%].
}
@defmethod[(get-orientation) boolean?]{
Initially returns @racket[#t], but if
@method[horizontal-panel% set-orientation] is called,
this method returns whatever the last value passed to it was.
}
}