KUrlCompletion Class Reference

#include <KUrlCompletion>

Inheritance diagram for KUrlCompletion:

Public Types
enum	Mode { ExeCompletion = 1 , FileCompletion , DirCompletion }
Public Types inherited from KCompletion
enum	CompletionMode
enum	CompOrder
typedef std::function< void(QStringList &)>	SorterFunction
Public Types inherited from QObject
typedef	QObjectList

Public Member Functions
	KUrlCompletion ()
	KUrlCompletion (Mode)
	~KUrlCompletion () override
virtual QUrl	dir () const
virtual bool	isRunning () const
QString	makeCompletion (const QString &text) override
QStringList	mimeTypeFilters () const
virtual Mode	mode () const
QString	replacedPath (const QString &text) const
virtual bool	replaceEnv () const
virtual bool	replaceHome () const
virtual void	setDir (const QUrl &dir)
void	setMimeTypeFilters (const QStringList &mimeTypes)
virtual void	setMode (Mode mode)
virtual void	setReplaceEnv (bool replace)
virtual void	setReplaceHome (bool replace)
virtual void	stop ()
Public Member Functions inherited from KCompletion
QStringList	allMatches ()
QStringList	allMatches (const QString &string)
KCompletionMatches	allWeightedMatches ()
KCompletionMatches	allWeightedMatches (const QString &string)
CompletionMode	completionMode () const
bool	hasMultipleMatches () const
bool	ignoreCase () const
bool	isEmpty () const
QStringList	items () const
virtual const QString &	lastMatch () const
CompOrder	order () const
virtual void	setCompletionMode (CompletionMode mode)
virtual void	setIgnoreCase (bool ignoreCase)
virtual void	setOrder (CompOrder order)
virtual void	setSoundsEnabled (bool enable)
bool	shouldAutoSuggest () const
bool	soundsEnabled () const
QStringList	substringCompletion (const QString &string) 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 Member Functions
static QString	replacedPath (const QString &text, bool replaceHome, bool replaceEnv=true)
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)

Protected Member Functions
void	postProcessMatch (QString *match) const override
void	postProcessMatches (KCompletionMatches *matches) const override
void	postProcessMatches (QStringList *matches) const override
Protected Member Functions inherited from KCompletion
void	setShouldAutoSuggest (bool shouldAutosuggest)
void	setSorterFunction (SorterFunction sortFunc)
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
Signals inherited from KCompletion
void	match (const QString &item)
void	matches (const QStringList &matchlist)
void	multipleMatches ()
Public Slots inherited from KCompletion
void	addItem (const QString &item)
void	addItem (const QString &item, uint weight)
virtual void	clear ()
void	insertItems (const QStringList &items)
QString	nextMatch ()
QString	previousMatch ()
void	removeItem (const QString &item)
virtual void	setItems (const QStringList &itemList)
Public Attributes inherited from KCompletion
	CompletionAuto
	CompletionMan
	CompletionNone
	CompletionPopup
	CompletionPopupAuto
	CompletionShell
	Insertion
	Sorted
	Weighted

Detailed Description

This class does completion of URLs including user directories (~user) and environment variables.

Remote URLs are passed to KIO.

Completion of a single URL

Author

David Smith dsmit.nosp@m.h@al.nosp@m.gonet.nosp@m..se

Definition at line 40 of file kurlcompletion.h.

Member Enumeration Documentation

Mode

enum KUrlCompletion::Mode

Determines how completion is done.

• ExeCompletion - executables in $PATH or with full path.
• FileCompletion - all files with full path or in dir(), URLs are listed using KIO.
• DirCompletion - Same as FileCompletion but only returns directories.

Definition at line 52 of file kurlcompletion.h.

Constructor & Destructor Documentation

KUrlCompletion() [1/2]

KUrlCompletion::KUrlCompletion

(

)

Constructs a KUrlCompletion object in FileCompletion mode.

Definition at line 531 of file kurlcompletion.cpp.

KUrlCompletion() [2/2]

KUrlCompletion::KUrlCompletion

(

Mode

_mode

)

This overloaded constructor allows you to set the Mode to ExeCompletion or FileCompletion without using setMode.

Default is FileCompletion.

Definition at line 536 of file kurlcompletion.cpp.

~KUrlCompletion()

KUrlCompletion::~KUrlCompletion ( )

override

Destructs the KUrlCompletion object.

Definition at line 542 of file kurlcompletion.cpp.

Member Function Documentation

dir()

QUrl KUrlCompletion::dir ( ) const

virtual

Returns the current directory, as it was given in setDir.

Returns

the current directory, as a URL (use QUrl::toLocalFile for local paths)

Definition at line 552 of file kurlcompletion.cpp.

isRunning()

bool KUrlCompletion::isRunning ( ) const

virtual

Check whether asynchronous completion is in progress.

Returns

true if asynchronous completion is in progress

Definition at line 696 of file kurlcompletion.cpp.

makeCompletion()

QString KUrlCompletion::makeCompletion ( const QString & text )

overridevirtual

Finds completions to the given text.

Remote URLs are listed with KIO. For performance reasons, local files are listed with KIO only if KURLCOMPLETION_LOCAL_KIO is set. The completion is done asynchronously if KIO is used.

Returns the first match for user, environment, and local dir completion and QString() for asynchronous completion (KIO or threaded).

Parameters

text	the text to complete

Returns

the first match, or QString() if not found

Reimplemented from KCompletion.

Definition at line 592 of file kurlcompletion.cpp.

mimeTypeFilters()

QStringList KUrlCompletion::mimeTypeFilters

(

)

const

Returns the MIME type filters for the file dialog.

See also

QFileDialog::mimeTypeFilters()

Since

5.38

Definition at line 1359 of file kurlcompletion.cpp.

mode()

KUrlCompletion::Mode KUrlCompletion::mode ( ) const

virtual

Returns the completion mode: exe or file completion (default FileCompletion).

Returns

the completion mode

Definition at line 557 of file kurlcompletion.cpp.

postProcessMatch()

void KUrlCompletion::postProcessMatch ( QString * match ) const

overrideprotectedvirtual

Reimplemented from KCompletion.

Definition at line 1266 of file kurlcompletion.cpp.

postProcessMatches() [1/2]

void KUrlCompletion::postProcessMatches ( KCompletionMatches * matches ) const

overrideprotectedvirtual

Reimplemented from KCompletion.

Definition at line 1304 of file kurlcompletion.cpp.

postProcessMatches() [2/2]

void KUrlCompletion::postProcessMatches ( QStringList * matches ) const

overrideprotectedvirtual

Reimplemented from KCompletion.

Definition at line 1297 of file kurlcompletion.cpp.

replacedPath() [1/2]

QString KUrlCompletion::replacedPath

(

const QString &

text

)

const

Replaces username and/or environment variables, depending on the current settings and returns the filtered url.

Only works with local files, i.e. returns back the original string for non-local urls.

Parameters

text	the text to process

Returns

the path or URL resulting from this operation. If you want to convert it to a QUrl, use QUrl::fromUserInput.

Definition at line 1349 of file kurlcompletion.cpp.

replacedPath() [2/2]

QString KUrlCompletion::replacedPath ( const QString & text, bool replaceHome, bool replaceEnv = true )

static

I'll let ossi add a real one to KShell :)

Definition at line 1334 of file kurlcompletion.cpp.

replaceEnv()

bool KUrlCompletion::replaceEnv ( ) const

virtual

Checks whether environment variables are completed and whether they are replaced internally while finding completions.

Default is enabled.

Returns

true if environment variables will be replaced

Definition at line 567 of file kurlcompletion.cpp.

replaceHome()

bool KUrlCompletion::replaceHome ( ) const

virtual

Returns whether ~username is completed and whether ~username is replaced internally with the user's home directory while finding completions.

Default is enabled.

Returns

true to replace tilde with the home directory

Definition at line 577 of file kurlcompletion.cpp.

setDir()

void KUrlCompletion::setDir ( const QUrl & dir )

virtual

Sets the current directory (used as base for completion).

Default = $HOME.

Parameters

dir	the current directory, as a URL (use QUrl::fromLocalFile for local paths)

Definition at line 547 of file kurlcompletion.cpp.

setMimeTypeFilters()

void KUrlCompletion::setMimeTypeFilters

(

const QStringList &

mimeTypes

)

Sets the MIME type filters for the file dialog.

See also

QFileDialog::setMimeTypeFilters()

Since

5.38

Definition at line 1354 of file kurlcompletion.cpp.

setMode()

void KUrlCompletion::setMode ( Mode mode )

virtual

Changes the completion mode: exe or file completion.

Parameters

mode	the new completion mode

Definition at line 562 of file kurlcompletion.cpp.

setReplaceEnv()

void KUrlCompletion::setReplaceEnv ( bool replace )

virtual

Enables/disables completion and replacement (internally) of environment variables in URLs.

Default is enabled.

Parameters

replace

true to replace environment variables

Definition at line 572 of file kurlcompletion.cpp.

setReplaceHome()

void KUrlCompletion::setReplaceHome ( bool replace )

virtual

Enables/disables completion of ~username and replacement (internally) of ~username with the user's home directory.

Default is enabled.

Parameters

replace

true to replace tilde with the home directory

Definition at line 582 of file kurlcompletion.cpp.

stop()

void KUrlCompletion::stop ( )

virtual

Stops asynchronous completion.

Definition at line 706 of file kurlcompletion.cpp.

---

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

• kurlcompletion.h
• kurlcompletion.cpp