KStdAction Namespace Reference

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

Enumerations

enum  StdAction {
  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, AddBookmark, EditBookmarks,
  Spelling, ShowMenubar, ShowToolbar, ShowStatusbar,
  SaveOptions, KeyBindings, Preferences, ConfigureToolbars,
  Help, HelpContents, WhatsThis, ReportBug,
  AboutApp, AboutKDE, TipofDay, ConfigureNotifications,
  FullScreen, Clear, PasteText, SwitchApplicationLanguage
}

Functions

QStringList stdNames ()
KActioncreate (StdAction id, const char *name, const QObject *recvr, const char *slot, KActionCollection *parent)
const char * name (StdAction id)
KActionopenNew (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionopen (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KRecentFilesActionopenRecent (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionsave (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionsaveAs (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionrevert (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionprint (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionprintPreview (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionclose (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionmail (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionquit (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionundo (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionredo (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActioncut (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActioncopy (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionpaste (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionpasteText (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionclear (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionselectAll (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActiondeselect (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionfind (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionfindNext (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionfindPrev (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionreplace (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionactualSize (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionfitToPage (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionfitToWidth (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionfitToHeight (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionzoomIn (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionzoomOut (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionzoom (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionredisplay (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionup (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionback (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionforward (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionhome (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionprior (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionnext (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActiongoTo (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActiongotoPage (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActiongotoLine (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionfirstPage (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionlastPage (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionaddBookmark (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActioneditBookmarks (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionspelling (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KToggleActionshowMenubar (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KToggleActionshowToolbar (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) KDE_DEPRECATED
KToggleToolBarActionshowToolbar (const char *toolBarName, KActionCollection *parent, const char *name=0) KDE_DEPRECATED
KToggleActionshowStatusbar (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KToggleFullScreenActionfullScreen (const QObject *recvr, const char *slot, KActionCollection *parent, QWidget *window, const char *name=0)
KActionsaveOptions (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionkeyBindings (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionpreferences (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionconfigureToolbars (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionconfigureNotifications (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionhelp (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionhelpContents (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionwhatsThis (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActiontipOfDay (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionreportBug (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionswitchApplicationLanguage (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionaboutApp (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActionaboutKDE (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0)
KActioncreate (StdAction id, const QObject *recvr, const char *slot, KActionCollection *parent)
KActionaction (StdAction act_enum, const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0L)
const char * stdName (StdAction act_enum)

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 KStdAction also. When in doubt on how things work, check the KAction documention first.

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"), QIconSet(BarIcon("filenew")),
                               KStdAccel::shortcut(KStdAccel::New), this,
                               SLOT(fileNew()), actionCollection());

You could drop that and replace it with:

 KAction *newAct = KStdAction::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 stdName action like so: KStdAction::stdName(KStdAction::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)KStdAction::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 the 'openNew' example above... or you could do it the hard way:

 KAction *cut = actionCollection()->action(KStdAction::stdName(KStdAction::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., KStdAction::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)KStdAction::action(KStdAction::New, this, SLOT(fileNew()), actionCollection());
 (void)KStdAction::action(KStdAction::Cut, this, SLOT(editCut()), actionCollection());
Author:
Kurt Granroth <granroth@kde.org>

Enumeration Type Documentation

The standard menubar and toolbar actions.

Enumerator:
TipofDay 
Since:
3.1
FullScreen 
Since:
3.2
Clear 
Since:
3.2
PasteText 
Since:
3.2
SwitchApplicationLanguage 
Since:
3.5.8

Definition at line 122 of file kstdaction.h.


Function Documentation

KAction * KStdAction::aboutApp ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Display the application's About box.

KAction * KStdAction::aboutKDE ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Display the About KDE dialog.

KAction* KStdAction::action ( StdAction  act_enum,
const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name = 0L 
) [inline]
Deprecated:
. Creates an action corresponding to the KStdAction::StdAction enum.

Definition at line 181 of file kstdaction.h.

KAction * KStdAction::actualSize ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

View the document at its actual size.

KAction * KStdAction::addBookmark ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Add the current page to the bookmarks tree.

KAction * KStdAction::back ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Move back (web style menu).

KAction * KStdAction::clear ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name = 0 
)

Clear the content of the focus widget.

Since:
3.2
KAction * KStdAction::close ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Close the current document.

KAction * KStdAction::configureNotifications ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name = 0 
)

The Configure Notifications dialog.

Since:
3.1
KAction * KStdAction::configureToolbars ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

The Customize Toolbar dialog.

KAction * KStdAction::copy ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Copy the selected area into the clipboard.

KAction * KStdAction::create ( StdAction  id,
const char *  name,
const QObject recvr,
const char *  slot,
KActionCollection parent 
)

Creates an action corresponding to the KStdAction::StdAction enum.

KAction * KStdAction::cut ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Cut selected area and store it in the clipboard.

KAction * KStdAction::deselect ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Deselect any selected elements in the current document.

KAction * KStdAction::editBookmarks ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Edit the application bookmarks.

KAction * KStdAction::find ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Initiate a 'find' request in the current document.

KAction * KStdAction::findNext ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Find the next instance of a stored 'find'.

KAction * KStdAction::findPrev ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Find a previous instance of a stored 'find'.

KAction * KStdAction::firstPage ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Jump to the first page.

KAction * KStdAction::fitToHeight ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

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

KAction * KStdAction::fitToPage ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

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

KAction * KStdAction::fitToWidth ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

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

KAction * KStdAction::forward ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Move forward (web style menu).

KToggleFullScreenAction * KStdAction::fullScreen ( const QObject recvr,
const char *  slot,
KActionCollection parent,
QWidget window,
const char *  name = 0 
)

Switch to/from full screen mode.

Since:
3.2
KAction * KStdAction::goTo ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Go to somewhere in general.

KAction * KStdAction::gotoLine ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Go to a specific line (dialog).

KAction * KStdAction::gotoPage ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Go to a specific page (dialog).

KAction * KStdAction::help ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Display the help.

KAction * KStdAction::helpContents ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Display the help contents.

KAction * KStdAction::home ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Go to the "Home" position or document.

KAction * KStdAction::keyBindings ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name = 0 
)

Display the configure key bindings dialog.

Note that you might be able to use the pre-built KXMLGUIFactory's fuction: KStdAction::keyBindings(guiFactory(), SLOT(configureShortcuts()), actionCollection());

KAction * KStdAction::lastPage ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Jump to the last page.

KAction * KStdAction::mail ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Mail this document.

const char * KStdAction::name ( StdAction  id  ) 

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

KAction * KStdAction::next ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Scroll down one page.

KAction * KStdAction::open ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Open an existing file.

KAction * KStdAction::openNew ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Create a new document or window.

KRecentFilesAction * KStdAction::openRecent ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name = 0 
)

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
name name of widget
KAction * KStdAction::paste ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

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

KAction * KStdAction::pasteText ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name = 0 
)

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.

Since:
3.2
KAction * KStdAction::preferences ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Display the preferences/options dialog.

KAction * KStdAction::print ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Print the current document.

KAction * KStdAction::printPreview ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Show a print preview of the current document.

KAction * KStdAction::prior ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Scroll up one page.

KAction * KStdAction::quit ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Quit the program.

KAction * KStdAction::redisplay ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Redisplay or redraw the document.

KAction * KStdAction::redo ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Redo the last operation.

KAction * KStdAction::replace ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Find and replace matches.

KAction * KStdAction::reportBug ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Open up the Report Bug dialog.

KAction * KStdAction::revert ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

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

KAction * KStdAction::save ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Save the current document.

KAction * KStdAction::saveAs ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Save the current document under a different name.

KAction * KStdAction::saveOptions ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Display the save options dialog.

KAction * KStdAction::selectAll ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Select all elements in the current document.

KToggleAction * KStdAction::showMenubar ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  _name 
)

Show/Hide the menubar.

KToggleAction * KStdAction::showStatusbar ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  _name 
)

Show/Hide the statusbar.

KToggleToolBarAction * KStdAction::showToolbar ( const char *  toolBarName,
KActionCollection parent,
const char *  name = 0 
)
Deprecated:
. toolbar actions are created automatically now in the Settings menu. Don't use this anymore. See: KMainWindow::setStandardToolBarMenuEnabled(bool); Show/Hide the primary toolbar.
KToggleAction * KStdAction::showToolbar ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name = 0 
)
Deprecated:
. toolbar actions are created automatically now in the Settings menu. Don't use this anymore. See: KMainWindow::createStandardStatusBarAction() Show/Hide the primary toolbar.
Since:
3.1
KAction * KStdAction::spelling ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Pop up the spell checker.

const char* KStdAction::stdName ( StdAction  act_enum  )  [inline]
Deprecated:
. Use name()

Definition at line 192 of file kstdaction.h.

QStringList KStdAction::stdNames (  ) 

Returns a list of all standard names.

Used by KAccelManager to give those heigher weight.

Since:
3.1
KAction * KStdAction::switchApplicationLanguage ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name = 0 
)

Display "Switch application language" dialog.

Since:
3.5.8
KAction * KStdAction::tipOfDay ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name = 0 
)

Display "Tip of the Day".

Since:
3.1
KAction * KStdAction::undo ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Undo the last operation.

KAction * KStdAction::up ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Move up (web style menu).

KAction * KStdAction::whatsThis ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Trigger the What's This cursor.

KAction * KStdAction::zoom ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Popup a zoom dialog.

KAction * KStdAction::zoomIn ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Zoom in.

KAction * KStdAction::zoomOut ( const QObject recvr,
const char *  slot,
KActionCollection parent,
const char *  name 
)

Zoom out.

KDE Home | KDE Accessibility Home | Description of Access Keys