#include <kapplication.h>
Inheritance diagram for KApplication:

Public Types | |
| enum | ShutdownConfirm { ShutdownConfirmDefault = -1, ShutdownConfirmNo = 0, ShutdownConfirmYes = 1 } |
| enum | ShutdownType { ShutdownTypeDefault = -1, ShutdownTypeNone = 0, ShutdownTypeReboot = 1, ShutdownTypeHalt = 2 } |
| enum | ShutdownMode { ShutdownModeDefault = -1, ShutdownModeSchedule = 0, ShutdownModeTryNow = 1, ShutdownModeForceNow = 2, ShutdownModeInteractive = 3 } |
| enum | SettingsCategory |
Public Slots | |
| void | invokeBrowser (const QString &url) |
| void | ref () |
| void | deref () |
Signals | |
| void | kdisplayPaletteChanged () |
| void | kdisplayStyleChanged () |
| void | kdisplayFontChanged () |
| void | appearanceChanged () |
| void | toolbarAppearanceChanged (int) |
| void | backgroundChanged (int desk) |
| void | settingsChanged (int category) |
| void | iconChanged (int group) |
| void | kipcMessage (int id, int data) |
| void | saveYourself () |
| void | shutDown () |
Public Methods | |
| KApplication (bool allowStyles=true, bool GUIenabled=true) | |
| KApplication (Display *display, int &argc, char **argv, const QCString &rAppName, bool allowStyles=true, bool GUIenabled=true) | |
| KApplication (int &argc, char **argv, const QCString &rAppName, bool allowStyles=true, bool GUIenabled=true) | |
| KConfig * | sessionConfig () |
| bool | isRestored () const |
| void | disableSessionManagement () |
| bool | requestShutDown (ShutdownConfirm confirm=ShutdownConfirmDefault, ShutdownType sdtype=ShutdownTypeDefault, ShutdownMode sdmode=ShutdownModeDefault) |
| void | propagateSessionManager () |
| bool | sessionSaving () const |
| QPixmap | icon () const |
| QString | iconName () const |
| QPixmap | miniIcon () const |
| QString | miniIconName () const |
| void | setTopWidget (QWidget *topWidget) |
| void | invokeHelp (const QString &anchor=QString::null, const QString &appname=QString::null) const |
| void | invokeHTMLHelp (const QString &aFilename, const QString &aTopic=QString::null) const |
| void | invokeMailer (const QString &address, const QString &subject) |
| void | invokeMailer (const KURL &mailtoURL) |
| void | invokeMailer (const QString &to, const QString &cc, const QString &bcc, const QString &subject, const QString &body, const QString &messageFile=QString::null, const QStringList &attachURLs=QStringList()) |
| QString | caption () const |
| KStyle * | kstyle () const |
| QString | makeStdCaption (const QString &userCaption, bool withAppName=true, bool modified=false) const |
| QString | tempSaveName (const QString &pFilename) const |
| QString | checkRecoverFile (const QString &pFilename, bool &bRecover) const |
| void | enableStyles () |
| void | disableStyles () |
| void | installX11EventFilter (QWidget *filter) |
| void | addKipcEventMask (int id) |
| void | removeKipcEventMask (int id) |
| QCString | startupId () const |
| void | setStartupId (const QCString &startup_id) |
| QString | geometryArgument () const |
| void | installKDEPropertyMap () |
| bool | authorize (const QString &genericAction) |
| bool | authorizeKAction (const char *action) |
| bool | authorizeURLAction (const QString &action, const KURL &baseURL, const KURL &destURL) |
Static Public Methods | |
| void | addCmdLineOptions () |
| KApplication * | kApplication () |
| DCOPClient * | dcopClient () |
| void | disableAutoDcopRegistration () |
| QCString | launcher () |
| int | startServiceByName (const QString &_name, const QString &URL, QString *error=0, QCString *dcopService=0, int *pid=0, const QCString &startup_id="", bool noWait=false) |
| int | startServiceByName (const QString &_name, const QStringList &URLs=QStringList(), QString *error=0, QCString *dcopService=0, int *pid=0, const QCString &startup_id="", bool noWait=false) |
| int | startServiceByDesktopPath (const QString &_name, const QString &URL, QString *error=0, QCString *dcopService=0, int *pid=0, const QCString &startup_id="", bool noWait=false) |
| int | startServiceByDesktopPath (const QString &_name, const QStringList &URLs=QStringList(), QString *error=0, QCString *dcopService=0, int *pid=0, const QCString &startup_id="", bool noWait=false) |
| int | startServiceByDesktopName (const QString &_name, const QString &URL, QString *error=0, QCString *dcopService=0, int *pid=0, const QCString &startup_id="", bool noWait=false) |
| int | startServiceByDesktopName (const QString &_name, const QStringList &URLs=QStringList(), QString *error=0, QCString *dcopService=0, int *pid=0, const QCString &startup_id="", bool noWait=false) |
| int | kdeinitExec (const QString &name, const QStringList &args=QStringList(), QString *error=0, int *pid=0) |
| int | kdeinitExecWait (const QString &name, const QStringList &args=QStringList(), QString *error=0, int *pid=0) |
| int | random () |
| QString | randomString (int length) |
| uint | keyboardModifiers () |
| uint | mouseState () |
| QPalette | createApplicationPalette () |
Protected Methods | |
| virtual void | virtual_hook (int id, void *data) |
Static Protected Attributes | |
| KApplication * | KApp |
| Current application object. | |
Controls and provides information to all KDE applications.
Only one object of this class can be instantiated in a single app. This instance is always accessible via the kApplication() method.
This class provides the following services to all KDE applications.
There are three possibilities:
Definition at line 91 of file kapplication.h.
|
|
Valid values for the settingsChanged signal Definition at line 956 of file kapplication.h. |
|
|
The possible values for the
Definition at line 210 of file kapplication.h. |
|
|
The possible values for the
Definition at line 250 of file kapplication.h. |
|
|
The possible values for the
Definition at line 228 of file kapplication.h. |
|
||||||||||||
|
This constructor takes aboutData and command line arguments from KCmdLineArgs.
|
|
||||||||||||||||||||||||||||
|
Constructor. Parses command-line arguments. Use this constructor to use KApplication in a Motif or Xt program.
|
|
||||||||||||||||||||||||
|
Constructor. Parses command-line arguments.
|
|
|
Add Qt and KDE command line options to KCmdLineArgs. Reimplemented in KUniqueApplication. |
|
|
Adds a message type to the KIPC event mask. You can only add "system messages" to the event mask. These are the messages with id < 32. Messages with id >= 32 are user messages.
|
|
|
Emitted when KApplication has changed either its GUI style, its font or its palette in response to a kdisplay request. Normally, widgets will update their styles automatically, but you should connect to this to program special behavior. |
|
|
Returns whether a certain action is authorized
|
|
|
Returns whether a certain KAction is authorized.
|
|
||||||||||||||||
|
Returns whether a certain URL related action is authorized.
|
|
|
Emitted when the desktop background has been changed by
|
|
|
Returns a text for the window caption. This may be set by "-caption", otherwise it will be equivalent to the name of the executable.
|
|
||||||||||||
|
Check whether an auto-save file exists for the document you want to open.
|
|
|
Used to obtain the QPalette that will be used to set the application palette. This is only useful for configuration modules such as krdb and should not be used in normal circumstances.
|
|
|
Returns a pointer to a DCOPClient for the application. If a client does not exist yet, it is created when this function is called.
|
|
|
Tells KApplication that one operation such as those described in just finished. The application exits if the counter is back to 0. |
|
|
Disable automatic dcop registration Must be called before creating a KApplication instance to have an effect. |
|
|
Disables session management for this application. Useful in case your application is started by the initial "startkde" script. |
|
|
Disables style plugins. Current style plugins do not get unloaded. This is only useful when used in combination with enableStyles(). |
|
|
Enables style plugins. This is useful only to applications that normally do not display a GUI and create the KApplication with allowStyles set to false. |
|
|
Returns the argument to --geometry if any, so the geometry can be set wherever necessary
|
|
|
Returns a QPixmap with the application icon.
|
|
|
Emitted when the global icon settings have been changed.
|
|
|
Returns the name of the application icon.
|
|
|
Install a Qt SQL property map with entries for all KDE widgets Call this in any application using KDE widgets in QSqlForm or QDataView. |
|
|
Installs widget filter as global X11 event filter. The widget filter receives XEvents in its standard QWidget::x11Event() function. Warning: Only do this when absolutely necessary. An installed X11 filter can slow things down. |
|
|
Invokes the standard browser. Note that you should only do this when you know for sure that the browser can handle the URL (i.e. its mimetype). In doubt, if the URL can point to an image or anything else than directory or HTML, prefer to use new KRun( url ).
|
|
||||||||||||
|
Invokes the KHelpCenter HTML help viewer from docbook sources.
|
|
||||||||||||
|
|
|
||||||||||||||||||||||||||||||||
|
Convenience method; invokes the standard email application. All parameters are optional.
|
|
|
Invokes the standard email application.
|
|
||||||||||||
|
Convenience method; invokes the standard email application.
|
|
|
Is the application restored from the session manager?
Definition at line 197 of file kapplication.h. |
|
|
Returns the current application object. This is similar to the global QApplication pointer qApp. It allows access to the single global KApplication object, since more than one cannot be created in the same application. It saves you the trouble of having to pass the pointer explicitly to every function that may require it.
Definition at line 178 of file kapplication.h. References KApp. |
|
||||||||||||||||||||
|
Starts a program via kdeinit. There will be no application startup notification, so you should use it only for starting internal processes. program name and arguments are converted to according to the local encoding and passed as is to kdeinit.
|
|
||||||||||||||||||||
|
Starts a program via kdeinit and wait for it to finish. Like kdeinitExec(), but it waits till the program is finished. As such it behaves similar to the system(...) function.
|
|
|
Emitted when KApplication has changed its font in response to a KControl request. Normally widgets will update their fonts automatically, but you should connect to this to monitor global font changes, especially if you are using explicit fonts. |
|
|
Emitted when KApplication has changed its palette due to a KControl request. Normally, widgets will update their palette automatically, but you should connect to this to program special behavior. |
|
|
Emitted when KApplication has changed its GUI style in response to a KControl request. Normally, widgets will update their styles automatically (as they would respond to an explicit setGUIStyle() call), but you should connect to this to program special behavior. |
|
|
Returns the currently pressed keyboard modifiers (e.g. shift, control, etc.) Usually you simply want to test for those in key events, in which case QKeyEvent::state() does the job (or QKeyEvent::key() to notice when a modifier is pressed alone). But it can be useful to query for the status of the modifiers at another moment (e.g. some KDE apps do that upon a drop event).
|
|
||||||||||||
|
Emitted when a KIPC user message has been received.
|
|
|
Definition at line 652 of file kapplication.h. |
|
|
Returns the DCOP name of the service launcher. This will be something like klaucher_$host_$uid.
|
|
||||||||||||||||
|
Builds a caption that contains the application name along with the userCaption() using a standard layout.
To make a compliant caption for your window, simply do:
|
|
|
Returns the mini-icon for the application as a QPixmap.
|
|
|
Returns the name of the mini-icon for the application.
|
|
|
Returns the currently pressed mouse buttons. Usually you simply want to test for those in mouse events, in which case QMouseEvent::button() does the job (or QMouseEvent::state()). But it can be useful to query for the status of the mouse buttons at another moment. To query for the mouse pointer position, use QCursor::pos().
|
|
|
Propagates the network address of the session manager in the SESSION_MANAGER environment variable so that child processes can pick it up. If SESSION_MANAGER isn't defined yet, the address is searched in $HOME/.KSMserver. This function is called by clients that are started outside the session ( i.e. before ksmserver is started), but want to launch other processes that should participate in the session. Examples are kdesktop or kicker. |
|
|
Generates a uniform random number.
|
|
|
Generates a random string. It operates in the range [A-Za-z0-9]
|
|
|
Tells KApplication about one more operation that should be finished before the application exits. The standard behavior is to exit on the "last window closed" event, but some events should outlive the last window closed (e.g. a file copy for a file manager, or 'compacting folders on exit' for a mail client). |
|
|
Removes a message type from the KIPC event mask. This message will not be handled anymore.
|
|
||||||||||||||||
|
Asks the session manager to shut the session down.
Using
|
|
|
Session management asks you to save the state of your application. This signal is provided for compatibility only. For new applications, simply use KMainWindow. By reimplementing KMainWindow::queryClose(), KMainWindow::saveProperties() and KMainWindow::readProperties() you can simply handle session management for applications with multiple toplevel windows. For purposes without KMainWindow, create an instance of KSessionManaged and reimplement the functions KSessionManaged::commitData() and/or KSessionManaged::saveState() If you still want to use this signal, here is what you should do: Connect to this signal in order to save your data. Do NOT manipulate the UI in that slot, it is blocked by the session manager. Use the sessionConfig() KConfig object to store all your instance specific data. Do not do any closing at this point! The user may still select Cancel wanting to continue working with your application. Cleanups could be done after shutDown() (see the following). |
|
|
Returns the application session config object.
|
|
|
Returns true if the application is currently saving its session data (most probably before KDE logout). This is intended for use mainly in KMainWindow::queryClose() and KMainWindow::queryExit().
|
|
|
Sets a new value for the application startup notification window property for newly created toplevel windows.
|
|
|
Emitted when the global settings have been changed - see KGlobalSettings KApplication takes care of calling reparseConfiguration on KGlobal::config() so that applications/classes using this only have to re-read the configuration
|
|
|
Sets the top widget of the application. This means basically applying the right window caption and icon. An application may have several top widgets. You don't need to call this function manually when using KMainWindow.
|
|
|
Your application is killed. Either by your program itself, The signal is particularly useful if your application has to do some last-second cleanups. Note that no user interaction is possible at this state. |
|
||||||||||||||||||||||||||||||||
|
Starts a service based on the desktop name of the service. E.g. "konqueror"
|
|
||||||||||||||||||||||||||||||||
|
Starts a service based on the desktop name of the service. E.g. "konqueror"
|
|
||||||||||||||||||||||||||||||||
|
Starts a service based on the desktop path of the service. E.g. "Applications/konqueror.desktop" or "/home/user/bla/myfile.desktop"
|
|
||||||||||||||||||||||||||||||||
|
Starts a service based on the desktop path of the service. E.g. "Applications/konqueror.desktop" or "/home/user/bla/myfile.desktop"
|
|
||||||||||||||||||||||||||||||||
|
Starts a service based on the (translated) name of the service. E.g. "Web Browser"
|
|
||||||||||||||||||||||||||||||||
|
Starts a service based on the (translated) name of the service. E.g. "Web Browser"
|
|
|
Returns the app startup notification identifier for this running application.
|
|
|
Get a file name in order to make a temporary copy of your document.
|
|
|
Emitted when the settings for toolbars have been changed. KToolBar will know what to do. |
1.2.18