• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KStandardShortcut Namespace Reference

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

Enumerations

enum  StandardShortcut {
  AccelNone = 0, Open, New, Close,
  Save, Print, Quit, Undo,
  Redo, Cut, Copy, Paste,
  PasteSelection, SelectAll, Deselect, DeleteWordBack,
  DeleteWordForward, Find, FindNext, FindPrev,
  Replace, Home, Begin, End,
  Prior, Next, Up, Back,
  Forward, Reload, BeginningOfLine, EndOfLine,
  GotoLine, BackwardWord, ForwardWord, AddBookmark,
  ZoomIn, ZoomOut, FullScreen, ShowMenubar,
  TabNext, TabPrev, Help, WhatsThis,
  TextCompletion, PrevCompletion, NextCompletion, SubstringCompletion,
  RotateUp, RotateDown, OpenRecent, SaveAs,
  Revert, PrintPreview, Mail, Clear,
  ActualSize, FitToPage, FitToWidth, FitToHeight,
  Zoom, Goto, GotoPage, DocumentBack,
  DocumentForward, EditBookmarks, Spelling, ShowToolbar,
  ShowStatusbar, SaveOptions, KeyBindings, Preferences,
  ConfigureToolbars, ConfigureNotifications, TipofDay, ReportBug,
  SwitchApplicationLanguage, AboutApp, AboutKDE, StandardShortcutCount
}

Functions

const KShortcut & addBookmark ()
const KShortcut & back ()
const KShortcut & backwardWord ()
const KShortcut & begin ()
const KShortcut & beginningOfLine ()
const KShortcut & close ()
const KShortcut & completion ()
const KShortcut & copy ()
const KShortcut & cut ()
const KShortcut & deleteWordBack ()
const KShortcut & deleteWordForward ()
const KShortcut & end ()
const KShortcut & endOfLine ()
const KShortcut & find ()
StandardShortcut find (const char *keyName)
StandardShortcut find (const QKeySequence &keySeq)
const KShortcut & findNext ()
const KShortcut & findPrev ()
const KShortcut & forward ()
const KShortcut & forwardWord ()
const KShortcut & fullScreen ()
const KShortcut & gotoLine ()
static KStandardShortcutInfo * guardedStandardShortcutInfo (StandardShortcut id)
KShortcut hardcodedDefaultShortcut (StandardShortcut id)
const KShortcut & help ()
const KShortcut & home ()
static void initialize (StandardShortcut id)
const KShortcut & insert ()
QString label (StandardShortcut id)
QString name (StandardShortcut id)
const KShortcut & next ()
const KShortcut & nextCompletion ()
const KShortcut & open ()
const KShortcut & openNew ()
const KShortcut & paste ()
const KShortcut & pasteSelection ()
const KShortcut & prevCompletion ()
const KShortcut & print ()
const KShortcut & prior ()
const KShortcut & quit ()
const KShortcut & redo ()
const KShortcut & reload ()
const KShortcut & replace ()
const KShortcut & rotateDown ()
const KShortcut & rotateUp ()
const KShortcut & save ()
void saveShortcut (StandardShortcut id, const KShortcut &newShortcut)
const KShortcut & selectAll ()
const KShortcut & shortcut (StandardShortcut id)
const KShortcut & showMenubar ()
const KShortcut & substringCompletion ()
const KShortcut & tabNext ()
const KShortcut & tabPrev ()
const KShortcut & undo ()
const KShortcut & up ()
QString whatsThis (StandardShortcut id)
const KShortcut & whatsThis ()
const KShortcut & zoomIn ()
const KShortcut & zoomOut ()

Variables

static KStandardShortcutInfo g_infoStandardShortcut []
QString whatsThis (StandardShortcut)

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

enum KStandardShortcut::StandardShortcut

Defines the identifier of all standard accelerators.

Enumerator:
AccelNone 
Open 
New 
Close 
Save 
Print 
Quit 
Undo 
Redo 
Cut 
Copy 
Paste 
PasteSelection 
SelectAll 
Deselect 
DeleteWordBack 
DeleteWordForward 
Find 
FindNext 
FindPrev 
Replace 
Home 
Begin 
End 
Prior 
Next 
Up 
Back 
Forward 
Reload 
BeginningOfLine 
EndOfLine 
GotoLine 
BackwardWord 
ForwardWord 
AddBookmark 
ZoomIn 
ZoomOut 
FullScreen 
ShowMenubar 
TabNext 
TabPrev 
Help 
WhatsThis 
TextCompletion 
PrevCompletion 
NextCompletion 
SubstringCompletion 
RotateUp 
RotateDown 
OpenRecent 
SaveAs 
Revert 
PrintPreview 
Mail 
Clear 
ActualSize 
FitToPage 
FitToWidth 
FitToHeight 
Zoom 
Goto 
GotoPage 
DocumentBack 
DocumentForward 
EditBookmarks 
Spelling 
ShowToolbar 
ShowStatusbar 
SaveOptions 
KeyBindings 
Preferences 
ConfigureToolbars 
ConfigureNotifications 
TipofDay 
ReportBug 
SwitchApplicationLanguage 
AboutApp 
AboutKDE 
StandardShortcutCount 

Definition at line 55 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
const KShortcut & KStandardShortcut::back (  ) 

Back.

Default: Alt+Left

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::backwardWord (  ) 

BackwardWord.

Default: Ctrl+Left

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::begin (  ) 

Goto beginning of the document.

Default: Ctrl-Home

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::beginningOfLine (  ) 

Goto beginning of current line.

Default: Home

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::close (  ) 

Close current document.

Default: Ctrl-w

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::completion (  ) 

Complete text in input widgets.

Default Ctrl+E

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::copy (  ) 

Copy selected area into the clipboard.

Default: Ctrl-c

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::cut (  ) 

Cut selected area and store it in the clipboard.

Default: Ctrl-x

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::deleteWordBack (  ) 

Delete a word back from mouse/cursor position.

Default: Ctrl-Backspace

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::deleteWordForward (  ) 

Delete a word forward from mouse/cursor position.

Default: Ctrl-Delete

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::end (  ) 

Goto end of the document.

Default: Ctrl-End

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::endOfLine (  ) 

Goto end of current line.

Default: End

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::find (  ) 

Find, search.

Default: Ctrl-f

Returns:
the shortcut of the standard accelerator
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
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
const KShortcut & KStandardShortcut::findNext (  ) 

Find/search next.

Default: F3

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::findPrev (  ) 

Find/search previous.

Default: Shift-F3

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::forward (  ) 

Forward.

Default: ALT+Right

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::forwardWord (  ) 

ForwardWord.

Default: Ctrl+Right

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::fullScreen (  ) 

Full Screen Mode.

Default: Ctrl+Shift+F

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::gotoLine (  ) 

Go to line.

Default: Ctrl+G

Returns:
the shortcut of the standard accelerator
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 188 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
const KShortcut & KStandardShortcut::help (  ) 

Help the user in the current situation.

Default: F1

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::home (  ) 

Goto home page.

Default: Alt-Home

Returns:
the shortcut of the standard accelerator
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 203 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
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
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
const KShortcut & KStandardShortcut::next (  ) 

Scroll down one page.

Default: Next

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::nextCompletion (  ) 

Iterate through a list when completion returns multiple items.

Default: Ctrl+Down

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::open (  ) 

Open file.

Default: Ctrl-o

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::openNew (  ) 

Create a new document (or whatever).

Default: Ctrl-n

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::paste (  ) 

Paste contents of clipboard at mouse/cursor position.

Default: Ctrl-v

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::pasteSelection (  ) 

Paste the selection at mouse/cursor position.

Default: Ctrl-Shift-Insert

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::prevCompletion (  ) 

Iterate through a list when completion returns multiple items.

Default: Ctrl+Up

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::print (  ) 

Print current document.

Default: Ctrl-p

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::prior (  ) 

Scroll up one page.

Default: Prior

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::quit (  ) 

Quit the program.

Default: Ctrl-q

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::redo (  ) 

Redo.

Default: Shift-Ctrl-z

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::reload (  ) 

Reload.

Default: F5

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::replace (  ) 

Find and replace matches.

Default: Ctrl-r

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::rotateDown (  ) 

Help users iterate through a list of entries.

Default: Down

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::rotateUp (  ) 

Help users iterate through a list of entries.

Default: Up

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::save (  ) 

Save current document.

Default: Ctrl-s

Returns:
the shortcut of the standard accelerator
void KStandardShortcut::saveShortcut ( StandardShortcut  id,
const KShortcut &  newShortcut 
)

Saves the new shortcut cut for standard accel id.

const KShortcut & KStandardShortcut::selectAll (  ) 

Select all.

Default: Ctrl-A

Returns:
the shortcut of the standard accelerator
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
const KShortcut & KStandardShortcut::showMenubar (  ) 

Show Menu Bar.

Default: Ctrl-M

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::substringCompletion (  ) 

Find a string within another string or list of strings.

Default: Ctrl-T

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::tabNext (  ) 

Next Tab.

Default: Ctrl-<

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::tabPrev (  ) 

Previous Tab.

Default: Ctrl->

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::undo (  ) 

Undo last operation.

Default: Ctrl-z

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::up (  ) 

Up.

Default: Alt+Up

Returns:
the shortcut of the standard accelerator
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
const KShortcut & KStandardShortcut::zoomIn (  ) 

Zoom in.

Default: Ctrl-Plus

Returns:
the shortcut of the standard accelerator
const KShortcut & KStandardShortcut::zoomOut (  ) 

Zoom out.

Default: Ctrl-Minus

Returns:
the shortcut of the standard accelerator

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 81 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 275 of file kstandardshortcut.cpp.

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal