KURLCompletion Class Reference
This class does completion of URLs including user directories (~user) and environment variables. Completion of a single URL. More...
#include <kurlcompletion.h>
Inheritance diagram for KURLCompletion:


| Public Types | |
| enum | Mode { ExeCompletion = 1, FileCompletion, DirCompletion } | 
| Public Member Functions | |
| KURLCompletion () | |
| KURLCompletion (Mode) | |
| virtual | ~KURLCompletion () | 
| virtual QString | makeCompletion (const QString &text) | 
| virtual void | setDir (const QString &dir) | 
| virtual QString | dir () const | 
| virtual bool | isRunning () const | 
| virtual void | stop () | 
| virtual Mode | mode () const | 
| virtual void | setMode (Mode mode) | 
| virtual bool | replaceEnv () const | 
| virtual void | setReplaceEnv (bool replace) | 
| virtual bool | replaceHome () const | 
| virtual void | setReplaceHome (bool replace) | 
| QString | replacedPath (const QString &text) | 
| Static Public Member Functions | |
| QString | replacedPath (const QString &text, bool replaceHome, bool replaceEnv=true) | 
| Protected Slots | |
| void | slotEntries (KIO::Job *, const KIO::UDSEntryList &) | 
| void | slotIOFinished (KIO::Job *) | 
| Protected Member Functions | |
| void | postProcessMatch (QString *match) const | 
| void | postProcessMatches (QStringList *matches) const | 
| void | postProcessMatches (KCompletionMatches *matches) const | 
| virtual void | virtual_hook (int id, void *data) | 
Detailed Description
This class does completion of URLs including user directories (~user) and environment variables. Completion of a single URL.Remote URLs are passed to KIO.
- Author:
- David Smith <dsmith@algonet.se>
- Version:
- Id
- kurlcompletion.h,v 1.35 2004/01/02 02:27:15 adawit Exp
 
Definition at line 42 of file kurlcompletion.h.
Member Enumeration Documentation
| 
 | 
| Determines how completion is done. 
 
 Definition at line 54 of file kurlcompletion.h. Referenced by mode(). | 
Constructor & Destructor Documentation
| 
 | 
| Constructs a KURLCompletion object in FileCompletion mode. 
 Definition at line 483 of file kurlcompletion.cpp. | 
| 
 | 
| This overloaded constructor allows you to set the Mode to ExeCompletion or FileCompletion without using setMode. Default is FileCompletion. Definition at line 489 of file kurlcompletion.cpp. | 
| 
 | 
| Destructs the KURLCompletion object. 
 Definition at line 495 of file kurlcompletion.cpp. References stop(). | 
Member Function Documentation
| 
 | 
| 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::null for asynchronous completion (KIO). 
 
 
 Reimplemented from KCompletion. Reimplemented in KShellCompletion. Definition at line 572 of file kurlcompletion.cpp. References stop(). Referenced by KShellCompletion::makeCompletion(). | 
| 
 | 
| Sets the current directory (used as base for completion). Default = $HOME. 
 Definition at line 524 of file kurlcompletion.cpp. References QString::mid(), and QString::startsWith(). Referenced by KFileDialog::init(). | 
| 
 | 
| Returns the current directory. 
 
 Definition at line 532 of file kurlcompletion.cpp. | 
| 
 | 
| Check whether asynchronous completion is in progress. 
 
 Definition at line 651 of file kurlcompletion.cpp. | 
| 
 | 
| Stops asynchronous completion. 
 Definition at line 662 of file kurlcompletion.cpp. Referenced by makeCompletion(), and ~KURLCompletion(). | 
| 
 | 
| Returns the completion mode: exe or file completion (default FileCompletion). 
 
 Definition at line 537 of file kurlcompletion.cpp. References Mode. Referenced by KURLCompletion(). | 
| 
 | 
| Changes the completion mode: exe or file completion. 
 
 Definition at line 542 of file kurlcompletion.cpp. Referenced by KDirSelectDialog::KDirSelectDialog(), KURLCompletion(), KShellCompletion::makeCompletion(), and KURLRequester::setMode(). | 
| 
 | 
| Checks whether environment variables are completed and whether they are replaced internally while finding completions. Default is enabled. 
 Definition at line 547 of file kurlcompletion.cpp. | 
| 
 | 
| Enables/disables completion and replacement (internally) of environment variables in URLs. Default is enabled. 
 Definition at line 552 of file kurlcompletion.cpp. | 
| 
 | 
| Returns whether ~username is completed and whether ~username is replaced internally with the user's home directory while finding completions. Default is enabled. 
 Definition at line 557 of file kurlcompletion.cpp. | 
| 
 | 
| Enables/disables completion of ~username and replacement (internally) of ~username with the user's home directory. Default is enabled. 
 Definition at line 562 of file kurlcompletion.cpp. | 
| 
 | 
| 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. 
 
 Definition at line 1390 of file kurlcompletion.cpp. | 
The documentation for this class was generated from the following files:

