textpage.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (C) 2005 by Piotr Szymanski <niedakh@gmail.com>             *
 *                                                                         *
 *   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_TEXTPAGE_H_
#define _OKULAR_TEXTPAGE_H_

#include <QtCore/QList>
#include <QtCore/QString>

#include "okular_export.h"
#include "global.h"

class QTransform;

namespace Okular {

class NormalizedPoint;
class NormalizedRect;
class Page;
class PagePrivate;
class TextPagePrivate;
class TextSelection;
class RegularAreaRect;

class OKULAR_EXPORT TextEntity
{
    public:
        typedef QList<TextEntity*> List;

        TextEntity( const QString &text, NormalizedRect *area );

        ~TextEntity();

        QString text() const;

        NormalizedRect* area() const;

        NormalizedRect transformedArea(const QTransform &matrix) const;

    private:
        QString m_text;
        NormalizedRect* m_area;

        class Private;
        const Private *d;

        Q_DISABLE_COPY( TextEntity )
};

class OKULAR_EXPORT TextPage
{
    friend class Page;
    friend class PagePrivate;

    public:
        enum TextAreaInclusionBehaviour
        {
            AnyPixelTextAreaInclusionBehaviour,      
            CentralPixelTextAreaInclusionBehaviour  
        };

        TextPage();

        TextPage( const TextEntity::List &words );

        ~TextPage();

        void append( const QString &text, NormalizedRect *area );

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

        QString text( const RegularAreaRect *rect = 0 ) const;

        QString text( const RegularAreaRect * rect, TextAreaInclusionBehaviour b ) const;

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

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

        RegularAreaRect *textArea( TextSelection *selection ) const;

    private:
        TextPagePrivate* const d;

        Q_DISABLE_COPY( TextPage )
};

}

#endif