KMessage Namespace Reference

Enumerations
enum	MessageType {   Error, Information, Warning, Sorry,   Fatal }

Functions
void	message (KMessage::MessageType messageType, const QString &text, const QString &caption=QString())
void	setMessageHandler (KMessageHandler *handler)

Detailed Description

Display an informative message using a KMessageHandler.

This class does not define how to display a message, it is just a clean interface for developers to use. The job is done by the current KMessageHandler set in the class.

If no KMessageHandler is currently registered in KMessage, the message will be outputed to stderr.

Use KMessage::setMessageHandler() to use a KMessageHandler.

KMessage::setMessageHandler( new KMessageBoxHandler(this) );
// some operation

KMessage::message( KMessage::Error, i18n("Could not load service. Use kbuildsycoca to fix the service database."), i18n("KService") );

Some KMessageHandler are already done such as KMessageBoxMessageHandler and KPassivePopupMessageHandler.

Author

Michaël Larouche micha.nosp@m.el.l.nosp@m.arouc.nosp@m.he@k.nosp@m.demai.nosp@m.l.ne.nosp@m.t

Enumeration Type Documentation

enum KMessage::MessageType

Enumerator
Error	Error message. Display critical information that affect the behavior of the application.
Information	Information message. Display useful information to the user.
Warning	Warning message. Display a message that could affect the behavior of the application.
Sorry	Sorry message. Display a message explaining that a task couldn't be accomplished.
Fatal	Fatal message. Display a message before the application fail and close itself.

Definition at line 51 of file kmessage.h.

Function Documentation

void KMessage::message	(	KMessage::MessageType	messageType,
		const QString &	text,
		const QString &	caption = QString()
	)

Display a long message of a certain type.

A long message span on multiple lines and can have a caption.

Parameters

messageType	Currrent type of message. See MessageType enum.
text	Long message to be displayed.
caption	Caption to be used. This is optional.

Definition at line 92 of file kmessage.cpp.

void KMessage::setMessageHandler

(

KMessageHandler *

handler

)

Set the current KMessageHandler Note that this method takes ownership of the KMessageHandler.

Parameters

handler

Instance of a real KMessageHandler.

Warning

This function isn't thread-safe. You don't want to change the message handler during the program's execution anyways. Do so only at start-up.

Definition at line 86 of file kmessage.cpp.