codecompletionmodel.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 2007-2008 David Nolden <david.nolden.kdevelop@art-master.de>
   Copyright (C) 2005-2006 Hamish Rodda <rodda@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.

   This library is distributed in the hope that it will be useful,
   but WITHOUT ANY WARRANTY; without even the implied warranty of
   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/

#ifndef KDELIBS_KTEXTEDITOR_CODECOMPLETIONMODEL_H
#define KDELIBS_KTEXTEDITOR_CODECOMPLETIONMODEL_H

#include <ktexteditor/ktexteditor_export.h>
#include <QtCore/QModelIndex>
#include <ktexteditor/range.h>

namespace KTextEditor {

class Document;
class View;

class KTEXTEDITOR_EXPORT CodeCompletionModel : public QAbstractItemModel
{
  Q_OBJECT

  public:
    CodeCompletionModel(QObject* parent);
    virtual ~CodeCompletionModel();

    enum Columns {
      Prefix = 0,
      Icon,
      Scope,
      Name,
      Arguments,
      Postfix
    };
    static const int ColumnCount = Postfix + 1;

    enum CompletionProperty {
      NoProperty  = 0x0,
      FirstProperty = 0x1,

      // Access specifiers - no more than 1 per item
      Public      = 0x1,
      Protected   = 0x2,
      Private     = 0x4,

      // Extra access specifiers - any number per item
      Static      = 0x8,
      Const       = 0x10,

      // Type - no more than 1 per item (except for Template)
      Namespace   = 0x20,
      Class       = 0x40,
      Struct      = 0x80,
      Union       = 0x100,
      Function    = 0x200,
      Variable    = 0x400,
      Enum        = 0x800,
      Template    = 0x1000,
      TypeAlias   = 0x2000,

      // Special attributes - any number per item
      Virtual     = 0x4000,
      Override    = 0x8000,
      Inline      = 0x10000,
      Friend      = 0x20000,
      Signal      = 0x40000,
      Slot        = 0x80000,

      // Scope - no more than 1 per item
      LocalScope      = 0x100000,
      NamespaceScope  = 0x200000,
      GlobalScope     = 0x400000,

      // Keep this in sync so the code knows when to stop
      LastProperty    = GlobalScope
    };
    Q_DECLARE_FLAGS(CompletionProperties, CompletionProperty)

    enum HighlightMethod {
      NoHighlighting        = 0x0,
      InternalHighlighting  = 0x1,
      CustomHighlighting    = 0x2
    };
    Q_DECLARE_FLAGS(HighlightMethods, HighlightMethod)

    
    enum ExtraItemDataRoles {
      CompletionRole = Qt::UserRole,

      ScopeIndex,

      MatchQuality,

      SetMatchContext,
      
      HighlightingMethod,

      CustomHighlight,

      InheritanceDepth,

      IsExpandable,
      ExpandingWidget,
      ItemSelected,

      ArgumentHintDepth,
      
      BestMatchesCount,
      
      AccessibilityNext,
      AccessibilityPrevious,
      AccessibilityAccept,

      GroupRole,


      UnimportantItemRole,

      LastExtraItemDataRole
    };
    // KDE5 remove
    static const int LastItemDataRole = AccessibilityAccept;

    void setRowCount(int rowCount);

    enum InvocationType {
      AutomaticInvocation,
      UserInvocation,
      ManualInvocation
    };

    virtual void completionInvoked(KTextEditor::View* view, const KTextEditor::Range& range, InvocationType invocationType);
    virtual void executeCompletionItem(Document* document, const Range& word, int row) const;

    // Reimplementations
    virtual int columnCount ( const QModelIndex & parent = QModelIndex() ) const;
    virtual QModelIndex index ( int row, int column, const QModelIndex & parent = QModelIndex() ) const;
    virtual QMap<int, QVariant> itemData ( const QModelIndex & index ) const;
    virtual QModelIndex parent ( const QModelIndex & index ) const;
    virtual int rowCount ( const QModelIndex & parent = QModelIndex() ) const;

    bool hasGroups() const;

  Q_SIGNALS:
    
    void waitForReset();
    
    void hasGroupsChanged(KTextEditor::CodeCompletionModel *model,bool hasGroups);

  protected:
    void setHasGroups(bool hasGroups);

  private:
    class CodeCompletionModelPrivate* const d;
};

class KTEXTEDITOR_EXPORT CodeCompletionModel2 : public CodeCompletionModel {
  Q_OBJECT
  public:
    CodeCompletionModel2(QObject* parent);
    virtual void executeCompletionItem2(Document* document, const Range& word, const QModelIndex& index) const;
};

Q_DECLARE_OPERATORS_FOR_FLAGS(CodeCompletionModel::CompletionProperties)
Q_DECLARE_OPERATORS_FOR_FLAGS(CodeCompletionModel::HighlightMethods)

}

#endif // KDELIBS_KTEXTEDITOR_CODECOMPLETIONMODEL_H