kmouth/wordcompletion/wordcompletion.h

   1 #ifndef WORDCOMPLETION_H
   2 #define WORDCOMPLETION_H
   3
   4 #include <kcompletion.h>
   5
   6 /**
   7  * This class does completion based on a dictionary of words.
   8  */
   9 class WordCompletion : public KCompletion {
  10    friend class WordListWidget;
  11    Q_OBJECT
  12 public:
  13    WordCompletion();
  14    virtual ~WordCompletion();
  15
  16    /**
  17     * Returns the names for the available word lists
  18     */
  19    QStringList wordLists();
  20
  21    /**
  22     * Returns the names for those word lists that contain
  23     * words of a given language.
  24     */
  25    QStringList wordLists(const QString &language);
  26
  27    /**
  28     * Returns the language of a given word list.
  29     */
  30    QString languageOfWordList(const QString &wordlist);
  31
  32    /**
  33     * Returns the name of the currently active word list.
  34     */
  35    QString currentWordList();
  36
  37    /**
  38     * Finds completions to the given text.
  39     */
  40    virtual QString makeCompletion(const QString&);
  41
  42    static bool isConfigured();
  43
  44    /**
  45     * Adds the words from the given sentence to the list of words.
  46     */
  47    void addSentence (const QString &sentence);
  48
  49 public slots:
  50    /**
  51     * Re-reads the configuration.
  52     */
  53    void configure();
  54
  55    /**
  56     * Specify which word list gets used for the actual word completion.
  57     * If there is no word list with the given name the first configured
  58     * list gets used.
  59     * The method returns true if the specified word list was found.
  60     */
  61    bool setWordList(const QString &wordlist);
  62
  63    /**
  64     * Saves the added words to disk.
  65     */
  66    void save ();
  67
  68 signals:
  69    void wordListsChanged (const QStringList &wordLists);
  70    void currentListChanged (const QString &wordList);
  71
  72 private:
  73    class WordCompletionPrivate;
  74    WordCompletionPrivate *d;
  75 };
  76
  77 #endif // KURLCOMPLETION_H