KKeyServer

KKeyServer Namespace Reference

Functions

uint accelModMaskX ()
 
void checkDisplay ()
 
bool codeWinToKeyQt (uint sym, int *keyQt)
 
bool codeXToSym (uchar codeX, uint modX, uint *sym)
 
uint getModsRequired (uint sym)
 
bool initializeMods ()
 
static void intializeKKeyLabels ()
 
static bool is_keypad_key (xcb_keysym_t keysym)
 
bool isShiftAsModifierAllowed (int keyQt)
 
bool keyboardHasMetaKey ()
 
KWINDOWSYSTEM_EXPORT bool keyQtToCodeMac (int keyQt, QList< uint > &keyCodes)
 
bool keyQtToCodeWin (int keyQt, uint *sym)
 
bool keyQtToCodeX (int keyQt, int *keyCode)
 
KWINDOWSYSTEM_EXPORT bool keyQtToModMac (int keyQt, uint &mod)
 
bool keyQtToModWin (int keyQt, uint *mod)
 
bool keyQtToModX (int keyQt, uint *mod)
 
KWINDOWSYSTEM_EXPORT bool keyQtToSymMac (int keyQt, int &sym)
 
bool keyQtToSymX (int keyQt, int *sym)
 
static QString modToString (uint mod, bool bUserSpace)
 
QString modToStringUser (uint mod)
 
bool modWinToKeyQt (uint mod, int *keyQt)
 
uint modXAlt ()
 
uint modXCtrl ()
 
uint modXLock ()
 
uint modXMeta ()
 
uint modXModeSwitch ()
 
uint modXNumLock ()
 
uint modXScrollLock ()
 
uint modXShift ()
 
bool modXToQt (uint modX, int *modQt)
 
uint stringUserToMod (const QString &mod)
 
bool symXModXToKeyQt (uint32_t keySym, uint16_t modX, int *keyQt)
 
bool symXToKeyQt (uint sym, int *keyQt)
 
bool xcbKeyPressEventToQt (xcb_generic_event_t *e, int *keyModQt)
 
bool xcbKeyPressEventToQt (xcb_key_press_event_t *e, int *keyModQt)
 
bool xEventToQt (XEvent *e, int *keyModQt)
 

Variables

static uint g_alt_mask
 
static bool g_bInitializedKKeyLabels
 
static bool g_bInitializedMods
 
static bool g_bMacLabels
 
static uint g_hyper_mask
 
static uint g_meta_mask
 
static uint g_modXModeSwitch
 
static uint g_modXNumLock
 
static uint g_modXScrollLock
 
static ModInfo g_rgModInfo [4]
 
static const TransKey g_rgQtToSymX []
 
static X11ModInfo g_rgX11ModInfo [4]
 
static uint g_super_mask
 
static const TransKey KeyTbl []
 
static const int MODE_SWITCH = 0x2000
 

Detailed Description

A collection of functions for the conversion of key presses and their modifiers from the window system specific format to the generic format and vice-versa.

Function Documentation

KWINDOWSYSTEM_EXPORT uint KKeyServer::accelModMaskX ( )

Returns bitwise OR'ed mask containing Shift, Ctrl, Alt, and Win (if available).

See also
modXShift()
modXLock()
modXCtrl()
modXAlt()
modXNumLock()
modXWin()
modXScrollLock()

Definition at line 887 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::initializeMods ( )

Initialises the values to return for the mod*() functions below.

Called automatically by those functions if not already initialized.

Definition at line 475 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::isShiftAsModifierAllowed ( int  keyQt)

Test if the shift modifier should be recorded for a given key.

For example, if shift+5 produces '' Qt wants ctrl+shift+5 recorded as ctrl+% and in that case this function would return false.

Since
4.7.1

Definition at line 96 of file kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::keyboardHasMetaKey ( )

Returns true if the current keyboard layout supports the Meta key.

Specifically, whether the Super or Meta keys are assigned to an X modifier.

Returns
true if the keyboard has a Meta key
See also
modXMeta()

Definition at line 675 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::keyQtToCodeMac ( int  keyQt,
QList< uint > &  keyCodes 
)

Extracts all the scancodes from the given Qt key.

The returned values can change if a different keyboard layout is selected.

Parameters
keyQtthe qt key code
keyCodesif successful, a list of scancodes will be written here
Returns
true if successful, false otherwise
KWINDOWSYSTEM_EXPORT bool KKeyServer::keyQtToCodeWin ( int  keyQt,
uint *  sym 
)

Extracts the symbol from the given Qt key and converts it to a Windows symbol.

Parameters
keyQtthe qt key code
symif successful, the symbol will be written here
Returns
true if successful, false otherwise

Definition at line 225 of file platforms/windows/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::keyQtToCodeX ( int  keyQt,
int *  keyCode 
)

Extracts the code from the given Qt key.

Parameters
keyQtthe qt key code
keyCodeif successful, the symbol will be written here
Returns
true if successful, false otherwise

Definition at line 721 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::keyQtToModMac ( int  keyQt,
uint &  mod 
)

Extracts the modifiers from the given Qt key and converts them in a mask of OSX modifiers.

Parameters
keyQtthe qt key code
modif successful, the modifiers will be written here
Returns
true if successful, false otherwise
KWINDOWSYSTEM_EXPORT bool KKeyServer::keyQtToModWin ( int  keyQt,
uint *  mod 
)

Extracts the modifiers from the given Qt key and converts them in a mask of Windows modifiers.

Parameters
keyQtthe qt key code
modif successful, the modifiers will be written here
Returns
true if successful, false otherwise

Definition at line 187 of file platforms/windows/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::keyQtToModX ( int  keyQt,
uint *  mod 
)

Extracts the modifiers from the given Qt key and converts them in a mask of X11 modifiers.

Parameters
keyQtthe qt key code
modif successful, the modifiers will be written here
Returns
true if successful, false otherwise

Definition at line 829 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::keyQtToSymMac ( int  keyQt,
int &  sym 
)

Extracts the symbol from the given Qt key, and converts it to an OSX symbol.

Parameters
keyQtthe qt key code
symif successful, the symbol will be written here
Returns
true if successful, false otherwise
KWINDOWSYSTEM_EXPORT bool KKeyServer::keyQtToSymX ( int  keyQt,
int *  sym 
)

Extracts the symbol from the given Qt key and converts it to an X11 symbol + modifiers.

Parameters
keyQtthe qt key code
symif successful, the symbol will be written here
Returns
true if successful, false otherwise

Definition at line 745 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT QString KKeyServer::modToStringUser ( uint  mod)

Converts the mask of ORed KKey::ModFlag modifiers to a user-readable string.

Parameters
modthe mask of ORed KKey::ModFlag modifiers
Returns
the user-readable string (in English)

Definition at line 81 of file kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT uint KKeyServer::modXAlt ( )

Returns the X11 Alt (Mod1) modifier mask/flag.

Returns
the X11 Alt (Mod1) modifier mask/flag.
See also
accelModMaskX()

Definition at line 639 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT uint KKeyServer::modXCtrl ( )

Returns the X11 Ctrl modifier mask/flag.

Returns
the X11 Ctrl modifier mask/flag.
See also
accelModMaskX()

Definition at line 635 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT uint KKeyServer::modXLock ( )

Returns the X11 Lock modifier mask/flag.

Returns
the X11 Lock modifier mask/flag.
See also
accelModMaskX()

Definition at line 658 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT uint KKeyServer::modXMeta ( )

Returns the X11 Win (Mod3) modifier mask/flag.

Returns
the X11 Win (Mod3) modifier mask/flag.
See also
keyboardHasWinKey()
accelModMaskX()

Definition at line 645 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT uint KKeyServer::modXModeSwitch ( )

Returns the X11 Mode_switch modifier mask/flag.

Returns
the X11 Mode_switch modifier mask/flag.
See also
accelModMaskX()

Definition at line 668 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT uint KKeyServer::modXNumLock ( )

Returns the X11 NumLock modifier mask/flag.

Returns
the X11 NumLock modifier mask/flag.
See also
accelModMaskX()

Definition at line 652 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT uint KKeyServer::modXScrollLock ( )

Returns the X11 ScrollLock modifier mask/flag.

Returns
the X11 ScrollLock modifier mask/flag.
See also
accelModMaskX()

Definition at line 662 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT uint KKeyServer::modXShift ( )

Returns the X11 Shift modifier mask/flag.

Returns
the X11 Shift modifier mask/flag.
See also
accelModMaskX()

Definition at line 631 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::modXToQt ( uint  modX,
int *  modQt 
)

Converts the mask of ORed X11 modifiers to a mask of ORed Qt key code modifiers.

Parameters
modXthe mask of X11 modifiers
modQtthe mask of Qt key code modifiers will be written here if successful
Returns
true if successful, false otherwise

Definition at line 850 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT uint KKeyServer::stringUserToMod ( const QString mod)

Converts the modifier given as user-readable string (in English) to KKey::ModFlag modifier, or 0.

Definition at line 86 of file kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::symXModXToKeyQt ( uint32_t  keySym,
uint16_t  modX,
int *  keyQt 
)

Converts the given symbol and modifier combination to a Qt key code.

Parameters
keySymthe X key symbol
modXthe mask of X11 modifiers
keyQtif successful, the qt key code will be written here
Returns
true if successful, false otherwise

Definition at line 778 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::symXToKeyQt ( uint  sym,
int *  keyQt 
)

Converts the given symbol to a Qt key code.

Parameters
symthe symbol
keyQtif successful, the qt key code will be written here
Returns
true if successful, false otherwise
Deprecated:
since 5.38, use symXModXToKeyQt in order to support numeric keypad keys too

Definition at line 823 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::xcbKeyPressEventToQt ( xcb_generic_event_t *  e,
int *  keyModQt 
)

Converts an XCB keypress event into a Qt key + modifier code.

Parameters
ethe XCB keypress event
keyModQtthe Qt keycode and mask of Qt key code modifiers will be written here if successful
Returns
true if successful, false otherwise

Definition at line 932 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::xcbKeyPressEventToQt ( xcb_key_press_event_t *  e,
int *  keyQt 
)

Overloaded method for convenience.

Definition at line 940 of file platforms/xcb/kkeyserver.cpp.

KWINDOWSYSTEM_EXPORT bool KKeyServer::xEventToQt ( XEvent *  e,
int *  keyModQt 
)

Converts an X keypress event into a Qt key + modifier code.

Parameters
ethe X11 keypress event
keyModQtthe Qt keycode and mask of Qt key code modifiers will be written here if successful
Returns
true if successful, false otherwise

Definition at line 892 of file platforms/xcb/kkeyserver.cpp.

Variable Documentation

ModInfo KKeyServer::g_rgModInfo[4]
static
Initial value:
= {
{ Qt::SHIFT, "Shift", nullptr },
{ Qt::CTRL, "Ctrl", nullptr },
{ Qt::ALT, "Alt", nullptr },
{ Qt::META, "Meta", nullptr }
}

Definition at line 33 of file kkeyserver.cpp.

X11ModInfo KKeyServer::g_rgX11ModInfo[4]
static
Initial value:
= {
{ Qt::SHIFT, X11_ONLY(ShiftMask) },
{ Qt::CTRL, X11_ONLY(ControlMask) },
{ Qt::ALT, X11_ONLY(Mod1Mask) },
{ Qt::META, X11_ONLY(Mod4Mask) }
}

Definition at line 67 of file platforms/xcb/kkeyserver.cpp.

This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Tue Oct 20 2020 22:46:28 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.