tdespell.h

/* 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 __TDESPELL_H__
#define __TDESPELL_H__
 
#include "ksconfig.h"
 
#include <tqobject.h>
#include <tqstringlist.h>
#include <tqstring.h>
#include <tdelibs_export.h>
 
class TQTextCodec;
class TDEProcIO;
class TDEProcess;
class KSpellDlg;
 
class TDEUI_EXPORT KSpell : public TQObject
{
  TQ_OBJECT
 
public:
 
  enum spellStatus { Starting = 0, Running, Cleaning, Finished, Error, Crashed, FinishedNoMisspellingsEncountered };
 
  enum SpellerType { Text = 0, HTML, TeX, Nroff };
 
  KSpell(TQWidget *parent, const TQString &caption,
     TQObject *receiver, const char *slot, KSpellConfig *kcs=0,
     bool progressbar = true, bool modal = false);
 
  KSpell(TQWidget *parent, const TQString &caption,
     TQObject *receiver, const char *slot, KSpellConfig *kcs,
     bool progressbar, bool modal, SpellerType type);
 
  spellStatus status() const { return m_status; }
 
  virtual void cleanUp ();
 
  void setAutoDelete(bool _autoDelete) { autoDelete = _autoDelete; }
 
  virtual bool check (const TQString &_buffer, bool usedialog = true);
 
  int lastPosition() const
    { return lastpos;}
 
  virtual bool checkList (TQStringList *_wordlist, bool usedialog = true);
 
  virtual bool checkWord (const TQString &_buffer, bool usedialog = false);
  bool checkWord( const TQString & buffer, bool _usedialog, bool suggest );
 
  void hide ();
 
  TQStringList suggestions () const { return sugg; }
 
  int dlgResult () const
    { return dlgresult; }
 
  void moveDlg (int x, int y);
 
  int heightDlg () const;
  int widthDlg () const;
 
  TQString intermediateBuffer () const {return newbuffer;}
 
  virtual bool ignore (const TQString & word);
 
  virtual bool addPersonal (const TQString & word);
 
  KSpellConfig ksConfig () const;
 
  void setProgressResolution (unsigned int res);
 
  virtual ~KSpell();
 
  static int modalCheck( TQString& text ) TDE_DEPRECATED;
 
  static int modalCheck( TQString& text, KSpellConfig * kcs );
 
  void setIgnoreUpperWords(bool b);
 
  void setIgnoreTitleCase(bool b);
 
signals:
 
  void misspelling (const TQString & originalword, const TQStringList & suggestions,
            unsigned int pos);
 
  void corrected (const TQString & originalword, const TQString & newword, unsigned int pos);
 
  void ignoreall (const TQString & originalword);
 
  void ignoreword (const TQString & originalword);
 
  void addword (const TQString & originalword);
 
  void replaceall( const TQString & origword ,  const TQString &replacement );
 
  void ready(KSpell *);
 
  void progress (unsigned int i);
 
  void done (const TQString &buffer);
 
  void done(bool);
 
  void death( );
 
 
protected slots:
  /* All of those signals from TDEProcIO get sent here. */
  void KSpell2 (TDEProcIO *);
  void checkWord2 (TDEProcIO *);
  void checkWord3 ();
  void check2 (TDEProcIO *);
  void checkList2 ();
  void checkList3a (TDEProcIO *);
  void checkListReplaceCurrent ();
  void checkList4 ();
  void dialog2 (int dlgresult);
  void check3 ();
  void suggestWord( TDEProcIO * );
 
  void slotStopCancel (int);
  void ispellExit (TDEProcess *);
  void emitDeath();
  void ispellErrors (TDEProcess *, char *, int);
  void checkNext();
 
private slots:
  void slotModalReady();
 
  void slotModalDone( const TQString & );
 
  void slotSpellCheckerCorrected( const TQString & oldText, const TQString & newText, unsigned int );
 
  void  slotModalSpellCheckerFinished( );
 
signals:
  void dialog3 ();
 
protected:
 
  TDEProcIO *proc;
  TQWidget *parent;
  KSpellConfig *ksconfig;
  KSpellDlg *ksdlg;
  TQStringList *wordlist;
  TQStringList::Iterator wlIt;
  TQStringList ignorelist;
  TQStringList replacelist;
  TQStringList sugg;
  TQTextCodec* codec;
 
  spellStatus m_status;
 
  bool usedialog;
  bool texmode;
  bool dlgon;
  bool personaldict;
  bool dialogwillprocess;
  bool progressbar;
  bool dialogsetup;
  bool autoDelete;
 
  TQString caption;
  TQString orig;
  TQString origbuffer;
  TQString newbuffer;
  TQString cwword;
  TQString dlgorigword;
  TQString dlgreplacement;
  TQString dialog3slot;
 
  int dlgresult;
  int trystart;
  int maxtrystart;
  int lastpos;
  unsigned int totalpos;
  unsigned int lastline;
  unsigned int posinline;
  unsigned int lastlastline;
  unsigned int offset;
  unsigned int progres;
  unsigned int curprog;
 
  bool modaldlg;
  static TQString modaltext;
  static int modalreturn;
  static TQWidget* modalWidgetHack;
 
  int parseOneResponse (const TQString &_buffer, TQString &word, TQStringList &sugg);
  TQString funnyWord (const TQString & word);
  void dialog (const TQString & word, TQStringList & sugg, const char* _slot);
  TQString replacement () const
    { return dlgreplacement; }
 
  void setUpDialog ( bool reallyusedialogbox = true);
 
  void emitProgress ();
  bool cleanFputs (const TQString & s, bool appendCR=true);
  bool cleanFputsWord (const TQString & s, bool appendCR=true);
  void startIspell();
  bool writePersonalDictionary();
  void initialize( TQWidget *_parent, const TQString &_caption,
                   TQObject *obj, const char *slot, KSpellConfig *_ksc,
                   bool _progressbar, bool _modal, SpellerType type );
 
private:
  class KSpellPrivate;
  KSpellPrivate *d;
};
 
#endif