Blame doc/man/man3/XmColorSelector.3

Packit b099d7
.DT
Packit b099d7
.TH XmColorSelector 3X ""
Packit b099d7
.SH NAME
Packit b099d7
The Color Selector widget
Packit b099d7
.SH SYNOPSIS
Packit b099d7
#include <Xm/ColorS.h>
Packit b099d7
.SH DESCRIPTION
Packit b099d7
.PP
Packit b099d7
.TS
Packit b099d7
tab(%);
Packit b099d7
l l.
Packit b099d7
.TE
Packit b099d7
.PP
Packit b099d7
The Color Selector widget allows users to choose a color by using either a set of RGB 
Packit b099d7
sliders or choosing from a list of all colors available in the rgb database. The name or 
Packit b099d7
rgb value, as well as the color selected, are dynamically displayed to the user as they 
Packit b099d7
pick and choose different colors.
Packit b099d7
.PP
Packit b099d7
.SH Normal Resources
Packit b099d7
.PP
Packit b099d7
.TS
Packit b099d7
tab (%);
Packit b099d7
l l l l.
Packit b099d7
Name%Class%Type%Initial Value
Packit b099d7
blueSliderLabel%SliderLabel%XmString%"Blue"
Packit b099d7
colorListTogLabel%TogLabel%XmString%"Color List"
Packit b099d7
colorMode%ColorMode%XiColorMode%XmScaleMode
Packit b099d7
colorName%String%String%White
Packit b099d7
fileReadError%FileReadError%XmString%"Could not read
Packit b099d7
%%% RGB.txt file"
Packit b099d7
greenSliderLabel%SliderLabel%XmString%"Green"
Packit b099d7
marginHeight%MarginHeight%VerticalDimension%2
Packit b099d7
marginWidth%MarginWidth%HorizontalDimension%2
Packit b099d7
noCellError%NoCellError%XmString%"No Color Cell
Packit b099d7
%%% Available"
Packit b099d7
redSliderLabel%SliderLabel%XmString%"Red"
Packit a21d5c
rgbFile%String%String%/usr/share/X11/rgb.txt
Packit b099d7
sliderTogLabel%TogLabel%XmString%"Color Sliders"
Packit b099d7
.TE
Packit b099d7
.PP
Packit b099d7
All resource names begin with XmN and all resource class names begin with XmC.
Packit b099d7
.SH blueSliderLabel
Packit b099d7
.PP
Packit b099d7
The string appearing for the label of the blue slider
Packit b099d7
.PP
Packit b099d7
.SH colorListTogLabel
Packit b099d7
.PP
Packit b099d7
The string appearing for the label of the color list toggle
Packit b099d7
.PP
Packit b099d7
.SH colorMode
Packit b099d7
.PP
Packit b099d7
The color list can be used in either slider or list mode. Acceptable values are 
Packit b099d7
XmListMode and XmScaleMode. This resource allows the application to determine 
Packit b099d7
the mode that the color selector should use when it is created. After this point, the 
Packit b099d7
user may freely change modes by utilizing a pair of radio buttons in the color 
Packit b099d7
selector. A type converter is registered to convert the strings "ScaleMode" and 
Packit b099d7
"ListMode" to color modes for use with the resource database.
Packit b099d7
.PP
Packit b099d7
.SH colorName
Packit b099d7
.PP
Packit b099d7
This resource controls the color name that is currently displayed to the user. This 
Packit b099d7
value can be modified to change the color displayed in the color selector or 
Packit b099d7
queried to find the color the user has selected. The string returned here is either a 
Packit b099d7
color name or a pound sign (#) followed by a set of rgb values as specified in the 
Packit b099d7
Xlib specification.
Packit b099d7
.PP
Packit b099d7
.SH fileReadError
Packit b099d7
.PP
Packit b099d7
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.
Packit b099d7
.PP
Packit b099d7
.SH greenSliderLabel
Packit b099d7
.PP
Packit b099d7
The string appearing for the label of the green slider
Packit b099d7
.PP
Packit b099d7
.SH marginHeight
Packit b099d7
.PP
Packit b099d7
.SH marginWidth
Packit b099d7
.PP
Packit b099d7
This is the amount of space left between each of the children in the color selector 
Packit b099d7
and between the outside children and the edge of the color selector widget.
Packit b099d7
.PP
Packit b099d7
.SH noCellError
Packit b099d7
.PP
Packit b099d7
This resource controls the message which is displayed in the sample color field when the Color Selector cannot allocate a read/write color cell
Packit b099d7
.PP
Packit b099d7
.SH redSliderLabel
Packit b099d7
.PP
Packit b099d7
The string appearing for the label of the red slider
Packit b099d7
.PP
Packit b099d7
.SH rgbFile
Packit b099d7
This is the name of the file to be loaded, which contains the valid color names. 
Packit b099d7
Each of these names is sorted and the duplicates removed before being shown to 
Packit b099d7
the user.
Packit b099d7
.PP
Packit b099d7
.SH sliderTogLabel
Packit b099d7
.PP
Packit b099d7
The string appearing for the label of the color slider toggle
Packit b099d7
.PP
Packit b099d7
.SH Convenience Routine
Packit b099d7
.PP
Packit b099d7
.SH 
Packit b099d7
.HP 5
Packit b099d7
.SH XmCreateColorSelector  - Widget creation convenience routine 
Packit b099d7
.nf
Packit b099d7
Packit b099d7
Widget XmCreateColorSelector( 
Packit b099d7
	Widget parent,     /* Widget id of parent for ColorSelector */
Packit b099d7
	String name,       /* Name of the created widget */
Packit b099d7
	ArgList args,      /* argument list */
Packit b099d7
	Cardinal num_args  /* number of items in argument list */
Packit b099d7
	)				 
Packit b099d7
Packit b099d7
.nf
Packit b099d7
.PP
Packit b099d7
.SH Children
Packit b099d7
.PP
Packit b099d7
The color selector is composed of many sub-widgets. As with all widgets, most values 
Packit b099d7
are passed to this widget through the argument list at creation time or via set values 
Packit b099d7
and are passed to each of this widget's children, although get values requests must be 
Packit b099d7
made on a child-by-child basis. The children of 
Packit b099d7
the color selector are listed below. The documentation for each of the children should 
Packit b099d7
be consulted for a list of resources for each child.
Packit b099d7
.ta 5,10,15,20,25,30,35
Packit b099d7
.df
Packit b099d7
Packit b099d7
Packit b099d7
XmColorSelector	<named by application>
Packit b099d7
Packit b099d7
	XmScrolledWindow	scrolled
Packit b099d7
Packit b099d7
		XmScrollBar	ListvScrollBar
Packit b099d7
Packit b099d7
		XmScrollBar	ListhScrollBar
Packit b099d7
Packit b099d7
		XmList	list
Packit b099d7
Packit b099d7
	XmButtonBox	buttonBox
Packit b099d7
Packit b099d7
		XmScale	scale
Packit b099d7
Packit b099d7
			XmLabelGadget	scale_title
Packit b099d7
Packit b099d7
			XmScrollBar	scale_scrollbar
Packit b099d7
Packit b099d7
		XmRowColumn	radioBox
Packit b099d7
Packit b099d7
			XmToggleButton	colorListToggle
Packit b099d7
Packit b099d7
			XmToggleButton	colorSlidersToggle
Packit b099d7
Packit b099d7
		XmFrame	colorFrame
Packit b099d7
Packit b099d7
			XmLabel	colorWindow 
Packit b099d7
.fi
Packit b099d7
.PP
Packit b099d7
.SH COPYRIGHT
Packit b099d7
.PP
Packit b099d7
Copyright (c) 1992 by Integrated Computer Solutions, Inc.