bookmarkmanager.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2006 by Pino Toscano <pino@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.                                   *
 ***************************************************************************/

#ifndef _OKULAR_BOOKMARK_MANAGER_H_
#define _OKULAR_BOOKMARK_MANAGER_H_

#include <kbookmark.h>

#include "okular_export.h"

class QAction;
class KUrl;

namespace Okular {

class Document;
class DocumentPrivate;
class DocumentViewport;

class OKULAR_EXPORT BookmarkManager : public QObject
{
    Q_OBJECT

    public:
        virtual ~BookmarkManager();

        KUrl::List files() const;

        KBookmark::List bookmarks( const KUrl& url ) const;

        KBookmark::List bookmarks() const;

        KBookmark::List bookmarks( int page ) const;

        KBookmark bookmark( int page ) const;

        KBookmark bookmark( const DocumentViewport &viewport ) const;

        void save() const;

        void addBookmark( int page );

        void addBookmark( const DocumentViewport &vp );

        bool addBookmark( const KUrl& referurl, const Okular::DocumentViewport& vp, const QString& title = QString() );

        void removeBookmark( int page );

        void removeBookmark( const DocumentViewport &vp );

        int removeBookmark( const KUrl& referurl, const KBookmark& bm );

        void removeBookmarks( const KUrl& referurl, const KBookmark::List& list );

        void renameBookmark( KBookmark* bm, const QString& newName );

        void renameBookmark( const KUrl& referurl, const QString& newName );

        QString titleForUrl( const KUrl& referurl ) const;

        bool isBookmarked( int page ) const;

        bool isBookmarked( const DocumentViewport &viewport ) const;

        KBookmark nextBookmark( const DocumentViewport &viewport ) const;

        KBookmark previousBookmark( const DocumentViewport &viewport ) const;

        QList< QAction* > actionsForUrl( const KUrl& url ) const;

    Q_SIGNALS:
        void openUrl( const KUrl& url );

        void saved();

        void bookmarksChanged( const KUrl& url );

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

        // private interface used by the Document
        friend class Document;
        friend class DocumentPrivate;

        BookmarkManager( DocumentPrivate * document );

        void setUrl( const KUrl& url );
        bool setPageBookmark( int page );
        bool removePageBookmark( int page );

        Q_DISABLE_COPY( BookmarkManager )

        Q_PRIVATE_SLOT( d, void _o_changed( const QString &, const QString & ) )
};

}

#endif