kurlnavigator.h

Go to the documentation of this file.

/*****************************************************************************
 * Copyright (C) 2006-2010 by Peter Penz <peter.penz@gmx.at>                 *
 * Copyright (C) 2006 by Aaron J. Seigo <aseigo@kde.org>                     *
 * Copyright (C) 2007 by Kevin Ottens <ervin@kde.org>                        *
 * Copyright (C) 2007 by Urs Wolfer <uwolfer @ kde.org>                      *
 *                                                                           *
 * 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 KURLNAVIGATOR_H
#define KURLNAVIGATOR_H

#include <kfile_export.h>

#include <kurl.h>
#include <QtGui/QWidget>
#include <QtCore/QByteArray>

class KFilePlacesModel;
class KUrlComboBox;
class QMouseEvent;

class KFILE_EXPORT KUrlNavigator : public QWidget
{
    Q_OBJECT

public:
    KUrlNavigator(QWidget* parent = 0);

    KUrlNavigator(KFilePlacesModel* placesModel, const KUrl& url, QWidget* parent);
    virtual ~KUrlNavigator();

    KUrl locationUrl(int historyIndex = -1) const;

    void saveLocationState(const QByteArray& state);

    QByteArray locationState(int historyIndex = -1) const;

    bool goBack();

    bool goForward();

    bool goUp();

    void goHome();

    void setHomeUrl(const KUrl& url);

    KUrl homeUrl() const;

    void setUrlEditable(bool editable);

    bool isUrlEditable() const;

    void setShowFullPath(bool show);

    bool showFullPath() const;

    void setActive(bool active);

    bool isActive() const;

    void setPlacesSelectorVisible(bool visible);

    bool isPlacesSelectorVisible() const;

    KUrl uncommittedUrl() const;

    int historySize() const;

    int historyIndex() const;

    KUrlComboBox* editor() const;

    void setCustomProtocols(const QStringList& protocols);

    QStringList customProtocols() const;

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED const KUrl& url() const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED KUrl url(int index) const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED KUrl historyUrl(int historyIndex) const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED const KUrl& savedRootUrl() const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED QPoint savedPosition() const;
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setHomeUrl(const QString& homeUrl);
#endif

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

    void requestActivation();

    /* @see QWidget::setFocus() */
    void setFocus();

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void setUrl(const KUrl& url);
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void saveRootUrl(const KUrl& url);
#endif

#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void savePosition(int x, int y);
#endif

Q_SIGNALS:
    void activated();

    void urlChanged(const KUrl& url);

    void urlAboutToBeChanged(const KUrl& newUrl);

    void editableStateChanged(bool editable);

    void historyChanged();

    void urlsDropped(const KUrl& destination, QDropEvent* event);

    void returnPressed();

    void tabRequested(const KUrl& url);

    // KDE5: remove, as the signal has been replaced by
    // urlsDropped(const KUrl& destination, QDropEvent* event)
#ifndef KDE_NO_DEPRECATED
    KDE_DEPRECATED void urlsDropped(const KUrl::List& urls,
                                    const KUrl& destination);
#endif

protected:
    /*
     * If the Escape key is pressed, the navigation bar should switch
     * to the breadcrumb view.
     * @see QWidget::keyPressEvent()
     */
    virtual void keyPressEvent(QKeyEvent* event);

    virtual void keyReleaseEvent(QKeyEvent* event);

    /*
     * Paste the clipboard content as URL, if the middle mouse
     * button has been clicked.
     * @see QWidget::mouseReleaseEvent()
     */
    virtual void mouseReleaseEvent(QMouseEvent* event);

    /* @see QWidget::resizeEvent() */
    virtual void resizeEvent(QResizeEvent* event);

    virtual bool eventFilter(QObject* watched, QEvent* event);

private:
    Q_PRIVATE_SLOT(d, void slotReturnPressed())
    Q_PRIVATE_SLOT(d, void slotProtocolChanged(const QString& protocol))
    Q_PRIVATE_SLOT(d, void switchView())
    Q_PRIVATE_SLOT(d, void dropUrls(const KUrl& destination, QDropEvent*))
    Q_PRIVATE_SLOT(d, void slotNavigatorButtonClicked(const KUrl& url, Qt::MouseButton button))
    Q_PRIVATE_SLOT(d, void openContextMenu())
    Q_PRIVATE_SLOT(d, void openPathSelectorMenu())
    Q_PRIVATE_SLOT(d, void updateButtonVisibility())
    Q_PRIVATE_SLOT(d, void switchToBreadcrumbMode())
    Q_PRIVATE_SLOT(d, void slotPathBoxChanged(const QString& text))
    Q_PRIVATE_SLOT(d, void updateContent())

private:
    class Private;
    Private* const d;

    Q_DISABLE_COPY(KUrlNavigator)
};

#endif