racket/collects/scribblings/gui/mult-color-intf.scrbl
Eli Barzilay a38f384a00 Finish converting scheme' -> racket'.
Everything compiles fine now even if the compatibility bindings are
gone.
2011-06-28 00:45:38 -04:00

79 lines
1.6 KiB
Racket

#lang scribble/doc
@(require "common.rkt")
@definterface/title[mult-color<%> ()]{
A @racket[mult-color<%>] object is used to scale the RGB values of a
@racket[color%] object. A @racket[mult-color<%>] object exist only
within a @racket[style-delta%] object.
See also @method[style-delta% get-foreground-mult] and
@method[style-delta% get-background-mult].
@defmethod[(get [r (box/c real?)]
[g (box/c real?)]
[b (box/c real?)])
void?]{
Gets all of the scaling values.
@boxisfill[@racket[r] @elem{the scaling value for the red component of the color}]
@boxisfill[@racket[g] @elem{the scaling value for the green component of the color}]
@boxisfill[@racket[b] @elem{the scaling value for the blue component of the color}]
}
@defmethod[(get-b)
real?]{
Gets the multiplicative scaling value for the blue component of the color.
}
@defmethod[(get-g)
real?]{
Gets the multiplicative scaling value for the green component of the color.
}
@defmethod[(get-r)
real?]{
Gets the multiplicative scaling value for the red component of the color.
}
@defmethod[(set [r real?]
[g real?]
[b real?])
void?]{
Sets all of the scaling values.
}
@defmethod[(set-b [v real?])
void?]{
Sets the multiplicative scaling value for the blue component of the color.
}
@defmethod[(set-g [v real?])
void?]{
Sets the multiplicative scaling value for the green component of the
color.
}
@defmethod[(set-r [v real?])
void?]{
Sets the additive value for the red component of the color.
}}