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     // Full screen mode since 3.2
00069     FullScreen
00070 
00071 #ifndef KDE_NO_COMPAT
00072     , WhatThis = WhatsThis
00073 #endif
00074   };
00075 
00080   const KShortcut& shortcut(StdAccel id);
00081 
00087   QString name(StdAccel id);
00088 
00094   QString label(StdAccel id);
00095 
00101   QString whatsThis(StdAccel id);
00102 
00111   StdAccel findStdAccel( const KKeySequence &keySeq );
00112 
00119   KShortcut shortcutDefault(StdAccel id);
00126   KShortcut shortcutDefault3(StdAccel id);
00133   KShortcut shortcutDefault4(StdAccel id);
00134 
00139   const KShortcut& open();
00140 
00145   const KShortcut& openNew();
00146 
00151   const KShortcut& close();
00152 
00157   const KShortcut& save();
00158 
00163   const KShortcut& print();
00164 
00169   const KShortcut& quit();
00170 
00175   const KShortcut& undo();
00176 
00181   const KShortcut& redo();
00182 
00187   const KShortcut& cut();
00188 
00193   const KShortcut& copy();
00194 
00199   const KShortcut& paste();
00200 
00205   const KShortcut& selectAll();
00206 
00211   const KShortcut& deleteWordBack();
00212 
00217   const KShortcut& deleteWordForward();
00218 
00223   const KShortcut& find();
00224 
00229   const KShortcut& findNext();
00230 
00235   const KShortcut& findPrev();
00236 
00241   const KShortcut& replace();
00242 
00247   const KShortcut& zoomIn();
00248 
00253   const KShortcut& zoomOut();
00254 
00259   const KShortcut& insert();
00260 
00265   const KShortcut& home();
00266 
00271   const KShortcut& end();
00272 
00277   const KShortcut& prior();
00278 
00283   const KShortcut& next();
00284 
00289   const KShortcut& gotoLine();
00290 
00295   const KShortcut& addBookmark();
00296 
00302   const KShortcut& tabNext();
00303 
00309   const KShortcut& tabPrev();
00310 
00316   const KShortcut& fullScreen();
00317 
00322   const KShortcut& help();
00323 
00328   const KShortcut& completion();
00329 
00335   const KShortcut& prevCompletion();
00336 
00342   const KShortcut& nextCompletion();
00343 
00349   const KShortcut& substringCompletion();
00350 
00355   const KShortcut& rotateUp();
00356 
00361   const KShortcut& rotateDown();
00362 
00367   const KShortcut& popupMenuContext();
00368 
00373   const KShortcut& whatsThis();
00374 
00379   const KShortcut& reload();
00380 
00385   const KShortcut& up();
00386 
00391   const KShortcut& back();
00392 
00397   const KShortcut& forward();
00398 
00403   const KShortcut& showMenubar();
00404 
00405 #if !defined(KDE_NO_COMPAT) && !defined(__KSTDACCEL_CPP_)
00406 
00410   QString action(StdAccel id) KDE_DEPRECATED;
00415   QString description(StdAccel id) KDE_DEPRECATED;
00420   int key(StdAccel) KDE_DEPRECATED;
00425   int defaultKey(StdAccel accel) KDE_DEPRECATED;
00426 
00442   bool isEqual(const QKeyEvent* pEvent, int keyQt) KDE_DEPRECATED;
00443 #endif // !KDE_NO_COMPAT
00444 
00445 }
00446 
00447 #endif
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 Wed May 5 07:15:45 2004 by doxygen 1.3.6 written by Dimitri van Heesch, © 1997-2003