k3spell.h

Go to the documentation of this file.

/* This file is part of the KDE libraries
   Copyright (C) 1997 David Sweet <dsweet@kde.org>
   Copyright (C) 2003 Zack Rusin <zack@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 version 2 as published by the Free Software Foundation.

   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 K3SPELL_H
#define K3SPELL_H

#include <kde3support_export.h>

#include <QtCore/QObject>
#include <QtCore/QStringList>
#include <QtCore/QString>

class QTextCodec;
class KProcess;
class K3SpellConfig;
class K3SpellDlg;

class KDE3SUPPORT_EXPORT_DEPRECATED K3Spell : public QObject
{
  Q_OBJECT

public:

  enum spellStatus { Starting = 0, Running, Cleaning, Finished, Error, Crashed, FinishedNoMisspellingsEncountered };

  enum SpellerType { Text = 0, HTML, TeX, Nroff };

  K3Spell(QWidget *parent, const QString &caption,
     QObject *receiver, const char *slot, K3SpellConfig *kcs=0,
     bool progressbar = true, bool modal = false);

  K3Spell(QWidget *parent, const QString &caption,
     QObject *receiver, const char *slot, K3SpellConfig *kcs,
     bool progressbar, bool modal, SpellerType type);

  spellStatus status() const;

  virtual void cleanUp ();

  void setAutoDelete(bool _autoDelete);

  virtual bool check (const QString &_buffer, bool usedialog = true);

  int lastPosition() const;

  virtual bool checkList (QStringList *_wordlist, bool usedialog = true);

  virtual bool checkWord (const QString &_buffer, bool usedialog = false);
  bool checkWord( const QString & buffer, bool _usedialog, bool suggest );

  void hide ();

  QStringList suggestions () const;

  int dlgResult () const;

  void moveDlg (int x, int y);

  int heightDlg () const;
  int widthDlg () const;

  QString intermediateBuffer () const;

  virtual bool ignore (const QString & word);

  virtual bool addPersonal (const QString & word);

  K3SpellConfig ksConfig () const;

  void setProgressResolution (unsigned int res);

  virtual ~K3Spell();

  static KDE_DEPRECATED int modalCheck( QString& text );

  static int modalCheck( QString& text, K3SpellConfig * kcs );

  void setIgnoreUpperWords(bool b);

  void setIgnoreTitleCase(bool b);

Q_SIGNALS:

  void misspelling (const QString & originalword, const QStringList & suggestions,
            unsigned int pos);

  void corrected (const QString & originalword, const QString & newword, unsigned int pos);

  void ignoreall (const QString & originalword);

  void ignoreword (const QString & originalword);

  void addword (const QString & originalword);

  void replaceall( const QString & origword ,  const QString &replacement );

  void ready(K3Spell *);

  void progress (unsigned int i);

  void done (const QString &buffer);

  void done(bool);

  void death( );


protected Q_SLOTS:
  /* All of those signals from KProcess get sent here. */
  void K3Spell2 ();
  void checkWord2 ();
  void checkWord3 ();
  void check2 ();
  void checkList2 ();
  void checkList3a ();
  void checkListReplaceCurrent ();
  void checkList4 ();
  void dialog2 (int dlgresult);
  void check3 ();
  void suggestWord();

  void slotStopCancel (int);
  void ispellExit ();
  void emitDeath();
  void ispellErrors ();
  void checkNext();

private Q_SLOTS:
  void slotModalReady();

  void slotModalDone( const QString & );

  void slotSpellCheckerCorrected( const QString & oldText, const QString & newText, unsigned int );

  void  slotModalSpellCheckerFinished( );

Q_SIGNALS:
  void dialog3 ();

protected:

  KProcess *proc;
  QWidget *parent;
  K3SpellConfig *ksconfig;
  K3SpellDlg *ksdlg;
  QStringList *wordlist;
  QStringList::Iterator wlIt;
  QStringList ignorelist;
  QStringList replacelist;
  QStringList sugg;

  spellStatus m_status;

  bool usedialog;
  bool texmode;
  bool dlgon;
  bool personaldict;
  bool dialogwillprocess;
  bool progressbar;
  bool dialogsetup;
  bool autoDelete;

  QString caption;
  QString orig;
  QString origbuffer;
  QString newbuffer;
  QString cwword;
  QString dlgorigword;
  QString dlgreplacement;
  QString dialog3slot;

  int dlgresult;
  int trystart;
  int maxtrystart;
  int lastpos;
  unsigned int totalpos;
  int lastline;
  unsigned int posinline;
  unsigned int lastlastline;
  unsigned int offset;
  unsigned int progres;
  unsigned int curprog;

  bool modaldlg;
  static QString modaltext;
  static int modalreturn;
  static QWidget* modalWidgetHack;

  int parseOneResponse (const QString &_buffer, QString &word, QStringList &sugg);
  QString funnyWord (const QString & word);
  void dialog (const QString & word, QStringList & sugg, const char* _slot);
  QString replacement () const;

  void setUpDialog ( bool reallyusedialogbox = true);

  void emitProgress ();
  bool cleanFputs (const QString & s );
  bool cleanFputsWord (const QString & s );
  void startIspell();
  bool writePersonalDictionary();
  void initialize( QWidget *_parent, const QString &_caption,
                   QObject *obj, const char *slot, K3SpellConfig *_ksc,
                   bool _progressbar, bool _modal, SpellerType type );

private:
  class K3SpellPrivate;
  K3SpellPrivate *d;
};

#endif