• Skip to content
  • Skip to link menu
KDE 4.1 API Reference
  • KDE API Reference
  • kdelibs
  • Sitemap
  • Contact Us
 

KIO

KUrlCompletion Class Reference

#include <kurlcompletion.h>

Inheritance diagram for KUrlCompletion:

Inheritance graph
[legend]

List of all members.


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 <dsmith@algonet.se>

Definition at line 41 of file kurlcompletion.h.


Public Types

enum  Mode { ExeCompletion = 1, FileCompletion, DirCompletion }

Public Member Functions

virtual QString dir () const
virtual bool isRunning () const
 KUrlCompletion (Mode)
 KUrlCompletion ()
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 ()
virtual ~KUrlCompletion ()

Static Public Member Functions

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

Protected Member Functions

virtual void customEvent (QEvent *e)
void postProcessMatch (QString *match) const
void postProcessMatches (KCompletionMatches *matches) const
void postProcessMatches (QStringList *matches) const

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

KUrlCompletion::~KUrlCompletion (  )  [virtual]

Destructs the KUrlCompletion object.

Definition at line 544 of file kurlcompletion.cpp.


Member Function Documentation

void KUrlCompletion::customEvent ( QEvent *  e  )  [protected, virtual]

Reimplemented from QObject.

Definition at line 1357 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 576 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 702 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 616 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 581 of file kurlcompletion.cpp.

void KUrlCompletion::postProcessMatch ( QString *  match  )  const [protected, virtual]

Reimplemented from KCompletion.

Reimplemented in KShellCompletion.

Definition at line 1303 of file kurlcompletion.cpp.

void KUrlCompletion::postProcessMatches ( KCompletionMatches *  matches  )  const [protected, virtual]

Reimplemented from KCompletion.

Reimplemented in KShellCompletion.

Definition at line 1350 of file kurlcompletion.cpp.

void KUrlCompletion::postProcessMatches ( QStringList *  matches  )  const [protected, virtual]

Reimplemented from KCompletion.

Reimplemented in KShellCompletion.

Definition at line 1343 of file kurlcompletion.cpp.

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

Definition at line 1384 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 1398 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 591 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 601 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 571 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 586 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 596 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 606 of file kurlcompletion.cpp.

void KUrlCompletion::stop (  )  [virtual]

Stops asynchronous completion.

Definition at line 712 of file kurlcompletion.cpp.


The documentation for this class was generated from the following files:
  • kurlcompletion.h
  • kurlcompletion.cpp

KIO

Skip menu "KIO"
  • Main Page
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

kdelibs

Skip menu "kdelibs"
  • DNSSD
  • Interfaces
  •   KHexEdit
  •   KMediaPlayer
  •   KSpeech
  •   KTextEditor
  • Kate
  • kconf_update
  • KDE3Support
  •   KUnitTest
  • KDECore
  • KDED
  • KDEsu
  • KDEUI
  • KDocTools
  • KFile
  • KHTML
  • KImgIO
  • KInit
  • KIO
  • KIOSlave
  • KJS
  •   KJS-API
  •   WTF
  • kjsembed
  • KNewStuff
  • KParts
  • Kross
  • KUtils
  • Nepomuk
  • Solid
  • Sonnet
  • ThreadWeaver
Generated for kdelibs by doxygen 1.5.4
This website is maintained by Adriaan de Groot and Allen Winter.
KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V. | Legal