racket/collects/scribblings/gui/mult-color-intf.scrbl
Eli Barzilay 264af9a6d0 improved scribble syntax use
svn: r8720
2008-02-19 12:22:45 +00:00

79 lines
1.6 KiB
Racket

#lang scribble/doc
@(require "common.ss")
@definterface/title[mult-color<%> ()]{
A @scheme[mult-color<%>] object is used to scale the RGB values of a
@scheme[color%] object. A @scheme[mult-color<%>] object exist only
within a @scheme[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[(scheme r) @elem{the scaling value for the red component of the color}]
@boxisfill[(scheme g) @elem{the scaling value for the green component of the color}]
@boxisfill[(scheme 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.
}}