KDE API Reference

Contents

KIO::JobUiDelegateFactory Class

class KIO::JobUiDelegateFactory

A factory for creating job ui delegates. More...

Header: #include <KIO/JobUiDelegateFactory>
CMake: find_package(KF6 REQUIRED COMPONENTS KIO)
target_link_libraries(mytarget PRIVATE KF6::KIOCore)
Since: 5.0

Public Functions

virtual KJobUiDelegate *createDelegate() const = 0
(since 6.0) virtual KJobUiDelegate *createDelegate(KJobUiDelegate::Flags flags, QWidget *window) const = 0

Protected Functions

JobUiDelegateFactory()
KJobUiDelegate *createDefaultJobUiDelegate()
(since 5.98) KJobUiDelegate *createDefaultJobUiDelegate(KJobUiDelegate::Flags flags, QWidget *window)
(since 6.0) KIO::JobUiDelegateFactory *defaultJobUiDelegateFactory()
(since 5.78) T delegateExtension(KJob *job)
(since 6.0) void setDefaultJobUiDelegateFactory(KIO::JobUiDelegateFactory *factory)

Detailed Description

Every KIO job will get a delegate from this factory.

Member Function Documentation

[protected] JobUiDelegateFactory::JobUiDelegateFactory()

Constructor

[pure virtual] KJobUiDelegate *JobUiDelegateFactory::createDelegate() const

[pure virtual, since 6.0] KJobUiDelegate *JobUiDelegateFactory::createDelegate(KJobUiDelegate::Flags flags, QWidget *window) const

This function was introduced in 6.0.

Related Non-Members

KJobUiDelegate *createDefaultJobUiDelegate()

Convenience method: use default factory, if there's one, to create a delegate and return it.

[since 5.98] KJobUiDelegate *createDefaultJobUiDelegate(KJobUiDelegate::Flags flags, QWidget *window)

Convenience method: use default factory, if there's one, to create a delegate and return it.

This function was introduced in 5.98.

[since 6.0] KIO::JobUiDelegateFactory *defaultJobUiDelegateFactory()

Returns the default job UI delegate factory to be used by all KIO jobs (in which HideProgressInfo is not set) Can return nullptr, if no kio GUI library is loaded.

This function was introduced in 6.0.

See also setDefaultJobUiDelegateFactory().

[since 5.78] template <typename T> T delegateExtension(KJob *job)

Returns the child of the job's uiDelegate() that implements the given extension, or nullptr if none was found (or if the job had no uiDelegate).

This function was introduced in 5.78.

[since 6.0] void setDefaultJobUiDelegateFactory(KIO::JobUiDelegateFactory *factory)

Internal. Allows the KIO widgets library to register its widget-based job UI delegate factory automatically.

This function was introduced in 6.0.

See also defaultJobUiDelegateFactory().