diff -r 000000000000 -r de9c2efb9d02 QScintilla/TypingCompleters/CompleterBase.py
--- /dev/null Thu Jan 01 00:00:00 1970 +0000
+++ b/QScintilla/TypingCompleters/CompleterBase.py Mon Dec 28 16:03:33 2009 +0000
@@ -0,0 +1,77 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2007 - 2009 Detlev Offenbach <detlev@die-offenbachs.de>
+#
+
+"""
+Module implementing a base class for all typing completers.
+
+Typing completers are classes that implement some convenience actions,
+that are performed while the user is typing (e.g. insert ')' when the
+user types '(').
+"""
+
+from PyQt4.QtCore import QObject, SIGNAL
+
+class CompleterBase(QObject):
+ """
+ Class implementing the base class for all completers.
+ """
+ def __init__(self, editor, parent = None):
+ """
+ Constructor
+
+ @param editor reference to the editor object (QScintilla.Editor)
+ @param parent reference to the parent object (QObject)
+ If parent is None, we set the editor as the parent.
+ """
+ if parent is None:
+ parent = editor
+
+ QObject.__init__(self, parent)
+
+ self.editor = editor
+ self.enabled = False
+
+ def setEnabled(self, enable):
+ """
+ Public slot to set the enabled state.
+
+ @param enabled flag indicating the new state (boolean)
+ """
+ if enable:
+ if not self.enabled:
+ self.connect(self.editor, SIGNAL("SCN_CHARADDED(int)"), self.charAdded)
+ else:
+ if self.enabled:
+ self.disconnect(self.editor, SIGNAL("SCN_CHARADDED(int)"), self.charAdded)
+ self.enabled = enable
+
+ def isEnabled(self):
+ """
+ Public method to get the enabled state.
+ """
+ return self.enabled
+
+ def charAdded(self, charNumber):
+ """
+ Public slot called to handle the user entering a character.
+
+ Note 1: this slot must be overridden by subclasses implementing the
+ specific behavior for the language.
+
+ Note 2: charNumber can be greater than 255 because the editor is
+ in UTF-8 mode by default.
+
+ @param charNumber value of the character entered (integer)
+ """
+ pass # just do nothing
+
+ def readSettings(self):
+ """
+ Public slot called to reread the configuration parameters.
+
+ Note: this slot should be overridden by subclasses having
+ configurable parameters.
+ """
+ pass # just do nothing
