Blob Blame History Raw
.DT
.TH XmColorSelector 3X ""
.SH NAME
The Color Selector widget
.SH SYNOPSIS
#include <Xm/ColorS.h>
.SH DESCRIPTION
.PP
.TS
tab(%);
l l.
.TE
.PP
The Color Selector widget allows users to choose a color by using either a set of RGB 
sliders or choosing from a list of all colors available in the rgb database. The name or 
rgb value, as well as the color selected, are dynamically displayed to the user as they 
pick and choose different colors.
.PP
.SH Normal Resources
.PP
.TS
tab (%);
l l l l.
Name%Class%Type%Initial Value
blueSliderLabel%SliderLabel%XmString%"Blue"
colorListTogLabel%TogLabel%XmString%"Color List"
colorMode%ColorMode%XiColorMode%XmScaleMode
colorName%String%String%White
fileReadError%FileReadError%XmString%"Could not read
%%% RGB.txt file"
greenSliderLabel%SliderLabel%XmString%"Green"
marginHeight%MarginHeight%VerticalDimension%2
marginWidth%MarginWidth%HorizontalDimension%2
noCellError%NoCellError%XmString%"No Color Cell
%%% Available"
redSliderLabel%SliderLabel%XmString%"Red"
rgbFile%String%String%/usr/share/X11/rgb.txt
sliderTogLabel%TogLabel%XmString%"Color Sliders"
.TE
.PP
All resource names begin with XmN and all resource class names begin with XmC.
.SH blueSliderLabel
.PP
The string appearing for the label of the blue slider
.PP
.SH colorListTogLabel
.PP
The string appearing for the label of the color list toggle
.PP
.SH colorMode
.PP
The color list can be used in either slider or list mode. Acceptable values are 
XmListMode and XmScaleMode. This resource allows the application to determine 
the mode that the color selector should use when it is created. After this point, the 
user may freely change modes by utilizing a pair of radio buttons in the color 
selector. A type converter is registered to convert the strings "ScaleMode" and 
"ListMode" to color modes for use with the resource database.
.PP
.SH colorName
.PP
This resource controls the color name that is currently displayed to the user. This 
value can be modified to change the color displayed in the color selector or 
queried to find the color the user has selected. The string returned here is either a 
color name or a pound sign (#) followed by a set of rgb values as specified in the 
Xlib specification.
.PP
.SH fileReadError
.PP
The message which is displayed when the Color Selector cannot read the rgb.txt file. The message is displayed at the top of the window in which the color list would normally appear.
.PP
.SH greenSliderLabel
.PP
The string appearing for the label of the green slider
.PP
.SH marginHeight
.PP
.SH marginWidth
.PP
This is the amount of space left between each of the children in the color selector 
and between the outside children and the edge of the color selector widget.
.PP
.SH noCellError
.PP
This resource controls the message which is displayed in the sample color field when the Color Selector cannot allocate a read/write color cell
.PP
.SH redSliderLabel
.PP
The string appearing for the label of the red slider
.PP
.SH rgbFile
This is the name of the file to be loaded, which contains the valid color names. 
Each of these names is sorted and the duplicates removed before being shown to 
the user.
.PP
.SH sliderTogLabel
.PP
The string appearing for the label of the color slider toggle
.PP
.SH Convenience Routine
.PP
.SH 
.HP 5
.SH XmCreateColorSelector  - Widget creation convenience routine 
.nf

Widget XmCreateColorSelector( 
	Widget parent,     /* Widget id of parent for ColorSelector */
	String name,       /* Name of the created widget */
	ArgList args,      /* argument list */
	Cardinal num_args  /* number of items in argument list */
	)				 

.nf
.PP
.SH Children
.PP
The color selector is composed of many sub-widgets. As with all widgets, most values 
are passed to this widget through the argument list at creation time or via set values 
and are passed to each of this widget's children, although get values requests must be 
made on a child-by-child basis. The children of 
the color selector are listed below. The documentation for each of the children should 
be consulted for a list of resources for each child.
.ta 5,10,15,20,25,30,35
.df


XmColorSelector	<named by application>

	XmScrolledWindow	scrolled

		XmScrollBar	ListvScrollBar

		XmScrollBar	ListhScrollBar

		XmList	list

	XmButtonBox	buttonBox

		XmScale	scale

			XmLabelGadget	scale_title

			XmScrollBar	scale_scrollbar

		XmRowColumn	radioBox

			XmToggleButton	colorListToggle

			XmToggleButton	colorSlidersToggle

		XmFrame	colorFrame

			XmLabel	colorWindow 
.fi
.PP
.SH COPYRIGHT
.PP
Copyright (c) 1992 by Integrated Computer Solutions, Inc.