snippetrepository.h

Go to the documentation of this file.

/*  This file is part of the Kate project.
 *  Based on the snippet plugin from KDevelop 4.
 *
 *  Copyright (C) 2007 Robert Gruber <rgruber@users.sourceforge.net> 
 *  Copyright (C) 2010 Milian Wolff <mail@milianw.de>
 *  Copyright (C) 2012 Christoph Cullmann <cullmann@kde.org>
 *
 *  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 __SNIPPETREPOSITORY_H__
#define __SNIPPETREPOSITORY_H__

#include <QObject>
#include <QStandardItem>
#include <QStringList>

class Snippet;

namespace KTextEditor
{
class TemplateScript;
}

class SnippetRepository : public QObject, public QStandardItem
{
    Q_OBJECT

public:
    SnippetRepository(const QString& file);
    ~SnippetRepository();

    static SnippetRepository* createRepoFromName(const QString& name);

    QString license() const;
    void setLicense(const QString& license);

    QString authors() const;
    void setAuthors(const QString& authors);

    QStringList fileTypes() const;
    void setFileTypes(const QStringList& filetypes);

    const QString& file() const;

    QString completionNamespace() const;
    void setCompletionNamespace(const QString& completionNamespace);

    QString script() const;
    KTextEditor::TemplateScript* registeredScript() const;
    void setScript(const QString& script);

    void remove();

    void save();

    virtual QVariant data(int role = Qt::UserRole + 1) const;
    virtual void setData(const QVariant& value, int role = Qt::UserRole + 1);

private Q_SLOTS:
    void slotParseFile();

private:
    QString m_file;
    QString m_license;
    QString m_authors;
    QStringList m_filetypes;
    QString m_namespace;
    QString m_script;
    KTextEditor::TemplateScript* m_registeredScript;
};

#endif