Copyright and License information  Home

__  A  B  C  D  E  F  G  H  I  L  M  P  R  S  T  U  V  W 

wxStyledTextCtrl - Key Mapping and Execution

• CmdKeyAssign
• CmdKeyClear
• CmdKeyClearAll
• CmdKeyExecute

Summary:

The first three commands in this set are used to modify keyboard-to-action mappings, the last one is normally used to programmatically invoke functions normally executed by a user pressing a keyboard key. It theoretically can also be used to send any parameterless command to the STC, but this feature is probably of limited use (?).

backgrounder:

The STC has a default mapping between certain keys and functions. This is simplified/summarized below, but also see the source files: contrib/src/stc/Scintilla/src/KeyMap.cxx and contrib/src/stc/Scintilla/include/Scintilla.iface.

The actual keystroke mappings occur in a platform-adaptation layer, e.g., see contrib/src/stc/ScintillaWx.cpp.

The xxEXTEND actions extend the selection, and the WORDPARTxxx actions move between word segments marked by capitalization or underscores; e.g., aMixedCaseIdentifier or a_broken_up_identifier, respectively.

CmdKeyAssign(key,modifiers,command)

This command is used to add or change an assignment in the key map. Returns None.

The key can be any visible (e.g., 'A') or control character (e.g., Ctrl-A) or a key from the SCK_ enumeration (an internal Scintilla enum). The SCK_ values are directly available in wxPython and are summarized below.

The modifiers are an OR of wxSTC_SCMOD_SHIFT, wxSTC_SCMOD_CTRL, and wxSTC_SCMOD_ALT (or 0 if you don't want to specify a modifier at all).

The message is an action from the second list (messages) below. You can use an action of SCI_NULL (which is not defined in wxPython but has a value of 2172) to set a key mapping to no action, or you can use CmdKeyClear, which will do the same thing. You can execute one of these actions with the CmdKeyExecute method.

Example

CmdKeyAssign('L', wxSTC_SCMOD_SHIFT | wxSTC_SCMOD_CTRL, wxSTC_CMD_LINEDELETE);

Special key value from SCK_ enum

• wxSTC_KEY_DOWN
• wxSTC_KEY_UP
• wxSTC_KEY_LEFT
• wxSTC_KEY_RIGHT
• wxSTC_KEY_HOME
• wxSTC_KEY_END
• wxSTC_KEY_PRIOR
• wxSTC_KEY_NEXT
• wxSTC_KEY_DELETE
• wxSTC_KEY_INSERT
• wxSTC_KEY_ESCAPE
• wxSTC_KEY_BACK
• wxSTC_KEY_TAB
• wxSTC_KEY_RETURN
• wxSTC_KEY_ADD
• wxSTC_KEY_SUBTRACT
• wxSTC_KEY_DIVIDE

Values to use for message

CmdKeyClear(key,modifiers)

Sets the keyboard action for the keyboard key specified by the method arguments to SCI_NULL, which effectively causes no action for that key. The arguments key and modifiers are identical to those that would be used in the CmdKeyAssign method, above. Returns None.

CmdKeyClearAll()

Actually completely removes all entries from the key-map. Doesn't restore the defaults: there's no method to do so, although obviously one could do that manually. Returns None.

CmdKeyExecute(cmd)

This method is used to programmatically execute one of the key-actions (wxSTC_CMD_xxx) that is normally executed by a keypress. For the cmd argument, use one of the values in the message table shown for the CmdKeyAssign method. Returns None.

Note that several of the messages have direct wxPython methods that you can use instead; for example,

HomeDisplay()