KJobUiDelegate Class Reference

#include <kjobuidelegate.h>

Inheritance diagram for KJobUiDelegate:

Public Member Functions
	KJobUiDelegate ()
virtual	~KJobUiDelegate ()
bool	isAutoErrorHandlingEnabled () const
bool	isAutoWarningHandlingEnabled () const
void	setAutoErrorHandlingEnabled (bool enable)
void	setAutoWarningHandlingEnabled (bool enable)
virtual void	showErrorMessage ()

Protected Slots
virtual void	slotWarning (KJob *job, const QString &plain, const QString &rich)

Protected Member Functions
KJob *	job ()

Detailed Description

The base class for all KJob UI delegate.

A UI delegate is responsible for the events of a job and provides a UI for them (an error message box or warning etc.).

See also

KJob

Definition at line 39 of file kjobuidelegate.h.

Constructor & Destructor Documentation

KJobUiDelegate::KJobUiDelegate

(

)

Constructs a new KJobUiDelegate.

Definition at line 43 of file kjobuidelegate.cpp.

KJobUiDelegate::~KJobUiDelegate ( )

virtual

Destroys a KJobUiDelegate.

Definition at line 49 of file kjobuidelegate.cpp.

Member Function Documentation

bool KJobUiDelegate::isAutoErrorHandlingEnabled

(

)

const

Returns whether automatic error handling is enabled or disabled.

See also setAutoErrorHandlingEnabled .

Returns

true if automatic error handling is enabled

See also

setAutoErrorHandlingEnabled()

Definition at line 81 of file kjobuidelegate.cpp.

bool KJobUiDelegate::isAutoWarningHandlingEnabled

(

)

const

Returns whether automatic warning handling is enabled or disabled.

See also setAutoWarningHandlingEnabled .

Returns

true if automatic warning handling is enabled

See also

setAutoWarningHandlingEnabled()

Definition at line 91 of file kjobuidelegate.cpp.

KJob * KJobUiDelegate::job ( )

protected

Retrieves the current job this UI delegate is attached to.

Returns

current job this UI delegate is attached to, or 0 if this UI delegate is not tracking any job

Definition at line 67 of file kjobuidelegate.cpp.

void KJobUiDelegate::setAutoErrorHandlingEnabled

(

bool

enable

)

Enable or disable the automatic error handling.

When automatic error handling is enabled and an error occurs, then showErrorDialog() is called, right before the emission of the result signal.

The default is false.

See also isAutoErrorHandlingEnabled , showErrorDialog

Parameters

enable

enable or disable automatic error handling

See also

isAutoErrorHandlingEnabled()

Definition at line 76 of file kjobuidelegate.cpp.

void KJobUiDelegate::setAutoWarningHandlingEnabled

(

bool

enable

)

Enable or disable the automatic warning handling.

When automatic warning handling is enabled and an error occurs, then a message box is displayed with the warning message

The default is true.

See also isAutoWarningHandlingEnabled , showErrorDialog

Parameters

enable

enable or disable automatic warning handling

See also

isAutoWarningHandlingEnabled()

Definition at line 86 of file kjobuidelegate.cpp.

void KJobUiDelegate::showErrorMessage ( )

virtual

Display a dialog box to inform the user of the error given by this job.

Only call if error is not 0, and only in the slot connected to result.

Definition at line 72 of file kjobuidelegate.cpp.

void KJobUiDelegate::slotWarning ( KJob *  job, const QString &  plain, const QString &  rich  )

protectedvirtualslot

Definition at line 96 of file kjobuidelegate.cpp.

---

The documentation for this class was generated from the following files:

• kjobuidelegate.h
• kjobuidelegate.cpp