colorwell statement

	<< Index >>	FutureBasic
ColorWell		statement / function

Statement Syntax
colorwell tag, enabled, color, rect, style, wndTag

Function Syntax


color = colorwell(tag)

Description
The colorwell statement puts a new colorwell in the current output window, or alters an existing colorwell's characteristics. The colorwell function returns the well's color as a ColorRef and is equivalent to calling fn ColorWellColor.

Parameters

Parameter
Description

tag A number (1 through 1000000) that you assign when you create the colorwell and that you refer to when altering the colorwell. The number you assign must be different from the tag value of all other existing widgets in the current window. A negative tag hides the colorwell.

enabled A boolean value which specifies whether the colorwell should be enabled or disabled.

color The initial color to be displayed in the colorwell. This can be either a ColorRef or one of FB's built-in constants, e.g.

_zYellow
_zGreen
_zCyan
_zBlue
_zMagenta
_zRed
_zBlack
_zWhite

See the CocoaUI.incl header for a complete list.

rect The colorwell's enclosing rectangle. This can be specified in either of two ways:

(i) (x,y,w,h) where x,y are the origin and w,h the size of the colorwell.
(ii) A CGRect value

style The style of the colorwell (macOS 13.0+).
NSColorWellStyleDefault (default)
NSColorWellStyleMinimal
NSColorWellStyleExpanded

wndTag An optional parameter for when the colorwell's window is not the current output window. Note specifying this parameter does not bring the window to the front or make it the output window.

Example


window 1, @"ColorWell"

colorwell 1,, fn ColorBlue

HandleEvents

Dialog Events
_btnClick
_colorWellPulldown - this event is used to override the default behavior of minimal and expanded style colorwells. To enable this event, call ColorWellEnablePulldownAction after creating the colorwell.

Subclass
To subclass a nib colorwell, set its class name to "ColorWellSC" in the nib.

Apple Documentation
NSColorWell

Parameter	Description
tag	A number (1 through 1000000) that you assign when you create the colorwell and that you refer to when altering the colorwell. The number you assign must be different from the tag value of all other existing widgets in the current window. A negative tag hides the colorwell.
enabled	A boolean value which specifies whether the colorwell should be enabled or disabled.
color	The initial color to be displayed in the colorwell. This can be either a ColorRef or one of FB's built-in constants, e.g. _zYellow _zGreen _zCyan _zBlue _zMagenta _zRed _zBlack _zWhite See the CocoaUI.incl header for a complete list.
rect	The colorwell's enclosing rectangle. This can be specified in either of two ways: (i) `(x,y,w,h)` where x,y are the origin and w,h the size of the colorwell. (ii) A CGRect value
style	The style of the colorwell (macOS 13.0+). NSColorWellStyleDefault (default) NSColorWellStyleMinimal NSColorWellStyleExpanded
wndTag	An optional parameter for when the colorwell's window is not the current output window. Note specifying this parameter does not bring the window to the front or make it the output window.