kdeui Library API Documentation

kstdaction.h

00001 /* This file is part of the KDE libraries
00002    Copyright (C) 1999,2000 Kurt Granroth <granroth@kde.org>
00003    Copyright (C) 2001,2002 Ellis Whitehead <ellis@kde.org>
00004 
00005    This library is free software; you can redistribute it and/or
00006    modify it under the terms of the GNU Library General Public
00007    License version 2 as published by the Free Software Foundation.
00008 
00009    This library is distributed in the hope that it will be useful,
00010    but WITHOUT ANY WARRANTY; without even the implied warranty of
00011    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
00012    Library General Public License for more details.
00013 
00014    You should have received a copy of the GNU Library General Public License
00015    along with this library; see the file COPYING.LIB.  If not, write to
00016    the Free Software Foundation, Inc., 59 Temple Place - Suite 330,
00017    Boston, MA 02111-1307, USA.
00018 */
00019 #ifndef KSTDACTION_H
00020 #define KSTDACTION_H
00021 
00022 class QObject;
00023 class KAction;
00024 class KActionCollection;
00025 class KRecentFilesAction;
00026 class KToggleAction;
00027 class KToggleToolBarAction;
00028 
00029 #include <qstringlist.h>
00030 
00113 namespace KStdAction
00114 {
00118         enum StdAction {
00119                 ActionNone,
00120 
00121                 // File Menu
00122                 New, Open, OpenRecent, Save, SaveAs, Revert, Close,
00123                 Print, PrintPreview, Mail, Quit,
00124 
00125                 // Edit Menu
00126                 Undo, Redo, Cut, Copy, Paste, SelectAll, Deselect, Find, FindNext, FindPrev,
00127                 Replace,
00128 
00129                 // View Menu
00130                 ActualSize, FitToPage, FitToWidth, FitToHeight, ZoomIn, ZoomOut,
00131                 Zoom, Redisplay,
00132 
00133                 // Go Menu
00134                 Up, Back, Forward, Home, Prior, Next, Goto, GotoPage, GotoLine,
00135                 FirstPage, LastPage,
00136 
00137                 // Bookmarks Menu
00138                 AddBookmark, EditBookmarks,
00139 
00140                 // Tools Menu
00141                 Spelling,
00142 
00143                 // Settings Menu
00144                 ShowMenubar, ShowToolbar, ShowStatusbar, SaveOptions, KeyBindings,
00145                 Preferences, ConfigureToolbars,
00146 
00147                 // Help Menu
00148                 Help, HelpContents, WhatsThis, ReportBug, AboutApp, AboutKDE, 
00149                 TipofDay, 
00150 
00151                 // Another settings menu item
00152                 ConfigureNotifications
00153         };
00154 
00159         KAction* create( StdAction id, const char *name,
00160                 const QObject *recvr, const char *slot,
00161                 KActionCollection* parent );
00162 
00163         inline KAction* create( StdAction id,
00164                 const QObject *recvr, const char *slot,
00165                 KActionCollection* parent )
00166                 { return KStdAction::create( id, 0, recvr, slot, parent ); }
00167 
00172         inline KAction *action(StdAction act_enum,
00173                 const QObject *recvr, const char *slot,
00174                 KActionCollection *parent, const char *name = 0L )
00175                 { return KStdAction::create( act_enum, name, recvr, slot, parent ); }
00176 
00180         const char* name( StdAction id );
00181 
00183         inline const char* stdName(StdAction act_enum) { return name( act_enum ); }
00184 
00190         QStringList stdNames();
00191 
00195         KAction *openNew(const QObject *recvr, const char *slot, KActionCollection* parent, const char *name = 0 );
00196 
00200         KAction *open(const QObject *recvr, const char *slot, KActionCollection* parent, const char *name = 0 );
00201 
00207         KRecentFilesAction *openRecent(const QObject *recvr, const char *slot, KActionCollection* parent, const char *name = 0 );
00208 
00212         KAction *save(const QObject *recvr, const char *slot,
00213                 KActionCollection* parent, const char *name = 0 );
00214 
00218         KAction *saveAs(const QObject *recvr, const char *slot,
00219                 KActionCollection* parent, const char *name = 0 );
00220 
00225         KAction *revert(const QObject *recvr, const char *slot,
00226                 KActionCollection* parent, const char *name = 0 );
00227 
00231         KAction *close(const QObject *recvr, const char *slot,
00232                 KActionCollection* parent, const char *name = 0 );
00233 
00237         KAction *print(const QObject *recvr, const char *slot,
00238                 KActionCollection* parent, const char *name = 0 );
00239 
00243         KAction *printPreview(const QObject *recvr, const char *slot,
00244                 KActionCollection* parent, const char *name = 0 );
00245 
00249         KAction *mail(const QObject *recvr, const char *slot,
00250                 KActionCollection* parent, const char *name = 0 );
00251 
00255         KAction *quit(const QObject *recvr, const char *slot,
00256                 KActionCollection* parent, const char *name = 0 );
00257 
00261         KAction *undo(const QObject *recvr, const char *slot,
00262                 KActionCollection* parent, const char *name = 0 );
00263 
00267         KAction *redo(const QObject *recvr, const char *slot,
00268                 KActionCollection* parent, const char *name = 0 );
00269 
00273         KAction *cut(const QObject *recvr, const char *slot,
00274                 KActionCollection* parent, const char *name = 0 );
00275 
00279         KAction *copy(const QObject *recvr, const char *slot,
00280                 KActionCollection* parent, const char *name = 0 );
00281 
00286         KAction *paste(const QObject *recvr, const char *slot,
00287                 KActionCollection* parent, const char *name = 0 );
00288 
00292         KAction *selectAll(const QObject *recvr, const char *slot,
00293                 KActionCollection* parent, const char *name = 0 );
00294 
00298         KAction *deselect(const QObject *recvr, const char *slot,
00299                 KActionCollection* parent, const char *name = 0 );
00300 
00304         KAction *find(const QObject *recvr, const char *slot,
00305                 KActionCollection* parent, const char *name = 0 );
00306 
00310         KAction *findNext(const QObject *recvr, const char *slot,
00311                 KActionCollection* parent, const char *name = 0 );
00312 
00316         KAction *findPrev(const QObject *recvr, const char *slot,
00317                 KActionCollection* parent, const char *name = 0 );
00318 
00322         KAction *replace(const QObject *recvr, const char *slot,
00323                 KActionCollection* parent, const char *name = 0 );
00324 
00328         KAction *actualSize(const QObject *recvr, const char *slot,
00329                 KActionCollection* parent, const char *name = 0 );
00330 
00334         KAction *fitToPage(const QObject *recvr, const char *slot,
00335                 KActionCollection* parent, const char *name = 0 );
00336 
00340         KAction *fitToWidth(const QObject *recvr, const char *slot,
00341                 KActionCollection* parent, const char *name = 0 );
00342 
00346         KAction *fitToHeight(const QObject *recvr, const char *slot,
00347                                         KActionCollection* parent, const char *name = 0 );
00348 
00352         KAction *zoomIn(const QObject *recvr, const char *slot,
00353                                 KActionCollection* parent, const char *name = 0 );
00354 
00358         KAction *zoomOut(const QObject *recvr, const char *slot,
00359                                 KActionCollection* parent, const char *name = 0 );
00360 
00364         KAction *zoom(const QObject *recvr, const char *slot,
00365                                 KActionCollection* parent, const char *name = 0 );
00366 
00370         KAction *redisplay(const QObject *recvr, const char *slot,
00371                                 KActionCollection* parent, const char *name = 0 );
00372 
00376         KAction *up(const QObject *recvr, const char *slot,
00377                         KActionCollection* parent, const char *name = 0 );
00378 
00382         KAction *back(const QObject *recvr, const char *slot,
00383                                 KActionCollection* parent, const char *name = 0 );
00384 
00388         KAction *forward(const QObject *recvr, const char *slot,
00389                                 KActionCollection* parent, const char *name = 0 );
00390 
00394         KAction *home(const QObject *recvr, const char *slot,
00395                                 KActionCollection* parent, const char *name = 0 );
00396 
00400         KAction *prior(const QObject *recvr, const char *slot,
00401                                 KActionCollection* parent, const char *name = 0 );
00402 
00406         KAction *next(const QObject *recvr, const char *slot,
00407                                 KActionCollection* parent, const char *name = 0 );
00408 
00412         KAction *goTo(const QObject *recvr, const char *slot,
00413                                 KActionCollection* parent, const char *name = 0 );
00414 
00415 
00419         KAction *gotoPage(const QObject *recvr, const char *slot,
00420                                 KActionCollection* parent, const char *name = 0 );
00421 
00425         KAction *gotoLine(const QObject *recvr, const char *slot,
00426                                 KActionCollection* parent, const char *name = 0 );
00427 
00431         KAction *firstPage(const QObject *recvr, const char *slot,
00432                                 KActionCollection* parent, const char *name = 0 );
00433 
00437         KAction *lastPage(const QObject *recvr, const char *slot,
00438                                 KActionCollection* parent, const char *name = 0 );
00439 
00443         KAction *addBookmark(const QObject *recvr, const char *slot,
00444                                         KActionCollection* parent, const char *name = 0 );
00445 
00449         KAction *editBookmarks(const QObject *recvr, const char *slot,
00450                                         KActionCollection* parent, const char *name = 0 );
00451 
00455         KAction *spelling(const QObject *recvr, const char *slot,
00456                                         KActionCollection* parent, const char *name = 0 );
00457 
00458 
00462         KToggleAction *showMenubar(const QObject *recvr, const char *slot,
00463                                         KActionCollection* parent, const char *name = 0 );
00464 
00470         KToggleAction *showToolbar(const QObject *recvr, const char *slot,
00471                                         KActionCollection* parent, const char *name = 0 );
00476         KToggleToolBarAction *showToolbar(const char* toolBarName,
00477                                         KActionCollection* parent, const char *name = 0 );
00478 
00482         KToggleAction *showStatusbar(const QObject *recvr, const char *slot,
00483                                                 KActionCollection* parent, const char *name = 0 );
00484 
00488         KAction *saveOptions(const QObject *recvr, const char *slot,
00489                                         KActionCollection* parent, const char *name = 0 );
00490 
00494         KAction *keyBindings(const QObject *recvr, const char *slot,
00495                                         KActionCollection* parent, const char *name = 0 );
00496 
00500         KAction *preferences(const QObject *recvr, const char *slot,
00501                                         KActionCollection* parent, const char *name = 0 );
00502 
00506         KAction *configureToolbars(const QObject *recvr,
00507                                         const char *slot,
00508                                         KActionCollection* parent,
00509                                         const char *name = 0 );
00510 
00515         KAction *configureNotifications(const QObject *recvr,
00516                                         const char *slot,
00517                                         KActionCollection *parent,
00518                                         const char *name = 0);
00519 
00523         KAction *help(const QObject *recvr, const char *slot,
00524                                 KActionCollection* parent, const char *name = 0 );
00525 
00529         KAction *helpContents(const QObject *recvr, const char *slot,
00530                                         KActionCollection* parent, const char *name = 0 );
00531 
00535         KAction *whatsThis(const QObject *recvr, const char *slot,
00536                                 KActionCollection* parent, const char *name = 0 );
00537 
00542         KAction *tipOfDay(const QObject *recvr, const char *slot,
00543                                 KActionCollection* parent, const char *name = 0 );
00544 
00548         KAction *reportBug(const QObject *recvr, const char *slot,
00549                                 KActionCollection* parent, const char *name = 0 );
00550 
00554         KAction *aboutApp(const QObject *recvr, const char *slot,
00555                                 KActionCollection* parent, const char *name = 0 );
00556 
00560         KAction *aboutKDE(const QObject *recvr, const char *slot,
00561                                 KActionCollection* parent, const char *name = 0 );
00562 }
00563 
00564 #endif // KSTDACTION_H
KDE Logo
This file is part of the documentation for kdelibs Version 3.1.5.
Documentation copyright © 1996-2002 the KDE developers.
Generated on Wed Jan 28 12:57:44 2004 by doxygen 1.3.4 written by Dimitri van Heesch, © 1997-2001