ktextedit.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
    Copyright (C) 2002 Carsten Pfeiffer <pfeiffer@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 KTEXTEDIT_H
#define KTEXTEDIT_H

#include <kdeui_export.h>
#include <sonnet/highlighter.h>
#include <QtGui/QTextEdit>

class KTextEditSpellInterface
{
  public:

    virtual bool isSpellCheckingEnabled() const = 0;

    virtual void setSpellCheckingEnabled(bool enable) = 0;

    virtual bool shouldBlockBeSpellChecked(const QString& block) const = 0;

    virtual ~KTextEditSpellInterface() {}
};

class KDEUI_EXPORT KTextEdit : public QTextEdit //krazy:exclude=qclasses
{
    Q_OBJECT
    Q_PROPERTY( QString clickMessage READ clickMessage WRITE setClickMessage )
    Q_PROPERTY( bool checkSpellingEnabled READ checkSpellingEnabled WRITE setCheckSpellingEnabled )
    Q_PROPERTY( QString spellCheckingLanguage READ spellCheckingLanguage WRITE setSpellCheckingLanguage )

  public:
    explicit KTextEdit( const QString& text, QWidget *parent = 0 );

    explicit KTextEdit( QWidget *parent = 0 );

    ~KTextEdit();

    virtual void setReadOnly( bool readOnly );

    void setCheckSpellingEnabled( bool check );

    bool checkSpellingEnabled() const;

    void highlightWord( int length, int pos );

    void setSpellCheckingConfigFileName(const QString &fileName);

    virtual void createHighlighter();

    Sonnet::Highlighter* highlighter() const;

    void setHighlighter(Sonnet::Highlighter *_highLighter);

    QMenu *mousePopupMenu();

    void enableFindReplace( bool enabled);

    void setSpellInterface( KTextEditSpellInterface *spellInterface );

    const QString& spellCheckingLanguage() const;

    void setClickMessage(const QString &msg);

    QString clickMessage() const;

  Q_SIGNALS:
     void checkSpellingChanged( bool );

     void spellCheckStatus(const QString &);

     void languageChanged(const QString &language);

    void aboutToShowContextMenu(QMenu* menu);

  public Q_SLOTS:

    void setSpellCheckingLanguage(const QString &language);

    void checkSpelling();

    void showSpellConfigDialog(const QString &configFileName,
                               const QString &windowIcon = QString());

    void replace();

  protected Q_SLOTS:
    void slotDoReplace();
    void slotReplaceNext();
    void slotDoFind();
    void slotFind();
    void slotFindNext();
    void slotReplace();
    void slotSpeakText();

  protected:
    virtual bool event(QEvent*);

    virtual void paintEvent(QPaintEvent *);
    virtual void focusOutEvent(QFocusEvent *);

    virtual void keyPressEvent( QKeyEvent* );

    virtual void focusInEvent( QFocusEvent* );

    virtual void wheelEvent( QWheelEvent* );

    virtual void deleteWordBack();

    virtual void deleteWordForward();

    virtual void contextMenuEvent( QContextMenuEvent* );

    // TODO: KDE5: get rid of these as soon as BIC changes are allowed, they
    //             should be folded back into the normal public version, which
    //             should be made virtual.
    //             These methods just provide a way for derived classes to call
    //             the base class version of the normal methods.

    void setCheckSpellingEnabledInternal(bool check);

    bool checkSpellingEnabledInternal() const;

  private:
    class Private;
    Private *const d;

    Q_PRIVATE_SLOT( d, void spellCheckerMisspelling( const QString&, int ) )
    Q_PRIVATE_SLOT( d, void spellCheckerCorrected(const QString&, int,const QString&) )
    Q_PRIVATE_SLOT( d, void spellCheckerCanceled())
    Q_PRIVATE_SLOT( d, void spellCheckerAutoCorrect(const QString&,const QString&) )
    Q_PRIVATE_SLOT( d, void spellCheckerFinished() )
    Q_PRIVATE_SLOT( d, void undoableClear() )
    Q_PRIVATE_SLOT( d, void toggleAutoSpellCheck() )
    Q_PRIVATE_SLOT( d, void slotAllowTab() )
    Q_PRIVATE_SLOT( d, void menuActivated( QAction* ) )
    Q_PRIVATE_SLOT( d, void slotFindHighlight(const QString&, int, int))
    Q_PRIVATE_SLOT( d, void slotReplaceText(const QString &, int, int, int))
};

#endif // KTEXTEDIT_H