Group Get System
@...BOX
Outputs a box on the screen.
@ <nTop>, <nLeft>, <nBottom>, <nRight> BOX <cBoxString> [COLOR <cColor>]
@...CLEAR
Positions the cursor and erases a screen area.
@ <nTop>, <nLeft> [ CLEAR [TO <nBottom>, <nRight>] ]
@...GET
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>]
@...PROMPT
Displays a menu item and an optional descriptive message.
@ <nRow>, <nCol> PROMPT <cMenuItem> [MESSAGE <bcMessage>]
@...SAY
Output data on the screen or to the printer.
@ <nRow>, <nCol> SAY <SayExpr> [PICTURE <cSayPicture>] [COLOR <cColor>]
@...TO
Displays a box with a single or double lined border.
@ <nTop>, <nLeft> TO <nBottom>, <nRight> [COLOR <cColor>] [DOUBLE]
CLEAR GETS
Releases all Get objects in the current GetList array.
CLEAR GETS
CountGets()
Determines the number of Gets in the current Getlist array.
CountGets() --> nGetListLen
CurrentGet()
Determines the position of the current Get in the Getlist array.
CurrentGet() --> nCurrentGetPos
Get()
Class
Class function of the Get class.
GetActive()
Returns the Get object that has input focus.
GetActive( [<oGet>] ) --> oGet | NIL
GetApplyKey()
Applies the key code result of Inkey() to the current Get object.
GetApplyKey( <oGet>, <nKey> ) --> xReturn
GetDoSetkey()
Executes a code block during input to a Get object.
GetDoSetkey( <bKeyBlock>, <oGet> ) --> NIL
GetEnableEvents()
Determines if AppEvent() or Inkey() is used by the Get system.
GetEnableEvents( [<lToggle>] ) --> lUseAppEvent
GetEventReader()
Implements the default READ behavior of a single Get object for the event code returned by AppEvent().
GetEventReader( <oGet> ) --> NIL
GetFldCol()
Retrieves the screen column position of a Get.
GetFldCol( [<nGetPos>] ; // Default: GetListPos() ) --> nGetColumn
GetFldRow()
Retrieves the screen row position of a Get.
GetFldRow( [<nGetPos>] ; // Default: GetListPos() ) --> nGetRow
GetFldVar()
Retrieves the name of a Get variable.
GetFldVar( [<nGetPos>] ; // Default: GetListPos() ) --> cGetVarName
GetHandleEvent()
Applies events to the active Get object.
GetHandleEvent( <oGet>, <nEvent>, [<mp1>], [<mp2>], [<oXbp>]) --> NIL
GetInput()
Simple Get input routine for strings.
GetInput( <cDefault>, [<nRow>], ; // Default: Row() [<nColumn>], ; // Default: Col() [<lReDisplay>], ; // Default: .F. [<cSay>] ; // Default: "" ) --> cInputString
GetKillActive()
Removes input focus from the active Get object.
GetKillActive() --> lKilled
GetList()
Returns a reference to the GetList array being used by ReadModal().
GetList() --> activeGetList
GetListPos()
Returns the position of the active Get object within the GetList array.
GetListPos() --> nGetPos
GetPostValidate()
Performs data validation after data input to a Get object.
GetPostValidate( <oGet> ) --> lValid
GetPreValidate()
Tests whether a Get object is permitted to gain input focus.
GetPreValidate( <oGet> ) --> lWhen
GetReader()
Implements the standard READ behavior of a single Get object for the key codes returned by the function Inkey().
GetReader( <oGet> ) --> NIL
GetSecret()
Simplified hidden Get input routine for strings.
GetSecret( <cDefault>, [<nRow>], ; // Default: Row() [<nColumn>], ; // Default: Col() [<lRedisplay>], ; // Default: .F. [<cSay>] ; // Default: "" ) --> cInput
GetToMousePos()
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
READ
Activates editing mode for the current Get objects.
READ [SAVE]
ReadExit()
Establishes the up arrow key and down arrow key as exit keys for READ.
ReadExit( [<lToggle>] ) --> lReadExit
ReadInsert()
Reads/sets insertion mode for GET input fields or MemoEdit().
ReadInsert( [<lToggle>] ) --> lInsert
ReadKill()
Terminates the READ command or ReadModal().
ReadKill( [<lToggle>] ) --> lKillRead
ReadModal()
Activates interactive data input for a GetList array.
ReadModal( <aGetList> [,<nStartGet>] ) --> lUpdated
ReadUpdated()
Reads or sets the Updated status.
ReadUpdated( [<lToggle>] ) --> lUpdated
ReadVar()
Determines name of the current GET or MENU TO variable.
ReadVar() --> cVariableName
RestGets()
Restores a previously saved Getlist array.
RestGets( <aSavedGets> ) --> lRestored
RestSetkey()
Restores SetKey()s and associated code blocks.
RestSetkey( <aSavedSetKey> ) --> lRestored
SaveGets()
Saves current Getlist array for nested gets.
SaveGets() --> aSavedGetList
SaveSetkey()
Saves SetKey()s and associated code blocks.
SaveSetkey() --> aSavedSetKeys
SET ESCAPE
Activates or deactivates the Esc key as an exit key for READ.
SET ESCAPE ON | off | <lToggle>
SetColor()
Reads or sets current color setting for the text mode.
SetColor( [<cColor>] ) --> cColor
SetKey()
Associates a code block with a specific key.
SetKey( <nInkey>, [<bNewBlock>] ) --> bOldBlock
Updated()
Determines whether data was changed with a Get object.
Updated() --> lUpdated