WPKeyboard

Class definition file: wpkeybd.idl

Class hierarchy SOMObject
WPObject
WPAbstract
WPKeyboard

Description

This is the keyboard object class. An instance of this class can be created as a Workplace object. An instance of this class is created initially by the system. It has the title "Keyboard" and resides in the "System Setup" folder.

Instance methods

The following list shows all the WPKeyboard methods:

• wpAddKeyboardMappingsPage
  
• wpAddKeyboardSpecialNeedsPage
  
• wpAddKeyboardTimingPage

SOMObject instance methods

The following list shows all the instance methods overridden by the WPObject class. These instance methods are overridden in order to modify the behavior defined by an ancestor class.

• somDefaultInit 
  somDestruct

  WPObject instance methods

  The following list shows all the methods overridden by the WPKeyboard class. These methods are overridden in order to modify the behavior defined by an ancestor class.

  • wpAddObjectWindowPage 
    wpAddSettingsPages
    
    wpFilterMenu

    Class methods

    There are currently no class methods defined for the WPKeyboard Workplace class object.

    WPObject class methods

    The following list shows all the class methods overridden by the WPKeyboard class. These methods are overridden to modify the behavior defined by an ancestor class.

    • wpclsQueryDefaultHelp 
      wpclsQueryDefaultView
      
      wpclsQueryIconData
      
      wpclsQuerySettingsPageSize
      
      wpclsQueryStyle
      
      wpclsQueryTitle

      WPAbstract class methods

      The following list shows all the class methods overridden by the WPKeyboard class. These methods are overridden to modify the behavior defined by an ancestor class.

      • wpclsQuerySetting 
        wpclsSetSetting

        wpclsSetSettings override by wpKeyboard

        The defaults can be specified on a wpclsSetSetting invocation to request that the setting be set to its default value. wpclsQuerySetting, however, never returns an xxxx_DEFAULT value.

        ┌─────────────────┬─────────────────────┬────────────────────────────┐│Setting          │Value                │Description                 │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │CursorBlinkRate  │rate                 │Sets the rate at which the  │
        │                 │                     │cursor blinks.              │
        │                 │                     │This value must be in the   │
        │                 │                     │range CURSORBLINK_MIN to    │
        │                 │                     │CURSORBLINK_MAX.            │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │                 │CURSORBLINK_DEFAULT  │Sets the default rate at    │
        │                 │                     │which the cursor blinks.    │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │EditTitleTextKey │AF_VIRTUALKEY        │High word. Sets the key used│
        │                 │AF_KBDCOMMAND        │with another key to edit    │
        │                 │                     │button text.                │
        │                 │                     │Both of these values are    │
        │                 │                     │required if the default is  │
        │                 │                     │not set.                    │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │                 │AF_ALT               │High word. Sets the key used│
        │                 │AF_SHIFT             │with another key to edit    │
        │                 │AF_CONTROL           │button text.                │
        │                 │                     │These are optional values.  │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │                 │VK_F1 through VK_F12 │Low word. Sets the key used │
        │                 │VK_PAGEUP            │to edit button text.        │
        │                 │VK_PAGEDOWN          │One of these values is      │
        │                 │VK_HOME              │required if the default is  │
        │                 │VK_END               │not set.                    │
        │                 │VK_INSERT            │                            │
        │                 │VK_TAB               │                            │
        │                 │VK_ENTER             │                            │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │                 │TEXTEDITKEY_DEFAULT  │Sets the default text edit  │
        │                 │                     │key.                        │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │KeyRepeatDelay   │rate                 │Sets the time before the key│
        │                 │                     │starts repeating. This value│
        │                 │                     │must be in the range        │
        │                 │                     │REPEATDELAY_MIN to          │
        │                 │                     │REPEATDELAY_MAX.            │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │                 │REPEATDELAY_DEFAULT  │Sets the default time before│
        │                 │                     │the key starts repeating.   │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │KeyRepeatRate    │rate                 │Sets the rate at which a key│
        │                 │                     │repeats. This value must be │
        │                 │                     │in the range REPEATRATE_MIN │
        │                 │                     │to REPEATRATE_MAX.          │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │                 │REPEATRATE_DEFAULT   │Sets the default rate at    │
        │                 │                     │which a key repeats.        │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │PopupMenuKey     │AF_VIRTUALKEY        │High word. Sets the key used│
        │                 │AF_KBDCOMMAND        │with another key to display │
        │                 │                     │the pop-up menu.            │
        │                 │                     │Both of these values are    │
        │                 │                     │required if the default is  │
        │                 │                     │not set.                    │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │                 │AF_ALT               │High word. Sets the key used│
        │                 │AF_SHIFT             │with another key to display │
        │                 │AF_CONTROL           │the pop-up menu.            │
        │                 │                     │These are optional values.  │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │                 │VK_F1 through VK_F12 │Low word. Sets the key used │
        │                 │VK_PAGEUP            │to display the pop-up menu. │
        │                 │VK_PAGEDOWN          │One of these values is      │
        │                 │VK_HOME              │required if the default is  │
        │                 │VK_END               │not set.                    │
        │                 │VK_INSERT            │                            │
        │                 │VK_TAB               │                            │
        │                 │VK_ENTER             │                            │
        ├─────────────────┼─────────────────────┼────────────────────────────┤
        │                 │POPUPKEY_DEFAULT     │Sets the default popup menu │
        │                 │                     │key.                        │
        └─────────────────┴─────────────────────┴────────────────────────────┘
        

        ---

        [Back: WPJob]
        [Next: WPLaunchPad]