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 "kdelibs_export.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
00067     TabNext,           
00068     TabPrev,           
00069 
00070     // Full screen mode
00071     FullScreen,        
00072 
00073     // Text Navigation
00074     BackwardWord,      
00075     ForwardWord,       
00076     BeginningOfLine,   
00077     EndOfLine         
00078 
00079 
00080 #ifndef KDE_NO_COMPAT
00081     , WhatThis = WhatsThis
00082 #endif
00083   };
00084 
00089   KDECORE_EXPORT const KShortcut& shortcut(StdAccel id);
00090 
00096   KDECORE_EXPORT QString name(StdAccel id);
00097 
00103   KDECORE_EXPORT QString label(StdAccel id);
00104 
00110   KDECORE_EXPORT QString whatsThis(StdAccel id);
00111 
00120   KDECORE_EXPORT StdAccel findStdAccel( const KKeySequence &keySeq );
00121 
00128   KDECORE_EXPORT KShortcut shortcutDefault(StdAccel id);
00135   KDECORE_EXPORT KShortcut shortcutDefault3(StdAccel id);
00142   KDECORE_EXPORT KShortcut shortcutDefault4(StdAccel id);
00143 
00148   KDECORE_EXPORT const KShortcut& open();
00149 
00154   KDECORE_EXPORT const KShortcut& openNew();
00155 
00160   KDECORE_EXPORT const KShortcut& close();
00161 
00166   KDECORE_EXPORT const KShortcut& save();
00167 
00172   KDECORE_EXPORT const KShortcut& print();
00173 
00178   KDECORE_EXPORT const KShortcut& quit();
00179 
00184   KDECORE_EXPORT const KShortcut& undo();
00185 
00190   KDECORE_EXPORT const KShortcut& redo();
00191 
00196   KDECORE_EXPORT const KShortcut& cut();
00197 
00202   KDECORE_EXPORT const KShortcut& copy();
00203 
00208   KDECORE_EXPORT const KShortcut& paste();
00209 
00214   KDECORE_EXPORT const KShortcut& selectAll();
00215 
00220   KDECORE_EXPORT const KShortcut& deleteWordBack();
00221 
00226   KDECORE_EXPORT const KShortcut& deleteWordForward();
00227 
00232   KDECORE_EXPORT const KShortcut& find();
00233 
00238   KDECORE_EXPORT const KShortcut& findNext();
00239 
00244   KDECORE_EXPORT const KShortcut& findPrev();
00245 
00250   KDECORE_EXPORT const KShortcut& replace();
00251 
00256   KDECORE_EXPORT const KShortcut& zoomIn();
00257 
00262   KDECORE_EXPORT const KShortcut& zoomOut();
00263 
00268   KDECORE_EXPORT const KShortcut& insert();
00269 
00274   KDECORE_EXPORT const KShortcut& home();
00275 
00280   KDECORE_EXPORT const KShortcut& end();
00281 
00287   KDECORE_EXPORT const KShortcut& beginningOfLine();
00288 
00294   KDECORE_EXPORT const KShortcut& endOfLine();
00295 
00300   KDECORE_EXPORT const KShortcut& prior();
00301 
00306   KDECORE_EXPORT const KShortcut& next();
00307 
00312   KDECORE_EXPORT const KShortcut& gotoLine();
00313 
00318   KDECORE_EXPORT const KShortcut& addBookmark();
00319 
00325   KDECORE_EXPORT const KShortcut& tabNext();
00326 
00332   KDECORE_EXPORT const KShortcut& tabPrev();
00333 
00339   KDECORE_EXPORT const KShortcut& fullScreen();
00340 
00345   KDECORE_EXPORT const KShortcut& help();
00346 
00351   KDECORE_EXPORT const KShortcut& completion();
00352 
00358   KDECORE_EXPORT const KShortcut& prevCompletion();
00359 
00365   KDECORE_EXPORT const KShortcut& nextCompletion();
00366 
00372   KDECORE_EXPORT const KShortcut& substringCompletion();
00373 
00378   KDECORE_EXPORT const KShortcut& rotateUp();
00379 
00384   KDECORE_EXPORT const KShortcut& rotateDown();
00385 
00390   KDECORE_EXPORT const KShortcut& popupMenuContext();
00391 
00396   KDECORE_EXPORT const KShortcut& whatsThis();
00397 
00402   KDECORE_EXPORT const KShortcut& reload();
00403 
00408   KDECORE_EXPORT const KShortcut& up();
00409 
00414   KDECORE_EXPORT const KShortcut& back();
00415 
00420   KDECORE_EXPORT const KShortcut& forward();
00421 
00427   KDECORE_EXPORT const KShortcut& backwardWord();
00428 
00434   KDECORE_EXPORT const KShortcut& forwardWord();
00435 
00440   KDECORE_EXPORT const KShortcut& showMenubar();
00441 
00442 #if !defined(KDE_NO_COMPAT) && !defined(__KSTDACCEL_CPP_)
00443 
00447   KDECORE_EXPORT QString action(StdAccel id) KDE_DEPRECATED;
00452   KDECORE_EXPORT QString description(StdAccel id) KDE_DEPRECATED;
00457   KDECORE_EXPORT int key(StdAccel) KDE_DEPRECATED;
00462   KDECORE_EXPORT int defaultKey(StdAccel accel) KDE_DEPRECATED;
00463 
00479   KDECORE_EXPORT bool isEqual(const QKeyEvent* pEvent, int keyQt) KDE_DEPRECATED;
00480 #endif // !KDE_NO_COMPAT
00481 
00482 }
00483 
00484 #endif
KDE Logo
This file is part of the documentation for kdecore Library Version 3.3.90.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Wed Mar 30 10:09:41 2005 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003