KateCompletionModel

#include <katecompletionmodel.h>

Inheritance diagram for KateCompletionModel:

[legend]

Public Types
enum	{ BestMatchesProperty = 2 * KTextEditor::CodeCompletionModel::LastProperty }

enum	gm { ScopeType = 0x1 , Scope = 0x2 , AccessType = 0x4 , ItemType = 0x8 }

typedef QFlags< gm >	GroupingMethods

typedef std::set< Group * >	GroupSet

enum	InternalRole { IsNonEmptyGroup = KTextEditor::CodeCompletionModel::LastExtraItemDataRole + 1 }

Public Types inherited from ExpandingWidgetModel
enum	ExpandingType { NotExpandable = 0 , Expandable , Expanded }

Public Types inherited from QAbstractItemModel
enum	CheckIndexOption

enum	LayoutChangeHint

Signals
void	argumentHintsChanged ()

void	expandIndex (const QModelIndex &index)

Public Member Functions
	KateCompletionModel (KateCompletionWidget *parent=nullptr)

KTEXTEDITOR_EXPORT void	addCompletionModel (KTextEditor::CodeCompletionModel *model)

void	clearCompletionModels ()

int	columnCount (const QModelIndex &parent=QModelIndex()) const override

QString	commonPrefix (QModelIndex selectedIndex) const

QList< KTextEditor::CodeCompletionModel * >	completionModels () const

KTEXTEDITOR_EXPORT QString	currentCompletion (KTextEditor::CodeCompletionModel *model) const

QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override

void	debugStats ()

KTEXTEDITOR_EXPORT uint	filteredItemCount () const

Qt::ItemFlags	flags (const QModelIndex &index) const override

bool	hasChildren (const QModelIndex &parent=QModelIndex()) const override

bool	hasGroups () const

virtual bool	hasIndex (int row, int column, const QModelIndex &parent=QModelIndex()) const

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

bool	indexIsItem (const QModelIndex &index) const override

virtual QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const

virtual QModelIndex	mapToSource (const QModelIndex &proxyIndex) const

QModelIndex	parent (const QModelIndex &index) const override

KTEXTEDITOR_EXPORT void	removeCompletionModel (KTextEditor::CodeCompletionModel *model)

int	rowCount (const QModelIndex &parent=QModelIndex()) const override

void	rowSelected (const QModelIndex &row) const

KTEXTEDITOR_EXPORT void	setCompletionModel (KTextEditor::CodeCompletionModel *model)

void	setCompletionModels (const QList< KTextEditor::CodeCompletionModel * > &models)

void	setCurrentCompletion (QMap< KTextEditor::CodeCompletionModel *, QString > currentMatch)

bool	shouldMatchHideCompletionList () const

int	translateColumn (int sourceColumn) const

KTextEditor::ViewPrivate *	view () const

KateCompletionWidget *	widget () const

Public Member Functions inherited from ExpandingWidgetModel
	ExpandingWidgetModel (QWidget *parent)

uint	matchColor (const QModelIndex &index) const

Public Member Functions inherited from QAbstractItemModel
	QAbstractItemModel (QObject *parent)

virtual QModelIndex	buddy (const QModelIndex &index) const const

virtual bool	canDropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent) const const

virtual bool	canFetchMore (const QModelIndex &parent) const const

bool	checkIndex (const QModelIndex &index, CheckIndexOptions options) const const

virtual bool	clearItemData (const QModelIndex &index)

void	columnsAboutToBeInserted (const QModelIndex &parent, int first, int last)

void	columnsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	columnsInserted (const QModelIndex &parent, int first, int last)

void	columnsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationColumn)

void	columnsRemoved (const QModelIndex &parent, int first, int last)

void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QList< int > &roles)

virtual bool	dropMimeData (const QMimeData *data, Qt::DropAction action, int row, int column, const QModelIndex &parent)

virtual void	fetchMore (const QModelIndex &parent)

bool	hasIndex (int row, int column, const QModelIndex &parent) const const

virtual QVariant	headerData (int section, Qt::Orientation orientation, int role) const const

void	headerDataChanged (Qt::Orientation orientation, int first, int last)

bool	insertColumn (int column, const QModelIndex &parent)

virtual bool	insertColumns (int column, int count, const QModelIndex &parent)

bool	insertRow (int row, const QModelIndex &parent)

virtual bool	insertRows (int row, int count, const QModelIndex &parent)

virtual QMap< int, QVariant >	itemData (const QModelIndex &index) const const

void	layoutAboutToBeChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

void	layoutChanged (const QList< QPersistentModelIndex > &parents, QAbstractItemModel::LayoutChangeHint hint)

virtual QModelIndexList	match (const QModelIndex &start, int role, const QVariant &value, int hits, Qt::MatchFlags flags) const const

virtual QMimeData *	mimeData (const QModelIndexList &indexes) const const

virtual QStringList	mimeTypes () const const

void	modelAboutToBeReset ()

void	modelReset ()

bool	moveColumn (const QModelIndex &sourceParent, int sourceColumn, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveColumns (const QModelIndex &sourceParent, int sourceColumn, int count, const QModelIndex &destinationParent, int destinationChild)

bool	moveRow (const QModelIndex &sourceParent, int sourceRow, const QModelIndex &destinationParent, int destinationChild)

virtual bool	moveRows (const QModelIndex &sourceParent, int sourceRow, int count, const QModelIndex &destinationParent, int destinationChild)

virtual void	multiData (const QModelIndex &index, QModelRoleDataSpan roleDataSpan) const const

bool	removeColumn (int column, const QModelIndex &parent)

virtual bool	removeColumns (int column, int count, const QModelIndex &parent)

bool	removeRow (int row, const QModelIndex &parent)

virtual bool	removeRows (int row, int count, const QModelIndex &parent)

virtual void	revert ()

virtual QHash< int, QByteArray >	roleNames () const const

void	rowsAboutToBeInserted (const QModelIndex &parent, int start, int end)

void	rowsAboutToBeMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsAboutToBeRemoved (const QModelIndex &parent, int first, int last)

void	rowsInserted (const QModelIndex &parent, int first, int last)

void	rowsMoved (const QModelIndex &sourceParent, int sourceStart, int sourceEnd, const QModelIndex &destinationParent, int destinationRow)

void	rowsRemoved (const QModelIndex &parent, int first, int last)

virtual bool	setData (const QModelIndex &index, const QVariant &value, int role)

virtual bool	setHeaderData (int section, Qt::Orientation orientation, const QVariant &value, int role)

virtual bool	setItemData (const QModelIndex &index, const QMap< int, QVariant > &roles)

virtual QModelIndex	sibling (int row, int column, const QModelIndex &index) const const

virtual void	sort (int column, Qt::SortOrder order)

virtual QSize	span (const QModelIndex &index) const const

virtual bool	submit ()

virtual Qt::DropActions	supportedDragActions () const const

virtual Qt::DropActions	supportedDropActions () const const

Public Member Functions inherited from QObject
	QObject (QObject *parent)

QBindable< QString >	bindableObjectName ()

bool	blockSignals (bool block)

const QObjectList &	children () const const

QMetaObject::Connection	connect (const QObject sender, const char signal, const char *method, Qt::ConnectionType type) const const

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const char signal, const QObject receiver, const char *method) const const

bool	disconnect (const QObject receiver, const char method) const const

void	dumpObjectInfo () const const

void	dumpObjectTree () const const

QList< QByteArray >	dynamicPropertyNames () const const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const

QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const

QList< T >	findChildren (Qt::FindChildOptions options) const const

bool	inherits (const char *className) const const

void	installEventFilter (QObject *filterObj)

bool	isQuickItemType () const const

bool	isWidgetType () const const

bool	isWindowType () const const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const const

void	moveToThread (QThread *targetThread)

QString	objectName () const const

void	objectNameChanged (const QString &objectName)

QObject *	parent () const const

QVariant	property (const char *name) const const

	Q_CLASSINFO (Name, Value)

	Q_EMIT Q_EMIT

	Q_ENUM (...)

	Q_ENUM_NS (...)

	Q_ENUMS (...)

	Q_FLAG (...)

	Q_FLAG_NS (...)

	Q_FLAGS (...)

	Q_GADGET Q_GADGET

	Q_GADGET_EXPORT (EXPORT_MACRO)

	Q_INTERFACES (...)

	Q_INVOKABLE Q_INVOKABLE

	Q_MOC_INCLUDE Q_MOC_INCLUDE

	Q_NAMESPACE Q_NAMESPACE

	Q_NAMESPACE_EXPORT (EXPORT_MACRO)

	Q_OBJECT Q_OBJECT

	Q_PROPERTY (...)

	Q_REVISION Q_REVISION

	Q_SET_OBJECT_NAME (Object)

	Q_SIGNAL Q_SIGNAL

	Q_SIGNALS Q_SIGNALS

	Q_SLOT Q_SLOT

	Q_SLOTS Q_SLOTS

T	qobject_cast (const QObject *object)

T	qobject_cast (QObject *object)

	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT

void	removeEventFilter (QObject *obj)

void	setObjectName (const QString &name)

void	setObjectName (QAnyStringView name)

void	setParent (QObject *parent)

bool	setProperty (const char *name, const QVariant &value)

bool	setProperty (const char *name, QVariant &&value)

bool	signalsBlocked () const const

int	startTimer (int interval, Qt::TimerType timerType)

int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)

QThread *	thread () const const

Static Public Attributes
static const int	AccessTypeMask = 0x7

static const int	ItemTypeMask = 0xfe0

static const int	ScopeTypeMask = 0x380000

Protected Member Functions
int	contextMatchQuality (const QModelIndex &index) const override

Protected Member Functions inherited from QAbstractItemModel
void	beginInsertColumns (const QModelIndex &parent, int first, int last)

void	beginInsertRows (const QModelIndex &parent, int first, int last)

bool	beginMoveColumns (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

bool	beginMoveRows (const QModelIndex &sourceParent, int sourceFirst, int sourceLast, const QModelIndex &destinationParent, int destinationChild)

void	beginRemoveColumns (const QModelIndex &parent, int first, int last)

void	beginRemoveRows (const QModelIndex &parent, int first, int last)

void	beginResetModel ()

void	changePersistentIndex (const QModelIndex &from, const QModelIndex &to)

void	changePersistentIndexList (const QModelIndexList &from, const QModelIndexList &to)

QModelIndex	createIndex (int row, int column, const void *ptr) const const

QModelIndex	createIndex (int row, int column, quintptr id) const const

void	endInsertColumns ()

void	endInsertRows ()

void	endMoveColumns ()

void	endMoveRows ()

void	endRemoveColumns ()

void	endRemoveRows ()

void	endResetModel ()

QModelIndexList	persistentIndexList () const const

virtual void	resetInternalData ()

Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const QMetaMethod &signal)

virtual void	customEvent (QEvent *event)

virtual void	disconnectNotify (const QMetaMethod &signal)

bool	isSignalConnected (const QMetaMethod &signal) const const

int	receivers (const char *signal) const const

QObject *	sender () const const

int	senderSignalIndex () const const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
Properties inherited from QObject
	objectName

Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject sender, const char signal, const QObject receiver, const char method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject context, Functor functor, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method, Qt::ConnectionType type)

QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)

bool	disconnect (const QMetaObject::Connection &connection)

bool	disconnect (const QObject sender, const char signal, const QObject receiver, const char method)

bool	disconnect (const QObject sender, const QMetaMethod &signal, const QObject receiver, const QMetaMethod &method)

bool	disconnect (const QObject sender, PointerToMemberFunction signal, const QObject receiver, PointerToMemberFunction method)

QString	tr (const char sourceText, const char disambiguation, int n)

Public Attributes inherited from QAbstractItemModel
typedef	CheckIndexOptions

	DoNotUseParent

	HorizontalSortHint

	IndexIsValid

	NoLayoutChangeHint

	NoOption

	ParentIsInvalid

	VerticalSortHint

Public Attributes inherited from QObject
typedef	QObjectList

Detailed Description

This class has the responsibility for filtering, sorting, and manipulating code completion data provided by a CodeCompletionModel.

Author: Hamish Rodda rodda.nosp@m.@kde.nosp@m..org

Definition at line 39 of file katecompletionmodel.h.

Member Typedef Documentation

◆ GroupingMethods

typedef QFlags< gm > KateCompletionModel::GroupingMethods

Definition at line 103 of file katecompletionmodel.h.

◆ GroupSet

typedef std::set<Group *> KateCompletionModel::GroupSet

Definition at line 230 of file katecompletionmodel.h.

Member Enumeration Documentation

◆ anonymous enum

anonymous enum

Definition at line 99 of file katecompletionmodel.h.

◆ gm

enum KateCompletionModel::gm

Definition at line 92 of file katecompletionmodel.h.

◆ InternalRole

enum KateCompletionModel::InternalRole

Definition at line 44 of file katecompletionmodel.h.

Constructor & Destructor Documentation

◆ KateCompletionModel()

KateCompletionModel::KateCompletionModel ( KateCompletionWidget * parent = nullptr )

explicit

Definition at line 141 of file katecompletionmodel.cpp.

◆ ~KateCompletionModel()

KateCompletionModel::~KateCompletionModel ( )

override

Definition at line 159 of file katecompletionmodel.cpp.

Member Function Documentation

◆ addCompletionModel()

void KateCompletionModel::addCompletionModel ( KTextEditor::CodeCompletionModel * model )

Definition at line 1501 of file katecompletionmodel.cpp.

◆ clearCompletionModels()

void KateCompletionModel::clearCompletionModels ( )

Definition at line 1791 of file katecompletionmodel.cpp.

◆ columnCount()

int KateCompletionModel::columnCount ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Implements QAbstractItemModel.

Definition at line 360 of file katecompletionmodel.cpp.

◆ commonPrefix()

QString KateCompletionModel::commonPrefix ( QModelIndex selectedIndex ) const

Returns a common prefix for all current visible completion entries If there is no common prefix, extracts the next useful prefix for the selected index.

Definition at line 919 of file katecompletionmodel.cpp.

◆ completionModels()

QList< KTextEditor::CodeCompletionModel * > KateCompletionModel::completionModels ( ) const

Definition at line 1554 of file katecompletionmodel.cpp.

◆ contextMatchQuality()

int KateCompletionModel::contextMatchQuality ( const QModelIndex & index ) const

overrideprotectedvirtual

Returns: the context-match quality from 0 to 10 if it could be determined, else -1

Implements ExpandingWidgetModel.

Definition at line 281 of file katecompletionmodel.cpp.

◆ currentCompletion()

QString KateCompletionModel::currentCompletion ( KTextEditor::CodeCompletionModel * model ) const

Definition at line 1496 of file katecompletionmodel.cpp.

◆ data()

QVariant KateCompletionModel::data	(	const QModelIndex &	index,
		int	role = Qt::DisplayRole ) const

overridevirtual

Does not request data from index, this only returns local data like highlighting for expanded rows and similar.

Reimplemented from ExpandingWidgetModel.

Definition at line 172 of file katecompletionmodel.cpp.

◆ debugStats()

void KateCompletionModel::debugStats ( )

Definition at line 1067 of file katecompletionmodel.cpp.

◆ filteredItemCount()

uint KateCompletionModel::filteredItemCount ( ) const

Definition at line 1330 of file katecompletionmodel.cpp.

◆ flags()

Qt::ItemFlags KateCompletionModel::flags ( const QModelIndex & index ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 337 of file katecompletionmodel.cpp.

◆ hasChildren()

bool KateCompletionModel::hasChildren ( const QModelIndex & parent = QModelIndex() ) const

overridevirtual

Reimplemented from QAbstractItemModel.

Definition at line 370 of file katecompletionmodel.cpp.

◆ hasGroups()

bool KateCompletionModel::hasGroups ( ) const

inline

Definition at line 232 of file katecompletionmodel.h.

◆ hasIndex()

bool KateCompletionModel::hasIndex	(	int	row,
		int	column,
		const QModelIndex &	parent = QModelIndex() ) const

virtual

Definition at line 434 of file katecompletionmodel.cpp.

◆ index()

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

overridevirtual

Implements QAbstractItemModel.

Definition at line 399 of file katecompletionmodel.cpp.

◆ indexIsItem()

bool KateCompletionModel::indexIsItem ( const QModelIndex & index ) const

overridevirtual

Should return true if the given row should be painted like a contained item(as opposed to label-rows etc.)

Implements ExpandingWidgetModel.

Definition at line 1047 of file katecompletionmodel.cpp.

◆ mapFromSource()

QModelIndex KateCompletionModel::mapFromSource ( const QModelIndex & sourceIndex ) const

virtual

Maps from an index in a source-model to the index of the item in this display-model.

Definition at line 825 of file katecompletionmodel.cpp.

◆ mapToSource()

QModelIndex KateCompletionModel::mapToSource ( const QModelIndex & proxyIndex ) const

virtual

Maps from this display-model into the appropriate source code-completion model.

Definition at line 802 of file katecompletionmodel.cpp.

◆ parent()

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

overridevirtual

Implements QAbstractItemModel.

Definition at line 750 of file katecompletionmodel.cpp.

◆ removeCompletionModel()

void KateCompletionModel::removeCompletionModel ( KTextEditor::CodeCompletionModel * model )

Definition at line 1559 of file katecompletionmodel.cpp.

◆ rowCount()

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

overridevirtual

Implements QAbstractItemModel.

Definition at line 774 of file katecompletionmodel.cpp.

◆ rowSelected()

void KateCompletionModel::rowSelected ( const QModelIndex & row ) const

Todo: delay this

Definition at line 1776 of file katecompletionmodel.cpp.

◆ setCompletionModel()

void KateCompletionModel::setCompletionModel ( KTextEditor::CodeCompletionModel * model )

Definition at line 1523 of file katecompletionmodel.cpp.

◆ setCompletionModels()

void KateCompletionModel::setCompletionModels ( const QList< KTextEditor::CodeCompletionModel * > & models )

Definition at line 1529 of file katecompletionmodel.cpp.

◆ setCurrentCompletion()

void KateCompletionModel::setCurrentCompletion ( QMap< KTextEditor::CodeCompletionModel *, QString > currentMatch )

Definition at line 853 of file katecompletionmodel.cpp.

◆ shouldMatchHideCompletionList()

bool KateCompletionModel::shouldMatchHideCompletionList ( ) const

Returns whether one of the filtered items exactly matches its completion string.

Definition at line 1340 of file katecompletionmodel.cpp.

◆ translateColumn()

int KateCompletionModel::translateColumn ( int sourceColumn ) const

Definition at line 1084 of file katecompletionmodel.cpp.

◆ view()

KTextEditor::ViewPrivate * KateCompletionModel::view ( ) const

Definition at line 355 of file katecompletionmodel.cpp.

◆ widget()

KateCompletionWidget * KateCompletionModel::widget ( ) const

Definition at line 350 of file katecompletionmodel.cpp.

Member Data Documentation

◆ AccessTypeMask

const int KateCompletionModel::AccessTypeMask = 0x7

static

Definition at line 106 of file katecompletionmodel.h.

◆ ItemTypeMask

const int KateCompletionModel::ItemTypeMask = 0xfe0

static

Definition at line 107 of file katecompletionmodel.h.

◆ ScopeTypeMask

const int KateCompletionModel::ScopeTypeMask = 0x380000

static

Definition at line 105 of file katecompletionmodel.h.

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

KDE's Doxygen guidelines are available online.

Class Picker

Quick Links

About KTextEditor

KateCompletionModel

Public Types

Signals

Public Member Functions

Static Public Attributes

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ GroupingMethods

◆ GroupSet

Member Enumeration Documentation

◆ anonymous enum

◆ gm

◆ InternalRole

Constructor & Destructor Documentation

◆ KateCompletionModel()

◆ ~KateCompletionModel()

Member Function Documentation

◆ addCompletionModel()

◆ clearCompletionModels()

◆ columnCount()

◆ commonPrefix()

◆ completionModels()

◆ contextMatchQuality()

◆ currentCompletion()

◆ data()

◆ debugStats()

◆ filteredItemCount()

◆ flags()

◆ hasChildren()

◆ hasGroups()

◆ hasIndex()

◆ index()

◆ indexIsItem()

◆ mapFromSource()

◆ mapToSource()

◆ parent()

◆ removeCompletionModel()

◆ rowCount()

◆ rowSelected()

◆ setCompletionModel()

◆ setCompletionModels()

◆ setCurrentCompletion()

◆ shouldMatchHideCompletionList()

◆ translateColumn()

◆ view()

◆ widget()

Member Data Documentation

◆ AccessTypeMask

◆ ItemTypeMask

◆ ScopeTypeMask