src/plugins/texteditor/completionsupport.h

   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 (qt-info@nokia.com)
   8 **
   9 ** No Commercial Usage
  10 **
  11 ** This file contains pre-release code and may not be distributed.
  12 ** You may use this file in accordance with the terms and conditions
  13 ** contained in the Technology Preview License Agreement accompanying
  14 ** this package.
  15 **
  16 ** GNU Lesser General Public License Usage
  17 **
  18 ** Alternatively, this file may be used under the terms of the GNU Lesser
  19 ** General Public License version 2.1 as published by the Free Software
  20 ** Foundation and appearing in the file LICENSE.LGPL included in the
  21 ** packaging of this file.  Please review the following information to
  22 ** ensure the GNU Lesser General Public License version 2.1 requirements
  23 ** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.
  24 **
  25 ** In addition, as a special exception, Nokia gives you certain additional
  26 ** rights.  These rights are described in the Nokia Qt LGPL Exception
  27 ** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.
  28 **
  29 ** If you have questions regarding the use of this file, please contact
  30 ** Nokia at qt-info@nokia.com.
  31 **
  32 **************************************************************************/
  33
  34 #ifndef COMPLETIONSUPPORT_H
  35 #define COMPLETIONSUPPORT_H
  36
  37 #include <texteditor/texteditor_global.h>
  38 #include <texteditor/icompletioncollector.h>
  39
  40 #include <QtCore/QObject>
  41
  42 namespace TextEditor {
  43
  44 class ITextEditor;
  45 class CompletionSupportPrivate;
  46
  47 /* Completion support is responsible for querying the list of completion collectors
  48    and popping up the CompletionWidget with the available completions.
  49  */
  50 class TEXTEDITOR_EXPORT CompletionSupport : public QObject
  51 {
  52     Q_OBJECT
  53
  54 public:
  55     virtual ~CompletionSupport();
  56
  57     static CompletionSupport *instance();
  58
  59     bool isActive() const;
  60     CompletionPolicy policy() const;
  61
  62 public slots:
  63     void complete(TextEditor::ITextEditor *editor,
  64         TextEditor::CompletionPolicy policy, bool forced);
  65
  66 private:
  67     CompletionSupport();
  68     QScopedPointer<CompletionSupportPrivate> d;
  69 };
  70
  71 } // namespace TextEditor
  72
  73 #endif // COMPLETIONSUPPORT_H
  74