Click above to get retro games delivered to your door ever month!

HB_SetKeyCheck()

Impliments common hot-key activation code
---------------------------------------------------------------------------------

 Syntax

        HB_SetKeyCheck( <nKey> [, <p1> ][, <p2> ][, <p3> ] )  

 Arguments

        <nKey>   is a numeric key value to be tested code-block, if 
                  executed

        <p1>..<p3>   are optional parameters that will be passed to the 
                  code-block

 Returns

       True  if there is a hot-key associated with <nKey> and it was 
                  executed; otherwise False  If there is a hot-key
                  association (before checking any condition):  - if there
                  is a condition-block, it is passed one parameter - <nKey>
                  - when the hot-key code-block is called, it is passed 1
                  to 4 parameters,  depending on the parameters passed to
                  HB_SetKeyCheck().  Any  parameters so passed are directly
                  passed to the code-block, with an  additional parameter
                  being <nKey>

 Description

      HB_SetKeyCheck() is intended as a common interface to the SetKey()
      functionality for such functions as ACHOICE(), DBEDIT(),
      MEMOEDIT(),  ACCEPT, INPUT, READ, and WAIT

 Examples

      // within ReadModal()
      if HB_SetKeyCheck( K_ALT_X, GetActive() )
      ... // some other processing
      endif
      // within TBrowse handler
      case HB_SetKeyCheck( nInkey, oTBrowse )
        return
      case nInKey == K_ESC
      ... // some other processing
  

 Tests

      None definable
  

Status

      Ready

 Compliance

      HB_SETKEYCHECK() is new.

 Files

      Library is rtl