KTextEditor::CodeCompletionModel2 Class Reference

#include <codecompletionmodel.h>

Inheritance diagram for KTextEditor::CodeCompletionModel2:

Public Member Functions
	CodeCompletionModel2 (QObject *parent)
virtual void	executeCompletionItem2 (Document *document, const Range &word, const QModelIndex &index) const
Public Member Functions inherited from KTextEditor::CodeCompletionModel
	CodeCompletionModel (QObject *parent)
virtual	~CodeCompletionModel ()
virtual int	columnCount (const QModelIndex &parent=QModelIndex()) const
virtual void	completionInvoked (KTextEditor::View *view, const KTextEditor::Range &range, InvocationType invocationType)
virtual void	executeCompletionItem (Document *document, const Range &word, int row) const
bool	hasGroups () 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
void	setRowCount (int rowCount)

Additional Inherited Members
Public Types inherited from KTextEditor::CodeCompletionModel
enum	Columns {   Prefix = 0, Icon, Scope, Name,   Arguments, Postfix }
enum	CompletionProperty {   NoProperty = 0x0, FirstProperty = 0x1, Public = 0x1, Protected = 0x2,   Private = 0x4, Static = 0x8, Const = 0x10, Namespace = 0x20,   Class = 0x40, Struct = 0x80, Union = 0x100, Function = 0x200,   Variable = 0x400, Enum = 0x800, Template = 0x1000, TypeAlias = 0x2000,   Virtual = 0x4000, Override = 0x8000, Inline = 0x10000, Friend = 0x20000,   Signal = 0x40000, Slot = 0x80000, LocalScope = 0x100000, NamespaceScope = 0x200000,   GlobalScope = 0x400000, LastProperty = GlobalScope }
enum	ExtraItemDataRoles {   CompletionRole = Qt::UserRole, ScopeIndex, MatchQuality, SetMatchContext,   HighlightingMethod, CustomHighlight, InheritanceDepth, IsExpandable,   ExpandingWidget, ItemSelected, ArgumentHintDepth, BestMatchesCount,   AccessibilityNext, AccessibilityPrevious, AccessibilityAccept, GroupRole,   UnimportantItemRole, LastExtraItemDataRole }
enum	HighlightMethod { NoHighlighting = 0x0, InternalHighlighting = 0x1, CustomHighlighting = 0x2 }
enum	InvocationType { AutomaticInvocation, UserInvocation, ManualInvocation }
Signals inherited from KTextEditor::CodeCompletionModel
void	hasGroupsChanged (KTextEditor::CodeCompletionModel *model, bool hasGroups)
void	waitForReset ()
Static Public Attributes inherited from KTextEditor::CodeCompletionModel
static const int	ColumnCount = Postfix + 1
static const int	LastItemDataRole = AccessibilityAccept
Protected Member Functions inherited from KTextEditor::CodeCompletionModel
void	setHasGroups (bool hasGroups)

Detailed Description

You must inherit your completion-model from CodeCompletionModel2 if you want to use a hierarchical structure and want to receive execution-feedback.

See also

CodeCompletionModel::GroupRole

Definition at line 477 of file codecompletionmodel.h.

Constructor & Destructor Documentation

CodeCompletionModel2::CodeCompletionModel2

(

QObject *

parent

)

Definition at line 115 of file codecompletionmodel.cpp.

Member Function Documentation

void CodeCompletionModel2::executeCompletionItem2 ( Document *  document, const Range &  word, const QModelIndex &  index  ) const

virtual

This function is responsible for inserting a selected completion into the document.

The default implementation replaces the text that the completions were based on with the Qt::DisplayRole of the Name column of the given match.

Parameters

document	the document to insert the completion into
word	the Range that the completions are based on (what the user entered so far)
index	identifies the completion match to insert

Definition at line 119 of file codecompletionmodel.cpp.

---

The documentation for this class was generated from the following files:

• codecompletionmodel.h
• codecompletionmodel.cpp