#include <kurlcompletion.h>

Inheritance diagram for KUrlCompletion:

Public Types
enum	Mode { ExeCompletion = 1, FileCompletion, DirCompletion }

Public Types inherited from KCompletion
enum	CompOrder

Public Member Functions
	KUrlCompletion ()

	KUrlCompletion (Mode)

virtual	~KUrlCompletion ()

virtual QString	dir () const

virtual bool	isRunning () const

virtual QString	makeCompletion (const QString &text)

virtual Mode	mode () const

QString	replacedPath (const QString &text) const

virtual bool	replaceEnv () const

virtual bool	replaceHome () const

virtual void	setDir (const QString &dir)

virtual void	setMode (Mode mode)

virtual void	setReplaceEnv (bool replace)

virtual void	setReplaceHome (bool replace)

virtual void	stop ()

Public Member Functions inherited from KCompletion
	KCompletion ()

virtual	~KCompletion ()

QStringList	allMatches (const QString &string)

QStringList	allMatches ()

KCompletionMatches	allWeightedMatches ()

KCompletionMatches	allWeightedMatches (const QString &string)

KGlobalSettings::Completion	completionMode () const

bool	hasMultipleMatches () const

bool	ignoreCase () const

bool	isEmpty () const

QStringList	items () const

virtual const QString &	lastMatch () const

QString	nextMatch ()

CompOrder	order () const

QString	previousMatch ()

virtual void	setCompletionMode (KGlobalSettings::Completion mode)

virtual void	setIgnoreCase (bool ignoreCase)

virtual void	setOrder (CompOrder order)

virtual void	setSoundsEnabled (bool enable)

bool	soundsEnabled () const

QStringList	substringCompletion (const QString &string) const

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

	QObject (QObject parent, const char name)

virtual	~QObject ()

bool	blockSignals (bool block)

QObject *	child (const char objName, const char inheritsClass, bool recursiveSearch) const

const QObjectList &	children () const

const char *	className () const

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

void	deleteLater ()

void	destroyed (QObject *obj)

bool	disconnect (const QObject receiver, const char method)

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

void	dumpObjectInfo ()

void	dumpObjectTree ()

QList< QByteArray >	dynamicPropertyNames () const

virtual bool	event (QEvent *e)

virtual bool	eventFilter (QObject watched, QEvent event)

T	findChild (const QString &name) const

QList< T >	findChildren (const QRegExp &regExp) const

QList< T >	findChildren (const QString &name) const

bool	inherits (const char *className) const

void	insertChild (QObject *object)

void	installEventFilter (QObject *filterObj)

bool	isA (const char *className) const

bool	isWidgetType () const

void	killTimer (int id)

virtual const QMetaObject *	metaObject () const

void	moveToThread (QThread *targetThread)

const char *	name () const

const char *	name (const char *defaultName) const

QString	objectName () const

QObject *	parent () const

QVariant	property (const char *name) const

void	removeChild (QObject *object)

void	removeEventFilter (QObject *obj)

void	setName (const char *name)

void	setObjectName (const QString &name)

void	setParent (QObject *parent)

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

bool	signalsBlocked () const

int	startTimer (int interval)

QThread *	thread () const

Static Public Member Functions
static QString	replacedPath (const QString &text, bool replaceHome, bool replaceEnv=true)

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

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

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)

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

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

Protected Member Functions
virtual void	customEvent (QEvent *e)

void	postProcessMatch (QString *match) const

void	postProcessMatches (QStringList *matches) const

void	postProcessMatches (KCompletionMatches *matches) const

Protected Member Functions inherited from QObject
bool	checkConnectArgs (const char signal, const QObject object, const char *method)

virtual void	childEvent (QChildEvent *event)

virtual void	connectNotify (const char *signal)

virtual void	disconnectNotify (const char *signal)

int	receivers (const char *signal) const

QObject *	sender () const

int	senderSignalIndex () const

virtual void	timerEvent (QTimerEvent *event)

Additional Inherited Members
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)

void	removeItem (const QString &item)

virtual void	setItems (const QStringList &list)

void	slotMakeCompletion (const QString &string)

void	slotNextMatch ()

void	slotPreviousMatch ()

Signals inherited from KCompletion
void	match (const QString &item)

void	matches (const QStringList &matchlist)

void	multipleMatches ()

Static Protected Member Functions inherited from QObject
QByteArray	normalizeSignalSlot (const char *signalSlot)

Properties inherited from KCompletion
bool	ignoreCase

QStringList	items

CompOrder	order

Properties inherited from QObject
	objectName

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 41 of file kurlcompletion.h.

Member Enumeration Documentation

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.

Enumerator
ExeCompletion
FileCompletion
DirCompletion

Definition at line 53 of file kurlcompletion.h.

Constructor & Destructor Documentation

KUrlCompletion::KUrlCompletion ( )

Constructs a KUrlCompletion object in FileCompletion mode.

Definition at line 502 of file kurlcompletion.cpp.

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 508 of file kurlcompletion.cpp.

KUrlCompletion::~KUrlCompletion ( )

virtual

Destructs the KUrlCompletion object.

Definition at line 516 of file kurlcompletion.cpp.

Member Function Documentation

void KUrlCompletion::customEvent ( QEvent * e )

protectedvirtual

Reimplemented from QObject.

Definition at line 1331 of file kurlcompletion.cpp.

QString KUrlCompletion::dir ( ) const

virtual

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

Returns: the current directory (path or URL)

Definition at line 549 of file kurlcompletion.cpp.

bool KUrlCompletion::isRunning ( ) const

virtual

Check whether asynchronous completion is in progress.

Returns: true if asynchronous completion is in progress

Definition at line 674 of file kurlcompletion.cpp.

QString KUrlCompletion::makeCompletion ( const QString & text )

virtual

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 asyncronously 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.

Reimplemented in KShellCompletion.

Definition at line 589 of file kurlcompletion.cpp.

KUrlCompletion::Mode KUrlCompletion::mode ( ) const

virtual

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

Returns: the completion mode

Definition at line 554 of file kurlcompletion.cpp.

void KUrlCompletion::postProcessMatch ( QString * match ) const

protectedvirtual

Reimplemented from KCompletion.

Definition at line 1268 of file kurlcompletion.cpp.

void KUrlCompletion::postProcessMatches ( QStringList * matches ) const

protectedvirtual

Reimplemented from KCompletion.

Definition at line 1317 of file kurlcompletion.cpp.

void KUrlCompletion::postProcessMatches ( KCompletionMatches * matches ) const

protectedvirtual

Reimplemented from KCompletion.

Definition at line 1324 of file kurlcompletion.cpp.

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 KUrl, use KUrl::fromPathOrUrl.

Definition at line 1372 of file kurlcompletion.cpp.

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 1358 of file kurlcompletion.cpp.

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 vvariables will be replaced

Definition at line 564 of file kurlcompletion.cpp.

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 574 of file kurlcompletion.cpp.

void KUrlCompletion::setDir ( const QString & dir )

virtual

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

Default = $HOME.

Parameters

dir	the current directory, either as a path or URL

Definition at line 544 of file kurlcompletion.cpp.

void KUrlCompletion::setMode ( Mode mode )

virtual

Changes the completion mode: exe or file completion.

Parameters

mode	the new completion mode

Definition at line 559 of file kurlcompletion.cpp.

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 569 of file kurlcompletion.cpp.

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 579 of file kurlcompletion.cpp.

void KUrlCompletion::stop ( )

virtual

Stops asynchronous completion.

Definition at line 684 of file kurlcompletion.cpp.

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

KIO

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Member Enumeration Documentation

Constructor & Destructor Documentation

Member Function Documentation

KIO

kdelibs API Reference

Search