templatesmodel.h

Go to the documentation of this file.

/*  This file is part of KDevelop
    Copyright 2007 Alexander Dymo <adymo@kdevelop.org>
    Copyright 2012 Miha Čančula <miha@noughmad.eu>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License as published by the Free Software Foundation; either
    version 2 of the License, or (at your option) any later version.

    This library is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
    Library General Public License for more details.

    You should have received a copy of the GNU Library General Public License
    along with this library; see the file COPYING.LIB.  If not, write to
    the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
 */

#ifndef KDEVPLATFORM_TEMPLATESMODEL_H
#define KDEVPLATFORM_TEMPLATESMODEL_H

#include <QStandardItemModel>

#include <language/languageexport.h>

namespace KDevelop {
class TemplatesModelPrivate;

class KDEVPLATFORMLANGUAGE_EXPORT TemplatesModel
    : public QStandardItemModel
{
    Q_OBJECT

public:

    enum TemplateRole
    {
        DescriptionFileRole = Qt::UserRole + 1, 
        PreviewIconRole = Qt::UserRole + 2, 
        CommentRole = Qt::UserRole + 3, 
        ArchiveFileRole = Qt::UserRole + 4 
    };

    explicit TemplatesModel(const QString& typePrefix, QObject* parent = nullptr);

    ~TemplatesModel() override;

    virtual void refresh();

    QString loadTemplateFile(const QString& fileName);

    QModelIndexList templateIndexes(const QString& fileName) const;

    QString typePrefix() const;

    void addDataPath(const QString& path);

private:
    const QScopedPointer<class TemplatesModelPrivate> d_ptr;
    Q_DECLARE_PRIVATE(TemplatesModel)
};
}

#endif // KDEVPLATFORM_TEMPLATESMODEL_H