Contents

KStandardAction Namespace

Convenience methods to access all standard KDE actions. More...

Header: #include <KStandardAction>
CMake: find_package(KF6 REQUIRED COMPONENTS ConfigWidgets)
target_link_libraries(mytarget PRIVATE KF6::ConfigWidgets)

Types

enum StandardAction { ActionNone, New, Open, OpenRecent, Save, …, HamburgerMenu }

Functions

QAction *aboutApp(const QObject *recvr, const char *slot, QObject *parent)
QAction *aboutKDE(const QObject *recvr, const char *slot, QObject *parent)
(since 4.2) QList<KStandardAction::StandardAction> actionIds()
QAction *actualSize(const QObject *recvr, const char *slot, QObject *parent)
QAction *addBookmark(const QObject *recvr, const char *slot, QObject *parent)
QAction *back(const QObject *recvr, const char *slot, QObject *parent)
QAction *clear(QObject *parent)
QAction *clear(const QObject *recvr, const char *slot, QObject *parent)
QAction *close(const QObject *recvr, const char *slot, QObject *parent)
QAction *configureNotifications(const QObject *recvr, const char *slot, QObject *parent)
QAction *configureToolbars(const QObject *recvr, const char *slot, QObject *parent)
QAction *copy(QObject *parent)
QAction *copy(const QObject *recvr, const char *slot, QObject *parent)
QAction *create(KStandardAction::StandardAction id, const QObject *recvr, const char *slot, QObject *parent)
(since 5.23 (The connectionType argument was added in 5.95)) typename std::enable_if<!std::is_convertible<Func, const char *>::value, QAction>::type *create(KStandardAction::StandardAction id, const Receiver *recvr, Func slot, QObject *parent, std::optional<Qt::ConnectionType> connectionType = std::nullopt)
QAction *cut(QObject *parent)
QAction *cut(const QObject *recvr, const char *slot, QObject *parent)
(since 5.25) QAction *deleteFile(const QObject *recvr, const char *slot, QObject *parent)
QAction *deselect(const QObject *recvr, const char *slot, QObject *parent)
QAction *documentBack(const QObject *recvr, const char *slot, QObject *parent)
QAction *documentForward(const QObject *recvr, const char *slot, QObject *parent)
(since 5.26) QAction *donate(const QObject *recvr, const char *slot, QObject *parent)
QAction *editBookmarks(const QObject *recvr, const char *slot, QObject *parent)
QAction *find(const QObject *recvr, const char *slot, QObject *parent)
QAction *findNext(const QObject *recvr, const char *slot, QObject *parent)
QAction *findPrev(const QObject *recvr, const char *slot, QObject *parent)
QAction *firstPage(const QObject *recvr, const char *slot, QObject *parent)
QAction *fitToHeight(const QObject *recvr, const char *slot, QObject *parent)
QAction *fitToPage(const QObject *recvr, const char *slot, QObject *parent)
QAction *fitToWidth(const QObject *recvr, const char *slot, QObject *parent)
QAction *forward(const QObject *recvr, const char *slot, QObject *parent)
KToggleFullScreenAction *fullScreen(const QObject *recvr, const char *slot, QWidget *window, QObject *parent)
(since 5.23) typename std::enable_if<!std::is_convertible<Func, const char *>::value, KToggleFullScreenAction>::type *fullScreen(const Receiver *recvr, Func slot, QWidget *window, QObject *parent)
QAction *goTo(const QObject *recvr, const char *slot, QObject *parent)
QAction *gotoLine(const QObject *recvr, const char *slot, QObject *parent)
QAction *gotoPage(const QObject *recvr, const char *slot, QObject *parent)
(since 5.81) KHamburgerMenu *hamburgerMenu(const QObject *recvr, const char *slot, QObject *parent)
QAction *helpContents(const QObject *recvr, const char *slot, QObject *parent)
QAction *home(const QObject *recvr, const char *slot, QObject *parent)
QAction *keyBindings(const QObject *recvr, const char *slot, QObject *parent)
QAction *lastPage(const QObject *recvr, const char *slot, QObject *parent)
QAction *mail(const QObject *recvr, const char *slot, QObject *parent)
(since 5.25) QAction *moveToTrash(const QObject *recvr, const char *slot, QObject *parent)
QString name(KStandardAction::StandardAction id)
QAction *next(const QObject *recvr, const char *slot, QObject *parent)
QAction *open(const QObject *recvr, const char *slot, QObject *parent)
QAction *openNew(const QObject *recvr, const char *slot, QObject *parent)
KRecentFilesAction *openRecent(const QObject *recvr, const char *slot, QObject *parent)
(since 5.23) typename std::enable_if<!std::is_convertible<Func, const char *>::value, KRecentFilesAction>::type *openRecent(const Receiver *recvr, Func slot, QObject *parent)
QAction *paste(QObject *parent)
QAction *paste(const QObject *recvr, const char *slot, QObject *parent)
QAction *preferences(const QObject *recvr, const char *slot, QObject *parent)
QAction *print(const QObject *recvr, const char *slot, QObject *parent)
QAction *printPreview(const QObject *recvr, const char *slot, QObject *parent)
QAction *prior(const QObject *recvr, const char *slot, QObject *parent)
QAction *quit(const QObject *recvr, const char *slot, QObject *parent)
QAction *redisplay(const QObject *recvr, const char *slot, QObject *parent)
QAction *redo(const QObject *recvr, const char *slot, QObject *parent)
(since 5.25) QAction *renameFile(const QObject *recvr, const char *slot, QObject *parent)
QAction *replace(const QObject *recvr, const char *slot, QObject *parent)
QAction *reportBug(const QObject *recvr, const char *slot, QObject *parent)
QAction *revert(const QObject *recvr, const char *slot, QObject *parent)
QAction *save(const QObject *recvr, const char *slot, QObject *parent)
QAction *saveAs(const QObject *recvr, const char *slot, QObject *parent)
QAction *selectAll(QObject *parent)
QAction *selectAll(const QObject *recvr, const char *slot, QObject *parent)
(since 4.2) KStandardShortcut::StandardShortcut shortcutForActionId(KStandardAction::StandardAction id)
KToggleAction *showMenubar(const QObject *recvr, const char *slot, QObject *parent)
(since 5.23) typename std::enable_if<!std::is_convertible<Func, const char *>::value, KToggleAction>::type *showMenubar(const Receiver *recvr, Func slot, QObject *parent)
KToggleAction *showStatusbar(const QObject *recvr, const char *slot, QObject *parent)
(since 5.23) typename std::enable_if<!std::is_convertible<Func, const char *>::value, KToggleAction>::type *showStatusbar(const Receiver *recvr, Func slot, QObject *parent)
QAction *spelling(const QObject *recvr, const char *slot, QObject *parent)
QStringList stdNames()
(since 5.67) QAction *switchApplicationLanguage(const QObject *recvr, const char *slot, QObject *parent)
QAction *undo(const QObject *recvr, const char *slot, QObject *parent)
QAction *up(const QObject *recvr, const char *slot, QObject *parent)
QAction *whatsThis(const QObject *recvr, const char *slot, QObject *parent)
QAction *zoom(const QObject *recvr, const char *slot, QObject *parent)
QAction *zoomIn(const QObject *recvr, const char *slot, QObject *parent)
QAction *zoomOut(const QObject *recvr, const char *slot, QObject *parent)

Detailed Description

These actions should be used instead of hardcoding menubar and toolbar items. Using these actions helps your application easily conform to the KDE Human Interface Guidelines.

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.

Simple Example:

In general, using standard actions should be a drop in replacement for regular actions. For example, if you previously had:

QAction *newAct = new QAction(QIcon::fromTheme("document-new"),
                              i18n("&New"),
                              this);
newAct->setShortcut(KStandardShortcut::shortcut(KStandardShortcut::New).constFirst());
connect(newAct, &QAction::triggered, this, &ClassFoo::fileNew);

You can replace it with:

QAction *newAct = KStandardAction::openNew(this, &ClassFoo::fileNew, this);

Alternatively you can instantiate the action using the StandardAction enums provided. This author can't think of a reason why you would want to, but, hey, if you do, here's how:

QAction *newAct = KStandardAction::create(KStandardAction::New, this, &ClassFoo::fileNew, this);

Relationship with KActionCollection from KXMLGui

If a KActionCollection is passed as the parent then the action will be automatically added to that collection:

QAction *cut = KStandardAction::cut(this, &ClassFoo::editCut, actionCollection());

Each action has a unique internal name which can be queried using the name method. For example KStandardAction::name(KStandardAction::Cut) would return 'edit_cut'. This name can be used as a unique identifier for the actions. So if you wanted to add an existing standard action to an action collection you can do so like this:

QAction *cut = KStandardAction::cut(this, &ClassFoo::editCut, this);
actionCollection()->addAction(KStandardAction::name(KStandardAction::Cut), cut);

You can then get a pointer to the action using

QAction *cutPtr = actionCollection()->action(KStandardAction::name(KStandardAction::Cut));

Type Documentation

enum KStandardAction::StandardAction

The standard menubar and toolbar actions.

Function Documentation

QAction *KStandardAction::aboutApp(const QObject *recvr, const char *slot, QObject *parent)

Display the application's About box.

QAction *KStandardAction::aboutKDE(const QObject *recvr, const char *slot, QObject *parent)

Display the About KDE dialog.

[since 4.2] QList<KStandardAction::StandardAction> KStandardAction::actionIds()

Returns a list of all actionIds.

This function was introduced in 4.2.

QAction *KStandardAction::actualSize(const QObject *recvr, const char *slot, QObject *parent)

View the document at its actual size.

QAction *KStandardAction::addBookmark(const QObject *recvr, const char *slot, QObject *parent)

Add the current page to the bookmarks tree.

QAction *KStandardAction::back(const QObject *recvr, const char *slot, QObject *parent)

Move back (web style menu).

QAction *KStandardAction::clear(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:

class MyListView : public K3ListView {
  Q_OBJECT
public:
  MyListView( QWidget * parent = 0, const char * name = 0, WFlags f = 0 ) : K3ListView( parent, name, f ) {}
  virtual ~MyListView() {}
public Q_SLOTS:
  virtual void clear() {}
};

QAction *KStandardAction::clear(const QObject *recvr, const char *slot, QObject *parent)

Clear the content of the focus widget

QAction *KStandardAction::close(const QObject *recvr, const char *slot, QObject *parent)

Close the current document.

QAction *KStandardAction::configureNotifications(const QObject *recvr, const char *slot, QObject *parent)

Display the notifications configuration dialog.

QAction *KStandardAction::configureToolbars(const QObject *recvr, const char *slot, QObject *parent)

Display the toolbar configuration dialog.

QAction *KStandardAction::copy(QObject *parent)

Copy selected area and store it in the clipboard. Calls copy() on the widget with the current focus.

QAction *KStandardAction::copy(const QObject *recvr, const char *slot, QObject *parent)

Copy the selected area into the clipboard.

QAction *KStandardAction::create(KStandardAction::StandardAction id, const QObject *recvr, const char *slot, QObject *parent)

Creates an action corresponding to one of the KStandardAction::StandardAction actions, which is connected to the given object and slot, and is owned by parent.

The signal that is connected to slot is triggered(bool), except for the case of OpenRecent standard action, which uses the urlSelected(const QUrl &) signal of KRecentFilesAction.

id The StandardAction identifier to create a QAction for.

recvr The QObject to receive the signal, or nullptr if no notification is needed.

slot The slot to connect the signal to (remember to use the SLOT() macro).

parent The QObject that should own the created QAction, or nullptr if no parent will own the QAction returned (ensure you delete it manually in this case).

[since 5.23 (The connectionType argument was added in 5.95)] template <typename Receiver, typename Func> typename std::enable_if<!std::is_convertible<Func, const char *>::value, QAction>::type *KStandardAction::create(KStandardAction::StandardAction id, const Receiver *recvr, Func slot, QObject *parent, std::optional<Qt::ConnectionType> connectionType = std::nullopt)

This overloads create() to allow using the new connect syntax

Note: if you use OpenRecent as id, you should manually connect to the urlSelected(const QUrl &) signal of the returned KRecentFilesAction instead or use KStandardAction::openRecent(Receiver *, Func).

If not explicitly specified, connectionType will be AutoConnection for all actions except for ConfigureToolbars it will be QueuedConnection.

create(StandardAction, const QObject *, const char *, QObject *)

This function was introduced in 5.23 (The connectionType argument was added in 5.95).

QAction *KStandardAction::cut(QObject *parent)

Cut selected area and store it in the clipboard. Calls cut() on the widget with the current focus.

QAction *KStandardAction::cut(const QObject *recvr, const char *slot, QObject *parent)

Cut selected area and store it in the clipboard.

[since 5.25] QAction *KStandardAction::deleteFile(const QObject *recvr, const char *slot, QObject *parent)

Permanently deletes files or folders.

This function was introduced in 5.25.

QAction *KStandardAction::deselect(const QObject *recvr, const char *slot, QObject *parent)

Deselect any selected elements in the current document.

QAction *KStandardAction::documentBack(const QObject *recvr, const char *slot, QObject *parent)

Move back (document style menu).

QAction *KStandardAction::documentForward(const QObject *recvr, const char *slot, QObject *parent)

Move forward (document style menu).

Open donation page on kde.org.

This function was introduced in 5.26.

QAction *KStandardAction::editBookmarks(const QObject *recvr, const char *slot, QObject *parent)

Edit the application bookmarks.

QAction *KStandardAction::find(const QObject *recvr, const char *slot, QObject *parent)

Initiate a 'find' request in the current document.

QAction *KStandardAction::findNext(const QObject *recvr, const char *slot, QObject *parent)

Find the next instance of a stored 'find'.

QAction *KStandardAction::findPrev(const QObject *recvr, const char *slot, QObject *parent)

Find a previous instance of a stored 'find'.

QAction *KStandardAction::firstPage(const QObject *recvr, const char *slot, QObject *parent)

Jump to the first page.

QAction *KStandardAction::fitToHeight(const QObject *recvr, const char *slot, QObject *parent)

Fit the document view to the height of the current window.

QAction *KStandardAction::fitToPage(const QObject *recvr, const char *slot, QObject *parent)

Fit the document view to the size of the current window.

QAction *KStandardAction::fitToWidth(const QObject *recvr, const char *slot, QObject *parent)

Fit the document view to the width of the current window.

QAction *KStandardAction::forward(const QObject *recvr, const char *slot, QObject *parent)

Move forward (web style menu).

KToggleFullScreenAction *KStandardAction::fullScreen(const QObject *recvr, const char *slot, QWidget *window, QObject *parent)

Switch to/from full screen mode

[since 5.23] template <typename Receiver, typename Func> typename std::enable_if<!std::is_convertible<Func, const char *>::value, KToggleFullScreenAction>::type *KStandardAction::fullScreen(const Receiver *recvr, Func slot, QWidget *window, QObject *parent)

Switch to/from full screen mode

This function was introduced in 5.23.

QAction *KStandardAction::goTo(const QObject *recvr, const char *slot, QObject *parent)

Jump to some specific location in the document.

QAction *KStandardAction::gotoLine(const QObject *recvr, const char *slot, QObject *parent)

Go to a specific line.

QAction *KStandardAction::gotoPage(const QObject *recvr, const char *slot, QObject *parent)

Go to a specific page.

[since 5.81] KHamburgerMenu *KStandardAction::hamburgerMenu(const QObject *recvr, const char *slot, QObject *parent)

Opens a menu that substitutes the menubar.

This function was introduced in 5.81.

QAction *KStandardAction::helpContents(const QObject *recvr, const char *slot, QObject *parent)

Display the handbook of the application.

QAction *KStandardAction::home(const QObject *recvr, const char *slot, QObject *parent)

Go to the "Home" position or document.

QAction *KStandardAction::keyBindings(const QObject *recvr, const char *slot, QObject *parent)

Display the configure keyboard shortcuts dialog.

Note that you might be able to use the pre-built KXMLGUIFactory's function:

KStandardAction::keyBindings(guiFactory(), &KXMLGUIFactory::showConfigureShortcutsDialog, actionCollection());

QAction *KStandardAction::lastPage(const QObject *recvr, const char *slot, QObject *parent)

Jump to the last page.

QAction *KStandardAction::mail(const QObject *recvr, const char *slot, QObject *parent)

Send the current document by mail.

[since 5.25] QAction *KStandardAction::moveToTrash(const QObject *recvr, const char *slot, QObject *parent)

Moves files or folders to the trash.

This function was introduced in 5.25.

QString KStandardAction::name(KStandardAction::StandardAction id)

This will return the internal name of a given standard action.

QAction *KStandardAction::next(const QObject *recvr, const char *slot, QObject *parent)

Scroll down one page.

QAction *KStandardAction::open(const QObject *recvr, const char *slot, QObject *parent)

Open an existing file.

QAction *KStandardAction::openNew(const QObject *recvr, const char *slot, QObject *parent)

Create a new document or window.

KRecentFilesAction *KStandardAction::openRecent(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 & ). recvr object to receive slot slot The SLOT to invoke when a URL is selected. The slot's signature is slotURLSelected( const QUrl & ). parent parent widget

[since 5.23] template <typename Receiver, typename Func> typename std::enable_if<!std::is_convertible<Func, const char *>::value, KRecentFilesAction>::type *KStandardAction::openRecent(const Receiver *recvr, Func slot, QObject *parent)

The same as openRecent(const QObject *, const char *, QObject *), but using new-style connect syntax openRecent(const QObject *, const char *, QObject *)

This function was introduced in 5.23.

QAction *KStandardAction::paste(QObject *parent)

Paste the contents of clipboard at the current mouse or cursor Calls paste() on the widget with the current focus.

QAction *KStandardAction::paste(const QObject *recvr, const char *slot, QObject *parent)

Paste the contents of clipboard at the current mouse or cursor position.

QAction *KStandardAction::preferences(const QObject *recvr, const char *slot, QObject *parent)

Display the preferences/options dialog.

QAction *KStandardAction::print(const QObject *recvr, const char *slot, QObject *parent)

Print the current document.

QAction *KStandardAction::printPreview(const QObject *recvr, const char *slot, QObject *parent)

Show a print preview of the current document.

QAction *KStandardAction::prior(const QObject *recvr, const char *slot, QObject *parent)

Scroll up one page.

QAction *KStandardAction::quit(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 KMainWindow::queryClose() is called on any open window (to warn the user about unsaved changes for example).

QAction *KStandardAction::redisplay(const QObject *recvr, const char *slot, QObject *parent)

Redisplay or redraw the document.

QAction *KStandardAction::redo(const QObject *recvr, const char *slot, QObject *parent)

Redo the last operation.

[since 5.25] QAction *KStandardAction::renameFile(const QObject *recvr, const char *slot, QObject *parent)

Renames files or folders.

This function was introduced in 5.25.

QAction *KStandardAction::replace(const QObject *recvr, const char *slot, QObject *parent)

Find and replace matches.

QAction *KStandardAction::reportBug(const QObject *recvr, const char *slot, QObject *parent)

Open up the Report Bug dialog.

QAction *KStandardAction::revert(const QObject *recvr, const char *slot, QObject *parent)

Revert the current document to the last saved version (essentially will undo all changes).

QAction *KStandardAction::save(const QObject *recvr, const char *slot, QObject *parent)

Save the current document.

QAction *KStandardAction::saveAs(const QObject *recvr, const char *slot, QObject *parent)

Save the current document under a different name.

QAction *KStandardAction::selectAll(QObject *parent)

Calls selectAll() on the widget with the current focus.

QAction *KStandardAction::selectAll(const QObject *recvr, const char *slot, QObject *parent)

Select all elements in the current document.

[since 4.2] KStandardShortcut::StandardShortcut KStandardAction::shortcutForActionId(KStandardAction::StandardAction id)

Returns the standardshortcut associated with @a actionId.

id The identifier whose associated shortcut is wanted.

This function was introduced in 4.2.

KToggleAction *KStandardAction::showMenubar(const QObject *recvr, const char *slot, QObject *parent)

Show/Hide the menubar.

[since 5.23] template <typename Receiver, typename Func> typename std::enable_if<!std::is_convertible<Func, const char *>::value, KToggleAction>::type *KStandardAction::showMenubar(const Receiver *recvr, Func slot, QObject *parent)

The same as showMenubar(const QObject *, const char *, QObject *), but using new-style connect syntax showMenubar(const QObject *, const char *, QObject *)

This function was introduced in 5.23.

KToggleAction *KStandardAction::showStatusbar(const QObject *recvr, const char *slot, QObject *parent)

Show/Hide the statusbar.

[since 5.23] template <typename Receiver, typename Func> typename std::enable_if<!std::is_convertible<Func, const char *>::value, KToggleAction>::type *KStandardAction::showStatusbar(const Receiver *recvr, Func slot, QObject *parent)

Show/Hide the statusbar.

This function was introduced in 5.23.

QAction *KStandardAction::spelling(const QObject *recvr, const char *slot, QObject *parent)

Pop up the spell checker.

QStringList KStandardAction::stdNames()

Returns a list of all standard names. Used by KAccelManager to give those higher weight.

[since 5.67] QAction *KStandardAction::switchApplicationLanguage(const QObject *recvr, const char *slot, QObject *parent)

Display the Switch Application Language dialog.

This function was introduced in 5.67.

QAction *KStandardAction::undo(const QObject *recvr, const char *slot, QObject *parent)

Undo the last operation.

QAction *KStandardAction::up(const QObject *recvr, const char *slot, QObject *parent)

Move up (web style menu).

QAction *KStandardAction::whatsThis(const QObject *recvr, const char *slot, QObject *parent)

Trigger the What's This cursor.

QAction *KStandardAction::zoom(const QObject *recvr, const char *slot, QObject *parent)

Select the current zoom level.

QAction *KStandardAction::zoomIn(const QObject *recvr, const char *slot, QObject *parent)

Zoom in the current document view.

QAction *KStandardAction::zoomOut(const QObject *recvr, const char *slot, QObject *parent)

Zoom out the current document view.