forked from qt-creator/qt-creator
8295b503be
Change-Id: I3c22ef2685d7aa589f5d0ab74d693653a4c32082 Reviewed-by: Alessandro Portale <alessandro.portale@digia.com>
105 lines
4.3 KiB
C++
105 lines
4.3 KiB
C++
/****************************************************************************
|
|
**
|
|
** Copyright (C) 2014 Digia Plc and/or its subsidiary(-ies).
|
|
** Contact: http://www.qt-project.org/legal
|
|
**
|
|
** This file is part of Qt Creator.
|
|
**
|
|
** Commercial License Usage
|
|
** Licensees holding valid commercial Qt licenses may use this file in
|
|
** accordance with the commercial license agreement provided with the
|
|
** Software or, alternatively, in accordance with the terms contained in
|
|
** a written agreement between you and Digia. For licensing terms and
|
|
** conditions see http://www.qt.io/licensing. For further information
|
|
** use the contact form at http://www.qt.io/contact-us.
|
|
**
|
|
** 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 or version 3 as published by the Free
|
|
** Software Foundation and appearing in the file LICENSE.LGPLv21 and
|
|
** LICENSE.LGPLv3 included in the packaging of this file. Please review the
|
|
** following information to ensure the GNU Lesser General Public License
|
|
** requirements will be met: https://www.gnu.org/licenses/lgpl.html and
|
|
** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
|
|
**
|
|
** In addition, as a special exception, Digia gives you certain additional
|
|
** rights. These rights are described in the Digia Qt LGPL Exception
|
|
** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
|
|
**
|
|
****************************************************************************/
|
|
|
|
#include "isnippetprovider.h"
|
|
|
|
using namespace TextEditor;
|
|
|
|
/*!
|
|
\group Snippets
|
|
\title Snippets for Editors
|
|
|
|
Snippets typically consist of chunks of code in a programming language (although they
|
|
can also be plain text) which you would like to avoid re-typing every time. They
|
|
are triggered in the same way as the completions (see \l{CodeAssist}{Providing
|
|
Code Assist}).
|
|
|
|
In order to create a new group of snippets two steps are necessary:
|
|
\list
|
|
\li Implement the TextEditor::ISnippetProvider interface and register it in
|
|
the extension system.
|
|
\li Create an XML configuration file and place it in the
|
|
/share/qtcreator/snippets directory. As an example of the file format
|
|
please take a look at the already available ones. The meaning and consistency rules
|
|
of the fields are described below:
|
|
\list
|
|
\li group - This is the group in which the snippet belongs in the user interface.
|
|
It must match TextEditor::ISnippetProvider::groupId().
|
|
\li id - A unique string that identifies this snippet among all others available.
|
|
The recommended practice is to prefix it with the group so it is easier to have
|
|
such control on a file level.
|
|
\li trigger - The sequence of characters to be compared by the completion engine
|
|
in order to display this snippet as a code assist proposal.
|
|
\li complement - Additional information that is displayed in the code assist
|
|
proposal so it is possible to disambiguate similar snippets that have the
|
|
same trigger.
|
|
\endlist
|
|
\endlist
|
|
|
|
All XML configuration files found in the directory mentioned above are parsed by
|
|
Qt Creator. However, only the ones which are associated with known groups (specified
|
|
by a provider) are taken into consideration.
|
|
*/
|
|
|
|
/*!
|
|
\class TextEditor::ISnippetProvider
|
|
\brief The ISnippetProvider class acts as an interface for providing groups of snippets.
|
|
\ingroup Snippets
|
|
|
|
Known implementors of this interface are the CppSnippetProvider, the QmlJSSnippetProvider,
|
|
and the PlainTextSnippetProvider.
|
|
*/
|
|
|
|
ISnippetProvider::ISnippetProvider() : QObject()
|
|
{}
|
|
|
|
ISnippetProvider::~ISnippetProvider()
|
|
{}
|
|
|
|
/*!
|
|
\fn QString TextEditor::ISnippetProvider::groupId() const
|
|
|
|
Returns the unique group id to which this provider is associated.
|
|
*/
|
|
|
|
/*!
|
|
\fn QString TextEditor::ISnippetProvider::displayName() const
|
|
|
|
Returns the name to be displayed in the user interface for snippets that belong to the group
|
|
associated with this provider.
|
|
*/
|
|
|
|
/*!
|
|
\fn void TextEditor::ISnippetProvider::decorateEditor(SnippetEditorWidget *editor) const
|
|
|
|
This is a hook which allows you to apply customizations such as highlighting or indentation
|
|
to the snippet editor.
|
|
*/
|