KateKeywordCompletionModel Class Reference

#include <katekeywordcompletion.h>

Inheritance diagram for KateKeywordCompletionModel:

Public Member Functions
	KateKeywordCompletionModel (QObject *parent)
virtual void	completionInvoked (KTextEditor::View *view, const KTextEditor::Range &range, InvocationType invocationType)
virtual KTextEditor::Range	completionRange (KTextEditor::View *view, const KTextEditor::Cursor &position)
virtual QVariant	data (const QModelIndex &index, int role) const
virtual QModelIndex	index (int row, int column, const QModelIndex &parent=QModelIndex()) const
virtual MatchReaction	matchingItem (const QModelIndex &matched)
virtual QModelIndex	parent (const QModelIndex &index) const
virtual int	rowCount (const QModelIndex &parent=QModelIndex()) const
virtual bool	shouldAbortCompletion (KTextEditor::View *view, const KTextEditor::Range &range, const QString &currentCompletion)
virtual bool	shouldHideItemsWithEqualNames () const
virtual bool	shouldStartCompletion (KTextEditor::View *view, const QString &insertedText, bool userInsertion, const KTextEditor::Cursor &position)

Detailed Description

Highlighting-file based keyword completion for the editor.

This model offers completion of language-specific keywords based on information taken from the kate syntax files. It queries the highlighting engine to get the correct context for a given cursor position, then suggests all keyword items from the XML file for the active language.

Definition at line 34 of file katekeywordcompletion.h.

Constructor & Destructor Documentation

KateKeywordCompletionModel::KateKeywordCompletionModel

(

QObject *

parent

)

Definition at line 29 of file katekeywordcompletion.cpp.

Member Function Documentation

void KateKeywordCompletionModel::completionInvoked ( KTextEditor::View *  view, const KTextEditor::Range &  range, InvocationType  invocationType  )

virtual

Definition at line 35 of file katekeywordcompletion.cpp.

KTextEditor::Range KateKeywordCompletionModel::completionRange ( KTextEditor::View *  view, const KTextEditor::Cursor &  position  )

virtual

Definition at line 126 of file katekeywordcompletion.cpp.

QVariant KateKeywordCompletionModel::data ( const QModelIndex &  index, int  role  ) const

virtual

Definition at line 173 of file katekeywordcompletion.cpp.

QModelIndex KateKeywordCompletionModel::index ( int  row, int  column, const QModelIndex &  parent = QModelIndex()  ) const

virtual

Definition at line 90 of file katekeywordcompletion.cpp.

KTextEditor::CodeCompletionModelControllerInterface3::MatchReaction KateKeywordCompletionModel::matchingItem ( const QModelIndex &  matched )

virtual

Definition at line 201 of file katekeywordcompletion.cpp.

QModelIndex KateKeywordCompletionModel::parent ( const QModelIndex &  index ) const

virtual

Definition at line 82 of file katekeywordcompletion.cpp.

int KateKeywordCompletionModel::rowCount ( const QModelIndex &  parent = QModelIndex() ) const

virtual

Definition at line 108 of file katekeywordcompletion.cpp.

bool KateKeywordCompletionModel::shouldAbortCompletion ( KTextEditor::View *  view, const KTextEditor::Range &  range, const QString &  currentCompletion  )

virtual

Definition at line 143 of file katekeywordcompletion.cpp.

bool KateKeywordCompletionModel::shouldHideItemsWithEqualNames ( ) const

virtual

When multiple completion models are used at the same time, it may happen that multiple models add items with the same name to the list.

This option allows to hide items from this completion model when another model with higher priority contains items with the same name.

Returns

Whether items of this completion model should be hidden if another completion model has items with the same name

Reimplemented from KTextEditor::CodeCompletionModelControllerInterface4.

Definition at line 168 of file katekeywordcompletion.cpp.

bool KateKeywordCompletionModel::shouldStartCompletion ( KTextEditor::View *  view, const QString &  insertedText, bool  userInsertion, const KTextEditor::Cursor &  position  )

virtual

Definition at line 158 of file katekeywordcompletion.cpp.

---

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

• katekeywordcompletion.h
• katekeywordcompletion.cpp