src/plugins/texteditor/codeassist/iassistproposalitem.cpp

   1 /**************************************************************************
   2 **
   3 ** This file is part of Qt Creator
   4 **
   5 ** Copyright (c) 2011 Nokia Corporation and/or its subsidiary(-ies).
   6 **
   7 ** Contact: Nokia Corporation (info@qt.nokia.com)
   8 **
   9 **
  10 ** GNU Lesser General Public License Usage
  11 **
  12 ** This file may be used under the terms of the GNU Lesser General Public
  13 ** License version 2.1 as published by the Free Software Foundation and
  14 ** appearing in the file LICENSE.LGPL included in the packaging of this file.
  15 ** Please review the following information to ensure the GNU Lesser General
  16 ** Public License version 2.1 requirements will be met:
  17 ** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  18 **
  19 ** In addition, as a special exception, Nokia gives you certain additional
  20 ** rights. These rights are described in the Nokia Qt LGPL Exception
  21 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  22 **
  23 ** Other Usage
  24 **
  25 ** Alternatively, this file may be used in accordance with the terms and
  26 ** conditions contained in a signed written agreement between you and Nokia.
  27 **
  28 ** If you have questions regarding the use of this file, please contact
  29 ** Nokia at info@qt.nokia.com.
  30 **
  31 **************************************************************************/
  32
  33 #include "iassistproposalitem.h"
  34
  35 using namespace TextEditor;
  36
  37 /*!
  38     \class TextEditor::IAssistProposalItem
  39     \brief The IAssistProposalItem class acts as an interface for representing an assist
  40     proposal item.
  41     \ingroup CodeAssist
  42
  43     This is class is part of the CodeAssist API.
  44 */
  45
  46 IAssistProposalItem::IAssistProposalItem()
  47 {}
  48
  49 IAssistProposalItem::~IAssistProposalItem()
  50 {}
  51
  52 /*!
  53     \fn bool TextEditor::IAssistProposalItem::implicitlyApplies() const
  54
  55     Returns whether this item should implicitly apply in the case it is the only proposal
  56     item available.
  57 */
  58
  59 /*!
  60     \fn bool TextEditor::IAssistProposalItem::prematurelyApplies(const QChar &c) const
  61
  62     Returns whether the character \a c causes this item to be applied.
  63 */
  64
  65 /*!
  66     \fn void TextEditor::IAssistProposalItem::apply(BaseTextEditor *editor, int basePosition) const
  67
  68     This is the place to implement the actual application of the item.
  69 */