• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • kdecore
 

kdecore

Public Types | Public Slots | Signals | Public Member Functions | Static Public Member Functions | Static Public Attributes | Protected Member Functions | Protected Attributes | Static Protected Attributes | List of all members
KApplication Class Reference

#include <kapplication.h>

Inheritance diagram for KApplication:
KInstance KUniqueApplication

Public Types

enum  CaptionLayout { CaptionAppLast =1, CaptionAppFirst, CaptionNoApp }
 
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  {
  ShiftModifier = 1<<0, LockModifier = 1<<1, ControlModifier = 1<<2, Modifier1 = 1<<3,
  Modifier2 = 1<<4, Modifier3 = 1<<5, Modifier4 = 1<<6, Modifier5 = 1<<7
}
 
enum  {
  Button1Pressed = 1<<8, Button2Pressed = 1<<9, Button3Pressed = 1<<10, Button4Pressed = 1<<11,
  Button5Pressed = 1<<12
}
 
enum  SettingsCategory {
  SETTINGS_MOUSE, SETTINGS_COMPLETION, SETTINGS_PATHS, SETTINGS_POPUPMENU,
  SETTINGS_QT, SETTINGS_SHORTCUTS
}
 

Public Slots

void invokeBrowser (const TQString &url, const TQCString &startup_id)
 
void invokeBrowser (const TQString &url)
 
void cut ()
 
void copy ()
 
void paste ()
 
void clear ()
 
void selectAll ()
 
void broadcastKeyCode (unsigned int keyCode)
 
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 ()
 
void updateIconLoaders ()
 
void coreFakeKeyPress (unsigned int keyCode)
 

Public Member Functions

 KApplication (bool allowStyles=true, bool GUIenabled=true, bool SMenabled=true)
 
 KApplication (int &argc, char **argv, const TQCString &rAppName, bool allowStyles=true, bool GUIenabled=true, bool SMenabled=true) KDE_DEPRECATED
 
KConfig * sessionConfig ()
 
bool isRestored () const
 
void disableSessionManagement ()
 
void enableSessionManagement ()
 
bool requestShutDown (ShutdownConfirm confirm=ShutdownConfirmDefault, ShutdownType sdtype=ShutdownTypeDefault, ShutdownMode sdmode=ShutdownModeDefault)
 
void propagateSessionManager ()
 
void commitData (TQSessionManager &sm)
 
void saveState (TQSessionManager &sm)
 
bool sessionSaving () const
 
TQPixmap icon () const
 
TQString iconName () const
 
TQPixmap miniIcon () const
 
TQString miniIconName () const
 
void setTopWidget (TQWidget *topWidget)
 
void invokeHelp (const TQString &anchor, const TQString &appname, const TQCString &startup_id) const
 
void invokeHelp (const TQString &anchor=TQString::null, const TQString &appname=TQString::null) const
 
void invokeHTMLHelp (const TQString &aFilename, const TQString &aTopic=TQString::null) const KDE_DEPRECATED
 
void invokeMailer (const TQString &address, const TQString &subject, const TQCString &startup_id)
 
void invokeMailer (const TQString &address, const TQString &subject)
 
void invokeMailer (const KURL &mailtoURL, const TQCString &startup_id, bool allowAttachments)
 
void invokeMailer (const KURL &mailtoURL, const TQCString &startup_id)
 
void invokeMailer (const KURL &mailtoURL)
 
void invokeMailer (const TQString &to, const TQString &cc, const TQString &bcc, const TQString &subject, const TQString &body, const TQString &messageFile, const TQStringList &attachURLs, const TQCString &startup_id)
 
void invokeMailer (const TQString &to, const TQString &cc, const TQString &bcc, const TQString &subject, const TQString &body, const TQString &messageFile=TQString::null, const TQStringList &attachURLs=TQStringList())
 
TQString caption () const
 
KDE_DEPRECATED KStyle * kstyle () const
 
TQString makeStdCaption (const TQString &userCaption, bool withAppName=true, bool modified=false) const
 
TQString tempSaveName (const TQString &pFilename) const
 
TQString checkRecoverFile (const TQString &pFilename, bool &bRecover) const
 
void getX11RGBAInformation (Display *dpy)
 
bool detectCompositionManagerAvailable (bool force_available=false, bool available=true)
 
Qt::HANDLE getX11RGBAVisual (Display *dpy)
 
Qt::HANDLE getX11RGBAColormap (Display *dpy)
 
bool isX11CompositionAvailable ()
 
void enableStyles ()
 
void disableStyles ()
 
void installX11EventFilter (TQWidget *filter)
 
void removeX11EventFilter (const TQWidget *filter)
 
void addKipcEventMask (int id)
 
void removeKipcEventMask (int id)
 
TQCString startupId () const
 
void setStartupId (const TQCString &startup_id)
 
void updateUserTimestamp (unsigned long time=0)
 
unsigned long userTimestamp () const
 
void updateRemoteUserTimestamp (const TQCString &dcopId, unsigned long time=0)
 
TQString geometryArgument () const
 
void installKDEPropertyMap ()
 
bool authorize (const TQString &genericAction)
 
bool authorizeKAction (const char *action)
 
bool authorizeURLAction (const TQString &action, const KURL &baseURL, const KURL &destURL)
 
void allowURLAction (const TQString &action, const KURL &_baseURL, const KURL &_destURL)
 
bool authorizeControlModule (const TQString &menuId)
 
TQStringList authorizeControlModules (const TQStringList &menuIds)
 
bool notify (TQObject *receiver, TQEvent *event)
 
int xErrhandler (Display *, void *)
 
int xioErrhandler (Display *)
 
void iceIOErrorHandler (_IceConn *conn)
 
- Public Member Functions inherited from KInstance
 KInstance (const TQCString &instanceName)
 
 KInstance (const KAboutData *aboutData)
 
 KInstance (KInstance *src)
 
virtual ~KInstance ()
 
KStandardDirs * dirs () const
 
KConfig * config () const
 
KSharedConfig * sharedConfig () const
 
KIconLoader * iconLoader () const
 
void newIconLoader () const
 
const KAboutData * aboutData () const
 
TQCString instanceName () const
 
KMimeSourceFactory * mimeSourceFactory () const
 

Static Public Member Functions

static void addCmdLineOptions ()
 
static KApplication * kApplication ()
 
static DCOPClient * dcopClient ()
 
static void disableAutoDcopRegistration ()
 
static TQCString launcher ()
 
static int startServiceByName (const TQString &_name, const TQString &URL, TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id="", bool noWait=false)
 
static int startServiceByName (const TQString &_name, const TQStringList &URLs=TQStringList(), TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id="", bool noWait=false)
 
static int startServiceByDesktopPath (const TQString &_name, const TQString &URL, TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id="", bool noWait=false)
 
static int startServiceByDesktopPath (const TQString &_name, const TQStringList &URLs=TQStringList(), TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id="", bool noWait=false)
 
static int startServiceByDesktopName (const TQString &_name, const TQString &URL, TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id="", bool noWait=false)
 
static int startServiceByDesktopName (const TQString &_name, const TQStringList &URLs=TQStringList(), TQString *error=0, TQCString *dcopService=0, int *pid=0, const TQCString &startup_id="", bool noWait=false)
 
static int kdeinitExec (const TQString &name, const TQStringList &args, TQString *error, int *pid, const TQCString &startup_id)
 
static int kdeinitExec (const TQString &name, const TQStringList &args=TQStringList(), TQString *error=0, int *pid=0)
 
static int kdeinitExecWait (const TQString &name, const TQStringList &args, TQString *error, int *pid, const TQCString &startup_id)
 
static int kdeinitExecWait (const TQString &name, const TQStringList &args=TQStringList(), TQString *error=0, int *pid=0)
 
static bool isCompositionManagerAvailable ()
 
static Display * openX11RGBADisplay ()
 
static int random ()
 
static TQString randomString (int length)
 
static ButtonState keyboardMouseState ()
 
static uint keyboardModifiers () KDE_DEPRECATED
 
static uint mouseState () KDE_DEPRECATED
 
static void startKdeinit ()
 
static TQPalette createApplicationPalette ()
 
static TQPalette createApplicationPalette (KConfig *config, int contrast)
 
static void installSigpipeHandler ()
 
static bool guiEnabled ()
 

Static Public Attributes

static bool loadedByKdeinit = false
 

Protected Member Functions

 KApplication (bool allowStyles, bool GUIenabled, KInstance *_instance)
 
void invokeEditSlot (const char *slot)
 
virtual void virtual_hook (int id, void *data)
 
- Protected Member Functions inherited from KInstance
 KInstance (const KInstance &)
 
void setConfigName (const TQString &name)
 

Protected Attributes

Atom kipcCommAtom
 
int kipcEventMask
 
int pArgc
 

Static Protected Attributes

static KApplication * KApp = 0L
 

Detailed Description

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 'kapp' global variable. See cut() for an example.

This class provides the following services to all KDE applications.

  • It controls the event queue (see TQApplication ).
  • It provides the application with KDE resources such as accelerators, common menu entries, a KConfig object. session management events, help invocation etc.
  • Installs a signal handler for the SIGCHLD signal in order to avoid zombie children. If you want to catch this signal yourself or don't want it to be caught at all, you have set a new signal handler (or SIG_IGN) after KApplication's constructor has run.
  • Installs an empty signal handler for the SIGPIPE signal using installSigpipeHandler(). If you want to catch this signal yourself, you have set a new signal handler after KApplication's constructor has run.
  • It can start new services

The way a service gets started depends on the 'X-DCOP-ServiceType' entry in the desktop file of the service:

There are three possibilities:

  • X-DCOP-ServiceType=None (default) Always start a new service, don't wait till the service registers with dcop.
  • X-DCOP-ServiceType=Multi Always start a new service, wait until the service has registered with dcop.
  • X-DCOP-ServiceType=Unique Only start the service if it isn't already running, wait until the service has registered with dcop.

Controls and provides information to all KDE applications.

Author
Matthias Kalle Dalheimer kalle.nosp@m.@kde.nosp@m..org

Definition at line 96 of file kapplication.h.

Member Enumeration Documentation

anonymous enum
Deprecated:
Same values as Button1Mask etc.

in X.h

Definition at line 1225 of file kapplication.h.

enum KApplication::CaptionLayout

Position of the caption (presumably in the application window's title bar).

This enum appears to be unused.

Todo:
Find out if this is used anywhere.
Enumerator
CaptionAppLast 

Display the application name last (before document name).

CaptionAppFirst 

Display the application name first.

CaptionNoApp 

Do not display application name at all.

Definition at line 106 of file kapplication.h.

enum KApplication::SettingsCategory

Valid values for the settingsChanged signal.

Definition at line 1387 of file kapplication.h.

enum KApplication::ShutdownConfirm

The possible values for the confirm parameter of requestShutDown().

Enumerator
ShutdownConfirmDefault 

Obey the user's confirmation setting.

ShutdownConfirmNo 

Don't confirm, shutdown without asking.

ShutdownConfirmYes 

Always confirm, ask even if the user turned it off.

Definition at line 341 of file kapplication.h.

enum KApplication::ShutdownMode

The possible values for the sdmode parameter of requestShutDown().

Enumerator
ShutdownModeDefault 

Select previous mode or the default if it's the first time.

ShutdownModeSchedule 

Schedule a shutdown (halt or reboot) for the time all active sessions have exited.

ShutdownModeTryNow 

Shut down, if no sessions are active.

Otherwise do nothing.

ShutdownModeForceNow 

Force shutdown.

Kill any possibly active sessions.

ShutdownModeInteractive 

Pop up a dialog asking the user what to do if sessions are still active.

Definition at line 381 of file kapplication.h.

enum KApplication::ShutdownType

The possible values for the sdtype parameter of requestShutDown().

Enumerator
ShutdownTypeDefault 

Select previous action or the default if it's the first time.

ShutdownTypeNone 

Only log out.

ShutdownTypeReboot 

Log out and reboot the machine.

ShutdownTypeHalt 

Log out and halt the machine.

Definition at line 359 of file kapplication.h.

Constructor & Destructor Documentation

KApplication::KApplication ( bool  allowStyles = true,
bool  GUIenabled = true,
bool  SMenabled = true 
)

This constructor takes aboutData and command line arguments from KCmdLineArgs.

If ARGB (transparent) widgets are to be used in your application, please use KApplication app(KApplication::openX11RGBADisplay()); or KApplication app(KApplication::openX11RGBADisplay(), useStyles);

Parameters
allowStylesSet to false to disable the loading on plugin based styles. This is only useful to applications that do not display a GUI normally. If you do create an application with allowStyles set to false it normally runs in the background but under special circumstances displays widgets. Call enableStyles() before displaying any widgets.
GUIenabledSet to false to disable all GUI stuff. This implies no styles either.

Definition at line 682 of file kapplication.cpp.

KApplication::KApplication ( int &  argc,
char **  argv,
const TQCString &  rAppName,
bool  allowStyles = true,
bool  GUIenabled = true,
bool  SMenabled = true 
)
Deprecated:
do not use it at all, it will make your application crash, use KCmdLineArgs

Constructor. Parses command-line arguments.

Parameters
argccommand line argument count
argvcommand line argument value(s)
rAppNameapplication name. Will be used for finding the associated message files and icon files, and as the default registration name for DCOP. This is a mandatory parameter.
allowStylesSet to false to disable the loading on plugin based styles. This is only useful to applications that do not display a GUI normally. If you do create an application with allowStyles set to false that normally runs in the background but under special circumstances displays widgets call enableStyles() before displaying any widgets.
GUIenabledSet to false to disable all GUI stuff. This implies no styles either.

Definition at line 629 of file kapplication.cpp.

Member Function Documentation

void KApplication::addCmdLineOptions ( )
static

Add Qt and KDE command line options to KCmdLineArgs.

Definition at line 1620 of file kapplication.cpp.

void KApplication::addKipcEventMask ( int  id)

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.

Parameters
idThe message id. See KIPC::Message.
See also
KIPC
removeKipcEventMask()
kipcMessage()

Definition at line 2261 of file kapplication.cpp.

void KApplication::allowURLAction ( const TQString &  action,
const KURL &  _baseURL,
const KURL &  _destURL 
)

Allow a certain URL action.

This can be useful if your application needs to ensure access to an application specific directory that may otherwise be subject to KIOSK restrictions.

Parameters
actionThe name of the action.
_baseURLThe url where the action originates from
_destURLThe object of the action
Since
3.2

Definition at line 3489 of file kapplication.cpp.

void KApplication::appearanceChanged ( )
signal

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.

bool KApplication::authorize ( const TQString &  genericAction)

Returns whether a certain action is authorized.

Parameters
genericActionThe name of a generic action
Returns
true if the action is authorized

Definition at line 3369 of file kapplication.cpp.

bool KApplication::authorizeControlModule ( const TQString &  menuId)

Returns whether access to a certain control module is authorized.

Parameters
menuIdidentifying the control module, e.g. kde-mouse.desktop
Returns
true if access to the module is authorized, false otherwise.
Since
3.2

Definition at line 3389 of file kapplication.cpp.

TQStringList KApplication::authorizeControlModules ( const TQStringList &  menuIds)

Returns whether access to a certain control modules is authorized.

Parameters
menuIdslist of menu-ids of control module, an example of a menu-id is kde-mouse.desktop.
Returns
Those control modules for which access has been authorized.
Since
3.2

Definition at line 3398 of file kapplication.cpp.

bool KApplication::authorizeKAction ( const char *  action)

Returns whether a certain KAction is authorized.

Parameters
actionThe name of a KAction action. The name is prepended with "action/" before being passed to authorize()
Returns
true if the KAction is authorized

Definition at line 3379 of file kapplication.cpp.

bool KApplication::authorizeURLAction ( const TQString &  action,
const KURL &  baseURL,
const KURL &  destURL 
)

Returns whether a certain URL related action is authorized.

Parameters
actionThe name of the action. Known actions are list (may be listed (e.g. in file selection dialog)), link (may be linked to), open (may open) and redirect (may be redirected to)
baseURLThe url where the action originates from
destURLThe object of the action
Returns
true when the action is authorized, false otherwise.
Since
3.1

Definition at line 3499 of file kapplication.cpp.

void KApplication::backgroundChanged ( int  desk)
signal

Emitted when the desktop background has been changed by kcmdisplay.

Parameters
deskThe desktop whose background has changed.
void KApplication::broadcastKeyCode ( unsigned int  keyCode)
slot

Broadcast a received keycode to all listening KDE applications The primary use for this feature is to connect hotkeys such as XF86Display to their respective KGlobalAccel functions while the screen is locked by kdesktop_lock.

Definition at line 2985 of file kapplication.cpp.

TQString KApplication::caption ( ) const

Returns a text for the window caption.

This may be set by "-caption", otherwise it will be equivalent to the name of the executable.

Returns
the text for the window caption

Definition at line 2322 of file kapplication.cpp.

TQString KApplication::checkRecoverFile ( const TQString &  pFilename,
bool &  bRecover 
) const

Check whether an auto-save file exists for the document you want to open.

Parameters
pFilenameThe full path to the document you want to open.
bRecoverThis gets set to true if there was a recover file.
Returns
The full path of the file to open.

Definition at line 3200 of file kapplication.cpp.

void KApplication::clear ( )
slot

If the widget with focus provides a clear() slot, call that slot.

Thus for a simple application clear() can be implemented as:

new KAction( i18n( "Clear" ), "editclear", 0, kapp, TQT_SLOT( clear() ), actionCollection(), "clear" );

Note that for some widgets, this may not provide the intended bahavior. For example if you make use of the code above and a KListView 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 KListView and reimplement this slot. For example the following code would implement a KListView without this behavior:

class MyListView : public KListView {
Q_OBJECT
public:
MyListView( TQWidget * parent = 0, const char * name = 0, WFlags f = 0 ) : KListView( parent, name, f ) {}
virtual ~MyListView() {}
public slots:
virtual void clear() {}
};

Definition at line 2975 of file kapplication.cpp.

void KApplication::commitData ( TQSessionManager &  sm)

Reimplemented for internal purposes, mainly the highlevel handling of session management with KSessionManaged.

Definition at line 1339 of file kapplication.cpp.

void KApplication::copy ( )
slot

If the widget with focus provides a copy() slot, call that slot.

Thus for a simple application copy can be implemented as:

KStdAction::copy( kapp, TQT_SLOT( copy() ), actionCollection() );

Definition at line 2965 of file kapplication.cpp.

TQPalette KApplication::createApplicationPalette ( )
static

Used to obtain the TQPalette 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
the QPalette
Since
3.1

Definition at line 2360 of file kapplication.cpp.

void KApplication::cut ( )
slot

If the widget with focus provides a cut() slot, call that slot.

Thus for a simple application cut can be implemented as:

KStdAction::cut( kapp, TQT_SLOT( cut() ), actionCollection() );

Definition at line 2960 of file kapplication.cpp.

DCOPClient * KApplication::dcopClient ( )
static

Returns a pointer to a DCOPClient for the application.

If a client does not exist yet, it is created when this function is called.

Returns
the DCOPClient for the application

Definition at line 1117 of file kapplication.cpp.

void KApplication::deref ( )
slot

Tells KApplication that one operation such as those described in ref() just finished.

The application exits if the counter is back to 0.

Definition at line 1183 of file kapplication.cpp.

bool KApplication::detectCompositionManagerAvailable ( bool  force_available = false,
bool  available = true 
)

Detects the availability of a composition manager such as kompmgr Note that calling this method will probably cause the screen to flicker.

See also
isCompositionManagerAvailable()
Parameters
force_availableIf set, force TDE to assume a composition manager is available
availableWhether or not the composition manager is available (only used if force_available is TRUE)
Returns
whether the composition manager is enabled

Definition at line 2043 of file kapplication.cpp.

void KApplication::disableAutoDcopRegistration ( )
static

Disable automatic dcop registration Must be called before creating a KApplication instance to have an effect.

Definition at line 1162 of file kapplication.cpp.

void KApplication::disableSessionManagement ( )

Disables session management for this application.

Useful in case your application is started by the initial "startkde" script.

Definition at line 1213 of file kapplication.cpp.

void KApplication::disableStyles ( )

Disables style plugins.

Current style plugins do not get unloaded.

This is only useful when used in combination with enableStyles().

Definition at line 2290 of file kapplication.cpp.

void KApplication::enableSessionManagement ( )

Enables again session management for this application, formerly disabled by calling disableSessionManagement().

You usually shouldn't call this function, as the session management is enabled by default.

Definition at line 1217 of file kapplication.cpp.

void KApplication::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.

Definition at line 2281 of file kapplication.cpp.

TQString KApplication::geometryArgument ( ) const

Returns the argument to –geometry if any, so the geometry can be set wherever necessary.

Returns
the geometry argument, or TQString::null if there is none

Definition at line 1746 of file kapplication.cpp.

Qt::HANDLE KApplication::getX11RGBAColormap ( Display *  dpy)

Returns the X11 display colormap.

Returns
An X11 display colormap object

Definition at line 2089 of file kapplication.cpp.

Qt::HANDLE KApplication::getX11RGBAVisual ( Display *  dpy)

Returns the X11 display visual.

Returns
A pointer to the X11 display visual

Definition at line 2085 of file kapplication.cpp.

TQPixmap KApplication::icon ( ) const

Returns a TQPixmap with the application icon.

Returns
the application icon
void KApplication::iconChanged ( int  group)
signal

Emitted when the global icon settings have been changed.

Parameters
groupthe new group
TQString KApplication::iconName ( ) const

Returns the name of the application icon.

Returns
the icon's name

Definition at line 1762 of file kapplication.cpp.

void KApplication::installKDEPropertyMap ( )

Install a Qt SQL property map with entries for all KDE widgets Call this in any application using KDE widgets in TQSqlForm or TQDataView.

If you are adding a widget that was missing please make sure to also add it to KConfigDialogManager's retrieveSettings() function. Thanks.

Definition at line 2547 of file kapplication.cpp.

void KApplication::installSigpipeHandler ( )
static

Installs a handler for the SIGPIPE signal.

It is thrown when you write to a pipe or socket that has been closed. The handler is installed automatically in the constructor, but you may need it if your application or component does not have a KApplication instance.

Definition at line 3620 of file kapplication.cpp.

void KApplication::installX11EventFilter ( TQWidget *  filter)

Installs widget filter as global X11 event filter.

The widget filter receives XEvents in its standard TQWidget::x11Event() function.

Warning: Only do this when absolutely necessary. An installed X11 filter can slow things down.

Definition at line 447 of file kapplication.cpp.

void KApplication::invokeBrowser ( const TQString &  url,
const TQCString &  startup_id 
)
slot

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 ).

Parameters
urlThe destination address
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default

Definition at line 2944 of file kapplication.cpp.

void KApplication::invokeBrowser ( const TQString &  url)
slot

Invoke the standard browser.

Uses a startup_id of "" (empty) and is otherwise the same as the above function.

Definition at line 2936 of file kapplication.cpp.

void KApplication::invokeEditSlot ( const char *  slot)
protected

This method is used internally to determine which edit slots are implemented by the widget that has the focus, and to invoke those slots if available.

Parameters
slotis the slot as returned using the TQT_SLOT() macro, for example TQT_SLOT( cut() )

This method can be used in KApplication subclasses to implement application wide edit actions not supported by the KApplication class. For example (in your subclass):

void MyApplication::deselect()
{
invokeEditSlot( TQT_SLOT( deselect() ) );
}

Now in your application calls to MyApplication::deselect() will call this slot on the focused widget if it provides this slot. You can combine this with KAction with:

KStdAction::deselect( static_cast<MyApplication *>( kapp ), TQT_SLOT( cut() ), actionCollection() );
See also
cut()
copy()
paste()
clear()
selectAll()
Since
3.2

Definition at line 2246 of file kapplication.cpp.

void KApplication::invokeHelp ( const TQString &  anchor,
const TQString &  appname,
const TQCString &  startup_id 
) const

Invokes the KHelpCenter HTML help viewer from docbook sources.

Parameters
anchorThis has to be a defined anchor in your docbook sources. If empty the main index is loaded
appnameThis allows you to show the help of another application. If empty the current name() is used
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default

Definition at line 2598 of file kapplication.cpp.

void KApplication::invokeHTMLHelp ( const TQString &  aFilename,
const TQString &  aTopic = TQString::null 
) const
Deprecated:
Invoke the khelpcenter HTML help viewer from HTML sources.

Please use invokeHelp() instead.

Parameters
aFilenameThe filename that is to be loaded. Its location is computed automatically according to the KFSSTND. If aFilename is empty, the logical appname with .html appended to it is used.
aTopicThis allows context-sensitive help. Its value will be appended to the filename, prefixed with a "#" (hash) character.

Definition at line 2632 of file kapplication.cpp.

void KApplication::invokeMailer ( const TQString &  address,
const TQString &  subject,
const TQCString &  startup_id 
)

Convenience method; invokes the standard email application.

Parameters
addressThe destination address
subjectSubject string. Can be TQString::null.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default

Definition at line 2672 of file kapplication.cpp.

void KApplication::invokeMailer ( const KURL &  mailtoURL,
const TQCString &  startup_id,
bool  allowAttachments 
)

Invokes the standard email application.

Parameters
mailtoURLA mailto URL.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default
allowAttachmentswhether attachments specified in mailtoURL should be honoured. The default is false; do not honour requests for attachments.

Definition at line 2688 of file kapplication.cpp.

void KApplication::invokeMailer ( const TQString &  to,
const TQString &  cc,
const TQString &  bcc,
const TQString &  subject,
const TQString &  body,
const TQString &  messageFile,
const TQStringList &  attachURLs,
const TQCString &  startup_id 
)

Convenience method; invokes the standard email application.

All parameters are optional.

Parameters
toThe destination address.
ccThe Cc field
bccThe Bcc field
subjectSubject string
bodyA string containing the body of the mail (exclusive with messageFile)
messageFileA file (URL) containing the body of the mail (exclusive with body) - currently unsupported
attachURLsList of URLs to be attached to the mail.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default

Definition at line 2803 of file kapplication.cpp.

bool KApplication::isCompositionManagerAvailable ( )
static

Gets the availability of a composition manager such as kompmgr Note that at least one application must have called detectCompositionManagerAvailable while the current X display was active in order for this method to return valid results.

See also
detectCompositionManagerAvailable()
Returns
whether the composition manager is enabled

Definition at line 2039 of file kapplication.cpp.

bool KApplication::isRestored ( ) const
inline

Is the application restored from the session manager?

Returns
If true, this application was restored by the session manager. Note that this may mean the config object returned by sessionConfig() contains data saved by a session closedown.
See also
sessionConfig()

Definition at line 320 of file kapplication.h.

bool KApplication::isX11CompositionAvailable ( )

Returns whether or not X11 composition is available.

You must first call getX11RGBAInformation()

Note that getX11RGBAInformation() has already been called if you used the default KApplication constructor.

Additionally, at least one application must have called detectCompositionManagerAvailable while the current X display was active in order for this method to return valid results.

Returns
true if composition is available

Definition at line 2093 of file kapplication.cpp.

static KApplication* KApplication::kApplication ( )
inlinestatic

Returns the current application object.

This is similar to the global TQApplication pointer tqApp. 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.

Returns
the current application object

Definition at line 301 of file kapplication.h.

int KApplication::kdeinitExec ( const TQString &  name,
const TQStringList &  args,
TQString *  error,
int *  pid,
const TQCString &  startup_id 
)
static

Starts a program via kdeinit.

program name and arguments are converted to according to the local encoding and passed as is to kdeinit.

Parameters
nameName of the program to start
argsArguments to pass to the program
errorOn failure, error contains a description of the error that occurred. If the pointer is 0, the argument will be ignored
pidOn success, the process id of the new service will be written here. If the pointer is 0, the argument will be ignored.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default
Returns
an error code indicating success (== 0) or failure (> 0).

Definition at line 3150 of file kapplication.cpp.

int KApplication::kdeinitExecWait ( const TQString &  name,
const TQStringList &  args,
TQString *  error,
int *  pid,
const TQCString &  startup_id 
)
static

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.

Parameters
nameName of the program to start
argsArguments to pass to the program
errorOn failure, error contains a description of the error that occurred. If the pointer is 0, the argument will be ignored
pidOn success, the process id of the new service will be written here. If the pointer is 0, the argument will be ignored.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default
Returns
an error code indicating success (== 0) or failure (> 0).

Definition at line 3165 of file kapplication.cpp.

void KApplication::kdisplayFontChanged ( )
signal

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.

Note: If you derive from a QWidget-based class, a faster method is to reimplement TQWidget::fontChange(). This is the preferred way to get informed about font updates.

void KApplication::kdisplayPaletteChanged ( )
signal

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.

void KApplication::kdisplayStyleChanged ( )
signal

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.

uint KApplication::keyboardModifiers ( )
static
Deprecated:
Use keyboardMouseState()
Since
3.1

Definition at line 3530 of file kapplication.cpp.

TQ_ButtonState KApplication::keyboardMouseState ( )
static

Returns the state of the currently pressed keyboard modifiers (e.g.

shift, control, etc.) and mouse buttons, similarly to TQKeyEvent::state() and TQMouseEvent::state(). You usually should simply use the information provided by TQKeyEvent and TQMouseEvent, 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).

Returns
the keyboard modifiers and mouse buttons state
Since
3.4

Definition at line 3573 of file kapplication.cpp.

void KApplication::kipcMessage ( int  id,
int  data 
)
signal

Emitted when a KIPC user message has been received.

Parameters
idthe message id
datathe data
See also
KIPC
KIPC::Message
addKipcEventMask
removeKipcEventMask
KDE_DEPRECATED KStyle* KApplication::kstyle ( ) const
inline
Deprecated:

Definition at line 896 of file kapplication.h.

TQCString KApplication::launcher ( )
static

Returns the DCOP name of the service launcher.

This will be something like klaucher_$host_$uid.

Returns
the name of the service launcher

Definition at line 2991 of file kapplication.cpp.

TQString KApplication::makeStdCaption ( const TQString &  userCaption,
bool  withAppName = true,
bool  modified = false 
) const

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: setCaption(kapp->makeStdCaption(yourCaption));

Parameters
userCaptionThe caption string you want to display in the window caption area. Do not include the application name!
withAppNameIndicates that the method shall include or ignore the application name when making the caption string. You are not compliant if you set this to false.
modifiedIf true, a 'modified' sign will be included in the returned string. This is useful when indicating that a file is modified, i.e., it contains data that has not been saved.
Returns
the created caption

Definition at line 2341 of file kapplication.cpp.

TQPixmap KApplication::miniIcon ( ) const

Returns the mini-icon for the application as a TQPixmap.

Returns
the application's mini icon
TQString KApplication::miniIconName ( ) const

Returns the name of the mini-icon for the application.

Returns
the mini icon's name

Definition at line 1778 of file kapplication.cpp.

uint KApplication::mouseState ( )
static
Deprecated:
Use keyboardMouseState()
Since
3.1

Definition at line 3548 of file kapplication.cpp.

void KApplication::paste ( )
slot

If the widget with focus provides a paste() slot, call that slot.

Thus for a simple application copy can be implemented as:

KStdAction::paste( kapp, TQT_SLOT( paste() ), actionCollection() );

Definition at line 2970 of file kapplication.cpp.

void KApplication::propagateSessionManager ( )

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.

Definition at line 1304 of file kapplication.cpp.

int KApplication::random ( )
static

Generates a uniform random number.

Returns
A truly unpredictable number in the range [0, RAND_MAX)

Definition at line 3331 of file kapplication.cpp.

TQString KApplication::randomString ( int  length)
static

Generates a random string.

It operates in the range [A-Za-z0-9]

Parameters
lengthGenerate a string of this length.
Returns
the random string

Definition at line 3351 of file kapplication.cpp.

void KApplication::ref ( )
slot

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).

Definition at line 1177 of file kapplication.cpp.

void KApplication::removeKipcEventMask ( int  id)

Removes a message type from the KIPC event mask.

This message will not be handled anymore.

Parameters
idThe message id.
See also
KIPC
addKipcEventMask()
kipcMessage()

Definition at line 2271 of file kapplication.cpp.

void KApplication::removeX11EventFilter ( const TQWidget *  filter)

Removes global X11 event filter previously installed by installX11EventFilter().

Definition at line 462 of file kapplication.cpp.

bool KApplication::requestShutDown ( ShutdownConfirm  confirm = ShutdownConfirmDefault,
ShutdownType  sdtype = ShutdownTypeDefault,
ShutdownMode  sdmode = ShutdownModeDefault 
)

Asks the session manager to shut the session down.

Using confirm == ShutdownConfirmYes or sdtype != ShutdownTypeDefault or sdmode != ShutdownModeDefault causes the use of ksmserver's DCOP interface. The remaining two combinations use the standard XSMP and will work with any session manager compliant with it.

Parameters
confirmWhether to ask the user if he really wants to log out. ShutdownConfirm
sdtypeThe action to take after logging out. ShutdownType
sdmodeIf/When the action should be taken. ShutdownMode
Returns
true on success, false if the session manager could not be contacted.

Definition at line 1241 of file kapplication.cpp.

void KApplication::saveState ( TQSessionManager &  sm)

Reimplemented for internal purposes, mainly the highlevel handling of session management with KSessionManaged.

Definition at line 1412 of file kapplication.cpp.

void KApplication::saveYourself ( )
signal

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).

void KApplication::selectAll ( )
slot

If the widget with focus provides a selectAll() slot, call that slot.

Thus for a simple application select all can be implemented as:

KStdAction::selectAll( kapp, TQT_SLOT( selectAll() ), actionCollection() );

Definition at line 2980 of file kapplication.cpp.

KConfig * KApplication::sessionConfig ( )

Returns the application session config object.

Returns
A pointer to the application's instance specific KConfig object.
See also
KConfig

Definition at line 1167 of file kapplication.cpp.

bool KApplication::sessionSaving ( ) const

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().

See also
KMainWindow::queryClose
KMainWindow::queryExit
Since
3.1.1

Definition at line 1494 of file kapplication.cpp.

void KApplication::settingsChanged ( int  category)
signal

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.

Parameters
categorythe category among the enum above
void KApplication::setTopWidget ( TQWidget *  topWidget)

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.

Parameters
topWidgetA top widget of the application.
See also
icon(), caption()

Definition at line 3272 of file kapplication.cpp.

void KApplication::shutDown ( )
signal

Your application is killed.

Either by your program itself, xkill or (the usual case) by KDE's logout.

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.

int KApplication::startServiceByDesktopName ( const TQString &  _name,
const TQString &  URL,
TQString *  error = 0,
TQCString *  dcopService = 0,
int *  pid = 0,
const TQCString &  startup_id = "",
bool  noWait = false 
)
static

Starts a service based on the desktop name of the service.

E.g. "konqueror"

Parameters
_namethe desktop name of the service
URLif not empty this URL is passed to the service
errorOn failure, error contains a description of the error that occurred. If the pointer is 0, the argument will be ignored
dcopServiceOn success, dcopService contains the DCOP name under which this service is available. If empty, the service does not provide DCOP services. If the pointer is 0 the argument will be ignored
pidOn success, the process id of the new service will be written here. If the pointer is 0, the argument will be ignored.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default
noWaitif set, the function does not wait till the service is running.
Returns
an error code indicating success (== 0) or failure (> 0).

Definition at line 3122 of file kapplication.cpp.

int KApplication::startServiceByDesktopName ( const TQString &  _name,
const TQStringList &  URLs = TQStringList(),
TQString *  error = 0,
TQCString *  dcopService = 0,
int *  pid = 0,
const TQCString &  startup_id = "",
bool  noWait = false 
)
static

Starts a service based on the desktop name of the service.

E.g. "konqueror"

Parameters
_namethe desktop name of the service
URLsif not empty these URLs will be passed to the service
errorOn failure, error contains a description of the error that occurred. If the pointer is 0, the argument will be ignored
dcopServiceOn success, dcopService contains the DCOP name under which this service is available. If empty, the service does not provide DCOP services. If the pointer is 0 the argument will be ignored
pidOn success, the process id of the new service will be written here. If the pointer is 0, the argument will be ignored.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default
noWaitif set, the function does not wait till the service is running.
Returns
an error code indicating success (== 0) or failure (> 0).

Definition at line 3134 of file kapplication.cpp.

int KApplication::startServiceByDesktopPath ( const TQString &  _name,
const TQString &  URL,
TQString *  error = 0,
TQCString *  dcopService = 0,
int *  pid = 0,
const TQCString &  startup_id = "",
bool  noWait = false 
)
static

Starts a service based on the desktop path of the service.

E.g. "Applications/konqueror.desktop" or "/home/user/bla/myfile.desktop"

Parameters
_namethe path of the desktop file
URLif not empty this URL is passed to the service
errorOn failure, error contains a description of the error that occurred. If the pointer is 0, the argument will be ignored
dcopServiceOn success, dcopService contains the DCOP name under which this service is available. If empty, the service does not provide DCOP services. If the pointer is 0 the argument will be ignored
pidOn success, the process id of the new service will be written here. If the pointer is 0, the argument will be ignored.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default
noWaitif set, the function does not wait till the service is running.
Returns
an error code indicating success (== 0) or failure (> 0).

Definition at line 3101 of file kapplication.cpp.

int KApplication::startServiceByDesktopPath ( const TQString &  _name,
const TQStringList &  URLs = TQStringList(),
TQString *  error = 0,
TQCString *  dcopService = 0,
int *  pid = 0,
const TQCString &  startup_id = "",
bool  noWait = false 
)
static

Starts a service based on the desktop path of the service.

E.g. "Applications/konqueror.desktop" or "/home/user/bla/myfile.desktop"

Parameters
_namethe path of the desktop file
URLsif not empty these URLs will be passed to the service
errorOn failure, error contains a description of the error that occurred. If the pointer is 0, the argument will be ignored
dcopServiceOn success, dcopService contains the DCOP name under which this service is available. If empty, the service does not provide DCOP services. If the pointer is 0 the argument will be ignored
pidOn success, the process id of the new service will be written here. If the pointer is 0, the argument will be ignored.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default
noWaitif set, the function does not wait till the service is running.
Returns
an error code indicating success (== 0) or failure (> 0).

Definition at line 3113 of file kapplication.cpp.

int KApplication::startServiceByName ( const TQString &  _name,
const TQString &  URL,
TQString *  error = 0,
TQCString *  dcopService = 0,
int *  pid = 0,
const TQCString &  startup_id = "",
bool  noWait = false 
)
static

Starts a service based on the (translated) name of the service.

E.g. "Web Browser"

Parameters
_namethe name of the service
URLif not empty this URL is passed to the service
errorOn failure, error contains a description of the error that occurred. If the pointer is 0, the argument will be ignored
dcopServiceOn success, dcopService contains the DCOP name under which this service is available. If empty, the service does not provide DCOP services. If the pointer is 0 the argument will be ignored
pidOn success, the process id of the new service will be written here. If the pointer is 0, the argument will be ignored.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default
noWaitif set, the function does not wait till the service is running.
Returns
an error code indicating success (== 0) or failure (> 0).

Definition at line 3080 of file kapplication.cpp.

int KApplication::startServiceByName ( const TQString &  _name,
const TQStringList &  URLs = TQStringList(),
TQString *  error = 0,
TQCString *  dcopService = 0,
int *  pid = 0,
const TQCString &  startup_id = "",
bool  noWait = false 
)
static

Starts a service based on the (translated) name of the service.

E.g. "Web Browser"

Parameters
_namethe name of the service
URLsif not empty these URLs will be passed to the service
errorOn failure, error contains a description of the error that occurred. If the pointer is 0, the argument will be ignored
dcopServiceOn success, dcopService contains the DCOP name under which this service is available. If empty, the service does not provide DCOP services. If the pointer is 0 the argument will be ignored
pidOn success, the process id of the new service will be written here. If the pointer is 0, the argument will be ignored.
startup_idfor app startup notification, "0" for none, "" ( empty string ) is the default
noWaitif set, the function does not wait till the service is running.
Returns
an error code indicating success (== 0) or failure (> 0).

Definition at line 3092 of file kapplication.cpp.

TQCString KApplication::startupId ( ) const

Returns the app startup notification identifier for this running application.

Returns
the startup notification identifier

Definition at line 3293 of file kapplication.cpp.

TQString KApplication::tempSaveName ( const TQString &  pFilename) const

Get a file name in order to make a temporary copy of your document.

Parameters
pFilenameThe full path to the current file of your document.
Returns
A new filename for auto-saving.

Definition at line 3172 of file kapplication.cpp.

void KApplication::toolbarAppearanceChanged ( int  )
signal

Emitted when the settings for toolbars have been changed.

KToolBar will know what to do.

void KApplication::updateRemoteUserTimestamp ( const TQCString &  dcopId,
unsigned long  time = 0 
)

Updates the last user action timestamp in the application registered to DCOP with dcopId to the given time, or to this application's user time, if 0 is given.

Use before causing user interaction in the remote application, e.g. invoking a dialog in the application using a DCOP call. Consult focus stealing prevention section in kdebase/kwin/README.

Since
3.3

Definition at line 2237 of file kapplication.cpp.

void KApplication::updateUserTimestamp ( unsigned long  time = 0)

Updates the last user action timestamp to the given time, or to the current time, if 0 is given.

Do not use unless you're really sure what you're doing. Consult focus stealing prevention section in kdebase/kwin/README.

Since
3.2

Definition at line 2204 of file kapplication.cpp.

unsigned long KApplication::userTimestamp ( ) const

Returns the last user action timestamp or 0 if no user activity has taken place yet.

Since
3.2.3
See also
updateuserTimestamp

Definition at line 2228 of file kapplication.cpp.

Member Data Documentation

KApplication * KApplication::KApp = 0L
staticprotected

Current application object.

Definition at line 1276 of file kapplication.h.


The documentation for this class was generated from the following files:
  • kapplication.h
  • kapplication.cpp
  • kapplication_win.cpp

kdecore

Skip menu "kdecore"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdecore

Skip menu "kdecore"
  • arts
  • dcop
  • dnssd
  • interfaces
  •     interface
  •     library
  •   kspeech
  •   ktexteditor
  • kabc
  • kate
  • kcmshell
  • kdecore
  • kded
  • kdefx
  • kdeprint
  • kdesu
  • kdeui
  • kdoctools
  • khtml
  • kimgio
  • kinit
  • kio
  •   bookmarks
  •   httpfilter
  •   kfile
  •   kio
  •   kioexec
  •   kpasswdserver
  •   kssl
  • kioslave
  •   http
  • kjs
  • kmdi
  •   kmdi
  • knewstuff
  • kparts
  • krandr
  • kresources
  • kspell2
  • kunittest
  • kutils
  • kwallet
  • libkmid
  • libkscreensaver
Generated for kdecore by doxygen 1.8.11
This website is maintained by Timothy Pearson.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. |