|
|
/* This file is part of the KDE libraries Copyright (C) 2000 David SmithThis class was inspired by a previous KURLCompletion by Henner Zeller This library is free software; you can redistribute it and/or modify it under the terms of the GNU Library General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version. This library is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library General Public License for more details. You should have received a copy of the GNU Library General Public License along with this library; see the file COPYING.LIB. If not, write to the Free Software Foundation, Inc., 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA. */ #ifndef KURLCOMPLETION_H #define KURLCOMPLETION_H #include #include #include #include class KURL; class KURLCompletionPrivate; /** * This class does completion of URLs including user directories (~user) * and environment variables. Remote URLs are passed to KIO. * * @short Completion of a single URL * @author David Smith * @version $Id: kurlcompletion_h.html 149726 2002-04-16 07:39:43Z dfaure $ */ class KURLCompletion : public KCompletion { Q_OBJECT public: /** * Determines how completion is done. * @li ExeCompletion - executables in $PATH or with full path. * @li FileCompletion - all files with full path or in dir(), URLs * are listed using KIO. * @li DirCompletion - as FileCompletion but only returns directories. */ enum Mode { ExeCompletion=1, FileCompletion, DirCompletion }; /** * Constructs a KURLCompletion object in FileCompletion mode. */ KURLCompletion(); /** * This overloaded constructor allows you to set the Mode to ExeCompletion * or FileCompletion without using @ref setMode. Default is FileCompletion */ KURLCompletion(Mode); /** * Destructs the KURLCompletion object. */ virtual ~KURLCompletion(); /** * 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 asyncronous completion (KIO). */ virtual QString makeCompletion(const QString&); /** * Sets the current directory (used as base for completion) * Default = $HOME. */ virtual void setDir(const QString &dir); /** * Returns the current directory. */ virtual QString dir() const; /** * Returns true if asyncronous completion is in progress. */ virtual bool isRunning() const; /** * Stops asyncronous completion. */ virtual void stop(); /** * Returns the completion mode: exe or file completion (default FileCompletion) */ virtual Mode mode() const; /** * Changes the completion mode: exe or file completion */ virtual void setMode( Mode mode ); /** * Returns whether environment variables are completed and * whether they are replaced internally while finding completions. * Default is enabled. */ virtual bool replaceEnv() const; /** * Enables/disables completion and replacement (internally) of * environment variables in URLs. Default is enabled. */ virtual void setReplaceEnv( bool replace ); /** * Returns whether ~username is completed and whether ~username * is replaced internally with the user's home directory while * finding completions. Default is enabled. */ virtual bool replaceHome() const; /** * Enables/disables completion of ~username and replacement * (internally) of ~username with the user's home directory. * Default is enabled. */ virtual void setReplaceHome( bool replace ); /** * 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. */ QString replacedPath( const QString& text ); class MyURL; class DirLister; protected: // Called by KCompletion, adds '/' to directories void postProcessMatch( QString *match ) const; void postProcessMatches( QStringList *matches ) const; void postProcessMatches( KCompletionMatches* matches ) const; protected slots: void slotEntries( KIO::Job *, const KIO::UDSEntryList& ); void slotIOFinished( KIO::Job * ); private slots: void slotTimer(); private: bool isAutoCompletion(); bool userCompletion(const MyURL &url, QString *match); bool envCompletion(const MyURL &url, QString *match); bool exeCompletion(const MyURL &url, QString *match); bool fileCompletion(const MyURL &url, QString *match); bool urlCompletion(const MyURL &url, QString *match); // List a directory using readdir() void listDir( const QString& dir, QStringList *matches, const QString& filter, bool only_exe, bool no_hidden ); // List the next dir in m_dirs QString listDirectories(const QStringList &, const QString &, bool only_exe = false, bool only_dir = false, bool no_hidden = false, bool stat_files = true); void listURLs( const QValueList &urls, const QString &filter = QString::null, bool only_exe = false, bool no_hidden = false ); void addMatches( QStringList * ); QString finished(); void init(Mode mode); void setListedURL(int compl_type /* enum ComplType */, QString dir = QString::null, QString filter = QString::null, bool no_hidden = false ); bool isListedURL( int compl_type /* enum ComplType */, QString dir = QString::null, QString filter = QString::null, bool no_hidden = false ); protected: virtual void virtual_hook( int id, void* data ); private: KURLCompletionPrivate *d; }; #endif // KURLCOMPLETION_H
Generated by: dfaure on faure on Tue Apr 16 08:49:48 2002, using kdoc 2.0a53. |