textextension.h

Go to the documentation of this file.

/* This file is part of the KDE project
   Copyright (C) 2010 David Faure <faure@kde.org>

   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License as published by the Free Software Foundation; either
   version 2 of the License, or (at your option) any later version.

   This library 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
   Library General Public License for more details.

   You should have received a copy of the GNU Library General Public License
   along with this library; see the file COPYING.LIB.  If not, write to
   the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
   Boston, MA 02110-1301, USA.
 */

#ifndef KPARTS_TEXTEXTENSION_H
#define KPARTS_TEXTEXTENSION_H

#include <QtCore/QObject>
#include <kparts/kparts_export.h>
#include <kfind.h>

namespace KParts
{

class ReadOnlyPart;
class TextExtensionPrivate;

class KPARTS_EXPORT TextExtension : public QObject
{
    Q_OBJECT
public:
    TextExtension(KParts::ReadOnlyPart* parent);
    ~TextExtension();

    static TextExtension *childObject( QObject *obj );

    enum Format { PlainText, HTML };

    virtual bool hasSelection() const;
    virtual QString selectedText(Format format) const;
    virtual QString completeText(Format format) const;


    virtual int pageCount() const;
    virtual int currentPage() const;
    virtual QString pageText(Format format) const;
   
    virtual bool findText(const QString& string, KFind::SearchOptions options) const;
    
    // for future extensions can be made via slots

Q_SIGNALS:
    void selectionChanged();

private:
    // for future extensions
    TextExtensionPrivate* const d;
};

}

#endif /* KPARTS_TEXTEXTENSION_H */