kurlrequester.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 1999,2000,2001 Carsten Pfeiffer <pfeiffer@kde.org>

    library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Library General Public
    License version 2, as published by the Free Software Foundation.

    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 KURLREQUESTER_H
#define KURLREQUESTER_H

#include <kfile.h>
#include <kpushbutton.h>
#include <kurl.h>
#include <khbox.h>

#ifndef KDE_NO_DEPRECATED
#include <keditlistbox.h>
#else
#include <keditlistwidget.h>
#endif

class KComboBox;
class KFileDialog;
class KLineEdit;
class KUrlCompletion;

class QString;
class QEvent;

class KIO_EXPORT KUrlRequester : public KHBox
{
    Q_OBJECT
    Q_PROPERTY( KUrl url READ url WRITE setUrl NOTIFY textChanged USER true )
    Q_PROPERTY( QString filter READ filter WRITE setFilter )
    Q_PROPERTY( KFile::Modes mode READ mode WRITE setMode )
    Q_PROPERTY( QString clickMessage READ clickMessage WRITE setClickMessage )
    Q_PROPERTY(QString text READ text WRITE setText)
    Q_PROPERTY( Qt::WindowModality fileDialogModality READ fileDialogModality WRITE setFileDialogModality )

public:
    explicit KUrlRequester( QWidget *parent=0);

    explicit KUrlRequester( const KUrl& url, QWidget *parent=0);

    KUrlRequester( QWidget *editWidget, QWidget *parent);
    ~KUrlRequester();

    KUrl url() const;

    KUrl startDir() const;

    QString text() const;

    void setMode( KFile::Modes m );

    KFile::Modes mode() const;

    void setFilter( const QString& filter );

    QString filter() const;

    virtual KFileDialog * fileDialog() const;

    KLineEdit * lineEdit() const;

    KComboBox * comboBox() const;

    KPushButton * button() const;

    KUrlCompletion *completionObject() const;

#ifndef KDE_NO_DEPRECATED
    const KEditListBox::CustomEditor &customEditor();
#else
    const KEditListWidget::CustomEditor &customEditor();
#endif

    QString clickMessage() const;

    void setClickMessage(const QString& msg);

    Qt::WindowModality fileDialogModality() const;

    void setFileDialogModality(Qt::WindowModality modality);

public Q_SLOTS:
    void setUrl( const KUrl& url );

    void setStartDir( const KUrl& startDir );

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setPath(const QString& path);
#endif

    void setText(const QString& text);

    void clear();

Q_SIGNALS:
    // forwards from LineEdit
    void textChanged( const QString& );

    void returnPressed();

    void returnPressed( const QString& );

    void openFileDialog( KUrlRequester * );

    void urlSelected( const KUrl& );

protected:
    virtual void changeEvent (QEvent *e);
    bool eventFilter( QObject *obj, QEvent *ev );

private:
    class KUrlRequesterPrivate;
    KUrlRequesterPrivate* const d;

    Q_DISABLE_COPY(KUrlRequester)

    Q_PRIVATE_SLOT(d, void _k_slotUpdateUrl())
    Q_PRIVATE_SLOT(d, void _k_slotOpenDialog())
    Q_PRIVATE_SLOT(d, void _k_slotFileDialogFinished())

};

class KIO_EXPORT KUrlComboRequester : public KUrlRequester // krazy:exclude=dpointer (For use in Qt Designer)
{
    Q_OBJECT
public:
    explicit KUrlComboRequester(QWidget *parent = 0);

private:
    class Private;
    Private* const d;
};

#endif // KURLREQUESTER_H