'\" t
.\" $Id: gen-scale.3,v 1.9 2016/12/11 01:37:52 tom Exp $"
.de bP
.IP \(bu 4
..
.de XX
..
.TH cdk_uscale 3
.SH NAME
.XX activateCDKUScale
.XX destroyCDKUScale
.XX drawCDKUScale
.XX eraseCDKUScale
.XX getCDKUScaleBox
.XX #if <FLOAT>
.XX getCDKUScaleDigits
.XX #endif <FLOAT>
.XX getCDKUScaleHighValue
.XX getCDKUScaleLowValue
.XX getCDKUScaleValue
.XX injectCDKUScale
.XX moveCDKUScale
.XX newCDKUScale
.XX positionCDKUScale
.XX setCDKUScale
.XX setCDKUScaleBackgroundAttrib
.XX setCDKUScaleBackgroundColor
.XX setCDKUScaleBox
.XX setCDKUScaleBoxAttribute
.XX #if <FLOAT>
.XX setCDKUScaleDigits
.XX #endif <FLOAT>
.XX setCDKUScaleHorizontalChar
.XX setCDKUScaleLLChar
.XX setCDKUScaleLRChar
.XX setCDKUScaleLowHigh
.XX setCDKUScalePostProcess
.XX setCDKUScalePreProcess
.XX setCDKUScaleULChar
.XX setCDKUScaleURChar
.XX setCDKUScaleValue
.XX setCDKUScaleVerticalChar
cdk_uscale \- curses scale widget (type unsigned).
.SH SYNOPSIS
.LP
.B cc
.RI "[ " "flag" " \|.\|.\|. ] " "file" " \|.\|.\|."
.B \-lcdk
.RI "[ " "library" " \|.\|.\|. ]"
.LP
#include <cdk.h>
.nf
.TP 15
.B "unsigned activateCDKUScale ("
.BI "CDKUSCALE *" "scale",
.BI "chtype *" "actions");
.TP 15
.B "void destroyCDKUScale ("
.BI "CDKUSCALE *" "scale");
.TP 15
.B "void drawCDKUScale ("
.BI "CDKUSCALE *" "scale",
.BI "boolean " "box");
.TP 15
.B "void eraseCDKUScale ("
.BI "CDKUSCALE *" "scale");
.TP 15
.B "boolean getCDKUScaleBox ("
.BI "CDKUSCALE *" "scale");
.TP 15
.B "unsigned getCDKUScaleHighValue ("
.BI "CDKUSCALE *" "scale");
.TP 15
.B "unsigned getCDKUScaleLowValue ("
.BI "CDKUSCALE *" "scale");
.TP 15
.B "unsigned getCDKUScaleValue ("
.BI "CDKUSCALE *" "scale");
.TP 15
.B "int injectCDKUScale ("
.BI "CDKUSCALE *" "scale",
.BI "chtype " "input");
.TP 15
.B "void moveCDKUScale ("
.BI "CDKUSCALE *" "scale",
.BI "int " "xpos",
.BI "int " "ypos",
.BI "boolean " "relative",
.BI "boolean " "refresh");
.TP 15
.B "CDKUSCALE *newCDKUScale ("
.BI "CDKSCREEN *" "cdkscreen",
.BI "int " "xpos",
.BI "int " "ypos",
.BI "const char *" "title",
.BI "const char *" "label",
.BI "chtype " "fieldAttribute",
.BI "int " "fieldWidth",
.BI "unsigned " "currentValue",
.BI "unsigned " "lowValue",
.BI "unsigned " "highValue",
.BI "unsigned " "increment",
.BI "unsigned " "fastIncrement",
.BI "boolean " "box",
.BI "boolean " "shadow");
.TP 15
.B "void positionCDKUScale ("
.BI "CDKUSCALE *" "scale");
.TP 15
.B "void setCDKUScale ("
.BI "CDKUSCALE *" "scale",
.BI "unsigned " "lowValue",
.BI "unsigned " "highValue",
.BI "unsigned " "currentValue",
.BI "boolean " "box");
.TP 15
.B "void setCDKUScaleBackgroundAttrib ("
.BI "CDKUSCALE *" "scale",
.BI "chtype " "attribute");
.TP 15
.B "void setCDKUScaleBackgroundColor ("
.BI "CDKUSCALE *" "scale",
.BI "const char * " "color");
.TP 15
.B "void setCDKUScaleBox ("
.BI "CDKUSCALE *" "scale",
.BI "boolean " "box");
.TP 15
.B "void setCDKUScaleBoxAttribute ("
.BI "CDKUSCALE *" "scale",
.BI "chtype " "character");
.TP 15
.B "void setCDKUScaleHorizontalChar ("
.BI "CDKUSCALE *" "scale",
.BI "chtype " "character");
.TP 15
.B "void setCDKUScaleLLChar ("
.BI "CDKUSCALE *" "scale",
.BI "chtype " "character");
.TP 15
.B "void setCDKUScaleLRChar ("
.BI "CDKUSCALE *" "scale",
.BI "chtype " "character");
.TP 15
.B "void setCDKUScaleLowHigh ("
.BI "CDKUSCALE *" "scale",
.BI "unsigned " "low",
.BI "unsigned " "high");
.TP 15
.B "void setCDKUScalePostProcess ("
.BI "CDKUSCALE *" "scale",
.BI "PROCESSFN " "callback",
.BI "void * " "data");
.TP 15
.B "void setCDKUScalePreProcess ("
.BI "CDKUSCALE *" "scale",
.BI "PROCESSFN " "callback",
.BI "void * " "data");
.TP 15
.B "void setCDKUScaleULChar ("
.BI "CDKUSCALE *" "scale",
.BI "chtype " "character");
.TP 15
.B "void setCDKUScaleURChar ("
.BI "CDKUSCALE *" "scale",
.BI "chtype " "character");
.TP 15
.B "void setCDKUScaleValue ("
.BI "CDKUSCALE *" "scale",
.BI "unsigned " "value");
.TP 15
.B "void setCDKUScaleVerticalChar ("
.BI "CDKUSCALE *" "scale",
.BI "chtype " "character");
.fi
.SH DESCRIPTION
The Cdk scale widget creates a scale box with a label and a scale field.
The following functions create or manipulate the Cdk scale box widget.
.SH AVAILABLE FUNCTIONS
.TP 5
.B activateCDKUScale
activates the scale widget and lets the user interact with the widget.
.RS
.bP
The parameter \fBscale\fR is a pointer to a non-NULL scale widget.
.bP
If the \fBactions\fR parameter is passed with a non-NULL value, the characters
in the array will be injected into the widget.
.IP
To activate the widget
interactively pass in a \fINULL\fR pointer for \fBactions\fR.
.IP
If the character entered
into this widget is \fIRETURN\fR or \fITAB\fR then this function will return a
value from the low value to the high value.
It will also set the widget data \fIexitType\fR to \fIvNORMAL\fR.
.IP
If the character entered into this
widget was \fIESCAPE\fR then the widget will return
the unknownUnsigned value (see the cdk_objs.h header file).
.RE
.IP
The widget data \fIexitType\fR will be set to \fIvESCAPE_HIT\fR.
.TP 5
.B destroyCDKUScale
removes the widget from the screen and frees memory the object used.
.TP 5
.B drawCDKUScale
draws the scale widget on the screen.
.IP
If the \fBbox\fR parameter is true, the widget is drawn with a box.
.TP 5
.B eraseCDKUScale
removes the widget from the screen.
This does \fINOT\fR destroy the widget.
.TP 5
.B getCDKUScaleBox
returns whether the widget will be drawn with a box around it.
.TP 5
.B getCDKUScaleHighValue
returns the high value of the scale widget.
.TP 5
.B getCDKUScaleLowValue
returns the low value of the scale widget.
.TP 5
.B getCDKUScaleValue
returns the current value of the widget.
.TP 5
.B injectCDKUScale
injects a single character into the widget.
.RS
.bP
The parameter \fBscale\fR is a pointer to a non-NULL scale widget.
.bP
The parameter \fBcharacter\fR is the character to inject into the widget.
.RE
.IP
The return value and side-effect (setting the widget data \fIexitType\fP)
depend upon the injected character:
.RS
.TP
\fIRETURN\fP or \fITAB\fR
the function returns
a value ranging from the scale's low value to the scale's high value.
The widget data \fIexitType\fR is set to \fIvNORMAL\fR.
.TP
\fIESCAPE\fP
the function returns
the unknownUnsigned value (see the cdk_objs.h header file).
The widget data \fIexitType\fR is set to \fIvESCAPE_HIT\fR.
.TP
Otherwise
unless modified by preprocessing, postprocessing or key bindings,
the function returns
the unknownUnsigned value (see the cdk_objs.h header file).
The widget data \fIexitType\fR is set to \fIvEARLY_EXIT\fR.
.RE
.TP 5
.B moveCDKUScale
moves the given widget to the given position.
.RS
.bP
The parameters \fBxpos\fR and \fBypos\fR are the new position of the widget.
.IP
The parameter \fBxpos\fR may be an integer or one of the pre-defined values
\fITOP\fR, \fIBOTTOM\fR, and \fICENTER\fR.
.IP
The parameter \fBypos\fR may be an integer or one of the pre-defined values \fILEFT\fR,
\fIRIGHT\fR, and \fICENTER\fR.
.bP
The parameter \fBrelative\fR states whether
the \fBxpos\fR/\fBypos\fR pair is a relative move or an absolute move.
.IP
For example, if \fBxpos\fR = 1 and \fBypos\fR = 2 and \fBrelative\fR = \fBTRUE\fR,
then the widget would move one row down and two columns right.
If the value of \fBrelative\fR was \fBFALSE\fR then the widget would move to the position (1,2).
.IP
Do not use the values \fITOP\fR, \fIBOTTOM\fR, \fILEFT\fR,
\fIRIGHT\fR, or \fICENTER\fR when \fBrelative\fR = \fITRUE\fR.
(weird things may happen).
The final parameter \fBrefresh\fR is a boolean value which
states whether the widget will get refreshed after the move.
.RE
.TP 5
.B newCDKUScale
creates a pointer to a scale widget.
Parameters:
.RS
.TP 5
\fBscreen\fR
is the screen you wish this widget to be placed in.
.TP 5
\fBxpos\fR
controls the placement of the object along the horizontal axis.
It may be an integer or one of the pre-defined values
\fILEFT\fR, \fIRIGHT\fR, and \fICENTER\fR.
.TP 5
\fBypos\fR
controls the placement of the object along the vertical axis.
It may be an integer or one of the pre-defined values
\fITOP\fR, \fIBOTTOM\fR, and \fICENTER\fR.
.TP 5
\fBtitle\fR
is the string to display at the top of the widget.
The title can be more than one line; just provide a carriage return
character at the line break.
.TP 5
\fBlabel\fR
is the string to display in the label of the scale field.
.TP 5
\fBfieldAttribute\fR
is the attribute of the characters displayed in the field.
.TP 5
\fBfieldWidth\fR
controls the width of the widget.
If you
provide a value of zero the widget will be created with the full width of
the screen.
If you provide a negative value, the widget will be created
the full width minus the value provided.
.TP 5
\fBcurrentValue\fR
is the value of the scale field when the widget is activated.
.TP 5
\fBlowValue\fR and
.TP 5
\fBhighValue\fR
are the low and high values of the widget respectively.
.TP 5
\fBincrement\fR
is the regular increment value
.TP 5
\fBfastIncrement\fR
is the accelerated increment value.
.TP 5
\fBbox\fR
is true if the widget should be drawn with a box around it.
.TP 5
\fBshadow\fR
turns the shadow on or off around this widget.
.RE
.IP
If the widget could not be created then a \fINULL\fR
pointer is returned.
.TP 5
.B positionCDKUScale
allows the user to move the widget around the screen via the cursor/keypad keys.
See \fBcdk_position (3)\fR for key bindings.
.TP 5
.B setCDKUScale
lets the programmer modify certain elements of an existing scale widget.
.IP
The parameter names correspond to the same parameter
names listed in the \fInewCDKUScale\fR function.
.TP 5
.B setCDKUScaleBackgroundAttrib
sets the background attribute of the widget.
.IP
The parameter \fBattribute\fR is a curses attribute, e.g., A_BOLD.
.TP 5
.B setCDKUScaleBackgroundColor
sets the background color of the widget.
.IP
The parameter \fBcolor\fR
is in the format of the Cdk format strings.
.IP
See \fBcdk_display (3)\fR.
.TP 5
.B setCDKUScaleBox
sets whether the widget will be drawn with a box around it.
.TP 5
.B setCDKUScaleBoxAttribute
sets the attribute of the box.
.TP 5
.B setCDKUScaleHorizontalChar
sets the horizontal drawing character for the box to
the given character.
.TP 5
.B setCDKUScaleLLChar
sets the lower left hand corner of the widget's box to
the given character.
.TP 5
.B setCDKUScaleLRChar
sets the lower right hand corner of the widget's box to
the given character.
.TP 5
.B setCDKUScaleLowHigh
sets the low and high values of the widget.
.TP 5
.B setCDKUScalePostProcess
allows the user to have the widget call a function after the
key has been applied to the widget.
.RS
.bP
The parameter \fBfunction\fR is the callback function.
.bP
The parameter \fBdata\fR points to data passed to the callback function.
.RE
.IP
To learn more about post-processing see \fIcdk_process (3)\fR.
.TP 5
.B setCDKUScalePreProcess
allows the user to have the widget call a function after a key
is hit and before the key is applied to the widget.
.RS
.bP
The parameter \fBfunction\fR is the callback function.
.bP
The parameter \fBdata\fR points to data passed to the callback function.
.RE
.IP
To learn more about pre-processing see \fIcdk_process (3)\fR.
.TP 5
.B setCDKUScaleULChar
sets the upper left hand corner of the widget's box to
the given character.
.TP 5
.B setCDKUScaleURChar
sets the upper right hand corner of the widget's box to
the given character.
.TP 5
.B setCDKUScaleValue
sets the current value of the widget.
.TP 5
.B setCDKUScaleVerticalChar
sets the vertical drawing character for the box to
the given character.
.SH KEY BINDINGS
When the widget is activated there are several default key bindings which will
help the user enter or manipulate the information quickly.
The following table
outlines the keys and their actions for this widget.
.LP
.TS
center tab(/) box;
l l
l l
lw15 lw50 .
\fBKey/Action\fR
=
Down Arrow/T{
Decrements the scale by the normal value.
T}
Up Arrow/Increments the scale by the normal value.
u/Increments the scale by the normal value.
Prev Page/Decrements the scale by the accelerated value.
U/Decrements the scale by the accelerated value.
Ctrl-B/Decrements the scale by the accelerated value.
Next Page/Increments the scale by the accelerated value.
Ctrl-F/Increments the scale by the accelerated value.
Home/Sets the scale to the low value.
g/Sets the scale to the low value.
^/Sets the scale to the low value.
End/Sets the scale to the high value.
G/Sets the scale to the high value.
$/Sets the scale to the high value.
Return/T{
Exits the widget and returns the index of the selected value.
This also sets the widget data \fIexitType\fR to \fIvNORMAL\fR.
T}
Tab/T{
Exits the widget and returns the index of the selected value.
This also sets the widget data \fIexitType\fR to \fIvNORMAL\fR.
T}
Escape/T{
Exits the widget and returns
the unknownUnsigned value (see the cdk_objs.h header file).
This also sets the widget data \fIexitType\fR to \fIvESCAPE_HIT\fR.
T}
Ctrl-R/Refreshes the screen.
.TE
.LP
If the cursor is not pointing to the field's value, the following
key bindings apply.  You may use the left/right arrows to move the
cursor onto the field's value and modify it by typing characters to
replace the digits and sign.
.TS
center tab(/) box;
l l
l l
lw15 lw50 .
\fBKey/Action\fR
=
Left Arrow/T{
Decrements the scale by the normal value.
T}
Right Arrow/Increments the scale by the normal value.
=
d/Decrements the scale by the normal value.
D/Increments the scale by the accelerated value.
-/Decrements the scale by the normal value.
+/Increments the scale by the normal value.
0/Sets the scale to the low value.
.TE
.SH SEE ALSO
.BR cdk (3),
.BR cdk_binding (3),
.BR cdk_display (3),
.BR cdk_position (3),
.BR cdk_screen (3)