PimCommon::TemplateListWidget Class
The TemplateListWidget class provides a list widget for templates Author: Laurent Montel <montel@kde.org>. More...
| Header: | #include <PimCommon/TemplateListWidget> |
| CMake: | find_package(KPim6PimCommon REQUIRED)target_link_libraries(mytarget PRIVATE KPim6::PimCommon) |
Public Functions
| TemplateListWidget(const QString &configName, QWidget *parent = nullptr) | |
| virtual | ~TemplateListWidget() override |
| void | addDefaultTemplate(const QString &templateName, const QString &templateScript) |
| virtual bool | addNewTemplate(QString &templateName, QString &templateScript) |
| virtual QList<PimCommon::defaultTemplate> | defaultTemplates() |
| void | loadTemplates() |
| virtual bool | modifyTemplate(QString &templateName, QString &templateScript, bool defaultTemplate) |
| void | setKNewStuffConfigFile(const QString &configName) |
Signals
| void | insertNewTemplate(const QString &) |
| void | insertTemplate(const QString &) |
Protected Types
| enum | TemplateData { Text, DefaultTemplate } |
Reimplemented Protected Functions
| virtual void | dropEvent(QDropEvent *event) override |
| virtual QMimeData * | mimeData(const QList<QListWidgetItem *> &items) const override |
| virtual QStringList | mimeTypes() const override |
Detailed Description
Member Type Documentation
enum TemplateListWidget::TemplateData
Enumeration for template data roles.
Member Function Documentation
[explicit] TemplateListWidget::TemplateListWidget(const QString &configName, QWidget *parent = nullptr)
Constructs a TemplateListWidget. @param configName The configuration name for storing templates @param parent The parent widget
[override virtual noexcept] TemplateListWidget::~TemplateListWidget()
Destructs the TemplateListWidget.
void TemplateListWidget::addDefaultTemplate(const QString &templateName, const QString &templateScript)
Adds a default template. @param templateName The name of the template @param templateScript The script content
[virtual] bool TemplateListWidget::addNewTemplate(QString &templateName, QString &templateScript)
Adds a new template. @param templateName The name of the new template (in/out parameter) @param templateScript The script content of the template (in/out parameter) @return true if the template was added successfully
[virtual] QList<PimCommon::defaultTemplate> TemplateListWidget::defaultTemplates()
Returns the list of default templates. @return A list of default templates
[override virtual protected] void TemplateListWidget::dropEvent(QDropEvent *event)
Handles drop events. @param event The drop event
[signal] void TemplateListWidget::insertNewTemplate(const QString &)
Emitted when a new template is created. @param template The new template content
[signal] void TemplateListWidget::insertTemplate(const QString &)
Emitted when a template is selected for insertion. @param template The template content to insert
void TemplateListWidget::loadTemplates()
Loads templates from disk.
[override virtual protected] QMimeData *TemplateListWidget::mimeData(const QList<QListWidgetItem *> &items) const
Creates MIME data for dragged items. @param items The list of items being dragged @return QMimeData containing the dragged items
[override virtual protected] QStringList TemplateListWidget::mimeTypes() const
Returns the MIME types supported for drag and drop. @return A list of supported MIME types
[virtual] bool TemplateListWidget::modifyTemplate(QString &templateName, QString &templateScript, bool defaultTemplate)
Modifies an existing template. @param templateName The name of the template to modify (in/out parameter) @param templateScript The script content to modify (in/out parameter) @param defaultTemplate Whether this is a default template @return true if the template was modified successfully
void TemplateListWidget::setKNewStuffConfigFile(const QString &configName)
Sets the KNewStuff configuration file. @param configName The configuration file name