KDE 4.1 PyKDE API Reference
KKeySequenceWidget Class Reference
from PyKDE4.kdeui import *
Detailed Description
A widget to input a QKeySequence.
This widget lets the user choose a QKeySequence, which is usually used as a shortcut key, by pressing the keys just like to trigger a shortcut. Calling captureKeySequence(), or the user clicking into the widget, start recording.
A check for conflict with shortcut of this application can also be performed. call setCheckActionCollections() to set the list of action collections to check with, and applyStealShortcut when applying changes.
- Internal:
Enumerations | |
| Validation | { Validate, NoValidate } |
Signals | |
| keySequenceChanged (QKeySequence seq) | |
Methods | |
| __init__ (self, QWidget parent=0) | |
| __init__ (self, KKeySequenceWidget a0) | |
| applyStealShortcut (self) | |
| captureKeySequence (self) | |
| clearKeySequence (self) | |
| bool | isModifierlessAllowed (self) |
| QKeySequence | keySequence (self) |
| keySequenceChanged (self, QKeySequence seq) | |
| setCheckActionCollections (self, [KActionCollectio] actionCollections) | |
| setCheckActionList (self, [QActio] checkList) | |
| setClearButtonShown (self, bool show) | |
| setKeySequence (self, QKeySequence seq, KKeySequenceWidget.Validation val=KKeySequenceWidget.NoValidate) | |
| setModifierlessAllowed (self, bool allow) | |
Method Documentation
| __init__ | ( | self, | ||
| QWidget | parent=0 | |||
| ) |
Constructor.
| __init__ | ( | self, | ||
| KKeySequenceWidget | a0 | |||
| ) |
| applyStealShortcut | ( | self ) |
Actually remove the shortcut that the user wanted to steal, from the action that was using it.
To be called before you apply your changes. No shortcuts are stolen until this function is called.
| captureKeySequence | ( | self ) |
Capture a shortcut from the keyboard. This call will only return once a key sequence has been captured or input was aborted. If a key sequence was input, keySequenceChanged() will be emitted.
- See also:
- setModifierlessAllowed()
| clearKeySequence | ( | self ) |
Clear the key sequence.
| bool isModifierlessAllowed | ( | self ) |
- See also:
- setModifierlessAllowed()
| QKeySequence keySequence | ( | self ) |
Return the currently selected key sequence.
| keySequenceChanged | ( | self, | ||
| QKeySequence | seq | |||
| ) |
This signal is emitted when the current key sequence has changed, be it by user input or programmatically.
- Signal syntax:
QObject.connect(source, SIGNAL("keySequenceChanged(const QKeySequence&)"), target_slot)
| setCheckActionCollections | ( | self, | ||
| [KActionCollectio] | actionCollections | |||
| ) |
Set a list of action collections to check against for conflictuous shortcut.
If there is a conflictuous shortcut with a KAction, and its shortcut can be configured (KAction.isShortcutConfigurable() returns true) the user will be prompted whether to steal the shortcut from this action.
Global shortcuts are automatically checked for conflicts
Don't forget to call applyStealShortcut to actually steal the shortcut.
- Since:
- 4.1
| setCheckActionList | ( | self, | ||
| [QActio] | checkList | |||
| ) |
- Deprecated:
- since 4.1 use setCheckActionCollections so that KKeySequenceWidget knows in which action collection to call the writeSettings method after stealing a shortcut from an action.
| setClearButtonShown | ( | self, | ||
| bool | show | |||
| ) |
Set whether a small button to set an empty key sequence should be displayed next to the main input widget. The default is to show the clear button.
| setKeySequence | ( | self, | ||
| QKeySequence | seq, | |||
| KKeySequenceWidget.Validation | val=KKeySequenceWidget.NoValidate | |||
| ) |
Set the key sequence.
If val == Validate, and the call is actually changing the key sequence, conflictuous shortcut will be checked.
| setModifierlessAllowed | ( | self, | ||
| bool | allow | |||
| ) |
This only applies to user input, not to setShortcut(). Set whether to accept "plain" keys without modifiers (like Ctrl, Alt, Meta). Plain keys by our definition include letter and symbol keys and text editing keys (Return, Space, Tab, Backspace, Delete). "Special" keys like F1, Cursor keys, Insert, PageDown will always work.
Enumeration Documentation
| Validation |
Validate key sequence
- Enumerator:
-
Validate = 0 NoValidate = 1
