KDEUI
KStandardShortcut Namespace Reference
Detailed Description
Convenient methods for access to the common accelerator keys in the key configuration.These are the standard keybindings that should be used in all KDE applications. They will be configurable, so do not hardcode the default behavior.
Enumeration Type Documentation
Defines the identifier of all standard accelerators.
- Enumerator:
Definition at line 50 of file kstandardshortcut.h.
Function Documentation
const KShortcut & KStandardShortcut::addBookmark | ( | ) |
Add current page to bookmarks.
Default: Ctrl+B
- Returns:
- the shortcut of the standard accelerator
Definition at line 287 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::back | ( | ) |
Back.
Default: Alt+Left
- Returns:
- the shortcut of the standard accelerator
Definition at line 304 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::backwardWord | ( | ) |
BackwardWord.
Default: Ctrl+Left
- Returns:
- the shortcut of the standard accelerator
Definition at line 284 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::begin | ( | ) |
Goto beginning of the document.
Default: Ctrl-Home
- Returns:
- the shortcut of the standard accelerator
Definition at line 278 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::beginningOfLine | ( | ) |
Goto beginning of current line.
Default: Home
- Returns:
- the shortcut of the standard accelerator
Definition at line 280 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::close | ( | ) |
Close current document.
Default: Ctrl-w
- Returns:
- the shortcut of the standard accelerator
Definition at line 261 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::completion | ( | ) |
Complete text in input widgets.
Default Ctrl+E
- Returns:
- the shortcut of the standard accelerator
Definition at line 294 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::copy | ( | ) |
Copy selected area into the clipboard.
Default: Ctrl-c
- Returns:
- the shortcut of the standard accelerator
Definition at line 266 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::cut | ( | ) |
Cut selected area and store it in the clipboard.
Default: Ctrl-x
- Returns:
- the shortcut of the standard accelerator
Definition at line 265 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::deleteWordBack | ( | ) |
Delete a word back from mouse/cursor position.
Default: Ctrl-Backspace
- Returns:
- the shortcut of the standard accelerator
Definition at line 269 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::deleteWordForward | ( | ) |
Delete a word forward from mouse/cursor position.
Default: Ctrl-Delete
- Returns:
- the shortcut of the standard accelerator
Definition at line 270 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::end | ( | ) |
Goto end of the document.
Default: Ctrl-End
- Returns:
- the shortcut of the standard accelerator
Definition at line 279 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::endOfLine | ( | ) |
Goto end of current line.
Default: End
- Returns:
- the shortcut of the standard accelerator
Definition at line 281 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::find | ( | ) |
Find, search.
Default: Ctrl-f
- Returns:
- the shortcut of the standard accelerator
Definition at line 273 of file kstandardshortcut.cpp.
StandardShortcut KStandardShortcut::find | ( | const char * | keyName | ) |
Return the StandardShortcut id of the standard accel action which has keyName as its name, or AccelNone if none of them do.
This is used by class KKeyChooser.
- Parameters:
-
keyName the key sequence to search
- Returns:
- the id of the standard accelerator, or AccelNone if there is none
Definition at line 242 of file kstandardshortcut.cpp.
StandardShortcut KStandardShortcut::find | ( | const QKeySequence & | keySeq | ) |
Return the StandardShortcut id of the standard accel action which uses this key sequence, or AccelNone if none of them do.
This is used by class KKeyChooser.
- Parameters:
-
keySeq the key sequence to search
- Returns:
- the id of the standard accelerator, or AccelNone if there is none
Definition at line 226 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::findNext | ( | ) |
Find/search next.
Default: F3
- Returns:
- the shortcut of the standard accelerator
Definition at line 274 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::findPrev | ( | ) |
Find/search previous.
Default: Shift-F3
- Returns:
- the shortcut of the standard accelerator
Definition at line 275 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::forward | ( | ) |
Forward.
Default: ALT+Right
- Returns:
- the shortcut of the standard accelerator
Definition at line 305 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::forwardWord | ( | ) |
ForwardWord.
Default: Ctrl+Right
- Returns:
- the shortcut of the standard accelerator
Definition at line 285 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::fullScreen | ( | ) |
Full Screen Mode.
Default: Ctrl+Shift+F
- Returns:
- the shortcut of the standard accelerator
Definition at line 290 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::gotoLine | ( | ) |
Go to line.
Default: Ctrl+G
- Returns:
- the shortcut of the standard accelerator
Definition at line 286 of file kstandardshortcut.cpp.
static KStandardShortcutInfo* KStandardShortcut::guardedStandardShortcutInfo | ( | StandardShortcut | id | ) | [static] |
Search for the KStandardShortcutInfo object associated with the given id
.
Return a dummy entry with no name and an empty shortcut if id
is invalid.
Definition at line 136 of file kstandardshortcut.cpp.
KShortcut KStandardShortcut::hardcodedDefaultShortcut | ( | StandardShortcut | id | ) |
Returns the hardcoded default shortcut for id
.
This does not take into account the user's configuration.
- Parameters:
-
id the id of the accelerator
- Returns:
- the default shortcut of the accelerator
Definition at line 251 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::help | ( | ) |
Help the user in the current situation.
Default: F1
- Returns:
- the shortcut of the standard accelerator
Definition at line 293 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::home | ( | ) |
Goto home page.
Default: Alt-Home
- Returns:
- the shortcut of the standard accelerator
Definition at line 277 of file kstandardshortcut.cpp.
static void KStandardShortcut::initialize | ( | StandardShortcut | id | ) | [static] |
Initialize the accelerator id
by checking if it is overridden in the configuration file (and if it isn't, use the default).
On X11, if QApplication was initialized with GUI disabled, the default will always be used.
Definition at line 151 of file kstandardshortcut.cpp.
const KShortcut& KStandardShortcut::insert | ( | ) |
Toggle insert/overwrite (with visual feedback, e.g.
in the statusbar). Default: Insert
- Returns:
- the shortcut of the standard accelerator
Definition at line 248 of file kstandardguiitem.cpp.
QString KStandardShortcut::label | ( | StandardShortcut | id | ) |
Returns a localized label for user-visible display.
- Parameters:
-
id the id of the accelerator
- Returns:
- a localized label for the accelerator
Definition at line 200 of file kstandardshortcut.cpp.
QString KStandardShortcut::name | ( | StandardShortcut | id | ) |
Returns a unique name for the given accel.
- Parameters:
-
id the id of the accelerator
- Returns:
- the unique name of the accelerator
Definition at line 195 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::next | ( | ) |
Scroll down one page.
Default: Next
- Returns:
- the shortcut of the standard accelerator
Definition at line 283 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::nextCompletion | ( | ) |
Iterate through a list when completion returns multiple items.
Default: Ctrl+Down
- Returns:
- the shortcut of the standard accelerator
Definition at line 296 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::open | ( | ) |
Open file.
Default: Ctrl-o
- Returns:
- the shortcut of the standard accelerator
Definition at line 259 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::openNew | ( | ) |
Create a new document (or whatever).
Default: Ctrl-n
- Returns:
- the shortcut of the standard accelerator
Definition at line 260 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::paste | ( | ) |
Paste contents of clipboard at mouse/cursor position.
Default: Ctrl-v
- Returns:
- the shortcut of the standard accelerator
Definition at line 267 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::pasteSelection | ( | ) |
Paste the selection at mouse/cursor position.
Default: Ctrl-Shift-Insert
- Returns:
- the shortcut of the standard accelerator
Definition at line 268 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::prevCompletion | ( | ) |
Iterate through a list when completion returns multiple items.
Default: Ctrl+Up
- Returns:
- the shortcut of the standard accelerator
Definition at line 295 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::print | ( | ) |
Print current document.
Default: Ctrl-p
- Returns:
- the shortcut of the standard accelerator
Definition at line 263 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::prior | ( | ) |
Scroll up one page.
Default: Prior
- Returns:
- the shortcut of the standard accelerator
Definition at line 282 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::quit | ( | ) |
Quit the program.
Default: Ctrl-q
- Returns:
- the shortcut of the standard accelerator
Definition at line 264 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::redo | ( | ) |
Redo.
Default: Shift-Ctrl-z
- Returns:
- the shortcut of the standard accelerator
Definition at line 272 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::reload | ( | ) |
Reload.
Default: F5
- Returns:
- the shortcut of the standard accelerator
Definition at line 301 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::replace | ( | ) |
Find and replace matches.
Default: Ctrl-r
- Returns:
- the shortcut of the standard accelerator
Definition at line 276 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::rotateDown | ( | ) |
Help users iterate through a list of entries.
Default: Down
- Returns:
- the shortcut of the standard accelerator
Definition at line 298 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::rotateUp | ( | ) |
Help users iterate through a list of entries.
Default: Up
- Returns:
- the shortcut of the standard accelerator
Definition at line 297 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::save | ( | ) |
Save current document.
Default: Ctrl-s
- Returns:
- the shortcut of the standard accelerator
Definition at line 262 of file kstandardshortcut.cpp.
void KStandardShortcut::saveShortcut | ( | StandardShortcut | id, | |
const KShortcut & | newShortcut | |||
) |
Saves the new shortcut cut for standard accel id.
Definition at line 175 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::selectAll | ( | ) |
Reload.
Default: Ctrl-A
- Returns:
- the shortcut of the standard accelerator
Definition at line 302 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::shortcut | ( | StandardShortcut | id | ) |
Returns the keybinding for accel
.
On X11, if QApplication was initialized with GUI disabled, the default keybinding will always be returned.
- Parameters:
-
id the id of the accelerator
Definition at line 216 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::showMenubar | ( | ) |
Show Menu Bar.
Default: Ctrl-M
- Returns:
- the shortcut of the standard accelerator
Definition at line 306 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::substringCompletion | ( | ) |
Find a string within another string or list of strings.
Default: Ctrl-T
- Returns:
- the shortcut of the standard accelerator
Definition at line 299 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::tabNext | ( | ) |
Next Tab.
Default: Ctrl-<
- Returns:
- the shortcut of the standard accelerator
Definition at line 288 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::tabPrev | ( | ) |
Previous Tab.
Default: Ctrl->
- Returns:
- the shortcut of the standard accelerator
Definition at line 289 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::undo | ( | ) |
Undo last operation.
Default: Ctrl-z
- Returns:
- the shortcut of the standard accelerator
Definition at line 271 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::up | ( | ) |
Up.
Default: Alt+Up
- Returns:
- the shortcut of the standard accelerator
Definition at line 303 of file kstandardshortcut.cpp.
QString KStandardShortcut::whatsThis | ( | StandardShortcut | id | ) |
Returns an extended WhatsThis description for the given accelerator.
- Parameters:
-
id the id of the accelerator
- Returns:
- a localized description of the accelerator
const KShortcut& KStandardShortcut::whatsThis | ( | ) |
What's This button.
Default: Shift+F1
- Returns:
- the shortcut of the standard accelerator
Definition at line 300 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::zoomIn | ( | ) |
Zoom in.
Default: Ctrl-Plus
- Returns:
- the shortcut of the standard accelerator
Definition at line 291 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::zoomOut | ( | ) |
Zoom out.
Default: Ctrl-Minus
- Returns:
- the shortcut of the standard accelerator
Definition at line 292 of file kstandardshortcut.cpp.
Variable Documentation
KStandardShortcutInfo KStandardShortcut::g_infoStandardShortcut[] [static] |
Array of predefined KStandardShortcutInfo objects, which cover all the "standard" accelerators.
Each enum value from StandardShortcut should appear in this table.
Definition at line 59 of file kstandardshortcut.cpp.
const KShortcut & KStandardShortcut::whatsThis | ( | StandardShortcut | ) |
What's This button.
Default: Shift+F1
- Returns:
- the shortcut of the standard accelerator
Definition at line 207 of file kstandardshortcut.cpp.