kurlcompletion.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 2000 David Smith  <dsmith@algonet.se>

    This class was inspired by a previous KUrlCompletion by
    Henner Zeller <zeller@think.de>

    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., 51 Franklin Street, Fifth Floor,
    Boston, MA 02110-1301, USA.
*/

#ifndef KURLCOMPLETION_H
#define KURLCOMPLETION_H

#include <kcompletion.h>
#include <kio/jobclasses.h>
#include <QtCore/QString>

class QStringList;
class KUrl;
class KUrlCompletionPrivate;

class KIO_EXPORT KUrlCompletion : public KCompletion
{
    Q_OBJECT

public:
    enum Mode { ExeCompletion=1, FileCompletion, DirCompletion };

    KUrlCompletion();
    KUrlCompletion(Mode);
    virtual ~KUrlCompletion();

    virtual QString makeCompletion(const QString &text); // KDE4: remove return value, it's often null due to threading

    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 ) const;

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

protected:
    // Called by KCompletion, adds '/' to directories
    void postProcessMatch( QString *match ) const;
    void postProcessMatches( QStringList *matches ) const;
    void postProcessMatches( KCompletionMatches* matches ) const;

    virtual void customEvent( QEvent *e );

private:
        KUrlCompletionPrivate* const d;

    Q_PRIVATE_SLOT( d, void _k_slotEntries( KIO::Job*, const KIO::UDSEntryList& ) )
    Q_PRIVATE_SLOT( d, void _k_slotIOFinished( KJob* ) )
};

#endif // KURLCOMPLETION_H