KDE 4.0 API Reference KDEUI
KStandardAction 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 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 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());
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 | |
| QStringList | stdNames () |
| KAction * | create (StandardAction id, const QObject *recvr, const char *slot, QObject *parent) |
| const char * | name (StandardAction id) |
| KAction * | openNew (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | open (const QObject *recvr, const char *slot, QObject *parent) |
| KRecentFilesAction * | openRecent (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 * | revert (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 * | close (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | mail (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | quit (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | undo (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | redo (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | cut (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | copy (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | paste (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | pasteText (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | clear (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | selectAll (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | deselect (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 * | replace (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | actualSize (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 * | fitToHeight (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) |
| KAction * | zoom (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | redisplay (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | up (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | back (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | forward (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | home (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | prior (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | next (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | goTo (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | gotoPage (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | gotoLine (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | firstPage (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | lastPage (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 * | addBookmark (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | editBookmarks (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | spelling (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | buildAutomaticAction (QObject *parent, StandardAction id, const char *slot) |
| KAction * | cut (QObject *parent) |
| KAction * | copy (QObject *parent) |
| KAction * | paste (QObject *parent) |
| KAction * | clear (QObject *parent) |
| KAction * | selectAll (QObject *parent) |
| KToggleAction * | showMenubar (const QObject *recvr, const char *slot, QObject *parent) |
| KToggleAction * | showStatusbar (const QObject *recvr, const char *slot, QObject *parent) |
| KToggleFullScreenAction * | fullScreen (const QObject *recvr, const char *slot, QWidget *window, QObject *parent) |
| KAction * | saveOptions (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | keyBindings (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | preferences (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | configureToolbars (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | configureNotifications (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 * | whatsThis (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | tipOfDay (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | reportBug (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | switchApplicationLanguage (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | aboutApp (const QObject *recvr, const char *slot, QObject *parent) |
| KAction * | aboutKDE (const QObject *recvr, const char *slot, QObject *parent) |
| const char * | stdName (StandardAction act_enum) |
Enumeration Type Documentation
The standard menubar and toolbar actions.
- Enumerator:
Definition at line 122 of file kstandardaction.h.
Function Documentation
| KAction* KStandardAction::buildAutomaticAction | ( | QObject * | parent, | |
| StandardAction | id, | |||
| const char * | slot | |||
| ) |
Definition at line 444 of file kstandardaction.cpp.
Clear selected area.
Calls clear() on the widget with the current focus. Note that for some widgets, this may not provide the intended bahavior. 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() {} };
Definition at line 473 of file kstandardaction.cpp.
Copy selected area and store it in the clipboard.
Calls copy() on the widget with the current focus.
Definition at line 463 of file kstandardaction.cpp.
| KAction * KStandardAction::create | ( | StandardAction | id, | |
| const QObject * | recvr, | |||
| const char * | slot, | |||
| QObject * | parent | |||
| ) |
Creates an action corresponding to the KStandardAction::StandardAction enum.
Definition at line 61 of file kstandardaction.cpp.
Cut selected area and store it in the clipboard.
Calls cut() on the widget with the current focus.
Definition at line 458 of file kstandardaction.cpp.
Cut selected area and store it in the clipboard.
Definition at line 269 of file kstandardaction.cpp.
Deselect any selected elements in the current document.
Definition at line 299 of file kstandardaction.cpp.
Initiate a 'find' request in the current document.
Definition at line 304 of file kstandardaction.cpp.
| KAction * KStandardAction::fitToHeight | ( | const QObject * | recvr, | |
| const char * | slot, | |||
| QObject * | parent | |||
| ) |
Fit the document view to the height of the current window.
Definition at line 339 of file kstandardaction.cpp.
Fit the document view to the size of the current window.
Definition at line 329 of file kstandardaction.cpp.
| KAction * KStandardAction::fitToWidth | ( | const QObject * | recvr, | |
| const char * | slot, | |||
| QObject * | parent | |||
| ) |
Fit the document view to the width of the current window.
Definition at line 334 of file kstandardaction.cpp.
| KToggleFullScreenAction * KStandardAction::fullScreen | ( | const QObject * | recvr, | |
| const char * | slot, | |||
| QWidget * | window, | |||
| QObject * | parent | |||
| ) |