#include <kurlcompletion.h>
Public Types | |
enum | Mode { ExeCompletion =1 , FileCompletion , DirCompletion , SystemExeCompletion } |
Public Member Functions | |
KURLCompletion () | |
KURLCompletion (Mode) | |
virtual | ~KURLCompletion () |
virtual TQString | makeCompletion (const TQString &text) |
virtual void | setDir (const TQString &dir) |
virtual TQString | 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) |
TQString | replacedPath (const TQString &text) |
Static Public Member Functions | |
static TQString | replacedPath (const TQString &text, bool replaceHome, bool replaceEnv=true) |
Protected Slots | |
void | slotEntries (TDEIO::Job *, const TDEIO::UDSEntryList &) |
void | slotIOFinished (TDEIO::Job *) |
Detailed Description
This class does completion of URLs including user directories (~user) and environment variables.
Remote URLs are passed to TDEIO.
Completion of a single URL
Definition at line 41 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 TDEIO.
- DirCompletion - Same as FileCompletion but only returns directories.
Definition at line 53 of file kurlcompletion.h.
Constructor & Destructor Documentation
◆ KURLCompletion() [1/2]
KURLCompletion::KURLCompletion | ( | ) |
Constructs a KURLCompletion object in FileCompletion mode.
Definition at line 488 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 494 of file kurlcompletion.cpp.
◆ ~KURLCompletion()
|
virtual |
Destructs the KURLCompletion object.
Definition at line 500 of file kurlcompletion.cpp.
Member Function Documentation
◆ dir()
|
virtual |
Returns the current directory, as it was given in setDir.
- Returns
- the current directory (path or URL)
Definition at line 534 of file kurlcompletion.cpp.
◆ isRunning()
|
virtual |
Check whether asynchronous completion is in progress.
- Returns
- true if asynchronous completion is in progress
Definition at line 672 of file kurlcompletion.cpp.
◆ makeCompletion()
|
virtual |
Finds completions to the given text.
Remote URLs are listed with TDEIO. For performance reasons, local files are listed with TDEIO only if KURLCOMPLETION_LOCAL_TDEIO is set. The completion is done asyncronously if TDEIO is used.
Returns the first match for user, environment, and local dir completion and TQString::null for asynchronous completion (TDEIO or threaded).
- Parameters
-
text the text to complete
- Returns
- the first match, or TQString::null if not found
Reimplemented in KShellCompletion.
Definition at line 574 of file kurlcompletion.cpp.
◆ mode()
|
virtual |
Returns the completion mode: exe or file completion (default FileCompletion).
- Returns
- the completion mode
Definition at line 539 of file kurlcompletion.cpp.
◆ replacedPath()
TQString KURLCompletion::replacedPath | ( | const TQString & | text | ) |
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 1464 of file kurlcompletion.cpp.
◆ replaceEnv()
|
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 549 of file kurlcompletion.cpp.
◆ replaceHome()
|
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 559 of file kurlcompletion.cpp.
◆ setDir()
|
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 529 of file kurlcompletion.cpp.
◆ setMode()
|
virtual |
Changes the completion mode: exe or file completion.
- Parameters
-
mode the new completion mode
Definition at line 544 of file kurlcompletion.cpp.
◆ setReplaceEnv()
|
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 554 of file kurlcompletion.cpp.
◆ setReplaceHome()
|
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 564 of file kurlcompletion.cpp.
◆ stop()
|
virtual |
Stops asynchronous completion.
Definition at line 682 of file kurlcompletion.cpp.
The documentation for this class was generated from the following files: