Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KStdAccel Namespace Reference


Compounds

class  ShortcutList

Enumerations

enum  StdAccel

Functions

const KShortcut & shortcut (StdAccel id)
QString name (StdAccel id)
QString label (StdAccel id)
QString whatsThis (StdAccel id)
StdAccel findStdAccel (const KKeySequence &keySeq)
KShortcut shortcutDefault (StdAccel id)
KShortcut shortcutDefault3 (StdAccel id)
KShortcut shortcutDefault4 (StdAccel id)
const KShortcut & open ()
const KShortcut & openNew ()
const KShortcut & close ()
const KShortcut & save ()
const KShortcut & print ()
const KShortcut & quit ()
const KShortcut & undo ()
const KShortcut & redo ()
const KShortcut & cut ()
const KShortcut & copy ()
const KShortcut & paste ()
const KShortcut & selectAll ()
const KShortcut & deleteWordBack ()
const KShortcut & deleteWordForward ()
const KShortcut & find ()
const KShortcut & findNext ()
const KShortcut & findPrev ()
const KShortcut & replace ()
const KShortcut & zoomIn ()
const KShortcut & zoomOut ()
const KShortcut & insert ()
const KShortcut & home ()
const KShortcut & end ()
const KShortcut & prior ()
const KShortcut & next ()
const KShortcut & gotoLine ()
const KShortcut & addBookmark ()
const KShortcut & help ()
const KShortcut & completion ()
const KShortcut & prevCompletion ()
const KShortcut & nextCompletion ()
const KShortcut & substringCompletion ()
const KShortcut & rotateUp ()
const KShortcut & rotateDown ()
const KShortcut & popupMenuContext ()
const KShortcut & whatsThis ()
const KShortcut & reload ()
const KShortcut & up ()
const KShortcut & back ()
const KShortcut & forward ()
const KShortcut & showMenubar ()
QString action (StdAccel id)
QString description (StdAccel id)
int key (StdAccel)
int defaultKey (StdAccel accel)
bool isEqual (const QKeyEvent *pEvent, int keyQt)


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 45 of file kstdaccel.h.


Function Documentation

QString action (  StdAccel    id ) 
 

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

const KShortcut& addBookmark (    ) 
 

Add current page to bookmarks. Default: Ctrl+B

Returns:
the shortcut of the standard accelerator

const KShortcut& back (    ) 
 

Back. Default: Alt+Left

Returns:
the shortcut of the standard accelerator

const KShortcut& close (    ) 
 

Close current document. Default: Ctrl-w

Returns:
the shortcut of the standard accelerator

const KShortcut& completion (    ) 
 

Complete text in input widgets. Default Ctrl+E

Returns:
the shortcut of the standard accelerator

const KShortcut& copy (    ) 
 

Copy selected area into the clipboard. Default: Ctrl-c

Returns:
the shortcut of the standard accelerator

const KShortcut& cut (    ) 
 

Cut selected area and store it in the clipboard. Default: Ctrl-x

Returns:
the shortcut of the standard accelerator

int defaultKey (  StdAccel    accel ) 
 

Deprecated:
Obsolete. Use shortcutDefault().

const KShortcut& deleteWordBack (    ) 
 

Delete a word back from mouse/cursor position. Default: Ctrl-Backspace

Returns:
the shortcut of the standard accelerator

const KShortcut& deleteWordForward (    ) 
 

Delete a word forward from mouse/cursor position. Default: Ctrl-Delete

Returns:
the shortcut of the standard accelerator

QString description (  StdAccel    id ) 
 

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

const KShortcut& end (    ) 
 

Goto end of current line. Default: End

Returns:
the shortcut of the standard accelerator

Referenced by KLineEdit::cursorAtEnd(), KAccelGen::generate(), KAccelGen::generateFromKeys(), and KAccelGen::loadPredefined().

const KShortcut& find (    ) 
 

Find, search. Default: Ctrl-f

Returns:
the shortcut of the standard accelerator

const KShortcut& findNext (    ) 
 

Find/search next. Default: F3

Returns:
the shortcut of the standard accelerator

const KShortcut& findPrev (    ) 
 

Find/search previous. Default: Shift-F3

Returns:
the shortcut of the standard accelerator

StdAccel 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 KShortcut& forward (    ) 
 

Forward. Default: ALT+Right

Returns:
the shortcut of the standard accelerator

const KShortcut& gotoLine (    ) 
 

Go to line. Default: Ctrl+G

Returns:
the shortcut of the standard accelerator

const KShortcut& help (    ) 
 

Help the user in the current situation. Default: F1

Returns:
the shortcut of the standard accelerator

const KShortcut& home (    ) 
 

Goto beginning of current line. Default: Home

Returns:
the shortcut of the standard accelerator

const KShortcut& insert (    ) 
 

Toggle insert/overwrite (with visual feedback, e.g. in the statusbar). Default: Insert

Returns:
the shortcut of the standard accelerator

bool 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

int key (  StdAccel    ) 
 

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

Referenced by KFileMetaInfoGroup::operator[](), and KFileMetaInfoGroup::value().

QString 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

Referenced by KDockWidget::setTabPageLabel().

QString 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 KShortcut& next (    ) 
 

Scroll down one page. Default: Next

Returns:
the shortcut of the standard accelerator

const KShortcut& nextCompletion (    ) 
 

Iterate through a list when completion returns mutiple items. Default: Ctrl+Down

Returns:
the shortcut of the standard accelerator

const KShortcut& open (    ) 
 

Open file. Default: Ctrl-o

Returns:
the shortcut of the standard accelerator

const KShortcut& openNew (    ) 
 

Create a new document (or whatever). Default: Ctrl-n

Returns:
the shortcut of the standard accelerator

const KShortcut& paste (    ) 
 

Paste contents of clipboard at mouse/cursor position. Default: Ctrl-v

Returns:
the shortcut of the standard accelerator

const KShortcut& popupMenuContext (    ) 
 

popup a context menu. Default: Menu

Returns:
the shortcut of the standard accelerator

const KShortcut& prevCompletion (    ) 
 

Iterate through a list when completion returns mutiple items. Default: Ctrl+Up

Returns:
the shortcut of the standard accelerator

const KShortcut& print (    ) 
 

Print current document. Default: Ctrl-p

Returns:
the shortcut of the standard accelerator

const KShortcut& prior (    ) 
 

Scroll up one page. Default: Prior

Returns:
the shortcut of the standard accelerator

const KShortcut& quit (    ) 
 

Quit the program. Default: Ctrl-q

Returns:
the shortcut of the standard accelerator

const KShortcut& redo (    ) 
 

Redo. Default: Shift-Ctrl-z

Returns:
the shortcut of the standard accelerator

const KShortcut& reload (    ) 
 

Reload. Default: F5

Returns:
the shortcut of the standard accelerator

const KShortcut& replace (    ) 
 

Find and replace matches. Default: Ctrl-r

Returns:
the shortcut of the standard accelerator

const KShortcut& rotateDown (    ) 
 

Help users iterate through a list of entries. Default: Down

Returns:
the shortcut of the standard accelerator

const KShortcut& rotateUp (    ) 
 

Help users iterate through a list of entries. Default: Up

Returns:
the shortcut of the standard accelerator

const KShortcut& save (    ) 
 

Save current document. Default: Ctrl-s

Returns:
the shortcut of the standard accelerator

const KShortcut& selectAll (    ) 
 

Reload. Default: Ctrl-A

Returns:
the shortcut of the standard accelerator

const KShortcut& shortcut (  StdAccel    id ) 
 

Returns the keybinding for accel.

Parameters:
id  the id of the accelerator

KShortcut 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

KShortcut 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

KShortcut 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 KShortcut& showMenubar (    ) 
 

Show Menu Bar. Default: Ctrl-M

Returns:
the shortcut of the standard accelerator

const KShortcut& substringCompletion (    ) 
 

Find a string within another string or list of strings. Default: Ctrl-T

Returns:
the shortcut of the standard accelerator

const KShortcut& undo (    ) 
 

Undo last operation. Default: Ctrl-z

Returns:
the shortcut of the standard accelerator

const KShortcut& up (    ) 
 

Up. Default: Alt+Up

Returns:
the shortcut of the standard accelerator

const KShortcut& whatsThis (    ) 
 

What's This button. Default: Shift+F1

Returns:
the shortcut of the standard accelerator

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& zoomIn (    ) 
 

Zoom in. Default: Ctrl-Plus

Returns:
the shortcut of the standard accelerator

const KShortcut& zoomOut (    ) 
 

Zoom out. Default: Ctrl-Minus

Returns:
the shortcut of the standard accelerator


Generated on Wed Aug 13 23:30:37 2003 for kdelibs by doxygen1.2.18