KStandardActions Namespace

Convenience methods to access all standard KDE actions. This namespace was introduced in Qt 6.3. More...

• Header: #include <KStandardActions>
• Since: Qt 6.3
• CMake: find_package(KF6 REQUIRED COMPONENTS Config)
target_link_libraries(mytarget PRIVATE KF6::ConfigGui)

#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 KStandardActions 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 = KStandardActions::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 = KStandardActions::create(KStandardActions::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 = KStandardActions::cut(this, &ClassFoo::editCut, actionCollection());

Each action has a unique internal name which can be queried using the name method. For example KStandardActions::name(KStandardActions::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 = KStandardActions::cut(this, &ClassFoo::editCut, this);
actionCollection()->addAction(KStandardActions::name(KStandardActions::Cut), cut);

You can then get a pointer to the action using

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

#Type Documentation

#enum KStandardActions::StandardAction

The standard menubar and toolbar actions.

#Function Documentation

#template <typename Receiver, typename Func> QAction *KStandardActions::aboutApp(const Receiver *recvr, Func slot, QObject *parent)

Display the application's About box.

#template <typename Receiver, typename Func> QAction *KStandardActions::aboutKDE(const Receiver *recvr, Func slot, QObject *parent)

Display the About KDE dialog.

#QList<KStandardActions::StandardAction> KStandardActions::actionIds()

Returns a list of all actionIds.

#template <typename Receiver, typename Func> QAction *KStandardActions::actualSize(const Receiver *recvr, Func slot, QObject *parent)

View the document at its actual size.

#template <typename Receiver, typename Func> QAction *KStandardActions::addBookmark(const Receiver *recvr, Func slot, QObject *parent)

Add the current page to the bookmarks tree.

#template <typename Receiver, typename Func> QAction *KStandardActions::back(const Receiver *recvr, Func slot, QObject *parent)

Move back (web style menu).

#template <typename Receiver, typename Func> QAction *KStandardActions::clear(const Receiver *recvr, Func slot, QObject *parent)

Clear the content of the focus widget

#template <typename Receiver, typename Func> QAction *KStandardActions::close(const Receiver *recvr, Func slot, QObject *parent)

Close the current document.

#template <typename Receiver, typename Func> QAction *KStandardActions::configureNotifications(const Receiver *recvr, Func slot, QObject *parent)

Display the notifications configuration dialog.

#template <typename Receiver, typename Func> QAction *KStandardActions::configureToolbars(const Receiver *recvr, Func slot, QObject *parent)

Display the toolbar configuration dialog.

#template <typename Receiver, typename Func> QAction *KStandardActions::copy(const Receiver *recvr, Func slot, QObject *parent)

Copy the selected area into the clipboard.

#template <typename Receiver, typename Func> QAction *KStandardActions::create(KStandardActions::StandardAction id, const Receiver *recvr, Func slot, QObject *parent, std::optional<Qt::ConnectionType> connectionType = std::nullopt)

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

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

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

#template <typename Receiver, typename Func> QAction *KStandardActions::cut(const Receiver *recvr, Func slot, QObject *parent)

Cut selected area and store it in the clipboard.

#template <typename Receiver, typename Func> QAction *KStandardActions::deleteFile(const Receiver *recvr, Func slot, QObject *parent)

Permanently deletes files or folders.

#template <typename Receiver, typename Func> QAction *KStandardActions::deselect(const Receiver *recvr, Func slot, QObject *parent)

Deselect any selected elements in the current document.

#template <typename Receiver, typename Func> QAction *KStandardActions::documentBack(const Receiver *recvr, Func slot, QObject *parent)

Move back (document style menu).

#template <typename Receiver, typename Func> QAction *KStandardActions::documentForward(const Receiver *recvr, Func slot, QObject *parent)

Move forward (document style menu).

#template <typename Receiver, typename Func> QAction *KStandardActions::donate(const Receiver *recvr, Func slot, QObject *parent)

Open donation page on kde.org.

#template <typename Receiver, typename Func> QAction *KStandardActions::editBookmarks(const Receiver *recvr, Func slot, QObject *parent)

Edit the application bookmarks.

#template <typename Receiver, typename Func> QAction *KStandardActions::find(const Receiver *recvr, Func slot, QObject *parent)

Initiate a 'find' request in the current document.

#template <typename Receiver, typename Func> QAction *KStandardActions::findNext(const Receiver *recvr, Func slot, QObject *parent)

Find the next instance of a stored 'find'.

#template <typename Receiver, typename Func> QAction *KStandardActions::findPrev(const Receiver *recvr, Func slot, QObject *parent)

Find a previous instance of a stored 'find'.

#template <typename Receiver, typename Func> QAction *KStandardActions::firstPage(const Receiver *recvr, Func slot, QObject *parent)

Jump to the first page.

#template <typename Receiver, typename Func> QAction *KStandardActions::fitToHeight(const Receiver *recvr, Func slot, QObject *parent)

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

#template <typename Receiver, typename Func> QAction *KStandardActions::fitToPage(const Receiver *recvr, Func slot, QObject *parent)

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

#template <typename Receiver, typename Func> QAction *KStandardActions::fitToWidth(const Receiver *recvr, Func slot, QObject *parent)

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

#template <typename Receiver, typename Func> QAction *KStandardActions::forward(const Receiver *recvr, Func slot, QObject *parent)

Move forward (web style menu).

#template <typename Receiver, typename Func> QAction *KStandardActions::goTo(const Receiver *recvr, Func slot, QObject *parent)

Jump to some specific location in the document.

#template <typename Receiver, typename Func> QAction *KStandardActions::gotoLine(const Receiver *recvr, Func slot, QObject *parent)

Go to a specific line.

#template <typename Receiver, typename Func> QAction *KStandardActions::gotoPage(const Receiver *recvr, Func slot, QObject *parent)

Go to a specific page.

#template <typename Receiver, typename Func> QAction *KStandardActions::helpContents(const Receiver *recvr, Func slot, QObject *parent)

Display the handbook of the application.

#template <typename Receiver, typename Func> QAction *KStandardActions::home(const Receiver *recvr, Func slot, QObject *parent)

Go to the "Home" position or document.

#template <typename Receiver, typename Func> QAction *KStandardActions::keyBindings(const Receiver *recvr, Func slot, QObject *parent)

Display the configure key bindings dialog.

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

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

#template <typename Receiver, typename Func> QAction *KStandardActions::lastPage(const Receiver *recvr, Func slot, QObject *parent)

Jump to the last page.

#template <typename Receiver, typename Func> QAction *KStandardActions::mail(const Receiver *recvr, Func slot, QObject *parent)

Mail this document.

#template <typename Receiver, typename Func> QAction *KStandardActions::moveToTrash(const Receiver *recvr, Func slot, QObject *parent)

Moves files or folders to the trash.

#QString KStandardActions::name(KStandardActions::StandardAction id)

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

#template <typename Receiver, typename Func> QAction *KStandardActions::next(const Receiver *recvr, Func slot, QObject *parent)

Scroll down one page.

#template <typename Receiver, typename Func> QAction *KStandardActions::open(const Receiver *recvr, Func slot, QObject *parent)

Open an existing file.

#template <typename Receiver, typename Func> QAction *KStandardActions::openNew(const Receiver *recvr, Func slot, QObject *parent)

Create a new document or window.

#template <typename Receiver, typename Func> QAction *KStandardActions::paste(const Receiver *recvr, Func slot, QObject *parent)

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

#template <typename Receiver, typename Func> QAction *KStandardActions::preferences(const Receiver *recvr, Func slot, QObject *parent)

Display the preferences/options dialog.

#template <typename Receiver, typename Func> QAction *KStandardActions::print(const Receiver *recvr, Func slot, QObject *parent)

Print the current document.

#template <typename Receiver, typename Func> QAction *KStandardActions::printPreview(const Receiver *recvr, Func slot, QObject *parent)

Show a print preview of the current document.

#template <typename Receiver, typename Func> QAction *KStandardActions::prior(const Receiver *recvr, Func slot, QObject *parent)

Scroll up one page.

#template <typename Receiver, typename Func> QAction *KStandardActions::quit(const Receiver *recvr, Func 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).

#template <typename Receiver, typename Func> QAction *KStandardActions::redisplay(const Receiver *recvr, Func slot, QObject *parent)

Redisplay or redraw the document.

#template <typename Receiver, typename Func> QAction *KStandardActions::redo(const Receiver *recvr, Func slot, QObject *parent)

Redo the last operation.

#template <typename Receiver, typename Func> QAction *KStandardActions::renameFile(const Receiver *recvr, Func slot, QObject *parent)

Renames files or folders.

#template <typename Receiver, typename Func> QAction *KStandardActions::replace(const Receiver *recvr, Func slot, QObject *parent)

Find and replace matches.

#template <typename Receiver, typename Func> QAction *KStandardActions::reportBug(const Receiver *recvr, Func slot, QObject *parent)

Open up the Report Bug dialog.

#template <typename Receiver, typename Func> QAction *KStandardActions::revert(const Receiver *recvr, Func slot, QObject *parent)

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

#template <typename Receiver, typename Func> QAction *KStandardActions::save(const Receiver *recvr, Func slot, QObject *parent)

Save the current document.

#template <typename Receiver, typename Func> QAction *KStandardActions::saveAs(const Receiver *recvr, Func slot, QObject *parent)

Save the current document under a different name.

#template <typename Receiver, typename Func> QAction *KStandardActions::selectAll(const Receiver *recvr, Func slot, QObject *parent)

Select all elements in the current document.

#KStandardShortcut::StandardShortcut KStandardActions::shortcutForActionId(KStandardActions::StandardAction id)

Returns the standardshortcut associated with actionId.

id The identifier whose associated shortcut is wanted.

#template <typename Receiver, typename Func> QAction *KStandardActions::spelling(const Receiver *recvr, Func slot, QObject *parent)

Pop up the spell checker.

#template <typename Receiver, typename Func> QAction *KStandardActions::switchApplicationLanguage(const Receiver *recvr, Func slot, QObject *parent)

Display the Switch Application Language dialog.

#template <typename Receiver, typename Func> QAction *KStandardActions::undo(const Receiver *recvr, Func slot, QObject *parent)

Undo the last operation.

#template <typename Receiver, typename Func> QAction *KStandardActions::up(const Receiver *recvr, Func slot, QObject *parent)

Move up (web style menu).

#template <typename Receiver, typename Func> QAction *KStandardActions::whatsThis(const Receiver *recvr, Func slot, QObject *parent)

Trigger the What's This cursor.

#template <typename Receiver, typename Func> QAction *KStandardActions::zoom(const Receiver *recvr, Func slot, QObject *parent)

Select the current zoom level.

#template <typename Receiver, typename Func> QAction *KStandardActions::zoomIn(const Receiver *recvr, Func slot, QObject *parent)

Zoom in the current document view.

#template <typename Receiver, typename Func> QAction *KStandardActions::zoomOut(const Receiver *recvr, Func slot, QObject *parent)

Zoom out the current document view.