KAbstractWidgetJobTracker Class

Member Function Documentation

[explicit] KAbstractWidgetJobTracker::KAbstractWidgetJobTracker(QWidget *parent = nullptr)

Creates a new KAbstractWidgetJobTracker

parent the parent of this object and of the widget displaying the job progresses

bool KAbstractWidgetJobTracker::autoDelete(KJob *job) const

Checks whether the dialog should be deleted or cleaned.

job the job's widget that will be auto-deleted

Returns false if the dialog only calls slotClean, true if it will be deleted

See also setAutoDelete().

[override virtual slot] void KAbstractWidgetJobTracker::registerJob(KJob *job)

Reimplements: KJobTrackerInterface::registerJob(KJob *job).

Register a new job in this tracker. Note that job trackers inheriting from this class can have only one job registered at a time.

job the job to register

[signal] void KAbstractWidgetJobTracker::resume(KJob *job)

Emitted when the user resumed the operation

job The job that has been resumed

void KAbstractWidgetJobTracker::setAutoDelete(KJob *job, bool autoDelete)

This controls whether the dialog should be deleted or only cleaned when the KJob is finished (or canceled).

If your dialog is an embedded widget and not a separate window, you should setAutoDelete(false) in the constructor of your custom dialog.

job the job's widget that is going to be auto-deleted

autoDelete If false the dialog will only call method slotClean.

If true the dialog will be deleted.

See also autoDelete().

void KAbstractWidgetJobTracker::setStopOnClose(KJob *job, bool stopOnClose)

This controls whether the job should be canceled if the dialog is closed.

job the job's widget that will be stopped when closing

stopOnClose If true the job will be stopped if the dialog is closed, otherwise the job will continue even on close.

See also stopOnClose().

[virtual protected slot] void KAbstractWidgetJobTracker::slotClean(KJob *job)

This method is called when the widget should be cleaned (after job is finished). redefine this for custom behavior.

job The job that is being cleaned

[virtual protected slot] void KAbstractWidgetJobTracker::slotResume(KJob *job)

This method should be called for pause/resume Connect this to the progress widgets buttons etc.

job The job that is being resumed

[virtual protected slot] void KAbstractWidgetJobTracker::slotStop(KJob *job)

This method should be called for correct cancellation of IO operation Connect this to the progress widgets buttons etc.

job The job that is being stopped

[virtual protected slot] void KAbstractWidgetJobTracker::slotSuspend(KJob *job)

This method should be called for pause/resume Connect this to the progress widgets buttons etc.

job The job that is being suspended

bool KAbstractWidgetJobTracker::stopOnClose(KJob *job) const

Checks whether the job will be killed when the dialog is closed.

job the job's widget that will be stopped when closing

Returns true if the job is killed on close event, false otherwise.

See also setStopOnClose().

[signal] void KAbstractWidgetJobTracker::stopped(KJob *job)

Emitted when the user aborted the operation

job The job that has been stopped

[signal] void KAbstractWidgetJobTracker::suspend(KJob *job)

Emitted when the user suspended the operation

job The job that has been suspended

[override virtual slot] void KAbstractWidgetJobTracker::unregisterJob(KJob *job)

Reimplements: KJobTrackerInterface::unregisterJob(KJob *job).

Unregister a job from this tracker.

job the job to unregister

[pure virtual] QWidget *KAbstractWidgetJobTracker::widget(KJob *job)

The widget associated to this tracker.

job the job that is assigned the widget we want to return Returns the widget displaying the job progresses