xHarbour Reference Documentation > Function Reference

GuiApplyKey()

Sends an Inkey() code to the associated control of the currently active Get object.

Syntax

GuiApplyKey( <oGet>, <nKey>, <oMenu>, <oGetMsg> ) --> NIL

Arguments

<oGet>

This must be the Get object that has input focus. It is determined with GetActive().

<nKey>

This is the numeric Inkey() code of the key to send to the Get object. Refer to the file Inkey.ch for #define constants that can be used for <nKey>.

<oMenu>

Optionally, a TopBarMenu() object can be specified. In this case, the menu is activated when <nKey> is a menu hot key.

<oGetMsg>

Optionally, a GetMssgLine() object can be specified. It displays a message associated with <oGet> in the status line.

Return

The return value is always NIL.

Description

GuiApplyKey() is a utility function of the Get system used for default processing of key strokes. It is automatically called within the Get system.

Note:  the prefix Gui comes from Clipper 5.3 and may be misleading. It has nothing to do with a Graphical User Interface. All Gui functions of the Get system operate with Get objects associated with text mode controls that mimick true GUI controls, such as menus, check boxes or radio buttons, for example.

Info

See also:	@...GET, Get(), GetActive(), GuiReader(), READ
Category:	Get system
Header:	Inkey.ch
Source:	rtl\getsys.prg
LIB:	xhb.lib
DLL:	xhbdll.dll