kbookmarkmanager.h

Go to the documentation of this file.

//  -*- c-basic-offset:4; indent-tabs-mode:nil -*-
// vim: set ts=4 sts=4 sw=4 et:
/* This file is part of the KDE libraries
   Copyright (C) 2000, 2006 David Faure <faure@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 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 __kbookmarkmanager_h
#define __kbookmarkmanager_h

#include <QtCore/QString>
#include <QtCore/QStringList>
#include <QtCore/QObject>
#include <QtCore/QPair>
#include <QtXml/QDomDocument>
#include <QtXml/QDomElement>

#include <kurl.h>
#include "kbookmark.h"

class KBookmarkGroup;
class QDBusMessage;

class QTreeWidgetItem;
class QLabel;
class QTreeWidget;
class KLineEdit;
class KMenu;
class KBookmarkDialog;

class KIO_EXPORT KBookmarkManager : public QObject
{
    Q_OBJECT
private:
    KBookmarkManager( const QString & bookmarksFile, const QString& dbusObjectName );

    KBookmarkManager( const QString & bookmarksFile );
    
    KBookmarkManager();

public:
    ~KBookmarkManager();

    bool autoErrorHandlingEnabled() const;

    void setAutoErrorHandlingEnabled( bool enable, QWidget *parent );

    void setUpdate( bool update );

     // KDE5 TODO: Use an enum and not a bool
    bool saveAs( const QString & filename, bool toolbarCache = true ) const;

    bool updateAccessMetadata( const QString &url );

    /*
     * NB. currently *unimplemented*
     *
     * Update favicon url for a given url.
     * @param url the viewed url
     * @param faviconurl the favicion url
     */
    void updateFavicon( const QString &url, const QString &faviconurl );

    QString path() const;

    KBookmarkGroup root() const;

    KBookmarkGroup toolbar();

    KBookmark findByAddress( const QString & address);


    void emitChanged();

    void emitChanged( const KBookmarkGroup & group );

     // KDE5 TODO: Use an enum and not a bool
    bool save( bool toolbarCache = true ) const;


    void emitConfigChanged();

     // KDE5 TODO: Use an enum and not a bool
    void setEditorOptions( const QString& caption, bool browser );

    static KBookmarkManager* managerForFile( const QString& bookmarksFile,
                                             const QString& dbusObjectName );

    static KBookmarkManager* managerForExternalFile( const QString& bookmarksFile);
    
    static KBookmarkManager* createTempManager();

    static KBookmarkManager* userBookmarksManager();

    QDomDocument internalDocument() const;

public Q_SLOTS:
    void slotEditBookmarks();
    void slotEditBookmarksAtAddress( const QString& address );

    void notifyCompleteChange( const QString &caller );

    void notifyChanged( const QString &groupAddress, const QDBusMessage &msg );

    void notifyConfigChanged();

Q_SIGNALS:
    void bookmarkCompleteChange( QString caller );

    void bookmarksChanged( QString groupAddress );

    void bookmarkConfigChanged();

    void changed( const QString & groupAddress, const QString & caller );

    void configChanged();

    void error(const QString &errorMessage);

private Q_SLOTS:    
    void slotFileChanged(const QString& path); // external bookmarks
    
private:
    // consts added to avoid a copy-and-paste of internalDocument
    void parse() const;

    static KBookmarkManager* managerForFile( const QString&, int);
    void init( const QString& dbusPath );
    
    class Private;
    Private * const d;

    friend class KBookmarkGroup;
};

class KIO_EXPORT KBookmarkOwner
{
public:
    virtual ~KBookmarkOwner() {}

  virtual QString currentTitle() const { return QString(); }

  virtual QString currentUrl() const { return QString(); }


  virtual bool supportsTabs() const { return false; }

  virtual QList<QPair<QString, QString> > currentBookmarkList() const { return QList<QPair<QString, QString> >(); }

  enum BookmarkOption { ShowAddBookmark, ShowEditBookmark };


  virtual bool enableOption(BookmarkOption option) const;

  virtual void openBookmark(const KBookmark & bm, Qt::MouseButtons mb, Qt::KeyboardModifiers km) = 0;

  virtual void openFolderinTabs(const KBookmarkGroup &bm);

  virtual KBookmarkDialog * bookmarkDialog(KBookmarkManager * mgr, QWidget *parent);

private:
  class KBookmarkOwnerPrivate;
  KBookmarkOwnerPrivate *d;
};

#endif