qt-creator/src/plugins/snippets/snippetspec.h

/***************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2008 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact:  Qt Software Information (qt-info@nokia.com)
**
**
** Non-Open Source Usage
**
** Licensees may use this file in accordance with the Qt Beta Version
** License Agreement, Agreement version 2.2 provided with the Software or,
** alternatively, in accordance with the terms contained in a written
** agreement between you and Nokia.
**
** GNU General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU General
** Public License versions 2.0 or 3.0 as published by the Free Software
** Foundation and appearing in the file LICENSE.GPL included in the packaging
** of this file.  Please review the following information to ensure GNU
** General Public Licensing requirements will be met:
**
** http://www.fsf.org/licensing/licenses/info/GPLv2.html and
** http://www.gnu.org/copyleft/gpl.html.
**
** In addition, as a special exception, Nokia gives you certain additional
** rights. These rights are described in the Nokia Qt GPL Exception
** version 1.2, included in the file GPL_EXCEPTION.txt in this package.
**
***************************************************************************/

#ifndef SNIPPETSPEC_H
#define SNIPPETSPEC_H

#include <QtCore/QMap>
#include <QtCore/QString>

namespace Snippets {
namespace Internal {

class SnippetSpec
{
public:
    bool load(const QString &fileName);

    QString contents() const;
    QString name() const;
    QString description() const;
    QString category() const;
    QString completionShortcut() const;
    QString argumentDescription(int id) const;
    QString argumentDefault(int id) const;

private:
    QString m_contents;
    QString m_name;
    QString m_description;
    QString m_category;
    QString m_completionShortcut;
    QMap<int, QString> m_argumentDescription;
    QMap<int, QString> m_argumentDefault;
};

} //namespace Internal
} //namespace Snippets

#endif // SNIPPETSPEC_H