File indexing completed on 2024-05-26 04:31:45

 /* This file is part of the KDE libraries
    SPDX-FileCopyrightText: 1999, 2000 Kurt Granroth <granroth@kde.org>
    SPDX-FileCopyrightText: 2001, 2002 Ellis Whitehead <ellis@kde.org>
 
    SPDX-License-Identifier: LGPL-2.0-only
 */
 #ifndef KSTANDARDACTION_H
 #define KSTANDARDACTION_H
 
 #include <kritawidgetutils_export.h>
 #include <kstandardshortcut.h>
 #include <QList>
 
 class QObject;
 class QStringList;
 class QWidget;
 class QAction;
 class KRecentFilesAction;
 class KDualAction;
 class KToggleAction;
 class KToggleFullScreenAction;
 
 /**
  * Convenience methods to access all standard KDE actions.
  *
  * These actions should be used instead of hardcoding menubar and
  * toolbar items.  Using these actions helps your application easily
  * conform to the KDE UI Style Guide.
  *
  * All of the documentation for QAction holds for KStandardAction
  * also.  When in doubt on how things work, check the QAction
  * documentation first.
  * Please note that calling any of these methods automatically adds the action
  * to the actionCollection() of the QObject given by the 'parent' parameter.
  *
  * <b>Simple Example:</b>\n
  *
  * In general, using standard actions should be a drop in replacement
  * for regular actions.  For example, if you previously had:
  *
  * \code
  * QAction *newAct = new QAction(i18n("&New"), KisIconUtils::loadIcon("document-new"),
  *                               KStandardShortcut::shortcut(KStandardShortcut::New), this,
  *                               SLOT(fileNew()), actionCollection());
  * \endcode
  *
  * You could drop that and replace it with:
  *
  * \code
  * QAction *newAct = KStandardAction::openNew(this, SLOT(fileNew()),
  *                                       actionCollection());
  * \endcode
  *
  * <b>Non-standard Usages</b>\n
  *
  * It is possible to use the standard actions in various
  * non-recommended ways.  Say, for instance, you wanted to have a
  * standard action (with the associated correct text and icon and
  * accelerator, etc) but you didn't want it to go in the standard
  * place (this is not recommended, by the way).  One way to do this is
  * to simply not use the XML UI framework and plug it into wherever
  * you want.  If you do want to use the XML UI framework (good!), then
  * it is still possible.
  *
  * Basically, the XML building code matches names in the XML code with
  * the internal names of the actions.  You can find out the internal
  * names of each of the standard actions by using the name
  * method like so: KStandardAction::name(KStandardAction::Cut) would return
  * 'edit_cut'.  The XML building code will match 'edit_cut' to the
  * attribute in the global XML file and place your action there.
  *
  * However, you can change the internal name.  In this example, just
  * do something like:
  *
  * \code
  * (void)KStandardAction::cut(this, SLOT(editCut()), actionCollection(), "my_cut");
  * \endcode
  *
  * Now, in your local XML resource file (e.g., yourappui.rc), simply
  * put 'my_cut' where you want it to go.
  *
  * Another non-standard usage concerns getting a pointer to an
  * existing action if, say, you want to enable or disable the action.
  * You could do it the recommended way and just grab a pointer when
  * you instantiate it as in the 'openNew' example above... or you
  * could do it the hard way:
  *
  * \code
  * QAction *cut = actionCollection()->action(KStandardAction::name(KStandardAction::Cut));
  * \endcode
  *
  * Another non-standard usage concerns instantiating the action in the
  * first place.  Usually, you would use the member functions as
  * shown above (e.g., KStandardAction::cut(this, SLOT, parent)).  You
  * may, however, do this using the enums provided.  This author can't
  * think of a reason why you would want to, but, hey, if you do,
  * here's how:
  *
  * \code
  * (void)KStandardAction::action(KStandardAction::New, this, SLOT(fileNew()), actionCollection());
  * (void)KStandardAction::action(KStandardAction::Cut, this, SLOT(editCut()), actionCollection());
  * \endcode
  *
  * @author Kurt Granroth <granroth@kde.org>
  */
 namespace KStandardAction
 {
 /**
  * The standard menubar and toolbar actions.
  */
 enum StandardAction {
     ActionNone,
 
     // File Menu
     New, Open, OpenRecent, Save, SaveAs, Revert, Close,
     Print, PrintPreview, Mail, Quit,
 
     // Edit Menu
     Undo, Redo, Cut, Copy, Paste, SelectAll, Deselect, Find, FindNext, FindPrev,
     Replace,
 
     // View Menu
     ActualSize, FitToPage, FitToWidth, FitToHeight, ZoomIn, ZoomOut,
     Zoom, Redisplay,
 
     // Go Menu
     Up, Back, Forward, Home /*Home page*/, Prior, Next, Goto, GotoPage, GotoLine,
     FirstPage, LastPage, DocumentBack, DocumentForward,
 
     // Bookmarks Menu
     AddBookmark, EditBookmarks,
 
     // Tools Menu
     Spelling,
 
     // Settings Menu
     ShowMenubar, ShowToolbar, ShowStatusbar,
     SaveOptions, KeyBindings,
     Preferences, ConfigureToolbars, ResetConfigurations,
 
     // Help Menu
     Help, HelpContents, WhatsThis, ReportBug, AboutApp, AboutKDE,
     TipofDay,
 
     // Other standard actions
     ConfigureNotifications,
     FullScreen,
     Clear,
     PasteText,
     SwitchApplicationLanguage
 };
 
 /**
  * Creates an action corresponding to one of the
  * KStandardAction::StandardAction actions, which is connected to the given
  * object and @p slot, and is owned by @p parent.
  *
  * The signal that is connected to @p slot is triggered(bool), except for the case of
  * OpenRecent standard action, which uses the urlSelected(const QUrl &) signal of
  * KRecentFilesAction.
  *
  * @param id The StandardAction identifier to create a QAction for.
  * @param recvr The QObject to receive the signal, or 0 if no notification
  *              is needed.
  * @param slot  The slot to connect the signal to (remember to use the SLOT() macro).
  * @param parent The QObject that should own the created QAction, or 0 if no parent will
  *               own the QAction returned (ensure you delete it manually in this case).
  */
 KRITAWIDGETUTILS_EXPORT QAction *create(StandardAction id, const QObject *recvr, const char *slot,
                                       QObject *parent);
 
 /**
  * This will return the internal name of a given standard action.
  */
 KRITAWIDGETUTILS_EXPORT const char *name(StandardAction id);
 
 /// @deprecated use name()
 #ifndef KDE_NO_DEPRECATED
 inline KRITAWIDGETUTILS_DEPRECATED const char *stdName(StandardAction act_enum)
 {
     return name(act_enum);
 }
 #endif
 
 /**
  * Returns a list of all standard names. Used by KAccelManager
  * to give those higher weight.
  */
 KRITAWIDGETUTILS_EXPORT QStringList stdNames();
 
 /**
  * Returns a list of all actionIds.
  *
  * @since 4.2
  */
 KRITAWIDGETUTILS_EXPORT QList<StandardAction> actionIds();
 
 /**
  * Returns the standardshortcut associated with @a actionId.
  *
  * @param id    The actionId whose associated shortcut is wanted.
  *
  * @since 4.2
  */
 KRITAWIDGETUTILS_EXPORT KStandardShortcut::StandardShortcut shortcutForActionId(StandardAction id);
 
 /**
  * Create a new document or window.
  */
 KRITAWIDGETUTILS_EXPORT QAction *openNew(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Open an existing file.
  */
 KRITAWIDGETUTILS_EXPORT QAction *open(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Open a recently used document. The signature of the slot being called
  * is of the form slotURLSelected( const QUrl & ).
  * @param recvr object to receive slot
  * @param slot The SLOT to invoke when a URL is selected. The slot's
  * signature is slotURLSelected( const QUrl & ).
  * @param parent parent widget
  */
 KRITAWIDGETUTILS_EXPORT KRecentFilesAction *openRecent(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Save the current document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *save(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Save the current document under a different name.
  */
 KRITAWIDGETUTILS_EXPORT QAction *saveAs(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Revert the current document to the last saved version
  * (essentially will undo all changes).
  */
 KRITAWIDGETUTILS_EXPORT QAction *revert(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Close the current document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *close(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Print the current document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *print(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Show a print preview of the current document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *printPreview(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Mail this document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *mail(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Quit the program.
  *
  * Note that you probably want to connect this action to either QWidget::close()
  * or QApplication::closeAllWindows(), but not QApplication::quit(), so that
  * KisKMainWindow::queryClose() is called on any open window (to warn the user
  * about unsaved changes for example).
  */
 KRITAWIDGETUTILS_EXPORT QAction *quit(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Undo the last operation.
  */
 KRITAWIDGETUTILS_EXPORT QAction *undo(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Redo the last operation.
  */
 KRITAWIDGETUTILS_EXPORT QAction *redo(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Cut selected area and store it in the clipboard.
  * Calls cut() on the widget with the current focus.
  */
 KRITAWIDGETUTILS_EXPORT QAction *cut(QObject *parent);
 
 /**
  * Copy selected area and store it in the clipboard.
  * Calls copy() on the widget with the current focus.
  */
 KRITAWIDGETUTILS_EXPORT QAction *copy(QObject *parent);
 
 /**
  * Paste the contents of clipboard at the current mouse or cursor
  * Calls paste() on the widget with the current focus.
  */
 KRITAWIDGETUTILS_EXPORT QAction *paste(QObject *parent);
 
 /**
  * Clear selected area.  Calls clear() on the widget with the current focus.
  * Note that for some widgets, this may not provide the intended behavior.  For
  * example if you make use of the code above and a K3ListView has the focus, clear()
  * will clear all of the items in the list.  If this is not the intended behavior
  * and you want to make use of this slot, you can subclass K3ListView and reimplement
  * this slot.  For example the following code would implement a K3ListView without this
  * behavior:
  *
  * \code
  * class MyListView : public K3ListView {
  *   Q_OBJECT
  * public:
  *   MyListView( QWidget * parent = 0, const char * name = 0, WFlags f = Qt::WindowFlags() ) : K3ListView( parent, name, f ) {}
  *   virtual ~MyListView() {}
  * public Q_SLOTS:
  *   virtual void clear() {}
  * };
  * \endcode
  */
 KRITAWIDGETUTILS_EXPORT QAction *clear(QObject *parent);
 
 /**
  * Calls selectAll() on the widget with the current focus.
  */
 KRITAWIDGETUTILS_EXPORT QAction *selectAll(QObject *parent);
 
 /**
  * Cut selected area and store it in the clipboard.
  */
 KRITAWIDGETUTILS_EXPORT QAction *cut(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Copy the selected area into the clipboard.
  */
 KRITAWIDGETUTILS_EXPORT QAction *copy(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Paste the contents of clipboard at the current mouse or cursor
  * position.
  */
 KRITAWIDGETUTILS_EXPORT QAction *paste(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Paste the contents of clipboard at the current mouse or cursor
  * position. Provide a button on the toolbar with the clipboard history
  * menu if Klipper is running.
  */
 KRITAWIDGETUTILS_EXPORT QAction *pasteText(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Clear the content of the focus widget
  */
 KRITAWIDGETUTILS_EXPORT QAction *clear(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Select all elements in the current document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *selectAll(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Deselect any selected elements in the current document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *deselect(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Initiate a 'find' request in the current document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *find(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Find the next instance of a stored 'find'.
  */
 KRITAWIDGETUTILS_EXPORT QAction *findNext(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Find a previous instance of a stored 'find'.
  */
 KRITAWIDGETUTILS_EXPORT QAction *findPrev(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Find and replace matches.
  */
 KRITAWIDGETUTILS_EXPORT QAction *replace(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * View the document at its actual size.
  */
 KRITAWIDGETUTILS_EXPORT QAction *actualSize(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Fit the document view to the size of the current window.
  */
 KRITAWIDGETUTILS_EXPORT QAction *fitToPage(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Fit the document view to the width of the current window.
  */
 KRITAWIDGETUTILS_EXPORT QAction *fitToWidth(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Fit the document view to the height of the current window.
  */
 KRITAWIDGETUTILS_EXPORT QAction *fitToHeight(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Zoom in.
  */
 KRITAWIDGETUTILS_EXPORT QAction *zoomIn(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Zoom out.
  */
 KRITAWIDGETUTILS_EXPORT QAction *zoomOut(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Popup a zoom dialog.
  */
 KRITAWIDGETUTILS_EXPORT QAction *zoom(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Redisplay or redraw the document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *redisplay(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Move up (web style menu).
  */
 KRITAWIDGETUTILS_EXPORT QAction *up(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Move back (web style menu).
  */
 KRITAWIDGETUTILS_EXPORT QAction *back(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Move forward (web style menu).
  */
 KRITAWIDGETUTILS_EXPORT QAction *forward(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Go to the "Home" position or document.
  */
 KRITAWIDGETUTILS_EXPORT QAction *home(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Scroll up one page.
  */
 KRITAWIDGETUTILS_EXPORT QAction *prior(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Scroll down one page.
  */
 KRITAWIDGETUTILS_EXPORT QAction *next(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Go to somewhere in general.
  */
 KRITAWIDGETUTILS_EXPORT QAction *goTo(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Go to a specific page (dialog).
  */
 KRITAWIDGETUTILS_EXPORT QAction *gotoPage(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Go to a specific line (dialog).
  */
 KRITAWIDGETUTILS_EXPORT QAction *gotoLine(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Jump to the first page.
  */
 KRITAWIDGETUTILS_EXPORT QAction *firstPage(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Jump to the last page.
  */
 KRITAWIDGETUTILS_EXPORT QAction *lastPage(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Move back (document style menu).
  */
 KRITAWIDGETUTILS_EXPORT QAction *documentBack(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Move forward (document style menu).
  */
 KRITAWIDGETUTILS_EXPORT QAction *documentForward(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Add the current page to the bookmarks tree.
  */
 KRITAWIDGETUTILS_EXPORT QAction *addBookmark(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Edit the application bookmarks.
  */
 KRITAWIDGETUTILS_EXPORT QAction *editBookmarks(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Pop up the spell checker.
  */
 KRITAWIDGETUTILS_EXPORT QAction *spelling(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Show/Hide the menubar.
  */
 KRITAWIDGETUTILS_EXPORT KToggleAction *showMenubar(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Show/Hide the statusbar.
  */
 KRITAWIDGETUTILS_EXPORT KToggleAction *showStatusbar(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Switch to/from full screen mode
  */
 KRITAWIDGETUTILS_EXPORT KToggleFullScreenAction *fullScreen(const QObject *recvr, const char *slot, QWidget *window, QObject *parent);
 
 /**
  * Display the save options dialog.
  */
 KRITAWIDGETUTILS_EXPORT QAction *saveOptions(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Display the configure key bindings dialog.
  *
  *  Note that you might be able to use the pre-built KisKXMLGUIFactory's function:
  *  KStandardAction::keyBindings(guiFactory(), SLOT(configureShortcuts()), actionCollection());
  */
 KRITAWIDGETUTILS_EXPORT QAction *keyBindings(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Display the preferences/options dialog.
  */
 KRITAWIDGETUTILS_EXPORT QAction *preferences(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * The Customize Toolbar dialog.
  */
 KRITAWIDGETUTILS_EXPORT QAction *configureToolbars(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * The Configure Notifications dialog.
  */
 KRITAWIDGETUTILS_EXPORT QAction *configureNotifications(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Display the help.
  */
 KRITAWIDGETUTILS_EXPORT QAction *help(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Display the help contents.
  */
 KRITAWIDGETUTILS_EXPORT QAction *helpContents(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Trigger the What's This cursor.
  */
 KRITAWIDGETUTILS_EXPORT QAction *whatsThis(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Display "Tip of the Day"
  */
 KRITAWIDGETUTILS_EXPORT QAction *tipOfDay(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Open up the Report Bug dialog.
  */
 KRITAWIDGETUTILS_EXPORT QAction *reportBug(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Display the application's About box.
  */
 KRITAWIDGETUTILS_EXPORT QAction *aboutApp(const QObject *recvr, const char *slot, QObject *parent);
 
 /**
  * Display the About KDE dialog.
  */
 KRITAWIDGETUTILS_EXPORT QAction *aboutKDE(const QObject *recvr, const char *slot, QObject *parent);
 }
 
 #endif // KSTANDARDACTION_H