KStdAction Namespace Reference
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
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>
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 } |
Functions | |
QStringList | stdNames () |
KAction * | create (StdAction id, const char *name, const QObject *recvr, const char *slot, KActionCollection *parent) |
const char * | name (StdAction id) |
KAction * | openNew (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | open (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KRecentFilesAction * | openRecent (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | save (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | saveAs (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | revert (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | print (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | printPreview (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | close (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | mail (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | quit (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | undo (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | redo (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | cut (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | copy (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | paste (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | pasteText (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | clear (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | selectAll (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | deselect (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | find (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | findNext (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | findPrev (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | replace (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | actualSize (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | fitToPage (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | fitToWidth (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | fitToHeight (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | zoomIn (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | zoomOut (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | zoom (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | redisplay (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | up (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | back (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | forward (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | home (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | prior (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | next (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | goTo (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | gotoPage (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | gotoLine (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | firstPage (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | lastPage (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | addBookmark (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | editBookmarks (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | spelling (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KToggleAction * | showMenubar (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KToggleAction * | showToolbar (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) KDE_DEPRECATED |
KToggleToolBarAction * | showToolbar (const char *toolBarName, KActionCollection *parent, const char *name=0) KDE_DEPRECATED |
KToggleAction * | showStatusbar (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KToggleFullScreenAction * | fullScreen (const QObject *recvr, const char *slot, KActionCollection *parent, QWidget *window, const char *name=0) |
KAction * | saveOptions (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | keyBindings (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | preferences (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | configureToolbars (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | configureNotifications (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | help (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | helpContents (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | whatsThis (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | tipOfDay (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | reportBug (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | aboutApp (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | aboutKDE (const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0) |
KAction * | create (StdAction id, const QObject *recvr, const char *slot, KActionCollection *parent) |
KAction * | action (StdAction act_enum, const QObject *recvr, const char *slot, KActionCollection *parent, const char *name=0L) |
const char * | stdName (StdAction act_enum) |
Enumeration Type Documentation
|
The standard menubar and toolbar actions.
Definition at line 122 of file kstdaction.h. |
Function Documentation
|
Display the application's About box.
Definition at line 314 of file kstdaction.cpp. |
|
Display the About KDE dialog.
Definition at line 316 of file kstdaction.cpp. |
|
Definition at line 180 of file kstdaction.h. |
|
View the document at its actual size.
Definition at line 188 of file kstdaction.cpp. |
|
Add the current page to the bookmarks tree.
Definition at line 226 of file kstdaction.cpp. |
|
Move back (web style menu).
Definition at line 206 of file kstdaction.cpp. |
|
Clear the content of the focus widget.
Definition at line 174 of file kstdaction.cpp. |
|
Close the current document.
Definition at line 156 of file kstdaction.cpp. |
|
The Configure Notifications dialog.
Definition at line 302 of file kstdaction.cpp. |
|
The Customize Toolbar dialog.
Definition at line 300 of file kstdaction.cpp. |
|
Copy the selected area into the clipboard.
Definition at line 168 of file kstdaction.cpp. |
|
Creates an action corresponding to the KStdAction::StdAction enum.
Definition at line 43 of file kstdaction.cpp. |
|
Cut selected area and store it in the clipboard.
Definition at line 166 of file kstdaction.cpp. |
|
Deselect any selected elements in the current document.
Definition at line 178 of file kstdaction.cpp. |
|
Edit the application bookmarks.
Definition at line 228 of file kstdaction.cpp. |
|
Initiate a 'find' request in the current document.
Definition at line 180 of file kstdaction.cpp. |
|
Find the next instance of a stored 'find'.
Definition at line 182 of file kstdaction.cpp. |
|
Find a previous instance of a stored 'find'.
Definition at line 184 of file kstdaction.cpp. |
|
Jump to the first page.
Definition at line 222 of file kstdaction.cpp. |
|
Fit the document view to the height of the current window.
Definition at line 194 of file kstdaction.cpp. |
|
Fit the document view to the size of the current window.
Definition at line 190 of file kstdaction.cpp. |
|
Fit the document view to the width of the current window.
Definition at line 192 of file kstdaction.cpp. |
|
Move forward (web style menu).
Definition at line 208 of file kstdaction.cpp. |
|
Switch to/from full screen mode.
Definition at line 285 of file kstdaction.cpp. |
|
Go to somewhere in general.
Definition at line 216 of file kstdaction.cpp. |
|
Go to a specific line (dialog).
Definition at line 220 of file kstdaction.cpp. |
|
Go to a specific page (dialog).
Definition at line 218 of file kstdaction.cpp. |
|
Display the help.
Definition at line 304 of file kstdaction.cpp. |
|
Display the help contents.
Definition at line 306 of file kstdaction.cpp. |
|
Go to the "Home" position or document.
Definition at line 210 of file kstdaction.cpp. |
|
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()); Definition at line 296 of file kstdaction.cpp. |
|
Jump to the last page.
Definition at line 224 of file kstdaction.cpp. |
|
Mail this document.
Definition at line 158 of file kstdaction.cpp. |
|
This will return the internal name of a given standard action.
Definition at line 134 of file kstdaction.cpp. |
|
Scroll down one page.
Definition at line 214 of file kstdaction.cpp. |
|
Open an existing file.
Definition at line 142 of file kstdaction.cpp. |
|
Create a new document or window.
Definition at line 140 of file kstdaction.cpp. |
|
Open a recently used document. The signature of the slot being called is of the form slotURLSelected( const KURL & ).
Definition at line 144 of file kstdaction.cpp. |
|
Paste the contents of clipboard at the current mouse or cursor position.
Definition at line 170 of file kstdaction.cpp. |
|
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.
Definition at line 172 of file kstdaction.cpp. |
|
Display the preferences/options dialog.
Definition at line 298 of file kstdaction.cpp. |
|
Print the current document.
Definition at line 152 of file kstdaction.cpp. |
|
Show a print preview of the current document.
Definition at line 154 of file kstdaction.cpp. |
|
Scroll up one page.
Definition at line 212 of file kstdaction.cpp. |
|
Quit the program.
Definition at line 160 of file kstdaction.cpp. |
|
Redisplay or redraw the document.
Definition at line 202 of file kstdaction.cpp. |
|
Redo the last operation.
Definition at line 164 of file kstdaction.cpp. |
|
Find and replace matches.
Definition at line 186 of file kstdaction.cpp. |
|
Open up the Report Bug dialog.
Definition at line 312 of file kstdaction.cpp. |
|
Revert the current document to the last saved version (essentially will undo all changes).
Definition at line 150 of file kstdaction.cpp. |
|
Save the current document.
Definition at line 146 of file kstdaction.cpp. |
|
Save the current document under a different name.
Definition at line 148 of file kstdaction.cpp. |
|
Display the save options dialog.
Definition at line 294 of file kstdaction.cpp. |
|
Select all elements in the current document.
Definition at line 176 of file kstdaction.cpp. |
|
Show/Hide the menubar.
Definition at line 233 of file kstdaction.cpp. |
|
Show/Hide the statusbar.
Definition at line 268 of file kstdaction.cpp. |
|
Definition at line 260 of file kstdaction.cpp. |
|
Definition at line 249 of file kstdaction.cpp. |
|
Pop up the spell checker.
Definition at line 230 of file kstdaction.cpp. |
|
Definition at line 191 of file kstdaction.h. |
|
Returns a list of all standard names. Used by KAccelManager to give those heigher weight.
Definition at line 38 of file kstdaction.cpp. |
|
Display "Tip of the Day".
Definition at line 310 of file kstdaction.cpp. |
|
Undo the last operation.
Definition at line 162 of file kstdaction.cpp. |
|
Move up (web style menu).
Definition at line 204 of file kstdaction.cpp. |
|
Trigger the What's This cursor.
Definition at line 308 of file kstdaction.cpp. |
|
Popup a zoom dialog.
Definition at line 200 of file kstdaction.cpp. |
|
Zoom in.
Definition at line 196 of file kstdaction.cpp. |
|
Zoom out.
Definition at line 198 of file kstdaction.cpp. |