tdecore
TDEStdAccel Namespace Reference
Convenient methods for access to the common accelerator keys in the key configuration. More...
Classes | |
class | ShortcutList |
TDEShortcutList implementation that accesses TDEStdAccel actions. More... | |
Enumerations | |
enum | StdAccel { AccelNone, Open, New, Close, Save, Print, Quit, Undo, Redo, Cut, Copy, Paste, SelectAll, Deselect, DeleteWordBack, DeleteWordForward, Find, FindNext, FindPrev, Replace, Home, End, Prior, Next, GotoLine, AddBookmark, ZoomIn, ZoomOut, Up, Back, Forward, Reload, PopupMenuContext, ShowMenubar, Help, WhatsThis, TextCompletion, PrevCompletion, NextCompletion, SubstringCompletion, RotateUp, RotateDown, TabNext, TabPrev, FullScreen, BackwardWord, ForwardWord, BeginningOfLine, EndOfLine, PasteSelection, WhatThis = WhatsThis } |
Functions | |
static TDEStdAccelInfo * | infoPtr (StdAccel id) |
static void | initialize (StdAccel id) |
TQString | name (StdAccel id) |
TQString | label (StdAccel id) |
const TDEShortcut & | shortcut (StdAccel id) |
StdAccel | findStdAccel (const KKeySequence &keySeq) |
TDEShortcut | shortcutDefault (StdAccel id) |
TDEShortcut | shortcutDefault3 (StdAccel id) |
TDEShortcut | shortcutDefault4 (StdAccel id) |
const TDEShortcut & | open () |
const TDEShortcut & | openNew () |
const TDEShortcut & | close () |
const TDEShortcut & | save () |
const TDEShortcut & | print () |
const TDEShortcut & | quit () |
const TDEShortcut & | cut () |
const TDEShortcut & | copy () |
const TDEShortcut & | paste () |
const TDEShortcut & | pasteSelection () |
const TDEShortcut & | deleteWordBack () |
const TDEShortcut & | deleteWordForward () |
const TDEShortcut & | undo () |
const TDEShortcut & | redo () |
const TDEShortcut & | find () |
const TDEShortcut & | findNext () |
const TDEShortcut & | findPrev () |
const TDEShortcut & | replace () |
const TDEShortcut & | home () |
const TDEShortcut & | end () |
const TDEShortcut & | beginningOfLine () |
const TDEShortcut & | endOfLine () |
const TDEShortcut & | prior () |
const TDEShortcut & | next () |
const TDEShortcut & | backwardWord () |
const TDEShortcut & | forwardWord () |
const TDEShortcut & | gotoLine () |
const TDEShortcut & | addBookmark () |
const TDEShortcut & | tabNext () |
const TDEShortcut & | tabPrev () |
const TDEShortcut & | fullScreen () |
const TDEShortcut & | zoomIn () |
const TDEShortcut & | zoomOut () |
const TDEShortcut & | help () |
const TDEShortcut & | completion () |
const TDEShortcut & | prevCompletion () |
const TDEShortcut & | nextCompletion () |
const TDEShortcut & | rotateUp () |
const TDEShortcut & | rotateDown () |
const TDEShortcut & | substringCompletion () |
const TDEShortcut & | popupMenuContext () |
const TDEShortcut & | whatsThis () |
const TDEShortcut & | reload () |
const TDEShortcut & | selectAll () |
const TDEShortcut & | up () |
const TDEShortcut & | back () |
const TDEShortcut & | forward () |
const TDEShortcut & | showMenubar () |
TQString | action (StdAccel id) KDE_DEPRECATED |
TQString | description (StdAccel id) KDE_DEPRECATED |
int | key (StdAccel) KDE_DEPRECATED |
int | defaultKey (StdAccel accel) KDE_DEPRECATED |
bool | isEqual (const TQKeyEvent *pEvent, int keyQt) KDE_DEPRECATED |
TQString | whatsThis (StdAccel id) |
const TDEShortcut & | insert () |
Variables | |
static TDEStdAccelInfo | g_infoStdAccel [] |
TQString | whatsThis (StdAccel) |
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.
If you want real configurable keybindings in your applications, please checkout the class TDEAccel in tdeaccel.h
- See also:
- TDEAccelShortcutList
Enumeration Type Documentation
Defines the identifier of all standard accelerators.
- Enumerator:
TabNext - Since:
- 3.2
TabPrev - Since:
- 3.2
FullScreen - Since:
- 3.2
BackwardWord - Since:
- 3.3
ForwardWord - Since:
- 3.3
BeginningOfLine - Since:
- 3.3
EndOfLine - Since:
- 3.3
PasteSelection - Since:
- 3.4
Definition at line 47 of file tdestdaccel.h.
Function Documentation
TQString TDEStdAccel::action | ( | StdAccel | id | ) |
- Deprecated:
- Obsolete. Use name(). Returns a string representation for
accel
.
const TDEShortcut & TDEStdAccel::addBookmark | ( | ) |
Add current page to bookmarks.
Default: Ctrl+B
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::back | ( | ) |
Back.
Default: Alt+Left
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::backwardWord | ( | ) |
BackwardWord.
Default: Ctrl+Left
- Returns:
- the shortcut of the standard accelerator
- Since:
- 3.3
const TDEShortcut & TDEStdAccel::beginningOfLine | ( | ) |
Goto beginning of current line.
Default: Home
- Returns:
- the shortcut of the standard accelerator
- Since:
- 3.3
const TDEShortcut & TDEStdAccel::close | ( | ) |
Close current document.
Default: Ctrl-w
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::completion | ( | ) |
Complete text in input widgets.
Default Ctrl+E
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::copy | ( | ) |
Copy selected area into the clipboard.
Default: Ctrl-c
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::cut | ( | ) |
Cut selected area and store it in the clipboard.
Default: Ctrl-x
- Returns:
- the shortcut of the standard accelerator
int TDEStdAccel::defaultKey | ( | StdAccel | accel | ) |
- Deprecated:
- Obsolete. Use shortcutDefault().
const TDEShortcut & TDEStdAccel::deleteWordBack | ( | ) |
Delete a word back from mouse/cursor position.
Default: Ctrl-Backspace
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::deleteWordForward | ( | ) |
Delete a word forward from mouse/cursor position.
Default: Ctrl-Delete
- Returns:
- the shortcut of the standard accelerator
TQString TDEStdAccel::description | ( | StdAccel | id | ) |
- Deprecated:
- Obsolete. Use desc(). Returns a localized description of
accel
.
const TDEShortcut & TDEStdAccel::end | ( | ) |
Goto end of the document.
Default: Ctrl-End
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::endOfLine | ( | ) |
Goto end of current line.
Default: End
- Returns:
- the shortcut of the standard accelerator
- Since:
- 3.3
const TDEShortcut & TDEStdAccel::find | ( | ) |
Find, search.
Default: Ctrl-f
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::findNext | ( | ) |
Find/search next.
Default: F3
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::findPrev | ( | ) |
Find/search previous.
Default: Shift-F3
- Returns:
- the shortcut of the standard accelerator
StdAccel TDEStdAccel::findStdAccel | ( | const KKeySequence & | keySeq | ) |
Return the StdAccel 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
const TDEShortcut & TDEStdAccel::forward | ( | ) |
Forward.
Default: ALT+Right
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::forwardWord | ( | ) |
ForwardWord.
Default: Ctrl+Right
- Returns:
- the shortcut of the standard accelerator
- Since:
- 3.3
const TDEShortcut & TDEStdAccel::fullScreen | ( | ) |
Full Screen Mode.
Default: Ctrl+Shift+F
- Returns:
- the shortcut of the standard accelerator
- Since:
- 3.2
const TDEShortcut & TDEStdAccel::gotoLine | ( | ) |
Go to line.
Default: Ctrl+G
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::help | ( | ) |
Help the user in the current situation.
Default: F1
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::home | ( | ) |
Goto beginning of the document.
Default: Ctrl-Home
- Returns:
- the shortcut of the standard accelerator
static TDEStdAccelInfo* TDEStdAccel::infoPtr | ( | StdAccel | id | ) | [static] |
Search for the TDEStdAccelInfo object associated with the given id
.
Definition at line 99 of file tdestdaccel.cpp.
static void TDEStdAccel::initialize | ( | StdAccel | id | ) | [static] |
Initialize the accelerator id
by checking if it is overridden in the configuration file (and if it isn't, use the default).
Definition at line 116 of file tdestdaccel.cpp.
const TDEShortcut& TDEStdAccel::insert | ( | ) |
Toggle insert/overwrite (with visual feedback, e.g.
in the statusbar). Default: Insert
- Returns:
- the shortcut of the standard accelerator
bool TDEStdAccel::isEqual | ( | const TQKeyEvent * | pEvent, | |
int | keyQt | |||
) |
- Deprecated:
- . Use KKey(const TQKeyEvent*) == KKey(int).
Compare the keys generated by the key event with the value of the integer.
If a modifier (Shift, Alt, Ctrl) key is present in TQKeyEvent, its sum with the actual key value is used for comparing it with the integer parameter.
- Parameters:
-
pEvent the key event to be used in the comparison. keyQt the int value to be compared to the key event.
- Returns:
- true if the int value matches the integer representation of the QKeyEvent
int TDEStdAccel::key | ( | StdAccel | ) |
- Deprecated:
- Obsolete. Use shortcut(). Returns the keybinding for
accel
.
TQString TDEStdAccel::label | ( | StdAccel | id | ) |
Returns a localized label for user-visible display.
- Parameters:
-
id the id of the accelerator
- Returns:
- a localized label for the accelerator
TQString TDEStdAccel::name | ( | StdAccel | id | ) |
Returns a unique name for the given accel.
- Parameters:
-
id the id of the accelerator
- Returns:
- the unique name of the accelerator
const TDEShortcut & TDEStdAccel::next | ( | ) |
Scroll down one page.
Default: Next
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::nextCompletion | ( | ) |
Iterate through a list when completion returns multiple items.
Default: Ctrl+Down
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::open | ( | ) |
Open file.
Default: Ctrl-o
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::openNew | ( | ) |
Create a new document (or whatever).
Default: Ctrl-n
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::paste | ( | ) |
Paste contents of clipboard at mouse/cursor position.
Default: Ctrl-v
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::pasteSelection | ( | ) |
Paste the selection at mouse/cursor position.
Default: Ctrl-Shift-Insert
- Returns:
- the shortcut of the standard accelerator
- Since:
- 3.4
const TDEShortcut & TDEStdAccel::popupMenuContext | ( | ) |
popup a context menu.
Default: Menu
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::prevCompletion | ( | ) |
Iterate through a list when completion returns multiple items.
Default: Ctrl+Up
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::print | ( | ) |
Print current document.
Default: Ctrl-p
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::prior | ( | ) |
Scroll up one page.
Default: Prior
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::quit | ( | ) |
Quit the program.
Default: Ctrl-q
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::redo | ( | ) |
Redo.
Default: Shift-Ctrl-z
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::reload | ( | ) |
Reload.
Default: F5
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::replace | ( | ) |
Find and replace matches.
Default: Ctrl-r
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::rotateDown | ( | ) |
Help users iterate through a list of entries.
Default: Down
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::rotateUp | ( | ) |
Help users iterate through a list of entries.
Default: Up
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::save | ( | ) |
Save current document.
Default: Ctrl-s
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::selectAll | ( | ) |
Reload.
Default: Ctrl-A
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::shortcut | ( | StdAccel | id | ) |
Returns the keybinding for accel
.
- Parameters:
-
id the id of the accelerator
TDEShortcut TDEStdAccel::shortcutDefault | ( | StdAccel | 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
TDEShortcut TDEStdAccel::shortcutDefault3 | ( | StdAccel | id | ) |
Returns the hardcoded default 3 modifier shortcut for id
.
This does not take into account the user's configuration.
- Parameters:
-
id the id of the accelerator
- Returns:
- the default 3 modifier shortcut
TDEShortcut TDEStdAccel::shortcutDefault4 | ( | StdAccel | id | ) |
Returns the hardcoded default 4 modifier shortcut for id
.
This does not take into account the user's configuration.
- Parameters:
-
id the id of the accelerator
- Returns:
- the default 4 modifier shortcut
const TDEShortcut & TDEStdAccel::showMenubar | ( | ) |
Show Menu Bar.
Default: Ctrl-M
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::substringCompletion | ( | ) |
Find a string within another string or list of strings.
Default: Ctrl-T
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::tabNext | ( | ) |
Next Tab.
Default: Ctrl-<
- Returns:
- the shortcut of the standard accelerator
- Since:
- 3.2
const TDEShortcut & TDEStdAccel::tabPrev | ( | ) |
Previous Tab.
Default: Ctrl->
- Returns:
- the shortcut of the standard accelerator
- Since:
- 3.2
const TDEShortcut & TDEStdAccel::undo | ( | ) |
Undo last operation.
Default: Ctrl-z
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::up | ( | ) |
Up.
Default: Alt+Up
- Returns:
- the shortcut of the standard accelerator
TQString TDEStdAccel::whatsThis | ( | StdAccel | 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 TDEShortcut& TDEStdAccel::whatsThis | ( | ) |
What's This button.
Default: Shift+F1
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::zoomIn | ( | ) |
Zoom in.
Default: Ctrl-Plus
- Returns:
- the shortcut of the standard accelerator
const TDEShortcut & TDEStdAccel::zoomOut | ( | ) |
Zoom out.
Default: Ctrl-Minus
- Returns:
- the shortcut of the standard accelerator
Variable Documentation
TDEStdAccelInfo TDEStdAccel::g_infoStdAccel[] [static] |
Array of predefined TDEStdAccelInfo objects, which cover all the "standard" accelerators.
Each enum value from StdAccel should appear in this table.
Definition at line 39 of file tdestdaccel.cpp.
const TDEShortcut & TDEStdAccel::whatsThis | ( | StdAccel | ) |
What's This button.
Default: Shift+F1
- Returns:
- the shortcut of the standard accelerator
Definition at line 154 of file tdestdaccel.cpp.