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
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());
Enumeration Type Documentation
The standard menubar and toolbar actions.
- Enumerator:
Definition at line 124 of file kstandardaction.h.
Function Documentation
Display the application's About box.
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.
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.
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:
Clear the content of the focus widget.
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.
Copy selected area and store it in the clipboard.
Calls copy() on the widget with the current focus.
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.
Cut selected area and store it in the clipboard.
Calls cut() on the widget with the current focus.
Cut selected area and store it in the clipboard.
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.
Initiate a 'find' request in the current document.
Find the next instance of a stored 'find'.
Find a previous instance of a stored 'find'.
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.
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.
Move forward (web style menu).
KToggleFullScreenAction * KStandardAction::fullScreen | ( | const QObject * | recvr, | |
const char * | slot, | |||
QWidget * | window, | |||
QObject * | parent | |||
) |
Switch to/from full screen mode.
Go to somewhere in general.
Go to a specific line (dialog).
Go to a specific page (dialog).
Display the help.
KAction * KStandardAction::helpContents | ( | const QObject * | recvr, | |
const char * | slot, | |||
QObject * | parent | |||
) |
Display the help contents.
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());
Jump to the last page.
Mail this document.
const char * KStandardAction::name | ( | StandardAction | id | ) |
This will return the internal name of a given standard action.
Scroll down one page.
Open an existing file.
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
Paste the contents of clipboard at the current mouse or cursor Calls paste() on the widget with the current focus.
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.
KAction * KStandardAction::preferences | ( | const QObject * | recvr, | |
const char * | slot, | |||
QObject * | parent | |||
) |
Display the preferences/options dialog.
Print the current document.
KAction * KStandardAction::printPreview | ( | const QObject * | recvr, | |
const char * | slot, | |||
QObject * | parent | |||
) |
Show a print preview of the current document.
Scroll up one page.
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.
Redo the last operation.
Find and replace matches.
Open up the Report Bug dialog.
Revert the current document to the last saved version (essentially will undo all changes).
Save the current document.
Save the current document under a different name.
KAction * KStandardAction::saveOptions | ( | const QObject * | recvr, | |
const char * | slot, | |||
QObject * | parent | |||
) |
Display the save options dialog.
Calls selectAll() on the widget with the current focus.
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.
Pop up the spell checker.
KDE_DEPRECATED const char* KStandardAction::stdName | ( | StandardAction | act_enum | ) | [inline] |
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.
Display "Tip of the Day".
Undo the last operation.
Move up (web style menu).
Trigger the What's This cursor.
Popup a zoom dialog.
Zoom in.