• Skip to content
  • Skip to link menu
Trinity API Reference
  • Trinity API Reference
  • tdeio/tdeio
 

tdeio/tdeio

Public Types | Public Member Functions | Static Public Member Functions | Protected Slots | Protected Member Functions | List of all members
KURLCompletion Class Reference

#include <kurlcompletion.h>

Inheritance diagram for KURLCompletion:
KShellCompletion

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 *)
 

Protected Member Functions

void postProcessMatch (TQString *match) const
 
void postProcessMatches (TQStringList *matches) const
 
void postProcessMatches (TDECompletionMatches *matches) const
 
virtual void customEvent (TQCustomEvent *e)
 
virtual void virtual_hook (int id, void *data)
 

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

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

◆ 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 487 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 493 of file kurlcompletion.cpp.

◆ ~KURLCompletion()

KURLCompletion::~KURLCompletion ( )
virtual

Destructs the KURLCompletion object.

Definition at line 499 of file kurlcompletion.cpp.

Member Function Documentation

◆ dir()

TQString KURLCompletion::dir ( ) const
virtual

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

Returns
the current directory (path or URL)

Definition at line 533 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 671 of file kurlcompletion.cpp.

◆ makeCompletion()

TQString KURLCompletion::makeCompletion ( const TQString &  text)
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
textthe text to complete
Returns
the first match, or TQString::null if not found

Reimplemented in KShellCompletion.

Definition at line 573 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 538 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
textthe 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 1463 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 vvariables will be replaced

Definition at line 548 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 558 of file kurlcompletion.cpp.

◆ setDir()

void KURLCompletion::setDir ( const TQString &  dir)
virtual

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

Default = $HOME.

Parameters
dirthe current directory, either as a path or URL

Definition at line 528 of file kurlcompletion.cpp.

◆ setMode()

void KURLCompletion::setMode ( Mode  mode)
virtual

Changes the completion mode: exe or file completion.

Parameters
modethe new completion mode

Definition at line 543 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
replacetrue to replace environment variables

Definition at line 553 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
replacetrue to replace tilde with the home directory

Definition at line 563 of file kurlcompletion.cpp.

◆ stop()

void KURLCompletion::stop ( )
virtual

Stops asynchronous completion.

Definition at line 681 of file kurlcompletion.cpp.


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

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • Main Page
  • Modules
  • Namespace List
  • Class Hierarchy
  • Alphabetical List
  • Class List
  • File List
  • Namespace Members
  • Class Members
  • Related Pages

tdeio/tdeio

Skip menu "tdeio/tdeio"
  • arts
  • dcop
  • dnssd
  • interfaces
  •   kspeech
  •     interface
  •     library
  •   tdetexteditor
  • kate
  • kded
  • kdoctools
  • kimgio
  • kjs
  • libtdemid
  • libtdescreensaver
  • tdeabc
  • tdecmshell
  • tdecore
  • tdefx
  • tdehtml
  • tdeinit
  • tdeio
  •   bookmarks
  •   httpfilter
  •   kpasswdserver
  •   kssl
  •   tdefile
  •   tdeio
  •   tdeioexec
  • tdeioslave
  •   http
  • tdemdi
  •   tdemdi
  • tdenewstuff
  • tdeparts
  • tdeprint
  • tderandr
  • tderesources
  • tdespell2
  • tdesu
  • tdeui
  • tdeunittest
  • tdeutils
  • tdewallet
Generated for tdeio/tdeio by doxygen 1.9.1
This website is maintained by Timothy Pearson.