snippet.h 2.55 KB
Newer Older
Leandro Melo's avatar
Leandro Melo committed
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29
/**************************************************************************
**
** This file is part of Qt Creator
**
** Copyright (c) 2010 Nokia Corporation and/or its subsidiary(-ies).
**
** Contact: Nokia Corporation (qt-info@nokia.com)
**
** Commercial Usage
**
** Licensees holding valid Qt Commercial licenses may use this file in
** accordance with the Qt Commercial License Agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and Nokia.
**
** GNU Lesser General Public License Usage
**
** Alternatively, this file may be used under the terms of the GNU Lesser
** General Public License version 2.1 as published by the Free Software
** Foundation and appearing in the file LICENSE.LGPL included in the
** packaging of this file.  Please review the following information to
** ensure the GNU Lesser General Public License version 2.1 requirements
** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
**
** If you are unsure which license is appropriate for your use, please
** contact the sales department at http://qt.nokia.com/contact.
**
**************************************************************************/

30 31
#ifndef SNIPPET_H
#define SNIPPET_H
Leandro Melo's avatar
Leandro Melo committed
32

33
#include <texteditor/texteditor_global.h>
Leandro Melo's avatar
Leandro Melo committed
34

35
#include <QtCore/QChar>
Leandro Melo's avatar
Leandro Melo committed
36 37 38 39
#include <QtCore/QString>

namespace TextEditor {

40
class TEXTEDITOR_EXPORT Snippet
Leandro Melo's avatar
Leandro Melo committed
41 42
{
public:
43 44
    Snippet(const QString &id = QString());
    ~Snippet();
Leandro Melo's avatar
Leandro Melo committed
45

46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78
    // Values from this enumeration need to be contiguous (they are used as indexes).
    enum Group {
        Cpp = 0,
        Qml,
        PlainText,
        GroupSize
    };

    const QString &id() const;

    bool isBuiltIn() const;

    void setTrigger(const QString &trigger);
    const QString &trigger() const;

    void setContent(const QString &content);
    const QString &content() const;

    void setComplement(const QString &complement);
    const QString &complement() const;

    void setIsRemoved(bool removed);
    bool isRemoved() const;

    void setIsModified(bool modified);
    bool isModified() const;

    void setGroup(Group group);
    Group group() const;

    QString generateTip() const;

    static const QChar kVariableDelimiter;
Leandro Melo's avatar
Leandro Melo committed
79 80

private:
81 82
    bool m_isRemoved;
    bool m_isModified;
Leandro Melo's avatar
Leandro Melo committed
83
    QString m_id; // Only built-in snippets have an id.
84 85 86 87
    QString m_trigger;
    QString m_content;
    QString m_complement;
    Group m_group;
Leandro Melo's avatar
Leandro Melo committed
88 89
};

90 91 92 93 94 95 96
inline Snippet::Group& operator++(Snippet::Group& group)
{
    group = Snippet::Group(group + 1);
    return group;
}

} // TextEditor
Leandro Melo's avatar
Leandro Melo committed
97

98
#endif // SNIPPET_H