Main Page   Modules   Namespace List   Class Hierarchy   Compound List   File List   Namespace Members   Compound Members   Related Pages  

KCrash Class Reference

#include <kcrash.h>

List of all members.

Public Types

typedef void(* HandlerType )(int)

Static Public Methods

void defaultCrashHandler (int signal)
void setCrashHandler (HandlerType handler=defaultCrashHandler)
HandlerType crashHandler ()
void setEmergencySaveFunction (HandlerType saveFunction=(HandlerType) 0)
HandlerType emergencySaveFunction ()
void setApplicationPath (QString path)
void setApplicationName (QString name)

Static Protected Attributes

HandlerType _crashHandler
HandlerType _emergencySaveFunction


Detailed Description

This class handles segmentation-faults. By default it displays a message-box saying the application crashed. This default can be overridden by setting a custom crash handler with setCrashHandler(). If a function is specified with setEmergencySaveFunction() it will be called by the default crash handler, giving the application a chance to save its data.

Definition at line 36 of file kcrash.h.


Member Typedef Documentation

typedef void(* KCrash::HandlerType)(int)
 

This function type is a pointer to a crash handler function. The function's argument is the number of the signal.

Definition at line 53 of file kcrash.h.

Referenced by crashHandler(), and emergencySaveFunction().


Member Function Documentation

HandlerType KCrash::crashHandler   [inline, static]
 

Returns the installed crash handler.

Returns:
the crash handler

Definition at line 72 of file kcrash.h.

References _crashHandler, and HandlerType.

void KCrash::defaultCrashHandler int    signal [static]
 

The default crash handler.

Parameters:
signal  the signal number

HandlerType KCrash::emergencySaveFunction   [inline, static]
 

Return the currently set emergency save function.

Returns:
the emergency save function

Definition at line 86 of file kcrash.h.

References _emergencySaveFunction, and HandlerType.

void KCrash::setApplicationName QString    name [inline, static]
 

Sets the application name name which should be passed to Dr. Konqi, our nice crash display application.

Parameters:
name  the name of the application, as shown in Dr. Konqi

Definition at line 100 of file kcrash.h.

void KCrash::setApplicationPath QString    path [inline, static]
 

Sets the application path which should be passed to Dr. Konqi, our nice crash display application.

Parameters:
path  the application path.

Definition at line 93 of file kcrash.h.

void KCrash::setCrashHandler HandlerType    handler = defaultCrashHandler [static]
 

Install a function to be called in case a SIGSEGV is caught.

Parameters:
HandlerType  handler can be one of
  • null in which case signal-catching is disabled (by calling signal(SIGSEGV, SIG_DFL))
  • if handler is omitted the default crash handler is installed.
  • an user defined function in the form: static (if in a class) void myCrashHandler(int);
handler  the crash handler

void KCrash::setEmergencySaveFunction HandlerType    saveFunction = (HandlerType) 0 [static]
 

Installs a function which should try to save the applications data. It is the crash handler´s responsibility to call this function. Therefore, if no crash handler is set, the default crash handler is installed to ensure the save function is called.

Parameters:
saveFunction  the handler to install


Member Data Documentation

HandlerType KCrash::_crashHandler [static, protected]
 

Pointer to the crash handler.

Definition at line 106 of file kcrash.h.

Referenced by crashHandler().

HandlerType KCrash::_emergencySaveFunction [static, protected]
 

Pointer to the emergency save function.

Definition at line 110 of file kcrash.h.

Referenced by emergencySaveFunction().


The documentation for this class was generated from the following file:
Generated on Wed Aug 13 23:30:08 2003 for kdelibs by doxygen1.2.18