• Skip to content
  • Skip to link menu
KDE API Reference
  • KDE API Reference
  • kdelibs API Reference
  • KDE Home
  • Contact Us
 

KDECore

Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KJobUiDelegate Class Reference

#include <kjobuidelegate.h>

Inheritance diagram for KJobUiDelegate:
Inheritance graph
[legend]

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
enableenable 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
enableenable 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
This file is part of the KDE documentation.
Documentation copyright © 1996-2014 The KDE developers.
Generated on Tue Oct 14 2014 22:47:11 by doxygen 1.8.7 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.

KDECore

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

kdelibs API Reference

Skip menu "kdelibs API Reference"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDEWebKit
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • kio
  • KIOSlave
  • KJS
  •   KJS-API
  • kjsembed
  •   WTF
  • KNewStuff
  • KParts
  • KPty
  • Kross
  • KUnitConversion
  • KUtils
  • Nepomuk
  • Nepomuk-Core
  • Nepomuk
  • Plasma
  • Solid
  • Sonnet
  • ThreadWeaver

Search



Report problems with this website to our bug tracking system.
Contact the specific authors with questions and comments about the page contents.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal