kdecore Library API Documentation

KStdAccel Namespace Reference

Convenient methods for access to the common accelerator keys in the key configuration. More...


Compounds

class  ShortcutList
 KShortcutList implementation that accesses KStdAccel actions. More...


Enumerations

enum  StdAccel

Functions

QString name (StdAccel id)
QString label (StdAccel id)
const KShortcutshortcut (StdAccel id)
StdAccel findStdAccel (const KKeySequence &seq)
KShortcut shortcutDefault (StdAccel id)
KShortcut shortcutDefault3 (StdAccel id)
KShortcut shortcutDefault4 (StdAccel id)
const KShortcutopen ()
const KShortcutopenNew ()
const KShortcutclose ()
const KShortcutsave ()
const KShortcutprint ()
const KShortcutquit ()
const KShortcutcut ()
const KShortcutcopy ()
const KShortcutpaste ()
const KShortcutdeleteWordBack ()
const KShortcutdeleteWordForward ()
const KShortcutundo ()
const KShortcutredo ()
const KShortcutfind ()
const KShortcutfindNext ()
const KShortcutfindPrev ()
const KShortcutreplace ()
const KShortcuthome ()
const KShortcutend ()
const KShortcutprior ()
const KShortcutnext ()
const KShortcutgotoLine ()
const KShortcutaddBookmark ()
const KShortcuttabNext ()
const KShortcuttabPrev ()
const KShortcutfullScreen ()
const KShortcutzoomIn ()
const KShortcutzoomOut ()
const KShortcuthelp ()
const KShortcutcompletion ()
const KShortcutprevCompletion ()
const KShortcutnextCompletion ()
const KShortcutrotateUp ()
const KShortcutrotateDown ()
const KShortcutsubstringCompletion ()
const KShortcutpopupMenuContext ()
const KShortcutwhatsThis ()
const KShortcutreload ()
const KShortcutselectAll ()
const KShortcutup ()
const KShortcutback ()
const KShortcutforward ()
const KShortcutshowMenubar ()
QString action (StdAccel id)
QString description (StdAccel id)
int key (StdAccel id)
int defaultKey (StdAccel id)
bool isEqual (const QKeyEvent *ev, int keyQt)
QString whatsThis (StdAccel id)
const KShortcutinsert ()

Variables

QString 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 KAccel in kaccel.h

See also:
KAccelShortcutList


Enumeration Type Documentation

enum KStdAccel::StdAccel
 

Defines the identifier of all standard accelerators.

Definition at line 47 of file kstdaccel.h.

Referenced by action(), defaultKey(), description(), findStdAccel(), key(), label(), name(), shortcut(), shortcutDefault(), shortcutDefault3(), and shortcutDefault4().


Function Documentation

QString KStdAccel::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

Definition at line 132 of file kstdaccel.cpp.

References StdAccel.

Referenced by action(), and KAccel::insert().

QString KStdAccel::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

Definition at line 140 of file kstdaccel.cpp.

References StdAccel.

Referenced by description(), and KConfigDialogManager::parseChildren().

const KShortcut & KStdAccel::shortcut StdAccel    id
 

Returns the keybinding for accel.

Parameters:
id  the id of the accelerator

Definition at line 158 of file kstdaccel.cpp.

References KShortcut::null(), and StdAccel.

Referenced by addBookmark(), back(), close(), completion(), copy(), cut(), deleteWordBack(), deleteWordForward(), end(), find(), findNext(), findPrev(), forward(), fullScreen(), gotoLine(), help(), home(), key(), next(), nextCompletion(), open(), openNew(), paste(), popupMenuContext(), prevCompletion(), print(), prior(), quit(), redo(), reload(), replace(), rotateDown(), rotateUp(), save(), selectAll(), showMenubar(), substringCompletion(), tabNext(), tabPrev(), undo(), up(), whatsThis(), zoomIn(), and zoomOut().

StdAccel KStdAccel::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

Definition at line 170 of file kstdaccel.cpp.

References KKeySequence::isNull(), and StdAccel.

KShortcut KStdAccel::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

Definition at line 186 of file kstdaccel.cpp.

References shortcutDefault3(), shortcutDefault4(), and StdAccel.

Referenced by defaultKey(), and KStdAccel::ShortcutList::shortcutDefault().

KShortcut KStdAccel::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

Definition at line 192 of file kstdaccel.cpp.

References KShortcut::append(), cut(), KShortcut::init(), and StdAccel.

Referenced by shortcutDefault().

KShortcut KStdAccel::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

Definition at line 209 of file kstdaccel.cpp.

References KShortcut::append(), KKeySequence::count(), cut(), KKeySequence::init(), KShortcut::init(), and StdAccel.

Referenced by shortcutDefault().

const KShortcut & KStdAccel::open  
 

Open file.

Default: Ctrl-o

Returns:
the shortcut of the standard accelerator

Definition at line 252 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::openNew  
 

Create a new document (or whatever).

Default: Ctrl-n

Returns:
the shortcut of the standard accelerator

Definition at line 253 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::close  
 

Close current document.

Default: Ctrl-w

Returns:
the shortcut of the standard accelerator

Definition at line 254 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::save  
 

Save current document.

Default: Ctrl-s

Returns:
the shortcut of the standard accelerator

Definition at line 255 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::print  
 

Print current document.

Default: Ctrl-p

Returns:
the shortcut of the standard accelerator

Definition at line 256 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::quit  
 

Quit the program.

Default: Ctrl-q

Returns:
the shortcut of the standard accelerator

Definition at line 257 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::cut  
 

Cut selected area and store it in the clipboard.

Default: Ctrl-x

Returns:
the shortcut of the standard accelerator

Definition at line 258 of file kstdaccel.cpp.

References shortcut().

Referenced by shortcutDefault3(), and shortcutDefault4().

const KShortcut & KStdAccel::copy  
 

Copy selected area into the clipboard.

Default: Ctrl-c

Returns:
the shortcut of the standard accelerator

Definition at line 259 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::paste  
 

Paste contents of clipboard at mouse/cursor position.

Default: Ctrl-v

Returns:
the shortcut of the standard accelerator

Definition at line 260 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::deleteWordBack  
 

Delete a word back from mouse/cursor position.

Default: Ctrl-Backspace

Returns:
the shortcut of the standard accelerator

Definition at line 261 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::deleteWordForward  
 

Delete a word forward from mouse/cursor position.

Default: Ctrl-Delete

Returns:
the shortcut of the standard accelerator

Definition at line 262 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::undo  
 

Undo last operation.

Default: Ctrl-z

Returns:
the shortcut of the standard accelerator

Definition at line 263 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::redo  
 

Redo.

Default: Shift-Ctrl-z

Returns:
the shortcut of the standard accelerator

Definition at line 264 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::find  
 

Find, search.

Default: Ctrl-f

Returns:
the shortcut of the standard accelerator

Definition at line 265 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::findNext  
 

Find/search next.

Default: F3

Returns:
the shortcut of the standard accelerator

Definition at line 266 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::findPrev  
 

Find/search previous.

Default: Shift-F3

Returns:
the shortcut of the standard accelerator

Definition at line 267 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::replace  
 

Find and replace matches.

Default: Ctrl-r

Returns:
the shortcut of the standard accelerator

Definition at line 268 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::home  
 

Goto beginning of current line.

Default: Home

Returns:
the shortcut of the standard accelerator

Definition at line 269 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::end  
 

Goto end of current line.

Default: End

Returns:
the shortcut of the standard accelerator

Definition at line 270 of file kstdaccel.cpp.

References shortcut().

Referenced by KExtendedSocket::connect(), KCodecs::quotedPrintableEncode(), KConfigBase::readPropertyEntry(), KCharsets::resolveEntities(), KCodecs::uudecode(), KCodecs::uuencode(), and KConfigBase::writeEntry().

const KShortcut & KStdAccel::prior  
 

Scroll up one page.

Default: Prior

Returns:
the shortcut of the standard accelerator

Definition at line 271 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::next  
 

Scroll down one page.

Default: Next

Returns:
the shortcut of the standard accelerator

Definition at line 272 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::gotoLine  
 

Go to line.

Default: Ctrl+G

Returns:
the shortcut of the standard accelerator

Definition at line 273 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::addBookmark  
 

Add current page to bookmarks.

Default: Ctrl+B

Returns:
the shortcut of the standard accelerator

Definition at line 274 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::tabNext  
 

Next Tab.

Default: Ctrl-<

Returns:
the shortcut of the standard accelerator
Since:
3.2

Definition at line 275 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::tabPrev  
 

Previous Tab.

Default: Ctrl->

Returns:
the shortcut of the standard accelerator
Since:
3.2

Definition at line 276 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::fullScreen  
 

Full Screen Mode.

Default: Ctrl+Shift+F

Returns:
the shortcut of the standard accelerator
Since:
3.2

Definition at line 277 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::zoomIn  
 

Zoom in.

Default: Ctrl-Plus

Returns:
the shortcut of the standard accelerator

Definition at line 278 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::zoomOut  
 

Zoom out.

Default: Ctrl-Minus

Returns:
the shortcut of the standard accelerator

Definition at line 279 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::help  
 

Help the user in the current situation.

Default: F1

Returns:
the shortcut of the standard accelerator

Definition at line 280 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::completion  
 

Complete text in input widgets.

Default Ctrl+E

Returns:
the shortcut of the standard accelerator

Definition at line 281 of file kstdaccel.cpp.

References shortcut().

Referenced by KGlobalSettings::completionMode(), KCompletion::makeCompletion(), KCompletion::nextMatch(), and KCompletion::previousMatch().

const KShortcut & KStdAccel::prevCompletion  
 

Iterate through a list when completion returns multiple items.

Default: Ctrl+Up

Returns:
the shortcut of the standard accelerator

Definition at line 282 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::nextCompletion  
 

Iterate through a list when completion returns multiple items.

Default: Ctrl+Down

Returns:
the shortcut of the standard accelerator

Definition at line 283 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::rotateUp  
 

Help users iterate through a list of entries.

Default: Up

Returns:
the shortcut of the standard accelerator

Definition at line 284 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::rotateDown  
 

Help users iterate through a list of entries.

Default: Down

Returns:
the shortcut of the standard accelerator

Definition at line 285 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::substringCompletion  
 

Find a string within another string or list of strings.

Default: Ctrl-T

Returns:
the shortcut of the standard accelerator

Definition at line 286 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::popupMenuContext  
 

popup a context menu.

Default: Menu

Returns:
the shortcut of the standard accelerator

Definition at line 287 of file kstdaccel.cpp.

References shortcut().

const KShortcut& whatsThis  
 

What's This button.

Default: Shift+F1

Returns:
the shortcut of the standard accelerator

Definition at line 288 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::reload  
 

Reload.

Default: F5

Returns:
the shortcut of the standard accelerator

Definition at line 289 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::selectAll  
 

Reload.

Default: Ctrl-A

Returns:
the shortcut of the standard accelerator

Definition at line 290 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::up  
 

Up.

Default: Alt+Up

Returns:
the shortcut of the standard accelerator

Definition at line 291 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::back  
 

Back.

Default: Alt+Left

Returns:
the shortcut of the standard accelerator

Definition at line 292 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::forward  
 

Forward.

Default: ALT+Right

Returns:
the shortcut of the standard accelerator

Definition at line 293 of file kstdaccel.cpp.

References shortcut().

const KShortcut & KStdAccel::showMenubar  
 

Show Menu Bar.

Default: Ctrl-M

Returns:
the shortcut of the standard accelerator

Definition at line 294 of file kstdaccel.cpp.

References shortcut().

QString KStdAccel::action StdAccel    id
 

Deprecated:
Obsolete. Use name(). Returns a string representation for accel.

Definition at line 356 of file kstdaccel.cpp.

References name(), and StdAccel.

QString KStdAccel::description StdAccel    id
 

Deprecated:
Obsolete. Use desc(). Returns a localized description of accel.

Definition at line 358 of file kstdaccel.cpp.

References label(), and StdAccel.

int KStdAccel::key StdAccel   
 

Deprecated:
Obsolete. Use shortcut(). Returns the keybinding for accel.

Definition at line 360 of file kstdaccel.cpp.

References KShortcut::keyCodeQt(), shortcut(), and StdAccel.

Referenced by KStandardDirs::addCustomized(), KConfigSkeleton::addItemBool(), KConfigSkeleton::addItemColor(), KConfigSkeleton::addItemDateTime(), KConfigSkeleton::addItemDouble(), KConfigSkeleton::addItemFont(), KConfigSkeleton::addItemInt(), KConfigSkeleton::addItemInt64(), KConfigSkeleton::addItemIntList(), KConfigSkeleton::addItemLong(), KConfigSkeleton::addItemPassword(), KConfigSkeleton::addItemPath(), KConfigSkeleton::addItemPoint(), KConfigSkeleton::addItemProperty(), KConfigSkeleton::addItemRect(), KConfigSkeleton::addItemSize(), KConfigSkeleton::addItemString(), KConfigSkeleton::addItemStringList(), KConfigSkeleton::addItemUInt(), KConfigSkeleton::addItemUInt64(), KConfigSkeleton::addItemULong(), KCharsets::codecForName(), KShortcut::contains(), KZoneAllocator::deallocate(), KURLDrag::decode(), KConfigBase::entryIsImmutable(), KConfigBase::hasDefault(), KConfigBase::hasKey(), KShortcut::init(), KKeySequence::init(), KKey::init(), KKey::KKey(), KKeySequence::KKeySequence(), KShortcut::KShortcut(), KIconLoader::loadIcon(), KKey::operator!=(), KKey::operator<(), KKey::operator=(), KKey::operator==(), KConfigINIBackEnd::parseSingleConfigFile(), KConfig::putData(), KConfigBase::revertToDefault(), and KKeySequence::setKey().

int KStdAccel::defaultKey StdAccel    accel
 

Deprecated:
Obsolete. Use shortcutDefault().

Definition at line 362 of file kstdaccel.cpp.

References KShortcut::keyCodeQt(), shortcutDefault(), and StdAccel.

bool KStdAccel::isEqual const QKeyEvent   pEvent,
int    keyQt
 

Deprecated:
. Use KKey(const QKeyEvent*) == 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 QKeyEvent, 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

Definition at line 365 of file kstdaccel.cpp.

QString 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 KShortcut& insert  
 

Toggle insert/overwrite (with visual feedback, e.g.

in the statusbar). Default: Insert

Returns:
the shortcut of the standard accelerator


Variable Documentation

const KShortcut & KStdAccel::whatsThis StdAccel   
 

What's This button.

Default: Shift+F1

Returns:
the shortcut of the standard accelerator

KDE Logo
This file is part of the documentation for kdecore Library Version 3.2.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Thu Apr 22 14:23:10 2004 by doxygen 1.2.18 written by Dimitri van Heesch, © 1997-2003