KontactInterface::Summary Class
class KontactInterface::SummaryBase class for summary widgets in Kontact. More...
| Header: | #include <KontactInterface/Summary> |
| CMake: | find_package(KPim6KontactInterface REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::KontactInterface) |
Public Functions
| Summary(QWidget *parent) | |
| virtual | ~Summary() override |
| virtual QStringList | configModules() const |
| QWidget * | createHeader(QWidget *parent, const QString &icon, const QString &heading) |
| virtual int | summaryHeight() const |
Public Slots
| virtual void | configChanged() |
| virtual void | updateSummary(bool force = false) |
Signals
| void | message(const QString &) |
Detailed Description
This class should be used as base class when creating new summary widgets for the Summary View plugin in Kontact.
Member Function Documentation
[explicit] Summary::Summary(QWidget *parent)
Creates a new summary widget.
parent The parent widget.
[override virtual noexcept] Summary::~Summary()
Destroys the summary widget.
[virtual slot] void Summary::configChanged()
This method is called whenever the configuration has been changed.
[virtual] QStringList Summary::configModules() const
Returns a list of names identifying configuration modules for this summary widget.
Note The names have to be suitable for being passed to KCMultiDialog::addModule().
QWidget *Summary::createHeader(QWidget *parent, const QString &icon, const QString &heading)
Creates a heading for a typical summary view with an icon and a heading.
parent The parent widget. icon The name of the icon. heading The text of the header.
[signal] void Summary::message(const QString &)
This signal can be emitted to signaling that an action is going on. The specified message QString will be shown in the status bar.
[virtual] int Summary::summaryHeight() const
Returns the logical height of summary widget.
This is used to calculate how much vertical space relative to other summary widgets this widget will use in the summary view.
[virtual slot] void Summary::updateSummary(bool force = false)
This method is called if the displayed information should be updated.
force true if the update was requested by the user