textedit.h

/*
  Copyright (c) 2009 Thomas McGuire <mcguire@kde.org>

  Based on KMail and libkdepim code by:
  Copyright 2007 - 2010 Laurent Montel <montel@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 KPIMTEXTEDIT_TEXTEDIT_H
#define KPIMTEXTEDIT_TEXTEDIT_H

#include "kpimtextedit_export.h"

#include <kpimidentities/signature.h> // TODO KF5: remove this

#include <KDE/KRichTextWidget>
#include <KActionCollection>

#include <QtCore/QSharedPointer>

#include <memory>
// TODO KF5: remove this
#define FIX_KMAIL_INSERT_IMAGE 1

class KUrl;
class QFileInfo;

namespace KPIMTextEdit {

class TextEditPrivate;
class EMailQuoteHighlighter;

struct EmbeddedImage
{
  QByteArray image;   
  QString contentID;  
  QString imageName;  
};

struct ImageWithName
{
  QImage image; 
  QString name; 
};

typedef QSharedPointer<ImageWithName> ImageWithNamePtr;
typedef QList< ImageWithNamePtr > ImageWithNameList;
typedef QList< QSharedPointer<EmbeddedImage> > ImageList;

class KPIMTEXTEDIT_EXPORT TextEdit : public KRichTextWidget,
                                     // TODO: KDE5: get rid of the spell interface
                                     protected KTextEditSpellInterface
{
  Q_OBJECT

  public:

    explicit TextEdit( const QString &text, QWidget *parent = 0 );

    explicit TextEdit( QWidget *parent = 0 );

    explicit TextEdit( QWidget *parent, const QString &configFile );

    void enableImageActions();
    void enableEmoticonActions();

    void enableInsertHtmlActions();

    void enableInsertTableActions();
    ~TextEdit();

    virtual void createActions( KActionCollection *actionCollection );

    void addImage( const KUrl &url );

    void addImage( const KUrl &url, int width, int height );

    void loadImage( const QImage &image, const QString &matchName, const QString &resourceName );

    void deleteCurrentLine();

    ImageList embeddedImages() const;

    ImageWithNameList imagesWithName() const;

    QString toWrappedPlainText() const;

    QString toWrappedPlainText( QTextDocument *document ) const;

    //TODO 5.0 merge it
    QString toCleanPlainText( const QString &plainText ) const;

    QString toCleanPlainText() const;

    virtual void setHighlighterColors( EMailQuoteHighlighter *highlighter );

    bool isLineQuoted( const QString &line ) const;

    virtual int quoteLength( const QString &line ) const;

    virtual const QString defaultQuoteSign() const;

    static QByteArray imageNamesToContentIds( const QByteArray &htmlBody,
                                              const ImageList &imageList );

    bool isFormattingUsed() const;

    QString configFile() const;

    bool isEnableImageActions() const;

    bool isEnableEmoticonActions() const;

    void insertImage( const QImage &image, const QFileInfo &info );

    bool isEnableInsertHtmlActions() const;

    bool isEnableInsertTableActions() const;

  protected:

    virtual bool canInsertFromMimeData( const QMimeData *source ) const;

    virtual void insertFromMimeData( const QMimeData *source );

    virtual bool eventFilter( QObject *o, QEvent *e );

    virtual void keyPressEvent ( QKeyEvent *e );

    // For the explaination for these four methods, see the comment at the
    // spellCheckingEnabled variable of the private class.

    virtual bool isSpellCheckingEnabled() const;

    virtual void setSpellCheckingEnabled( bool enable );

    virtual bool shouldBlockBeSpellChecked( const QString &block ) const;

    virtual void createHighlighter();

  private:
    void addImageHelper( const KUrl &url, int width = -1, int height = -1 );
    std::auto_ptr<TextEditPrivate> const d;
    friend class TextEditPrivate;
    Q_PRIVATE_SLOT( d, void _k_slotAddImage() )
    Q_PRIVATE_SLOT( d, void _k_slotDeleteLine() )
    Q_PRIVATE_SLOT( d, void _k_slotAddEmoticon( const QString & ) )
    Q_PRIVATE_SLOT( d, void _k_slotInsertHtml() )
    Q_PRIVATE_SLOT( d, void _k_slotFormatReset() )
    Q_PRIVATE_SLOT( d, void _k_slotTextModeChanged( KRichTextEdit::Mode ) )
};

} // namespace

#endif