okular/ui/annotationpopup.h

/***************************************************************************
 *   Copyright (C) 2006 by Tobias Koenig <tokoe@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 ANNOTATIONPOPUP_H
#define ANNOTATIONPOPUP_H

#include <QObject>
#include <QList>
#include <QPair>
#include <QPoint>

namespace Okular {
class Annotation;
class Document;
}

class AnnotationPopup : public QObject
{
    Q_OBJECT

    public:
        /**
         * Describes the structure of the popup menu.
         */
        enum MenuMode
        {
            SingleAnnotationMode, ///< The menu shows only entries to manipulate a single annotation, or multiple annotations as a group.
            MultiAnnotationMode   ///< The menu shows entries to manipulate multiple annotations.
        };

        AnnotationPopup( Okular::Document *document, MenuMode mode, QWidget *parent = nullptr );

        void addAnnotation( Okular::Annotation* annotation, int pageNumber );

        void exec( const QPoint &point = QPoint() );

    Q_SIGNALS:
        void openAnnotationWindow( Okular::Annotation *annotation, int pageNumber );

    public:
        struct AnnotPagePair {
            AnnotPagePair() : annotation( nullptr ),  pageNumber( -1 )
            { }

            AnnotPagePair( Okular::Annotation *a, int pn ) : annotation( a ),  pageNumber( pn )
            { }
            
            ~AnnotPagePair() = default;
            AnnotPagePair( const AnnotPagePair & pair ) = default;
            AnnotPagePair &operator=( const AnnotPagePair & pair ) = default;
            
            bool operator==( const AnnotPagePair & pair ) const
            { return annotation == pair.annotation && pageNumber == pair.pageNumber; }
            
            Okular::Annotation* annotation;
            int pageNumber;
        };

    private:
        QWidget *mParent;

        QList< AnnotPagePair > mAnnotations;
        Okular::Document *mDocument;
        MenuMode mMenuMode;
};


#endif