KateCompletionModel Class Reference

#include <katecompletionmodel.h>

Inheritance diagram for KateCompletionModel:

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 Slots
void	setColumnMergingEnabled (bool enable)
void	setGroupingEnabled (bool enable)
Public Slots inherited from ExpandingWidgetModel
void	placeExpandingWidgets ()

Public Member Functions
	KateCompletionModel (KateCompletionWidget *parent=nullptr)
bool	accessIncludeConst () const
bool	accessIncludeSignalSlot () const
bool	accessIncludeStatic () const
void	addCompletionModel (KTextEditor::CodeCompletionModel *model)
void	clearCompletionModels ()
int	columnCount (const QModelIndex &parent=QModelIndex()) const override
const QList< QList< int > > &	columnMerges () const
QString	commonPrefix (QModelIndex selectedIndex) const
QList< KTextEditor::CodeCompletionModel * >	completionModels () const
QString	currentCompletion (KTextEditor::CodeCompletionModel *model) const
QVariant	data (const QModelIndex &index, int role=Qt::DisplayRole) const override
void	debugStats ()
uint	filteredItemCount () const
Qt::ItemFlags	flags (const QModelIndex &index) const override
GroupingMethods	groupingMethod () const
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
bool	isColumnMergingEnabled () const
bool	isGroupingEnabled () const
virtual QModelIndex	mapFromSource (const QModelIndex &sourceIndex) const
virtual QModelIndex	mapToSource (const QModelIndex &proxyIndex) const
QModelIndex	parent (const QModelIndex &index) const override
void	removeCompletionModel (KTextEditor::CodeCompletionModel *model)
int	rowCount (const QModelIndex &parent=QModelIndex()) const override
void	rowSelected (const QModelIndex &row) const
void	setAccessIncludeConst (bool include)
void	setAccessIncludeSignalSlot (bool include)
void	setAccessIncludeStatic (bool include)
void	setColumnMerges (const QList< QList< int >> &columnMerges)
void	setCompletionModel (KTextEditor::CodeCompletionModel *model)
void	setCompletionModels (const QList< KTextEditor::CodeCompletionModel * > &models)
void	setCurrentCompletion (KTextEditor::CodeCompletionModel *model, const QString &completion)
void	setGroupingMethod (GroupingMethods m)
bool	shouldMatchHideCompletionList () const
void	sort (int column, Qt::SortOrder order=Qt::AscendingOrder) override
int	translateColumn (int sourceColumn) const
KTextEditor::ViewPrivate *	view () const
KateCompletionWidget *	widget () const
Public Member Functions inherited from ExpandingWidgetModel
	ExpandingWidgetModel (QWidget *parent)
void	clearExpanding ()
QWidget *	expandingWidget (const QModelIndex &row) const
bool	isExpandable (const QModelIndex &index) const
bool	isExpanded (const QModelIndex &row) const
uint	matchColor (const QModelIndex &index) const
void	placeExpandingWidget (const QModelIndex &row)
void	setExpanded (QModelIndex index, bool expanded)
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, QAbstractItemModel::CheckIndexOptions options) const const
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 &parent, int start, int end, const QModelIndex &destination, int column)
void	columnsRemoved (const QModelIndex &parent, int first, int last)
void	dataChanged (const QModelIndex &topLeft, const QModelIndex &bottomRight, const QVector< 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)
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 &parent, int start, int end, const QModelIndex &destination, int row)
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)
void	setSupportedDragActions (Qt::DropActions actions)
virtual QModelIndex	sibling (int row, int column, const QModelIndex &index) const const
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)
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 ()
void	dumpObjectInfo () const const
void	dumpObjectTree ()
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 QRegExp &regExp, 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
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
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_DISABLE_COPY (Class)
	Q_DISABLE_COPY_MOVE (Class)
	Q_DISABLE_MOVE (Class)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	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	qFindChild (const QObject *obj, const QString &name)
QList< T >	qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T >	qFindChildren (const QObject *obj, const QString &name)
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	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds time, 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 ExpandingWidgetModel
int	basicRowHeight (const QModelIndex &index) const
void	cacheIcons () const
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, quintptr id) const const
QModelIndex	createIndex (int row, int column, void *ptr) const const
void	endInsertColumns ()
void	endInsertRows ()
void	endMoveColumns ()
void	endMoveRows ()
void	endRemoveColumns ()
void	endRemoveRows ()
void	endResetModel ()
QModelIndexList	persistentIndexList () const const
void	reset ()
void	resetInternalData ()
void	setRoleNames (const QHash< int, QByteArray > &roleNames)
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)
QString	trUtf8 (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
Protected Attributes inherited from ExpandingWidgetModel
QIcon	m_collapsedIcon
QIcon	m_expandedIcon

Detailed Description

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

Author

Hamish Rodda rodda[email protected]@kde[email protected].org

Definition at line 39 of file katecompletionmodel.h.

Member Function Documentation

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 1054 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 279 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 165 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 1210 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 930 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 907 of file katecompletionmodel.cpp.

rowSelected()

void KateCompletionModel::rowSelected

(

const QModelIndex &

row

)

const

Todo:

delay this

Definition at line 2052 of file katecompletionmodel.cpp.

shouldMatchHideCompletionList()

bool KateCompletionModel::shouldMatchHideCompletionList

(

)

const

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

Definition at line 1634 of file katecompletionmodel.cpp.

---

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

• katecompletionmodel.h
• katecompletionmodel.cpp