Group Get System

Outputs a box on the screen.

@ <nTop>, <nLeft>, <nBottom>, <nRight> BOX <cBoxString> [COLOR <cColor>]

Positions the cursor and erases a screen area.

@ <nTop>, <nLeft> [ CLEAR [TO <nBottom>, <nRight>] ]

Creates a Get object (entry field) and displays it on the screen.

@ <nRow>, <nCol> [SAY <SayExpr> [PICTURE <cSayPicture>] [COLOR <cSayColor>]] GET <VarName> [PICTURE <cGetPicture>] [COLOR <cGetColor>] [WHEN <blPreValid>] [VALID <blPostValid>] | [RANGE <dnMinValue>, <dnMaxValue>] [SEND <message>]

Displays a menu item and an optional descriptive message.

@ <nRow>, <nCol> PROMPT <cMenuItem> [MESSAGE <bcMessage>]

Output data on the screen or to the printer.

@ <nRow>, <nCol> SAY <SayExpr> [PICTURE <cSayPicture>] [COLOR <cColor>]

Displays a box with a single or double lined border.

@ <nTop>, <nLeft> TO <nBottom>, <nRight> [COLOR <cColor>] [DOUBLE]

Releases all Get objects in the current GetList array.

CLEAR GETS

Determines the number of Gets in the current Getlist array.

CountGets() --> nGetListLen

Determines the position of the current Get in the Getlist array.

CurrentGet() --> nCurrentGetPos

Class function of the Get class.

Returns the Get object that has input focus.

GetActive( [<oGet>] ) --> oGet | NIL

Applies the key code result of Inkey() to the current Get object.

GetApplyKey( <oGet>, <nKey> ) --> xReturn

Executes a code block during input to a Get object.

GetDoSetkey( <bKeyBlock>, <oGet> ) --> NIL

Determines if AppEvent() or Inkey() is used by the Get system.

GetEnableEvents( [<lToggle>] ) --> lUseAppEvent

Implements the default READ behavior of a single Get object for the event code returned by AppEvent().

GetEventReader( <oGet> ) --> NIL

Retrieves the screen column position of a Get.

GetFldCol( [<nGetPos>] ; // Default: GetListPos() ) --> nGetColumn

Retrieves the screen row position of a Get.

GetFldRow( [<nGetPos>] ; // Default: GetListPos() ) --> nGetRow

Retrieves the name of a Get variable.

GetFldVar( [<nGetPos>] ; // Default: GetListPos() ) --> cGetVarName

Applies events to the active Get object.

GetHandleEvent( <oGet>, <nEvent>, [<mp1>], [<mp2>], [<oXbp>]) --> NIL

Simple Get input routine for strings.

GetInput( <cDefault>, [<nRow>], ; // Default: Row() [<nColumn>], ; // Default: Col() [<lReDisplay>], ; // Default: .F. [<cSay>] ; // Default: "" ) --> cInputString

Removes input focus from the active Get object.

GetKillActive() --> lKilled

Returns a reference to the GetList array being used by ReadModal().

GetList() --> activeGetList

Returns the position of the active Get object within the GetList array.

GetListPos() --> nGetPos

Performs data validation after data input to a Get object.

GetPostValidate( <oGet> ) --> lValid

Tests whether a Get object is permitted to gain input focus.

GetPreValidate( <oGet> ) --> lWhen

Implements the standard READ behavior of a single Get object for the key codes returned by the function Inkey().

GetReader( <oGet> ) --> NIL

Simplified hidden Get input routine for strings.

GetSecret( <cDefault>, [<nRow>], ; // Default: Row() [<nColumn>], ; // Default: Col() [<lRedisplay>], ; // Default: .F. [<cSay>] ; // Default: "" ) --> cInput

Moves the screen cursor to the location in the active Get object editing buffer at which the left mouse button was clicked.

GetToMousePos( <oGet>, <nMouseRow>, <nMouseCol> ) --> nBufferPos

Activates editing mode for the current Get objects.

READ [SAVE]

Establishes the up arrow key and down arrow key as exit keys for READ.

ReadExit( [<lToggle>] ) --> lReadExit

Reads/sets insertion mode for GET input fields or MemoEdit().

ReadInsert( [<lToggle>] ) --> lInsert

Terminates the READ command or ReadModal().

ReadKill( [<lToggle>] ) --> lKillRead

Activates interactive data input for a GetList array.

ReadModal( <aGetList> [,<nStartGet>] ) --> lUpdated

Reads or sets the Updated status.

ReadUpdated( [<lToggle>] ) --> lUpdated

Determines name of the current GET or MENU TO variable.

ReadVar() --> cVariableName

Restores a previously saved Getlist array.

RestGets( <aSavedGets> ) --> lRestored

Restores SetKey()s and associated code blocks.

RestSetkey( <aSavedSetKey> ) --> lRestored

Saves current Getlist array for nested gets.

SaveGets() --> aSavedGetList

Saves SetKey()s and associated code blocks.

SaveSetkey() --> aSavedSetKeys

Activates or deactivates the Esc key as an exit key for READ.

SET ESCAPE ON | off | <lToggle>

Reads or sets current color setting for the text mode.

SetColor( [<cColor>] ) --> cColor

Associates a code block with a specific key.

SetKey( <nInkey>, [<bNewBlock>] ) --> bOldBlock

Determines whether data was changed with a Get object.

Updated() --> lUpdated