KDE 4.5 PyKDE API Reference
KStandardAction Namespace Reference
from PyKDE4.kdeui.KStandardAction import *
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:\n
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\n
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());
Enumerations | |
| 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 (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | aboutKDE (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| [KStandardAction.StandardAction] | actionIds () |
| KAction | actualSize (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | addBookmark (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | back (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | clear (QObject parent) |
| KAction | clear (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | close (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | configureNotifications (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | configureToolbars (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | copy (QObject parent) |
| KAction | copy (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | create (KStandardAction.StandardAction id, SIP_RXOBJ_CON a1, SIP_SLOT_CON () a2, QObject parent) |
| KAction | cut (QObject parent) |
| KAction | cut (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | deselect (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | documentBack (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | documentForward (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | editBookmarks (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | find (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | findNext (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | findPrev (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | firstPage (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | fitToHeight (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | fitToPage (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | fitToWidth (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | forward (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KToggleFullScreenAction | fullScreen (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QWidget window, QObject parent) |
| KAction | goTo (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | gotoLine (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | gotoPage (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | help (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | helpContents (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | home (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | keyBindings (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | lastPage (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | mail (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| QString | name (KStandardAction.StandardAction id) |
| KAction | next (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | open (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | openNew (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KRecentFilesAction | openRecent (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | paste (QObject parent) |
| KAction | paste (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | pasteText (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | preferences (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | print_ (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | printPreview (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | prior (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | quit (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | redisplay (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | redo (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | replace (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | reportBug (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | revert (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | save (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | saveAs (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | saveOptions (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | selectAll (QObject parent) |
| KAction | selectAll (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KStandardShortcut.StandardShortcut | shortcutForActionId (KStandardAction.StandardAction id) |
| KToggleAction | showMenubar (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KToggleAction | showStatusbar (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | spelling (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| QString | stdName (KStandardAction.StandardAction act_enum) |
| QStringList | stdNames () |
| KAction | tipOfDay (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | undo (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | up (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | whatsThis (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | zoom (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | zoomIn (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
| KAction | zoomOut (SIP_RXOBJ_CON a0, SIP_SLOT_CON () a1, QObject parent) |
Enumeration Documentation
| 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
Function Documentation
Display the application's About box.
Display the About KDE dialog.
| [KStandardAction.StandardAction] actionIds | ( | ) |
Returns a list of all actionIds.
- Since:
- 4.2
View the document at its actual size.
Add the current page to the bookmarks tree.
Clear the content of the focus widget
The Configure Notifications dialog.
The Customize Toolbar dialog.
Copy the selected area into the clipboard.
| KAction create | ( | KStandardAction.StandardAction | id, | |
| SIP_RXOBJ_CON | a1, | |||
| SIP_SLOT_CON () | a2, | |||
| QObject | parent | |||
| ) |
Creates an action corresponding to one of the KStandardAction.StandardAction actions, which is connected to the given object and slot, and is owned by parent.
The signal that is connected to slot is triggered(bool), except for the case of OpenRecent standard action, which uses the urlSelected(const KUrl &) signal of KRecentFilesAction.
- Parameters:
-
id The StandardAction identifier to create a KAction for. recvr The QObject to receive the signal, or 0 if no notification is needed. slot The slot to connect the signal to (remember to use the SLOT() macro). parent The QObject that should own the created KAction, or 0 if no parent will own the KAction returned (ensure you delete it manually in this case).
Cut selected area and store it in the clipboard.
Deselect any selected elements in the current document.
Move back (document style menu).
Move forward (document style menu).
Edit the application bookmarks.
Initiate a 'find' request in the current document.
Find the next instance of a stored 'find'.
Find a previous instance of a stored 'find'.
Fit the document view to the height of the current window.
Fit the document view to the size of the current window.
Fit the document view to the width of the current window.
Move forward (web style menu).
| KToggleFullScreenAction fullScreen | ( | SIP_RXOBJ_CON | a0, | |
| SIP_SLOT_CON () | a1, | |||
| QWidget | window, | |||
| QObject | parent | |||
| ) |
Switch to/from full screen mode
Go to a specific line (dialog).
Go to a specific page (dialog).
Display the help contents.
Go to the "Home" position or document.
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());
| QString name | ( | KStandardAction.StandardAction | id | |
| ) |
This will return the internal name of a given standard action.
Create a new document or window.
| KRecentFilesAction openRecent | ( | SIP_RXOBJ_CON | a0, | |
| SIP_SLOT_CON () | a1, | |||
| 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
Paste the contents of clipboard at the current mouse or cursor position.
Paste the contents of clipboard at the current mouse or cursor position.
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.
Display the preferences/options dialog.
Show a print preview of the current document.
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).
Redisplay or redraw the document.
Open up the Report Bug dialog.
Revert the current document to the last saved version (essentially will undo all changes).
Save the current document under a different name.
Display the save options dialog.
Select all elements in the current document.
| KStandardShortcut.StandardShortcut shortcutForActionId | ( | KStandardAction.StandardAction | id | |
| ) |
Returns the standardshortcut associated with actionId.
- Parameters:
-
actionId The actionId whose associated shortcut is wanted.
- Since:
- 4.2
| KToggleAction showMenubar | ( | SIP_RXOBJ_CON | a0, | |
| SIP_SLOT_CON () | a1, | |||
| QObject | parent | |||
| ) |
Show/Hide the menubar.
| KToggleAction showStatusbar | ( | SIP_RXOBJ_CON | a0, | |
| SIP_SLOT_CON () | a1, | |||
| QObject | parent | |||
| ) |
Show/Hide the statusbar.
| QString stdName | ( | KStandardAction.StandardAction | act_enum | |
| ) |
| QStringList stdNames | ( | ) |
Returns a list of all standard names. Used by KAccelManager to give those heigher weight.
Trigger the What's This cursor.
