kdecore Library API Documentation

kstdaccel.h

00001 /* This file is part of the KDE libraries
00002     Copyright (C) 1997 Stefan Taferner (taferner@kde.org)
00003     Copyright (C) 2000 Nicolas Hadacek (hadacek@kde.org)
00004     Copyright (C) 2001,2002 Ellis Whitehead (ellis@kde.org)
00005 
00006     This library is free software; you can redistribute it and/or
00007     modify it under the terms of the GNU Library General Public
00008     License version 2 as published by the Free Software Foundation.
00009 
00010     This library is distributed in the hope that it will be useful,
00011     but WITHOUT ANY WARRANTY; without even the implied warranty of
00012     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00013     Library General Public License for more details.
00014 
00015     You should have received a copy of the GNU Library General Public License
00016     along with this library; see the file COPYING.LIB.  If not, write to
00017     the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00018     Boston, MA 02111-1307, USA.
00019 */
00020 #ifndef KSTDACCEL_H
00021 #define KSTDACCEL_H
00022 
00023 #include <qstring.h>
00024 #include <kshortcut.h>
00025 #include "kdemacros.h"
00026 
00027 class QKeyEvent;
00028 class KAccelActions;
00029 
00041 namespace KStdAccel
00042 {
00043   // Always add new std-accels to the end of this enum, never in the middle!
00047   enum StdAccel {
00048     AccelNone,
00049     // File menu
00050     Open, New, Close, Save,
00051     // The Print item
00052     Print,
00053     Quit,
00054     // Edit menu
00055     Undo, Redo, Cut, Copy, Paste, SelectAll, Deselect, DeleteWordBack,
00056     DeleteWordForward, Find, FindNext, FindPrev, Replace,
00057     // Navigation
00058     Home, End, Prior, Next, GotoLine, AddBookmark, ZoomIn, ZoomOut,
00059     Up, Back, Forward, Reload, PopupMenuContext, ShowMenubar,
00060     // Help menu
00061     Help, WhatsThis,
00062     // Text completion
00063     TextCompletion, PrevCompletion, NextCompletion, SubstringCompletion,
00064     RotateUp, RotateDown,
00065 
00066     // Tabular navigation since 3.2
00067     TabNext, TabPrev,
00068 
00069     // Full screen mode since 3.2
00070     FullScreen,
00071 
00072     // Text Navigation since 3.3
00073     BackwardWord, ForwardWord, BeginningOfLine, EndOfLine
00074 
00075 #ifndef KDE_NO_COMPAT
00076     , WhatThis = WhatsThis
00077 #endif
00078   };
00079 
00084   const KShortcut& shortcut(StdAccel id);
00085 
00091   QString name(StdAccel id);
00092 
00098   QString label(StdAccel id);
00099 
00105   QString whatsThis(StdAccel id);
00106 
00115   StdAccel findStdAccel( const KKeySequence &keySeq );
00116 
00123   KShortcut shortcutDefault(StdAccel id);
00130   KShortcut shortcutDefault3(StdAccel id);
00137   KShortcut shortcutDefault4(StdAccel id);
00138 
00143   const KShortcut& open();
00144 
00149   const KShortcut& openNew();
00150 
00155   const KShortcut& close();
00156 
00161   const KShortcut& save();
00162 
00167   const KShortcut& print();
00168 
00173   const KShortcut& quit();
00174 
00179   const KShortcut& undo();
00180 
00185   const KShortcut& redo();
00186 
00191   const KShortcut& cut();
00192 
00197   const KShortcut& copy();
00198 
00203   const KShortcut& paste();
00204 
00209   const KShortcut& selectAll();
00210 
00215   const KShortcut& deleteWordBack();
00216 
00221   const KShortcut& deleteWordForward();
00222 
00227   const KShortcut& find();
00228 
00233   const KShortcut& findNext();
00234 
00239   const KShortcut& findPrev();
00240 
00245   const KShortcut& replace();
00246 
00251   const KShortcut& zoomIn();
00252 
00257   const KShortcut& zoomOut();
00258 
00263   const KShortcut& insert();
00264 
00269   const KShortcut& home();
00270 
00275   const KShortcut& end();
00276 
00282   const KShortcut& beginningOfLine();
00283 
00289   const KShortcut& endOfLine();
00290 
00295   const KShortcut& prior();
00296 
00301   const KShortcut& next();
00302 
00307   const KShortcut& gotoLine();
00308 
00313   const KShortcut& addBookmark();
00314 
00320   const KShortcut& tabNext();
00321 
00327   const KShortcut& tabPrev();
00328 
00334   const KShortcut& fullScreen();
00335 
00340   const KShortcut& help();
00341 
00346   const KShortcut& completion();
00347 
00353   const KShortcut& prevCompletion();
00354 
00360   const KShortcut& nextCompletion();
00361 
00367   const KShortcut& substringCompletion();
00368 
00373   const KShortcut& rotateUp();
00374 
00379   const KShortcut& rotateDown();
00380 
00385   const KShortcut& popupMenuContext();
00386 
00391   const KShortcut& whatsThis();
00392 
00397   const KShortcut& reload();
00398 
00403   const KShortcut& up();
00404 
00409   const KShortcut& back();
00410 
00415   const KShortcut& forward();
00416 
00422   const KShortcut& backwardWord();
00423 
00429   const KShortcut& forwardWord();
00430 
00435   const KShortcut& showMenubar();
00436 
00437 #if !defined(KDE_NO_COMPAT) && !defined(__KSTDACCEL_CPP_)
00438 
00442   QString action(StdAccel id) KDE_DEPRECATED;
00447   QString description(StdAccel id) KDE_DEPRECATED;
00452   int key(StdAccel) KDE_DEPRECATED;
00457   int defaultKey(StdAccel accel) KDE_DEPRECATED;
00458 
00474   bool isEqual(const QKeyEvent* pEvent, int keyQt) KDE_DEPRECATED;
00475 #endif // !KDE_NO_COMPAT
00476 
00477 }
00478 
00479 #endif
KDE Logo
This file is part of the documentation for kdecore Library Version 3.3.2.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Fri Jul 22 10:16:20 2005 by doxygen 1.3.6 written by Dimitri van Heesch, © 1997-2003