kbookmarkmanager.h

/* This file is part of the KDE libraries
   Copyright (C) 2000 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 <tqstring.h>
#include <tqstringlist.h>
#include <tqobject.h>
#include <tqdom.h>
#include <dcopobject.h>
#include "kbookmark.h"
#include "kbookmarknotifier.h"

class TDEIO_EXPORT KBookmarkManager : public TQObject, public DCOPObject
{
    TQ_OBJECT
    K_DCOP
protected:
    KBookmarkManager( const TQString & bookmarksFile, bool bImportDesktopFiles = true );

    KBookmarkManager();
 
public:
    ~KBookmarkManager();

    void setUpdate( bool update );

    bool save( bool toolbarCache = true ) const;

    bool saveAs( const TQString & filename, bool toolbarCache = true ) const;

    bool updateAccessMetadata( const TQString &url, bool emitSignal = true );
 
    /*
     * NB. currently *unimplemented*
     *
     * Update favicon url for a given url.
     * @param url the viewed url
     * @param faviconurl the favicion url
     * @emitSignal iff true emit KBookmarkNotifier signal
     * @since 3.3
     */
    void updateFavicon( const TQString &url, const TQString &faviconurl, bool emitSignal = true );

    TQString path() { return m_bookmarksFile; }

    KBookmarkGroup root() const;

    KBookmarkGroup toolbar();

    KBookmark findByAddress( const TQString & address, bool tolerate = false );

    void emitChanged( KBookmarkGroup & group );
 
    void emitConfigChanged();

    bool showNSBookmarks() const;

    void setShowNSBookmarks( bool show );

    void setEditorOptions( const TQString& caption, bool browser );

    static KBookmarkManager* managerForFile( const TQString& bookmarksFile,
                                   bool bImportDesktopFiles = true );
 
 
    static KBookmarkManager* createTempManager();

    static KBookmarkManager* userBookmarksManager();
    
    static TQString userBookmarksFile();

    const TQDomDocument & internalDocument() const;

    KBookmarkNotifier& notifier() { return m_notifier; }

    KBookmarkGroup addBookmarkDialog( const TQString & _url, const TQString & _title,
                                      const TQString & _parentBookmarkAddress = TQString::null );
 
public slots:
    void slotEditBookmarks();
    void slotEditBookmarksAtAddress( const TQString& address );
 
public:
k_dcop:
    ASYNC notifyCompleteChange( TQString caller );

    ASYNC notifyChanged( TQString groupAddress );
 
    ASYNC notifyConfigChanged();
 
signals:
    void changed( const TQString & groupAddress, const TQString & caller );
 
protected:
    // consts added to avoid a copy-and-paste of internalDocument
    void parse() const;
    void importDesktopFiles();
    static void convertToXBEL( TQDomElement & group );
    static void convertAttribute( TQDomElement elem, const TQString & oldName, const TQString & newName );
 
private:
    KBookmarkNotifier m_notifier;
    TQString m_bookmarksFile;
    mutable TQDomDocument m_doc;
    mutable TQDomDocument m_toolbarDoc;
    mutable bool m_docIsLoaded;
    bool m_update;
    static TQPtrList<KBookmarkManager>* s_pSelf;
    bool m_showNSBookmarks;
 
private:
    class KBookmarkManagerPrivate* dptr() const;
};

class TDEIO_EXPORT KBookmarkOwner
{
public:
  virtual void openBookmarkURL(const TQString& _url);

  virtual TQString currentTitle() const { return TQString::null; }

  virtual TQString currentURL() const { return TQString::null; }
 
protected:
  virtual void virtual_hook( int id, void* data );
};

class TDEIO_EXPORT KExtendedBookmarkOwner : public TQObject, virtual public KBookmarkOwner
{
    TQ_OBJECT
public:
    typedef TQValueList<TQPair<TQString,TQString> > QStringPairList;
public slots:
    void fillBookmarksList( KExtendedBookmarkOwner::QStringPairList & list ) { emit signalFillBookmarksList( list ); };
signals:
    void signalFillBookmarksList( KExtendedBookmarkOwner::QStringPairList & list );
private:
    class KExtendedBookmarkOwnerPrivate;
    KExtendedBookmarkOwnerPrivate *d;
};
 
#endif