konq_historymgr.h

/* This file is part of the KDE project
   Copyright (C) 2000,2001 Carsten Pfeiffer <pfeiffer@kde.org>
 
   This program is free software; you can redistribute it and/or
   modify it under the terms of the GNU General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.
 
   This program 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
    General Public License for more details.
 
   You should have received a copy of the GNU General Public License
   along with this program; see the file COPYING.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
*/
 
#ifndef KONQ_HISTORY_H
#define KONQ_HISTORY_H
 
#include <tqdatastream.h>
#include <tqfile.h>
#include <tqptrlist.h>
#include <tqobject.h>
#include <tqmap.h>
#include <tqtimer.h>
 
#include <dcopobject.h>
 
#include <kcompletion.h>
#include <kurl.h>
#include <tdeparts/historyprovider.h>
 
#include "konq_historycomm.h"
 
#include <libkonq_export.h>
 
class TDECompletion;
 
 
typedef TQPtrList<KonqHistoryEntry> KonqBaseHistoryList;
typedef TQPtrListIterator<KonqHistoryEntry> KonqHistoryIterator;
 
class LIBKONQ_EXPORT KonqHistoryList : public KonqBaseHistoryList
{
public:
    KonqHistoryEntry * findEntry( const KURL& url );
 
protected:
    virtual int compareItems( TQPtrCollection::Item, TQPtrCollection::Item );
};
 

 

class LIBKONQ_EXPORT KonqHistoryManager : public KParts::HistoryProvider,
               public KonqHistoryComm
{
    TQ_OBJECT
 
public:
    static KonqHistoryManager *kself() {
    return static_cast<KonqHistoryManager*>( KParts::HistoryProvider::self() );
    }
 
    KonqHistoryManager( TQObject *parent, const char *name );
    ~KonqHistoryManager();

    void emitSetMaxCount( TQ_UINT32 count );

    void emitSetMaxAge( TQ_UINT32 days );

    void emitRemoveFromHistory( const KURL& url );

    void emitRemoveFromHistory( const KURL::List& urls );

    TQ_UINT32 maxCount() const { return m_maxCount; }

    TQ_UINT32 maxAge() const { return m_maxAgeDays; }

    void addPending( const KURL& url, const TQString& typedURL = TQString::null,
             const TQString& title = TQString::null );

    void confirmPending( const KURL& url,
             const TQString& typedURL = TQString::null,
             const TQString& title = TQString::null );

    void removePending( const KURL& url );

    TDECompletion * completionObject() const { return m_pCompletion; }

    const KonqHistoryList& entries() const { return m_history; }
 
    // HistoryProvider interfae, let konq handle this
    virtual void insert( const TQString& );
    virtual void remove( const TQString& ) {}
    virtual void clear() {}
 
 
public slots:
    bool loadHistory();

    bool saveHistory();

    void emitClear();
 
 
signals:
    void loadingFinished();

    void entryAdded( const KonqHistoryEntry *entry );

    void entryRemoved( const KonqHistoryEntry *entry );
 
protected:
    void adjustSize();

    inline bool isExpired( KonqHistoryEntry *entry ) {
    return (entry && m_maxAgeDays > 0 && entry->lastVisited <
        TQDateTime(TQDate::currentDate().addDays( -m_maxAgeDays )));
    }

    void emitAddToHistory( const KonqHistoryEntry& entry );

    virtual void notifyHistoryEntry( KonqHistoryEntry e, TQCString saveId );

    virtual void notifyMaxCount( TQ_UINT32 count, TQCString saveId );

    virtual void notifyMaxAge( TQ_UINT32 days, TQCString saveId );

    virtual void notifyClear( TQCString saveId );

    virtual void notifyRemove( KURL url, TQCString saveId );

    virtual void notifyRemove( KURL::List urls, TQCString saveId );

    virtual TQStringList allURLs() const;

    void addToHistory( bool pending, const KURL& url,
               const TQString& typedURL = TQString::null,
               const TQString& title = TQString::null );
 

    virtual bool filterOut( const KURL& url );
 
    void addToUpdateList( const TQString& url ) {
        m_updateURLs.append( url );
        m_updateTimer->start( 500, true );
    }

    TQStringList m_updateURLs;
 
private slots:
    void slotEmitUpdated();
 
private:
    bool isSenderOfBroadcast();
 
    void clearPending();
    KonqHistoryEntry * findEntry( const KURL& url );

    bool loadFallback();
    KonqHistoryEntry * createFallbackEntry( const TQString& ) const;
 
    void addToCompletion( const TQString& url, const TQString& typedURL, int numberOfTimesVisited = 1 );
    void removeFromCompletion( const TQString& url, const TQString& typedURL );
 
    TQString m_filename;
    KonqHistoryList m_history;

    TQMap<TQString,KonqHistoryEntry*> m_pending;
 
    TQ_UINT32 m_maxCount;   // maximum of history entries
    TQ_UINT32 m_maxAgeDays; // maximum age of a history entry
 
    TDECompletion *m_pCompletion; // the completion object we sync with

    TQTimer *m_updateTimer;
 
    static const TQ_UINT32 s_historyVersion;
};
 
 
#endif // KONQ_HISTORY_H