KConfig

kstandardshortcut.h
1 /*
2  This file is part of the KDE libraries
3  SPDX-FileCopyrightText: 1997 Stefan Taferner <[email protected]>
4  SPDX-FileCopyrightText: 2000 Nicolas Hadacek <[email protected]>
5  SPDX-FileCopyrightText: 2001, 2002 Ellis Whitehead <[email protected]>
6 
7  SPDX-License-Identifier: LGPL-2.0-only
8 */
9 #ifndef KSTANDARDSHORTCUT_H
10 #define KSTANDARDSHORTCUT_H
11 
12 #include <QString>
13 #include <QKeySequence>
14 
15 #include <kconfiggui_export.h>
16 
24 namespace KStandardShortcut
25 {
26 // STUFF WILL BREAK IF YOU DON'T READ THIS!!!
27 /*
28  *Always add new std-accels to the end of this enum, never in the middle!
29  *Don't forget to add the corresponding entries in g_infoStandardShortcut[] in kstandardshortcut.cpp, too.
30  *Values of elements here and positions of the corresponding entries in
31  *the big array g_infoStandardShortcut[] ABSOLUTELY MUST BE THE SAME.
32  * !!! !!!! !!!!! !!!!
33  * !!!! !!! !!!! !!!!
34  * Remember to also update kdoctools/genshortcutents.cpp.
35  *
36  * Other Rules:
37  *
38  * - Never change the name of an existing shortcut
39  * - Never translate the name of a shortcut
40  */
41 
46  //C++ requires that the value of an enum symbol be one more than the previous one.
47  //This means that everything will be well-ordered from here on.
48  AccelNone = 0,
49  // File menu
50  Open,
51  New,
53  Save,
54  // The Print item
56  Quit,
57  // Edit menu
58  Undo,
59  Redo,
60  Cut,
61  Copy,
68  Find,
72  // Navigation
73  Home,
75  End,
77  Next,
78  Up,
79  Back,
82  // Text Navigation
88  // View parameters
94  // Tabular navigation
97  // Help menu
98  Help,
100  // Text completion
126 #if KCONFIGGUI_ENABLE_DEPRECATED_SINCE(5, 39)
128 #else
129  SaveOptions_DEPRECATED_DO_NOT_USE,
130 #endif
145  // Insert new items here!
146 
147  StandardShortcutCount // number of standard shortcuts
148 };
149 
156 KCONFIGGUI_EXPORT const QList<QKeySequence> &shortcut(StandardShortcut id);
157 
163 KCONFIGGUI_EXPORT QString name(StandardShortcut id);
164 
170 KCONFIGGUI_EXPORT QString label(StandardShortcut id);
171 
177 KCONFIGGUI_EXPORT QString whatsThis(StandardShortcut id);
178 
187 KCONFIGGUI_EXPORT StandardShortcut find(const QKeySequence &keySeq);
188 
189 #if KCONFIGGUI_ENABLE_DEPRECATED_SINCE(5, 71)
190 
199 KCONFIGGUI_DEPRECATED_VERSION(5, 71, "Use findByName(const QString &name) instead")
200 KCONFIGGUI_EXPORT StandardShortcut find(const char *keyName);
201 #endif
202 
211 KCONFIGGUI_EXPORT StandardShortcut findByName(const QString &name);
212 
220 
224 KCONFIGGUI_EXPORT void saveShortcut(StandardShortcut id, const QList<QKeySequence> &newShortcut);
225 
230 KCONFIGGUI_EXPORT const QList<QKeySequence> &open();
231 
236 KCONFIGGUI_EXPORT const QList<QKeySequence> &openNew();
237 
242 KCONFIGGUI_EXPORT const QList<QKeySequence> &close();
243 
248 KCONFIGGUI_EXPORT const QList<QKeySequence> &save();
249 
254 KCONFIGGUI_EXPORT const QList<QKeySequence> &print();
255 
260 KCONFIGGUI_EXPORT const QList<QKeySequence> &quit();
261 
266 KCONFIGGUI_EXPORT const QList<QKeySequence> &undo();
267 
272 KCONFIGGUI_EXPORT const QList<QKeySequence> &redo();
273 
278 KCONFIGGUI_EXPORT const QList<QKeySequence> &cut();
279 
284 KCONFIGGUI_EXPORT const QList<QKeySequence> &copy();
285 
290 KCONFIGGUI_EXPORT const QList<QKeySequence> &paste();
291 
296 KCONFIGGUI_EXPORT const QList<QKeySequence> &pasteSelection();
297 
302 KCONFIGGUI_EXPORT const QList<QKeySequence> &selectAll();
303 
308 KCONFIGGUI_EXPORT const QList<QKeySequence> &deleteWordBack();
309 
314 KCONFIGGUI_EXPORT const QList<QKeySequence> &deleteWordForward();
315 
320 KCONFIGGUI_EXPORT const QList<QKeySequence> &find();
321 
326 KCONFIGGUI_EXPORT const QList<QKeySequence> &findNext();
327 
332 KCONFIGGUI_EXPORT const QList<QKeySequence> &findPrev();
333 
338 KCONFIGGUI_EXPORT const QList<QKeySequence> &replace();
339 
344 KCONFIGGUI_EXPORT const QList<QKeySequence> &zoomIn();
345 
350 KCONFIGGUI_EXPORT const QList<QKeySequence> &zoomOut();
351 
356 KCONFIGGUI_EXPORT const QList<QKeySequence> &home();
357 
362 KCONFIGGUI_EXPORT const QList<QKeySequence> &begin();
363 
368 KCONFIGGUI_EXPORT const QList<QKeySequence> &end();
369 
374 KCONFIGGUI_EXPORT const QList<QKeySequence> &beginningOfLine();
375 
380 KCONFIGGUI_EXPORT const QList<QKeySequence> &endOfLine();
381 
386 KCONFIGGUI_EXPORT const QList<QKeySequence> &prior();
387 
392 KCONFIGGUI_EXPORT const QList<QKeySequence> &next();
393 
398 KCONFIGGUI_EXPORT const QList<QKeySequence> &gotoLine();
399 
404 KCONFIGGUI_EXPORT const QList<QKeySequence> &addBookmark();
405 
410 KCONFIGGUI_EXPORT const QList<QKeySequence> &tabNext();
411 
416 KCONFIGGUI_EXPORT const QList<QKeySequence> &tabPrev();
417 
422 KCONFIGGUI_EXPORT const QList<QKeySequence> &fullScreen();
423 
428 KCONFIGGUI_EXPORT const QList<QKeySequence> &help();
429 
434 KCONFIGGUI_EXPORT const QList<QKeySequence> &completion();
435 
441 KCONFIGGUI_EXPORT const QList<QKeySequence> &prevCompletion();
442 
448 KCONFIGGUI_EXPORT const QList<QKeySequence> &nextCompletion();
449 
455 KCONFIGGUI_EXPORT const QList<QKeySequence> &substringCompletion();
456 
461 KCONFIGGUI_EXPORT const QList<QKeySequence> &rotateUp();
462 
467 KCONFIGGUI_EXPORT const QList<QKeySequence> &rotateDown();
468 
473 KCONFIGGUI_EXPORT const QList<QKeySequence> &whatsThis();
474 
479 KCONFIGGUI_EXPORT const QList<QKeySequence> &reload();
480 
485 KCONFIGGUI_EXPORT const QList<QKeySequence> &up();
486 
491 KCONFIGGUI_EXPORT const QList<QKeySequence> &back();
492 
497 KCONFIGGUI_EXPORT const QList<QKeySequence> &forward();
498 
503 KCONFIGGUI_EXPORT const QList<QKeySequence> &backwardWord();
504 
509 KCONFIGGUI_EXPORT const QList<QKeySequence> &forwardWord();
510 
515 KCONFIGGUI_EXPORT const QList<QKeySequence> &showMenubar();
516 
522 KCONFIGGUI_EXPORT const QList<QKeySequence> &deleteFile();
523 
529 KCONFIGGUI_EXPORT const QList<QKeySequence> &renameFile();
530 
536 KCONFIGGUI_EXPORT const QList<QKeySequence> &moveToTrash();
537 
543 KCONFIGGUI_EXPORT const QList<QKeySequence> &preferences();
544 
550 KCONFIGGUI_EXPORT const QList<QKeySequence> &showHideHiddenFiles();
551 
552 }
553 
554 #endif // KSTANDARDSHORTCUT_H
Open donation page on kde.org.
View the document at its actual size.
Fit the document view to the height of the current window.
const QList< QKeySequence > & redo()
Redo last operation.
const QList< QKeySequence > & rotateDown()
Help users iterate through a list of entries.
const QList< QKeySequence > & deleteWordBack()
Delete a word back from mouse/cursor position.
Initiate a &#39;find&#39; request in the current document.
Close current document.
void saveShortcut(StandardShortcut id, const QList< QKeySequence > &newShortcut)
Saves the new shortcut cut for standard accel id.
const QList< QKeySequence > & open()
Open file.
const QList< QKeySequence > & showMenubar()
Show Menu Bar.
const QList< QKeySequence > & moveToTrash()
Moves files or folders to the trash.
const QList< QKeySequence > & next()
Scroll down one page.
Find a string within another string or list of strings.
const QList< QKeySequence > & prevCompletion()
Iterate through a list when completion returns multiple items.
Scroll up one page.
Show/Hide the statusbar.
Pop up the spell checker.
Go to beginning of current line.
Cut selected area and store it in the clipboard.
const QList< QKeySequence > & findPrev()
Find a previous instance of a stored &#39;find&#39;.
StandardShortcut findByName(const QString &name)
Return the StandardShortcut id of the standard accelerator action which has name as its name...
const QList< QKeySequence > & completion()
Complete text in input widgets.
Paste contents of clipboard at mouse/cursor position.
Help the user in the current situation.
Save the current document under a different name.
Find and replace matches.
StandardShortcut find(const QKeySequence &seq)
Return the StandardShortcut id of the standard accel action which uses this key sequence, or AccelNone if none of them do.
Paste the selection at mouse/cursor position.
const QList< QKeySequence > & preferences()
Opens the app&#39;s settings window.
const QList< QKeySequence > & close()
Close current document.
const QList< QKeySequence > & fullScreen()
Full Screen Mode.
const QList< QKeySequence > & cut()
Cut selected area and store it in the clipboard.
Scroll down one page.
QList< QKeySequence > hardcodedDefaultShortcut(StandardShortcut id)
Returns the hardcoded default shortcut for id.
const QList< QKeySequence > & begin()
Go to beginning of the document.
const QList< QKeySequence > & tabPrev()
Previous Tab.
const QList< QKeySequence > & renameFile()
Rename files or folders.
QString name(StandardShortcut id)
Returns a unique name for the given accel.
const QList< QKeySequence > & reload()
Reload.
const QList< QKeySequence > & prior()
Scroll up one page.
Display the Switch Application Language dialog.
Permanently delete files or folders.
const QList< QKeySequence > & deleteWordForward()
Delete a word forward from mouse/cursor position.
const QList< QKeySequence > & deleteFile()
Permanently delete files or folders.
QString whatsThis(StandardShortcut)
What&#39;s This button.
Delete a word back from mouse/cursor position.
const QList< QKeySequence > & beginningOfLine()
Go to beginning of current line.
Display the notifications configuration dialog.
const QList< QKeySequence > & undo()
Undo last operation.
const QList< QKeySequence > & forwardWord()
ForwardWord.
Go to end of the document.
const QList< QKeySequence > & findNext()
Find the next instance of a stored &#39;find&#39; Default: F3.
const QList< QKeySequence > & back()
Back.
const QList< QKeySequence > & help()
Help the user in the current situation.
const QList< QKeySequence > & copy()
Copy selected area into the clipboard.
Move files or folders to the trash.
Iterate through a list when completion returns multiple items.
const QList< QKeySequence > & nextCompletion()
Iterate through a list when completion returns multiple items.
Add current page to bookmarks.
StandardShortcut
Defines the identifier of all standard accelerators.
const QList< QKeySequence > & zoomOut()
Zoom out.
QString label(StandardShortcut id)
Returns a localized label for user-visible display.
const QList< QKeySequence > & substringCompletion()
Find a string within another string or list of strings.
Open a recently used document.
Copy selected area into the clipboard.
Display the Report Bug dialog.
Display the About KDE dialog.
const QList< QKeySequence > & save()
Save current document.
Edit the application bookmarks.
Go to beginning of the document.
const QList< QKeySequence > & pasteSelection()
Paste the selection at mouse/cursor position.
Jump to some specific location in the document.
Redo last operation.
const QList< QKeySequence > & print()
Print current document.
const QList< QKeySequence > & openNew()
Create a new document (or whatever).
Rename files or folders.
const QList< QKeySequence > & replace()
Find and replace matches.
const QList< QKeySequence > & forward()
Forward.
Fit the document view to the width of the current window.
Display the preferences/options dialog.
Clear the content of the focus widget.
const QList< QKeySequence > & addBookmark()
Add current page to bookmarks.
const QList< QKeySequence > & home()
Go to home page.
Send the current document by mail.
const QList< QKeySequence > & endOfLine()
Go to end of current line.
Find the next instance of a stored &#39;find&#39;.
Complete text in input widgets.
const QList< QKeySequence > & up()
Up.
const QList< QKeySequence > & showHideHiddenFiles()
Shows or hides hidden files.
Show a print preview of the current document.
const QList< QKeySequence > & end()
Go to end of the document.
const QList< QKeySequence > & tabNext()
Next Tab.
Display the "Tip of the Day".
Find a previous instance of a stored &#39;find&#39;.
const QList< QKeySequence > & backwardWord()
BackwardWord.
Move back (document style menu).
Display the configure key bindings dialog.
Iterate through a list when completion returns multiple items.
Display the application&#39;s About dialog.
Help users iterate through a list of entries.
Move forward (document style menu).
Select the current zoom level.
Quit the program.
Fit the document view to the size of the current window.
Deselect any selected elements.
Print current document.
const QList< QKeySequence > & shortcut(StandardShortcut id)
Returns the keybinding for accel.
Help users iterate through a list of entries.
Save current document.
Toggle showing or hiding hidden files.
const QList< QKeySequence > & paste()
Paste contents of clipboard at mouse/cursor position.
Convenient methods for access to the common accelerator keys in the key configuration.
Create a new document.
const QList< QKeySequence > & selectAll()
Select all.
Delete a word forward from mouse/cursor position.
const QList< QKeySequence > & rotateUp()
Help users iterate through a list of entries.
Go to a specific page.
What&#39;s This button.
Display the toolbar configuration dialog.
Undo last operation.
const QList< QKeySequence > & quit()
Quit the program.
const QList< QKeySequence > & zoomIn()
Zoom in.
Revert the current document to the last saved version.
const QList< QKeySequence > & gotoLine()
Go to line.
Go to end of current line.
This file is part of the KDE documentation.
Documentation copyright © 1996-2020 The KDE developers.
Generated on Sat Jul 11 2020 22:47:24 by doxygen 1.8.11 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.