Snippets: Feature enhancement start...

Provide an interface so users can create/edit/remove snippets.
2010-10-27 17:38:22 +02:00
parent 27bab4e811
commit 7528c6d617
44 changed files with 2569 additions and 388 deletions
--- a/src/plugins/texteditor/snippets/snippet.h
+++ b/src/plugins/texteditor/snippets/snippet.h
@@ -0,0 +1,98 @@
+/**************************************************************************
+**
+** 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.
+**
+**************************************************************************/
+
+#ifndef SNIPPET_H
+#define SNIPPET_H
+
+#include <texteditor/texteditor_global.h>
+
+#include <QtCore/QChar>
+#include <QtCore/QString>
+
+namespace TextEditor {
+
+class TEXTEDITOR_EXPORT Snippet
+{
+public:
+    Snippet(const QString &id = QString());
+    ~Snippet();
+
+    // 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;
+
+private:
+    bool m_isRemoved;
+    bool m_isModified;
+    QString m_id;
+    QString m_trigger;
+    QString m_content;
+    QString m_complement;
+    Group m_group;
+};
+
+inline Snippet::Group& operator++(Snippet::Group& group)
+{
+    group = Snippet::Group(group + 1);
+    return group;
+}
+
+} // TextEditor
+
+#endif // SNIPPET_H