SetKey()

Assign an action block to a key

Syntax

      SetKey( <anKey> [,  <bAction> [,  <bCondition> ] ] )

Arguments

<anKey> is either a numeric key value, or an array of such values

<bAction> is an optional code-block to be assigned

<bCondition> is an optional condition code-block

Returns

Current assigned action-block

Description

The SetKey() function returns the current code-block assigned to a key when called with only the key value. If the action block (and optionally the condition block) are passed, the current block is returned, and the new code block and condition block are stored. A group of keys may be assigned the same code block/condition block by using an array of key values in place on the first parameter.

Examples

      LOCAL bOldF10 := SetKey( K_F10,  {|| Yahoo() } )
      ... // some other processing
      SetKey( K_F10,  bOldF10 )
      ... // some other processing
      bBlock := SetKey( K_SPACE )
      IF bBlock != NIL ...

      // make F10 exit current get,  but only if in a get - ignores other
      // wait-states such as menus,  achoices,  etc...
      SetKey( K_F10,  {|| GetActive():State := GE_WRITE }, ;
       {|| GetActive() != NIL } )

Compliance

SetKey() is mostly CA-Cl*pper compliant. The only difference is the addition of the condition code-block parameter, allowing set-keys to be conditionally turned off or on. This condition-block cannot be returned once set – see SetKeyGet()

Files

Library is core

Seealso

hb_SetKeySave()

SET KEY

Assign an action block to a key

Syntax

      SET KEY   <anKey> to p<bAction>] [when  <bCondition> ]  )

Arguments

<anKey> is either a numeric key value, or an array of such values

<bAction> is an optional code-block to be assigned

<bCondition> is an optional condition code-block

Description

The Set Key Command function is translated to the SetKey() function witch returns the current code-block assigned to a key when called with only the key value. If the action block (and optionally the condition block) are passed, the current block is returned, and the new code block and condition block are stored. A group of keys may be assigned the same code block/condition block by using an array of key values in place on the first parameter.

Examples

      LOCAL bOldF10 := SetKey( K_F10,  {|| Yahoo() } )
      ... // some other processing
      SET KEY K_F10 TO bOldF10
      ... // some other processing
      bBlock := SetKey( K_SPACE )
      IF bBlock != NIL ...

         // make F10 exit current get,  but only if in a get - ignores other
         // wait-states such as menus,  achoices,  etc...
         SetKey( K_F10,  {|| GetActive():State := GE_WRITE },  ;
            {|| GetActive() != NIL } )

Compliance

SET KEY is mostly CA-Cl*pper compliant. The only difference is the addition of the condition code-block parameter, allowing set-keys to be conditionally turned off or on. This condition-block cannot be returned once set – see SetKeyGet()

Seealso

hb_SetKeySave()