src/plugins/texteditor/completionwidget.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 COMPLETIONWIDGET_H
  35 #define COMPLETIONWIDGET_H
  36
  37 #include <QtGui/QListView>
  38 #include <QtCore/QPointer>
  39 #include <QtCore/QTimer>
  40
  41 namespace TextEditor {
  42
  43 class CompletionItem;
  44 class ITextEditor;
  45 class CompletionSupport;
  46
  47 namespace Internal {
  48
  49 class AutoCompletionModel;
  50 class CompletionListView;
  51 class CompletionInfoFrame;
  52
  53 /* The completion widget is responsible for showing a list of possible completions.
  54    It is only used by the CompletionSupport.
  55  */
  56 class CompletionWidget : public QFrame
  57 {
  58     Q_OBJECT
  59
  60 public:
  61     CompletionWidget(CompletionSupport *support, ITextEditor *editor);
  62     ~CompletionWidget();
  63
  64     void setCompletionItems(const QList<TextEditor::CompletionItem> &completionitems);
  65     void showCompletions(int startPos);
  66
  67     QChar typedChar() const;
  68     CompletionItem currentCompletionItem() const;
  69
  70     void setCurrentIndex(int index);
  71     bool explicitlySelected() const;
  72
  73 signals:
  74     void itemSelected(const TextEditor::CompletionItem &item);
  75     void completionListClosed();
  76
  77 public slots:
  78     void closeList(const QModelIndex &index = QModelIndex());
  79
  80 private:
  81     void updatePositionAndSize(int startPos);
  82
  83 private:
  84     CompletionSupport *m_support;
  85     ITextEditor *m_editor;
  86     CompletionListView *m_completionListView;
  87 };
  88
  89 class CompletionListView : public QListView
  90 {
  91     Q_OBJECT
  92
  93 public:
  94     ~CompletionListView();
  95
  96     CompletionItem currentCompletionItem() const;
  97     bool explicitlySelected() const;
  98
  99 signals:
 100     void itemSelected(const TextEditor::CompletionItem &item);
 101     void completionListClosed();
 102
 103 protected:
 104     bool event(QEvent *e);
 105
 106     void currentChanged(const QModelIndex &current, const QModelIndex &previous);
 107
 108 private:
 109     friend class CompletionWidget;
 110
 111     CompletionListView(CompletionSupport *support, ITextEditor *editor, CompletionWidget *completionWidget);
 112
 113     void setCompletionItems(const QList<TextEditor::CompletionItem> &completionitems);
 114     void keyboardSearch(const QString &search);
 115     void closeList(const QModelIndex &index);
 116
 117 private slots:
 118     void maybeShowInfoTip();
 119
 120 private:
 121     bool m_blockFocusOut;
 122     ITextEditor *m_editor;
 123     QWidget *m_editorWidget;
 124     CompletionWidget *m_completionWidget;
 125     AutoCompletionModel *m_model;
 126     CompletionSupport *m_support;
 127     QPointer<CompletionInfoFrame> m_infoFrame;
 128     QTimer m_infoTimer;
 129     QChar m_typedChar;
 130     bool m_explicitlySelected;
 131 };
 132
 133 } // namespace Internal
 134 } // namespace TextEditor
 135
 136 #endif // COMPLETIONWIDGET_H
 137