• Skip to content
  • Skip to link menu
KDE 4.3 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KDEUI

KStandardAction Namespace Reference

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

Enumerations

enum  StandardAction {
  ActionNone, New, Open, OpenRecent,
  Save, SaveAs, Revert, Close,
  Print, PrintPreview, Mail, Quit,
  Undo, Redo, Cut, Copy,
  Paste, SelectAll, Deselect, Find,
  FindNext, FindPrev, Replace, ActualSize,
  FitToPage, FitToWidth, FitToHeight, ZoomIn,
  ZoomOut, Zoom, Redisplay, Up,
  Back, Forward, Home, Prior,
  Next, Goto, GotoPage, GotoLine,
  FirstPage, LastPage, DocumentBack, DocumentForward,
  AddBookmark, EditBookmarks, Spelling, ShowMenubar,
  ShowToolbar, ShowStatusbar, SaveOptions, KeyBindings,
  Preferences, ConfigureToolbars, Help, HelpContents,
  WhatsThis, ReportBug, AboutApp, AboutKDE,
  TipofDay, ConfigureNotifications, FullScreen, Clear,
  PasteText, SwitchApplicationLanguage
}

Functions

KAction * aboutApp (const QObject *recvr, const char *slot, QObject *parent)
KAction * aboutKDE (const QObject *recvr, const char *slot, QObject *parent)
QList< StandardAction > actionIds ()
KAction * actualSize (const QObject *recvr, const char *slot, QObject *parent)
KAction * addBookmark (const QObject *recvr, const char *slot, QObject *parent)
KAction * back (const QObject *recvr, const char *slot, QObject *parent)
static KAction * buildAutomaticAction (QObject *parent, StandardAction id, const char *slot)
KAction * clear (QObject *parent)
KAction * clear (const QObject *recvr, const char *slot, QObject *parent)
KAction * close (const QObject *recvr, const char *slot, QObject *parent)
KAction * configureNotifications (const QObject *recvr, const char *slot, QObject *parent)
KAction * configureToolbars (const QObject *recvr, const char *slot, QObject *parent)
KAction * copy (QObject *parent)
KAction * copy (const QObject *recvr, const char *slot, QObject *parent)
KAction * create (StandardAction id, const QObject *recvr, const char *slot, QObject *parent)
KAction * cut (QObject *parent)
KAction * cut (const QObject *recvr, const char *slot, QObject *parent)
KAction * deselect (const QObject *recvr, const char *slot, QObject *parent)
KAction * documentBack (const QObject *recvr, const char *slot, QObject *parent)
KAction * documentForward (const QObject *recvr, const char *slot, QObject *parent)
KAction * editBookmarks (const QObject *recvr, const char *slot, QObject *parent)
KAction * find (const QObject *recvr, const char *slot, QObject *parent)
KAction * findNext (const QObject *recvr, const char *slot, QObject *parent)
KAction * findPrev (const QObject *recvr, const char *slot, QObject *parent)
KAction * firstPage (const QObject *recvr, const char *slot, QObject *parent)
KAction * fitToHeight (const QObject *recvr, const char *slot, QObject *parent)
KAction * fitToPage (const QObject *recvr, const char *slot, QObject *parent)
KAction * fitToWidth (const QObject *recvr, const char *slot, QObject *parent)
KAction * forward (const QObject *recvr, const char *slot, QObject *parent)
KToggleFullScreenAction * fullScreen (const QObject *recvr, const char *slot, QWidget *window, QObject *parent)
KAction * goTo (const QObject *recvr, const char *slot, QObject *parent)
KAction * gotoLine (const QObject *recvr, const char *slot, QObject *parent)
KAction * gotoPage (const QObject *recvr, const char *slot, QObject *parent)
KAction * help (const QObject *recvr, const char *slot, QObject *parent)
KAction * helpContents (const QObject *recvr, const char *slot, QObject *parent)
KAction * home (const QObject *recvr, const char *slot, QObject *parent)
KAction * keyBindings (const QObject *recvr, const char *slot, QObject *parent)
KAction * lastPage (const QObject *recvr, const char *slot, QObject *parent)
KAction * mail (const QObject *recvr, const char *slot, QObject *parent)
const char * name (StandardAction id)
KAction * next (const QObject *recvr, const char *slot, QObject *parent)
KAction * open (const QObject *recvr, const char *slot, QObject *parent)
KAction * openNew (const QObject *recvr, const char *slot, QObject *parent)
KRecentFilesAction * openRecent (const QObject *recvr, const char *slot, QObject *parent)
KAction * paste (QObject *parent)
KAction * paste (const QObject *recvr, const char *slot, QObject *parent)
KAction * pasteText (const QObject *recvr, const char *slot, QObject *parent)
KAction * preferences (const QObject *recvr, const char *slot, QObject *parent)
KAction * print (const QObject *recvr, const char *slot, QObject *parent)
KAction * printPreview (const QObject *recvr, const char *slot, QObject *parent)
KAction * prior (const QObject *recvr, const char *slot, QObject *parent)
KAction * quit (const QObject *recvr, const char *slot, QObject *parent)
KAction * redisplay (const QObject *recvr, const char *slot, QObject *parent)
KAction * redo (const QObject *recvr, const char *slot, QObject *parent)
KAction * replace (const QObject *recvr, const char *slot, QObject *parent)
KAction * reportBug (const QObject *recvr, const char *slot, QObject *parent)
KAction * revert (const QObject *recvr, const char *slot, QObject *parent)
KAction * save (const QObject *recvr, const char *slot, QObject *parent)
KAction * saveAs (const QObject *recvr, const char *slot, QObject *parent)
KAction * saveOptions (const QObject *recvr, const char *slot, QObject *parent)
KAction * selectAll (QObject *parent)
KAction * selectAll (const QObject *recvr, const char *slot, QObject *parent)
KStandardShortcut::StandardShortcut shortcutForActionId (StandardAction id)
KToggleAction * showMenubar (const QObject *recvr, const char *slot, QObject *parent)
KToggleAction * showStatusbar (const QObject *recvr, const char *slot, QObject *parent)
KAction * spelling (const QObject *recvr, const char *slot, QObject *parent)
KDE_DEPRECATED const char * stdName (StandardAction act_enum)
QStringList stdNames ()
KAction * switchApplicationLanguage (const QObject *recvr, const char *slot, QObject *parent)
KAction * tipOfDay (const QObject *recvr, const char *slot, QObject *parent)
KAction * undo (const QObject *recvr, const char *slot, QObject *parent)
KAction * up (const QObject *recvr, const char *slot, QObject *parent)
KAction * whatsThis (const QObject *recvr, const char *slot, QObject *parent)
KAction * zoom (const QObject *recvr, const char *slot, QObject *parent)
KAction * zoomIn (const QObject *recvr, const char *slot, QObject *parent)
KAction * zoomOut (const QObject *recvr, const char *slot, QObject *parent)

Detailed Description

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

See also:
http://developer.kde.org/documentation/standards/kde/style/basics/index.html .

All of the documentation for KAction holds for KStandardAction also. When in doubt on how things work, check the KAction documention 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:

 KAction *newAct = new KAction(i18n("&New"), KIcon("document-new"),
                               KStandardShortcut::shortcut(KStandardShortcut::New), this,
                               SLOT(fileNew()), actionCollection());

You could drop that and replace it with:

 KAction *newAct = KStandardAction::openNew(this, SLOT(fileNew()),
                                       actionCollection());

Non-standard Usages

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:

 (void)KStandardAction::cut(this, SLOT(editCut()), actionCollection(), "my_cut");

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:

 KAction *cut = actionCollection()->action(KStandardAction::name(KStandardAction::Cut));

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:

 (void)KStandardAction::action(KStandardAction::New, this, SLOT(fileNew()), actionCollection());
 (void)KStandardAction::action(KStandardAction::Cut, this, SLOT(editCut()), actionCollection());
Author:
Kurt Granroth <granroth@kde.org>

Enumeration Type Documentation

enum KStandardAction::StandardAction

The standard menubar and toolbar actions.

Enumerator:
ActionNone 
New 
Open 
OpenRecent 
Save 
SaveAs 
Revert 
Close 
Print 
PrintPreview 
Mail 
Quit 
Undo 
Redo 
Cut 
Copy 
Paste 
SelectAll 
Deselect 
Find 
FindNext 
FindPrev 
Replace 
ActualSize 
FitToPage 
FitToWidth 
FitToHeight 
ZoomIn 
ZoomOut 
Zoom 
Redisplay 
Up 
Back 
Forward 
Home 
Prior 
Next 
Goto 
GotoPage 
GotoLine 
FirstPage 
LastPage 
DocumentBack 
DocumentForward 
AddBookmark 
EditBookmarks 
Spelling 
ShowMenubar 
ShowToolbar 
ShowStatusbar 
SaveOptions 
KeyBindings 
Preferences 
ConfigureToolbars 
Help 
HelpContents 
WhatsThis 
ReportBug 
AboutApp 
AboutKDE 
TipofDay 
ConfigureNotifications 
FullScreen 
Clear 
PasteText 
SwitchApplicationLanguage 

Definition at line 124 of file kstandardaction.h.


Function Documentation

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

Display the application's About box.

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

Display the About KDE dialog.

QList< StandardAction > KStandardAction::actionIds (  ) 

Returns a list of all actionIds.

Since:
4.2
KAction * KStandardAction::actualSize ( const QObject *  recvr,
const char *  slot,
QObject *  parent 
)

View the document at its actual size.

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

Add the current page to the bookmarks tree.

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

Move back (web style menu).

static KAction* KStandardAction::buildAutomaticAction ( QObject *  parent,
StandardAction  id,
const char *  slot 
) [static]

Definition at line 465 of file kstandardaction.cpp.

KAction * 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 intened 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() {}
 };
KAction * KStandardAction::clear ( const QObject *  recvr,
const char *  slot,
QObject *  parent 
)

Clear the content of the focus widget.

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

Close the current document.

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

The Configure Notifications dialog.

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

The Customize Toolbar dialog.

KAction * KStandardAction::copy ( QObject *  parent  ) 

Copy selected area and store it in the clipboard.

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

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

Copy the selected area into the clipboard.

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

Creates an action corresponding to the KStandardAction::StandardAction enum.

KAction * KStandardAction::cut ( QObject *  parent  ) 

Cut selected area and store it in the clipboard.

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

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

Cut selected area and store it in the clipboard.

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

Deselect any selected elements in the current document.

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

Move back (document style menu).

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

Move forward (document style menu).

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

Edit the application bookmarks.

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

Initiate a 'find' request in the current document.

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

Find the next instance of a stored 'find'.

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

Find a previous instance of a stored 'find'.

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

Jump to the first page.

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

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

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

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

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

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

KAction * 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.

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

Go to somewhere in general.

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

Go to a specific line (dialog).

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

Go to a specific page (dialog).

KAction * KStandardAction::help ( const QObject *  recvr,
const char *  slot,
QObject *  parent 
)

Display the help.

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

Display the help contents.

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

Go to the "Home" position or document.

KAction * KStandardAction::keyBindings ( 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 KXMLGUIFactory's function: KStandardAction::keyBindings(guiFactory(), SLOT(configureShortcuts()), actionCollection());

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

Jump to the last page.

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

Mail this document.

const char * KStandardAction::name ( StandardAction  id  ) 

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

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

Scroll down one page.

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

Open an existing file.

KAction * 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 KUrl & ).

Parameters:
recvr object to receive slot
slot The SLOT to invoke when a URL is selected. The slot's signature is slotURLSelected( const KUrl & ).
parent parent widget
KAction * KStandardAction::paste ( QObject *  parent  ) 

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

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

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

KAction * KStandardAction::pasteText ( 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.

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

Display the preferences/options dialog.

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

Print the current document.

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

Show a print preview of the current document.

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

Scroll up one page.

KAction * 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).

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

Redisplay or redraw the document.

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

Redo the last operation.

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

Find and replace matches.

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

Open up the Report Bug dialog.

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

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

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

Save the current document.

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

Save the current document under a different name.

KAction * KStandardAction::saveOptions ( const QObject *  recvr,
const char *  slot,
QObject *  parent 
)

Display the save options dialog.

KAction * KStandardAction::selectAll ( QObject *  parent  ) 

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

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

Select all elements in the current document.

KStandardShortcut::StandardShortcut KStandardAction::shortcutForActionId ( StandardAction  id  ) 

Returns the standardshortcut associated with actionId.

Parameters:
actionId The actionId whose associated shortcut is wanted.
Since:
4.2
KToggleAction * KStandardAction::showMenubar ( const QObject *  recvr,
const char *  slot,
QObject *  parent 
)

Show/Hide the menubar.

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

Show/Hide the statusbar.

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

Pop up the spell checker.

KDE_DEPRECATED const char* KStandardAction::stdName ( StandardAction  act_enum  )  [inline]
Deprecated:
use name()

Definition at line 179 of file kstandardaction.h.

QStringList KStandardAction::stdNames (  ) 

Returns a list of all standard names.

Used by KAccelManager to give those heigher weight.

KAction* KStandardAction::switchApplicationLanguage ( const QObject *  recvr,
const char *  slot,
QObject *  parent 
)

Definition at line 615 of file kstandardaction.cpp.

KAction * KStandardAction::tipOfDay ( const QObject *  recvr,
const char *  slot,
QObject *  parent 
)

Display "Tip of the Day".

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

Undo the last operation.

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

Move up (web style menu).

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

Trigger the What's This cursor.

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

Popup a zoom dialog.

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

Zoom in.

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

Zoom out.

KDEUI

Skip menu "KDEUI"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUtils
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.6.1
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal