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 QWidget;
00024 class KAction;
00025 class KActionCollection;
00026 class KRecentFilesAction;
00027 class KToggleAction;
00028 class KToggleToolBarAction;
00029 class KToggleFullScreenAction;
00030 
00031 #include <qstringlist.h>
00032 
00115 namespace KStdAction
00116 {
00120     enum StdAction {
00121         ActionNone,
00122 
00123         // File Menu
00124         New, Open, OpenRecent, Save, SaveAs, Revert, Close,
00125         Print, PrintPreview, Mail, Quit,
00126 
00127         // Edit Menu
00128         Undo, Redo, Cut, Copy, Paste, SelectAll, Deselect, Find, FindNext, FindPrev,
00129         Replace,
00130 
00131         // View Menu
00132         ActualSize, FitToPage, FitToWidth, FitToHeight, ZoomIn, ZoomOut,
00133         Zoom, Redisplay,
00134 
00135         // Go Menu
00136         Up, Back, Forward, Home, Prior, Next, Goto, GotoPage, GotoLine,
00137         FirstPage, LastPage,
00138 
00139         // Bookmarks Menu
00140         AddBookmark, EditBookmarks,
00141 
00142         // Tools Menu
00143         Spelling,
00144 
00145         // Settings Menu
00146         ShowMenubar, ShowToolbar, ShowStatusbar,
00147         SaveOptions, KeyBindings,
00148         Preferences, ConfigureToolbars,
00149 
00150         // Help Menu
00151         Help, HelpContents, WhatsThis, ReportBug, AboutApp, AboutKDE,
00152         TipofDay, 
00153 
00154         // Another settings menu item
00155         ConfigureNotifications,
00156         FullScreen, 
00157         Clear, 
00158         PasteText 
00159     };
00160 
00165     KAction* create( StdAction id, const char *name,
00166         const QObject *recvr, const char *slot,
00167         KActionCollection* parent );
00168 
00169     inline KAction* create( StdAction id,
00170         const QObject *recvr, const char *slot,
00171         KActionCollection* parent )
00172         { return KStdAction::create( id, 0, recvr, slot, parent ); }
00173 
00178     inline KAction *action(StdAction act_enum,
00179         const QObject *recvr, const char *slot,
00180         KActionCollection *parent, const char *name = 0L )
00181         { return KStdAction::create( act_enum, name, recvr, slot, parent ); }
00182 
00186     const char* name( StdAction id );
00187 
00189     inline const char* stdName(StdAction act_enum) { return name( act_enum ); }
00190 
00196         QStringList stdNames();
00197 
00201     KAction *openNew(const QObject *recvr, const char *slot, KActionCollection* parent, const char *name = 0 );
00202 
00206     KAction *open(const QObject *recvr, const char *slot, KActionCollection* parent, const char *name = 0 );
00207 
00217     KRecentFilesAction *openRecent(const QObject *recvr, const char *slot, KActionCollection* parent, const char *name = 0 );
00218 
00222     KAction *save(const QObject *recvr, const char *slot,
00223         KActionCollection* parent, const char *name = 0 );
00224 
00228     KAction *saveAs(const QObject *recvr, const char *slot,
00229         KActionCollection* parent, const char *name = 0 );
00230 
00235     KAction *revert(const QObject *recvr, const char *slot,
00236         KActionCollection* parent, const char *name = 0 );
00237 
00241     KAction *close(const QObject *recvr, const char *slot,
00242         KActionCollection* parent, const char *name = 0 );
00243 
00247     KAction *print(const QObject *recvr, const char *slot,
00248         KActionCollection* parent, const char *name = 0 );
00249 
00253     KAction *printPreview(const QObject *recvr, const char *slot,
00254         KActionCollection* parent, const char *name = 0 );
00255 
00259     KAction *mail(const QObject *recvr, const char *slot,
00260         KActionCollection* parent, const char *name = 0 );
00261 
00265     KAction *quit(const QObject *recvr, const char *slot,
00266         KActionCollection* parent, const char *name = 0 );
00267 
00271     KAction *undo(const QObject *recvr, const char *slot,
00272         KActionCollection* parent, const char *name = 0 );
00273 
00277     KAction *redo(const QObject *recvr, const char *slot,
00278         KActionCollection* parent, const char *name = 0 );
00279 
00283     KAction *cut(const QObject *recvr, const char *slot,
00284         KActionCollection* parent, const char *name = 0 );
00285 
00289     KAction *copy(const QObject *recvr, const char *slot,
00290         KActionCollection* parent, const char *name = 0 );
00291 
00296     KAction *paste(const QObject *recvr, const char *slot,
00297         KActionCollection* parent, const char *name = 0 );
00298 
00305     KAction *pasteText(const QObject *recvr, const char *slot,
00306         KActionCollection* parent, const char *name = 0 );
00307 
00312     KAction *clear(const QObject *recvr, const char *slot,
00313         KActionCollection* parent, const char *name = 0 );
00314 
00318     KAction *selectAll(const QObject *recvr, const char *slot,
00319         KActionCollection* parent, const char *name = 0 );
00320 
00324     KAction *deselect(const QObject *recvr, const char *slot,
00325         KActionCollection* parent, const char *name = 0 );
00326 
00330     KAction *find(const QObject *recvr, const char *slot,
00331         KActionCollection* parent, const char *name = 0 );
00332 
00336     KAction *findNext(const QObject *recvr, const char *slot,
00337         KActionCollection* parent, const char *name = 0 );
00338 
00342     KAction *findPrev(const QObject *recvr, const char *slot,
00343         KActionCollection* parent, const char *name = 0 );
00344 
00348     KAction *replace(const QObject *recvr, const char *slot,
00349         KActionCollection* parent, const char *name = 0 );
00350 
00354     KAction *actualSize(const QObject *recvr, const char *slot,
00355         KActionCollection* parent, const char *name = 0 );
00356 
00360     KAction *fitToPage(const QObject *recvr, const char *slot,
00361         KActionCollection* parent, const char *name = 0 );
00362 
00366     KAction *fitToWidth(const QObject *recvr, const char *slot,
00367         KActionCollection* parent, const char *name = 0 );
00368 
00372     KAction *fitToHeight(const QObject *recvr, const char *slot,
00373                     KActionCollection* parent, const char *name = 0 );
00374 
00378     KAction *zoomIn(const QObject *recvr, const char *slot,
00379                 KActionCollection* parent, const char *name = 0 );
00380 
00384     KAction *zoomOut(const QObject *recvr, const char *slot,
00385                 KActionCollection* parent, const char *name = 0 );
00386 
00390     KAction *zoom(const QObject *recvr, const char *slot,
00391                 KActionCollection* parent, const char *name = 0 );
00392 
00396     KAction *redisplay(const QObject *recvr, const char *slot,
00397                 KActionCollection* parent, const char *name = 0 );
00398 
00402     KAction *up(const QObject *recvr, const char *slot,
00403             KActionCollection* parent, const char *name = 0 );
00404 
00408     KAction *back(const QObject *recvr, const char *slot,
00409                 KActionCollection* parent, const char *name = 0 );
00410 
00414     KAction *forward(const QObject *recvr, const char *slot,
00415                 KActionCollection* parent, const char *name = 0 );
00416 
00420     KAction *home(const QObject *recvr, const char *slot,
00421                 KActionCollection* parent, const char *name = 0 );
00422 
00426     KAction *prior(const QObject *recvr, const char *slot,
00427                 KActionCollection* parent, const char *name = 0 );
00428 
00432     KAction *next(const QObject *recvr, const char *slot,
00433                 KActionCollection* parent, const char *name = 0 );
00434 
00438     KAction *goTo(const QObject *recvr, const char *slot,
00439                 KActionCollection* parent, const char *name = 0 );
00440 
00441 
00445     KAction *gotoPage(const QObject *recvr, const char *slot,
00446                 KActionCollection* parent, const char *name = 0 );
00447 
00451     KAction *gotoLine(const QObject *recvr, const char *slot,
00452                 KActionCollection* parent, const char *name = 0 );
00453 
00457     KAction *firstPage(const QObject *recvr, const char *slot,
00458                 KActionCollection* parent, const char *name = 0 );
00459 
00463     KAction *lastPage(const QObject *recvr, const char *slot,
00464                 KActionCollection* parent, const char *name = 0 );
00465 
00469     KAction *addBookmark(const QObject *recvr, const char *slot,
00470                     KActionCollection* parent, const char *name = 0 );
00471 
00475     KAction *editBookmarks(const QObject *recvr, const char *slot,
00476                     KActionCollection* parent, const char *name = 0 );
00477 
00481     KAction *spelling(const QObject *recvr, const char *slot,
00482                     KActionCollection* parent, const char *name = 0 );
00483 
00484 
00488     KToggleAction *showMenubar(const QObject *recvr, const char *slot,
00489                     KActionCollection* parent, const char *name = 0 );
00490 
00498     KToggleAction *showToolbar(const QObject *recvr, const char *slot,
00499                     KActionCollection* parent, const char *name = 0 );
00506     KToggleToolBarAction *showToolbar(const char* toolBarName,
00507                     KActionCollection* parent, const char *name = 0 );
00508 
00512     KToggleAction *showStatusbar(const QObject *recvr, const char *slot,
00513                     KActionCollection* parent, const char *name = 0 );
00514 
00519     KToggleFullScreenAction *fullScreen(const QObject *recvr, const char *slot,
00520                     KActionCollection* parent, QWidget* window, const char *name = 0 );
00521 
00525     KAction *saveOptions(const QObject *recvr, const char *slot,
00526                     KActionCollection* parent, const char *name = 0 );
00527 
00534     KAction *keyBindings(const QObject *recvr, const char *slot,
00535                     KActionCollection* parent, const char *name = 0 );
00536 
00540     KAction *preferences(const QObject *recvr, const char *slot,
00541                     KActionCollection* parent, const char *name = 0 );
00542 
00546     KAction *configureToolbars(const QObject *recvr,
00547                     const char *slot,
00548                     KActionCollection* parent,
00549                     const char *name = 0 );
00550 
00555     KAction *configureNotifications(const QObject *recvr,
00556                     const char *slot,
00557                     KActionCollection *parent,
00558                     const char *name = 0);
00559 
00563     KAction *help(const QObject *recvr, const char *slot,
00564                 KActionCollection* parent, const char *name = 0 );
00565 
00569     KAction *helpContents(const QObject *recvr, const char *slot,
00570                     KActionCollection* parent, const char *name = 0 );
00571 
00575     KAction *whatsThis(const QObject *recvr, const char *slot,
00576                 KActionCollection* parent, const char *name = 0 );
00577 
00582     KAction *tipOfDay(const QObject *recvr, const char *slot,
00583                 KActionCollection* parent, const char *name = 0 );
00584 
00588     KAction *reportBug(const QObject *recvr, const char *slot,
00589                 KActionCollection* parent, const char *name = 0 );
00590 
00594     KAction *aboutApp(const QObject *recvr, const char *slot,
00595                 KActionCollection* parent, const char *name = 0 );
00596 
00600     KAction *aboutKDE(const QObject *recvr, const char *slot,
00601                 KActionCollection* parent, const char *name = 0 );
00602 }
00603 
00604 #endif // KSTDACTION_H
KDE Logo
This file is part of the documentation for kdeui Library Version 3.3.0.
Documentation copyright © 1996-2004 the KDE developers.
Generated on Sat Nov 27 13:43:14 2004 by doxygen 1.3.9.1 written by Dimitri van Heesch, © 1997-2003