KDEUI
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 (const QObject *recvr, const char *slot, QObject *parent) |
KAction * | clear (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 (const QObject *recvr, const char *slot, QObject *parent) |
KAction * | copy (QObject *parent) |
KAction * | create (StandardAction id, const QObject *recvr, const char *slot, QObject *parent) |
KAction * | cut (const QObject *recvr, const char *slot, QObject *parent) |
KAction * | cut (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 (const QObject *recvr, const char *slot, QObject *parent) |
KAction * | paste (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 (const QObject *recvr, const char *slot, QObject *parent) |
KAction * | selectAll (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) |
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:
You could drop that and replace it with:
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:
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:
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:
Enumeration Type Documentation
The standard menubar and toolbar actions.
Definition at line 125 of file kstandardaction.h.
Function Documentation
Display the application's About box.
Definition at line 626 of file kstandardaction.cpp.
Display the About KDE dialog.
Definition at line 631 of file kstandardaction.cpp.
QList< StandardAction > KStandardAction::actionIds | ( | ) |
KAction * KStandardAction::actualSize | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
View the document at its actual size.
Definition at line 349 of file kstandardaction.cpp.
KAction * KStandardAction::addBookmark | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Add the current page to the bookmarks tree.
Definition at line 454 of file kstandardaction.cpp.
Move back (web style menu).
Definition at line 394 of file kstandardaction.cpp.
|
static |
Definition at line 469 of file kstandardaction.cpp.
Clear the content of the focus widget.
Definition at line 314 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:
Definition at line 509 of file kstandardaction.cpp.
Close the current document.
Definition at line 269 of file kstandardaction.cpp.
KAction * KStandardAction::configureNotifications | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
The Configure Notifications dialog.
Definition at line 591 of file kstandardaction.cpp.
KAction * KStandardAction::configureToolbars | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
The Customize Toolbar dialog.
Definition at line 586 of file kstandardaction.cpp.
Copy the selected area into the clipboard.
Definition at line 299 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 499 of file kstandardaction.cpp.
KAction * KStandardAction::create | ( | StandardAction | id, |
const QObject * | recvr, | ||
const char * | slot, | ||
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).
Definition at line 82 of file kstandardaction.cpp.
Cut selected area and store it in the clipboard.
Definition at line 294 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 494 of file kstandardaction.cpp.
Deselect any selected elements in the current document.
Definition at line 324 of file kstandardaction.cpp.
KAction * KStandardAction::documentBack | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Move back (document style menu).
Definition at line 444 of file kstandardaction.cpp.
KAction * KStandardAction::documentForward | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Move forward (document style menu).
Definition at line 449 of file kstandardaction.cpp.
KAction * KStandardAction::editBookmarks | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Edit the application bookmarks.
Definition at line 459 of file kstandardaction.cpp.
Initiate a 'find' request in the current document.
Definition at line 329 of file kstandardaction.cpp.
Find the next instance of a stored 'find'.
Definition at line 334 of file kstandardaction.cpp.
Find a previous instance of a stored 'find'.
Definition at line 339 of file kstandardaction.cpp.
Jump to the first page.
Definition at line 434 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 364 of file kstandardaction.cpp.
Fit the document view to the size of the current window.
Definition at line 354 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 359 of file kstandardaction.cpp.
Move forward (web style menu).
Definition at line 399 of file kstandardaction.cpp.
KToggleFullScreenAction * KStandardAction::fullScreen | ( | const QObject * | recvr, |
const char * | slot, | ||
QWidget * | window, | ||
QObject * | parent | ||
) |
Switch to/from full screen mode.
Definition at line 562 of file kstandardaction.cpp.
Go to somewhere in general.
Definition at line 419 of file kstandardaction.cpp.
Go to a specific line (dialog).
Definition at line 429 of file kstandardaction.cpp.
Go to a specific page (dialog).
Definition at line 424 of file kstandardaction.cpp.
Display the help.
Definition at line 596 of file kstandardaction.cpp.
KAction * KStandardAction::helpContents | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Display the help contents.
Definition at line 601 of file kstandardaction.cpp.
Go to the "Home" position or document.
Definition at line 404 of file kstandardaction.cpp.
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());
Definition at line 576 of file kstandardaction.cpp.
Jump to the last page.
Definition at line 439 of file kstandardaction.cpp.
Mail this document.
Definition at line 274 of file kstandardaction.cpp.
const char * KStandardAction::name | ( | StandardAction | id | ) |
This will return the internal name of a given standard action.
Definition at line 223 of file kstandardaction.cpp.
Scroll down one page.
Definition at line 414 of file kstandardaction.cpp.
Open an existing file.
Definition at line 234 of file kstandardaction.cpp.
Create a new document or window.
Definition at line 229 of file kstandardaction.cpp.
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
Definition at line 239 of file kstandardaction.cpp.
Paste the contents of clipboard at the current mouse or cursor position.
Definition at line 304 of file kstandardaction.cpp.
Paste the contents of clipboard at the current mouse or cursor Calls paste() on the widget with the current focus.
Definition at line 504 of file kstandardaction.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 309 of file kstandardaction.cpp.
KAction * KStandardAction::preferences | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Display the preferences/options dialog.
Definition at line 581 of file kstandardaction.cpp.
Print the current document.
Definition at line 259 of file kstandardaction.cpp.
KAction * KStandardAction::printPreview | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Show a print preview of the current document.
Definition at line 264 of file kstandardaction.cpp.
Scroll up one page.
Definition at line 409 of file kstandardaction.cpp.
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).
Definition at line 279 of file kstandardaction.cpp.
Redisplay or redraw the document.
Definition at line 384 of file kstandardaction.cpp.
Redo the last operation.
Definition at line 289 of file kstandardaction.cpp.
Find and replace matches.
Definition at line 344 of file kstandardaction.cpp.
Open up the Report Bug dialog.
Definition at line 616 of file kstandardaction.cpp.
Revert the current document to the last saved version (essentially will undo all changes).
Definition at line 254 of file kstandardaction.cpp.
Save the current document.
Definition at line 244 of file kstandardaction.cpp.
Save the current document under a different name.
Definition at line 249 of file kstandardaction.cpp.
KAction * KStandardAction::saveOptions | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Display the save options dialog.
Definition at line 571 of file kstandardaction.cpp.
Select all elements in the current document.
Definition at line 319 of file kstandardaction.cpp.
Calls selectAll() on the widget with the current focus.
Definition at line 514 of file kstandardaction.cpp.
KStandardShortcut::StandardShortcut KStandardAction::shortcutForActionId | ( | StandardAction | id | ) |
Returns the standardshortcut associated with actionId.
- Parameters
-
actionId The actionId whose associated shortcut is wanted.
- Since
- 4.2
Definition at line 75 of file kstandardaction.cpp.
KToggleAction * KStandardAction::showMenubar | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Show/Hide the menubar.
Definition at line 519 of file kstandardaction.cpp.
KToggleAction * KStandardAction::showStatusbar | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Show/Hide the statusbar.
Definition at line 542 of file kstandardaction.cpp.
Pop up the spell checker.
Definition at line 464 of file kstandardaction.cpp.
|
inline |
Definition at line 193 of file kstandardaction.h.
QStringList KStandardAction::stdNames | ( | ) |
Returns a list of all standard names.
Used by KAccelManager to give those heigher weight.
Definition at line 58 of file kstandardaction.cpp.
KAction* KStandardAction::switchApplicationLanguage | ( | const QObject * | recvr, |
const char * | slot, | ||
QObject * | parent | ||
) |
Definition at line 621 of file kstandardaction.cpp.
Display "Tip of the Day".
Definition at line 611 of file kstandardaction.cpp.
Undo the last operation.
Definition at line 284 of file kstandardaction.cpp.
Move up (web style menu).
Definition at line 389 of file kstandardaction.cpp.
Trigger the What's This cursor.
Definition at line 606 of file kstandardaction.cpp.
Popup a zoom dialog.
Definition at line 379 of file kstandardaction.cpp.
Zoom in.
Definition at line 369 of file kstandardaction.cpp.
Zoom out.
Definition at line 374 of file kstandardaction.cpp.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:49:18 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.