racket/collects/scribblings/gui/add-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

63 lines
1.8 KiB
Racket

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