page.h

/***************************************************************************
 *   Copyright (C) 2004 by Enrico Ros <[email protected]>                  *
 *   Copyright (C) 2017    Klarälvdalens Datakonsult AB, a KDAB Group      *
 *                         company, [email protected] Work sponsored by the   *
 *                         LiMux project of the city of Munich             *
 *                                                                         *
 *   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_PAGE_H_
#define _OKULAR_PAGE_H_

#include <QLinkedList>

#include "area.h"
#include "global.h"
#include "okularcore_export.h"
#include "textpage.h"

class QPixmap;

class PagePainter;

namespace Okular
{
class Annotation;
class Document;
class DocumentObserver;
class DocumentPrivate;
class FormField;
class PagePrivate;
class PageTransition;
class SourceReference;
class TextSelection;
class Tile;

class OKULARCORE_EXPORT Page
{
public:
    enum PageAction {
        Opening, 
        Closing  
    };

    Page(uint pageNumber, double width, double height, Rotation orientation);

    ~Page();

    int number() const;

    Rotation orientation() const;

    Rotation rotation() const;

    Rotation totalOrientation() const;

    double width() const;

    double height() const;

    double ratio() const;

    NormalizedRect boundingBox() const;

    bool isBoundingBoxKnown() const;

    void setBoundingBox(const NormalizedRect &bbox);

    bool hasPixmap(DocumentObserver *observer, int width = -1, int height = -1, const NormalizedRect &rect = NormalizedRect()) const;

    bool hasTextPage() const;

    bool hasObjectRect(double x, double y, double xScale, double yScale) const;

    bool hasHighlights(int id = -1) const;

    bool hasTransition() const;

    bool hasAnnotations() const;

    RegularAreaRect *findText(int id, const QString &text, SearchDirection direction, Qt::CaseSensitivity caseSensitivity, const RegularAreaRect *lastRect = nullptr) const;

    QString text(const RegularAreaRect *area = nullptr) const;

    QString text(const RegularAreaRect *area, TextPage::TextAreaInclusionBehaviour b) const;

    TextEntity::List words(const RegularAreaRect *area, TextPage::TextAreaInclusionBehaviour b) const;

    RegularAreaRect *wordAt(const NormalizedPoint &p, QString *word = nullptr) const;

    RegularAreaRect *textArea(TextSelection *selection) const;

    const ObjectRect *objectRect(ObjectRect::ObjectType type, double x, double y, double xScale, double yScale) const;

    QLinkedList<const ObjectRect *> objectRects(ObjectRect::ObjectType type, double x, double y, double xScale, double yScale) const;

    const ObjectRect *nearestObjectRect(ObjectRect::ObjectType type, double x, double y, double xScale, double yScale, double *distance) const;

    const PageTransition *transition() const;

    QLinkedList<Annotation *> annotations() const;

    Annotation *annotation(const QString &uniqueName) const;

    const Action *pageAction(PageAction action) const;

    QLinkedList<FormField *> formFields() const;

    void setPixmap(DocumentObserver *observer, QPixmap *pixmap, const NormalizedRect &rect = NormalizedRect());

    void setTextPage(TextPage *text);

    void setObjectRects(const QLinkedList<ObjectRect *> &rects);

    void setSourceReferences(const QLinkedList<SourceRefObjectRect *> &rects);

    void setDuration(double seconds);

    double duration() const;

    void setLabel(const QString &label);

    QString label() const;

    const RegularAreaRect *textSelection() const;

    QColor textSelectionColor() const;

    void addAnnotation(Annotation *annotation);

    bool removeAnnotation(Annotation *annotation);

    void setTransition(PageTransition *transition);

    void setPageAction(PageAction action, Action *link);

    void setFormFields(const QLinkedList<FormField *> &fields);

    void deletePixmap(DocumentObserver *observer);

    void deletePixmaps();

    void deleteRects();

    void deleteSourceReferences();

    void deleteAnnotations();

    bool hasTilesManager(const DocumentObserver *observer) const;

    QList<Tile> tilesAt(const DocumentObserver *observer, const NormalizedRect &rect) const;

private:
    PagePrivate *d;
    friend class PagePrivate;
    friend class Document;
    friend class DocumentPrivate;
    friend class PixmapRequestPrivate;

    friend class ::PagePainter;

    const QPixmap *_o_nearestPixmap(DocumentObserver *, int, int) const;

    QLinkedList<ObjectRect *> m_rects;
    QLinkedList<HighlightAreaRect *> m_highlights;
    QLinkedList<Annotation *> m_annotations;

    Q_DISABLE_COPY(Page)
};

}

#endif