summaryrefslogtreecommitdiffstats
path: root/tdespell2/dictionary.h
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2013-01-26 13:17:21 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2013-01-26 13:17:21 -0600
commitdfe289850f068f19ba4a83ab4e7e22a7e09c13c9 (patch)
treec297348a55df66c571de4525646e0b9762427353 /tdespell2/dictionary.h
parentb7658a0d5eca24a9d37c6e04f88298ef02389db0 (diff)
downloadtdelibs-dfe289850f068f19ba4a83ab4e7e22a7e09c13c9.tar.gz
tdelibs-dfe289850f068f19ba4a83ab4e7e22a7e09c13c9.zip
Rename a number of libraries and executables to avoid conflicts with KDE4
Diffstat (limited to 'tdespell2/dictionary.h')
-rw-r--r--tdespell2/dictionary.h110
1 files changed, 110 insertions, 0 deletions
diff --git a/tdespell2/dictionary.h b/tdespell2/dictionary.h
new file mode 100644
index 000000000..31567ece9
--- /dev/null
+++ b/tdespell2/dictionary.h
@@ -0,0 +1,110 @@
+// -*- Mode: C++; c-basic-offset: 4; indent-tabs-mode: nil; -*-
+/*
+ * dictionary.h
+ *
+ * Copyright (C) 2004 Zack Rusin <zack@kde.org>
+ *
+ * This library is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 2.1 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
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public
+ * License along with this library; if not, write to the Free Software
+ * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA
+ * 02110-1301 USA
+ */
+#ifndef KSPELL_DICTIONARY_H
+#define KSPELL_DICTIONARY_H
+
+#include <tqstringlist.h>
+#include <tqstring.h>
+
+namespace KSpell2
+{
+ /**
+ * Class is returned by from Broker. It acts
+ * as the actual spellchecker.
+ *
+ * @author Zack Rusin <zack@kde.org>
+ * @short class used for actuall spell checking
+ */
+ class Dictionary
+ {
+ public:
+ virtual ~Dictionary() {}
+
+ /**
+ * Checks the given word.
+ * @return false if the word is misspelled. true otherwise
+ */
+ virtual bool check( const TQString& word ) =0;
+
+ /**
+ * Fetches suggestions for the word.
+ *
+ * @return list of all suggestions for the word
+ */
+ virtual TQStringList suggest( const TQString& word ) =0;
+
+ /**
+ * Checks the word and fetches suggestions for it.
+ */
+ virtual bool checkAndSuggest( const TQString& word,
+ TQStringList& suggestions ) =0;
+
+ /**
+ * Stores user defined good replacement for the bad word.
+ * @returns true on success
+ */
+ virtual bool storeReplacement( const TQString& bad,
+ const TQString& good ) =0;
+
+ /**
+ * Adds word to the list of of personal words.
+ * @return true on success
+ */
+ virtual bool addToPersonal( const TQString& word ) =0;
+
+ /**
+ * Adds word to the words recognizable in the current session.
+ * @return true on success
+ */
+ virtual bool addToSession( const TQString& word ) =0;
+
+ /**
+ * Returns language supported by this dictionary.
+ */
+ TQString language() const
+ {
+ return m_language;
+ }
+
+ /**
+ * Returns true if this dictionary was constructed from
+ * default Settings values
+ */
+ bool isDefault() const
+ {
+ return m_default;
+ }
+
+ protected:
+ Dictionary( const TQString& lang, bool def = false )
+ : m_language( lang ), m_default( def ) {}
+ protected:
+ friend class Broker;
+ TQString m_language;
+ bool m_default;
+ private:
+ class Private;
+ Private *d;
+ };
+}
+
+#endif