#ifndef WORDCOMPLETION_H
#define WORDCOMPLETION_H

#include <kcompletion.h>

/**
 * This class does completion based on a dictionary of words.
 */
class WordCompletion : public KCompletion {
   friend class WordListWidget;
   Q_OBJECT
public:
   WordCompletion();
   virtual ~WordCompletion();

   /**
    * Returns the names for the available word lists
    */
   QStringList wordLists();

   /**
    * Returns the names for those word lists that contain
    * words of a given language.
    */
   QStringList wordLists(const QString &language);
   
   /**
    * Returns the language of a given word list.
    */
   QString languageOfWordList(const QString &wordlist);

   /**
    * Returns the name of the currently active word list.
    */
   QString currentWordList();

   /**
    * Finds completions to the given text.
    */
   virtual QString makeCompletion(const QString&);

   static bool isConfigured();
   
   /**
    * Adds the words from the given sentence to the list of words.
    */
   void addSentence (const QString &sentence);
   
public slots:
   /**
    * Re-reads the configuration.
    */
   void configure();
   
   /**
    * Specify which word list gets used for the actual word completion.
    * If there is no word list with the given name the first configured
    * list gets used.
    * The method returns true if the specified word list was found.
    */
   bool setWordList(const QString &wordlist);

   /**
    * Saves the added words to disk.
    */
   void save ();

signals:
   void wordListsChanged (const QStringList &wordLists);
   void currentListChanged (const QString &wordList);

private:
   class WordCompletionPrivate;
   WordCompletionPrivate *d;
};

#endif // KURLCOMPLETION_H