From 51812f21de24aae47772c927a0b8c9643fd4fb57 Mon Sep 17 00:00:00 2001
From: Jon Tibble <meths@btinternet.com>
Date: Wed, 26 Jan 2011 17:13:26 +0000
Subject: [PATCH] Stop redefining builtins and docstrings

---
 openlp/core/lib/spelltextedit.py | 42 ++++++++++++++++++++------------
 1 file changed, 26 insertions(+), 16 deletions(-)

diff --git a/openlp/core/lib/spelltextedit.py b/openlp/core/lib/spelltextedit.py
index 82391a0b3..44180a25c 100644
--- a/openlp/core/lib/spelltextedit.py
+++ b/openlp/core/lib/spelltextedit.py
@@ -47,13 +47,16 @@ class SpellTextEdit(QtGui.QPlainTextEdit):
         # Default dictionary based on the current locale.
         if ENCHANT_AVAILABLE:
             try:
-                self.dict = enchant.Dict()
+                self.dictionary = enchant.Dict()
             except DictNotFoundError:
-                self.dict = enchant.Dict(u'en_US')
+                self.dictionary = enchant.Dict(u'en_US')
             self.highlighter = Highlighter(self.document())
-            self.highlighter.setDict(self.dict)
+            self.highlighter.spellingDictionary = self.dictionary
 
     def mousePressEvent(self, event):
+        """
+        Handle mouse clicks within the text edit region.
+        """
         if event.button() == QtCore.Qt.RightButton:
             # Rewrite the mouse event to a left button event so the cursor is
             # moved to the location of the pointer.
@@ -63,6 +66,9 @@ class SpellTextEdit(QtGui.QPlainTextEdit):
         QtGui.QPlainTextEdit.mousePressEvent(self, event)
 
     def contextMenuEvent(self, event):
+        """
+        Provide the context menu for the text edit region.
+        """
         popupMenu = self.createStandardContextMenu()
         # Select the word under the cursor.
         cursor = self.textCursor()
@@ -74,10 +80,10 @@ class SpellTextEdit(QtGui.QPlainTextEdit):
         # suggestions if it is.
         if ENCHANT_AVAILABLE and self.textCursor().hasSelection():
             text = unicode(self.textCursor().selectedText())
-            if not self.dict.check(text):
+            if not self.dictionary.check(text):
                 spell_menu = QtGui.QMenu(translate('OpenLP.SpellTextEdit',
                     'Spelling Suggestions'))
-                for word in self.dict.suggest(text):
+                for word in self.dictionary.suggest(text):
                     action = SpellAction(word, spell_menu)
                     action.correct.connect(self.correctWord)
                     spell_menu.addAction(action)
@@ -126,28 +132,32 @@ class SpellTextEdit(QtGui.QPlainTextEdit):
                     cursor.insertText(html[u'start tag'])
                     cursor.insertText(html[u'end tag'])
 
-class Highlighter(QtGui.QSyntaxHighlighter):
 
+class Highlighter(QtGui.QSyntaxHighlighter):
+    """
+    Provides a text highlighter for pointing out spelling errors in text.
+    """
     WORDS = u'(?iu)[\w\']+'
 
     def __init__(self, *args):
         QtGui.QSyntaxHighlighter.__init__(self, *args)
-        self.dict = None
-
-    def setDict(self, dict):
-        self.dict = dict
+        self.spellingDictionary = None
 
     def highlightBlock(self, text):
-        if not self.dict:
+        """
+        Highlight misspelt words in a block of text
+        """
+        if not self.spellingDictionary:
             return
         text = unicode(text)
-        format = QtGui.QTextCharFormat()
-        format.setUnderlineColor(QtCore.Qt.red)
-        format.setUnderlineStyle(QtGui.QTextCharFormat.SpellCheckUnderline)
+        charFormat = QtGui.QTextCharFormat()
+        charFormat.setUnderlineColor(QtCore.Qt.red)
+        charFormat.setUnderlineStyle(QtGui.QTextCharFormat.SpellCheckUnderline)
         for word_object in re.finditer(self.WORDS, text):
-            if not self.dict.check(word_object.group()):
+            if not self.spellingDictionary.check(word_object.group()):
                 self.setFormat(word_object.start(),
-                    word_object.end() - word_object.start(), format)
+                    word_object.end() - word_object.start(), charFormat)
+
 
 class SpellAction(QtGui.QAction):
     """