racket/collects/scribblings/gui/column-control-event-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

29 lines
734 B
Racket

#lang scribble/doc
@(require "common.rkt")
@defclass/title[column-control-event% control-event% ()]{
A @racket[column-control-event%] object contains information about a
event on an @racket[list-box%] column header.
@defconstructor[([column exact-nonnegative-integer?]
[event-type (or/c 'list-box-column)]
[time-stamp exact-integer? 0])]{
The @racket[column] argument indicates the column that was clicked.
}
@defmethod[(get-column) exact-nonnegative-integer?]{
Returns the column number (counting from 0) of the clicked column.
}
@defmethod[(set-column
[column exact-nonnegative-integer?])
void?]{
Sets the column number (counting from 0) of the clicked column.
}}