[ jEdit-CVS ] plugins/TextAutocomplete TextAutocomplete.html,1.6,1.7

[Jakub H. <mal...@us...>]

Update of /cvsroot/jedit/plugins/TextAutocomplete
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv18264

Modified Files:
	TextAutocomplete.html 
Log Message:
+ How it works?

Index: TextAutocomplete.html
===================================================================
RCS file: /cvsroot/jedit/plugins/TextAutocomplete/TextAutocomplete.html,v
retrieving revision 1.6
retrieving revision 1.7
diff -u -d -r1.6 -r1.7
--- TextAutocomplete.html	15 Mar 2006 19:38:19 -0000	1.6
+++ TextAutocomplete.html	26 Mar 2006 19:22:58 -0000	1.7
@@ -27,6 +27,7 @@
       <li><a href="#Wish">Wish list</a></li>
       <li><a href="#Change">Change Log</a></li>
       <li><a href="#Overview">Overview of the Classes</a></li>
+      <li><a href="#Working">How does it work?</a></li>
     </ul>
   </li>
   <li><a href="#License">License</a></li>
@@ -238,6 +239,15 @@
 
 <p>For more info see <a href="http://jakubholy.net/comp/jedit.html">http://jakubholy.net/comp/jedit.html</a>.</p>
 
+<h3><a name="Working">How does it work?</a></h3>
+<p>
+A BufferListener (implemented by my WordTypedListener) is attached to the buffer. When it detects an important event 
+(a letter appended to a word, a word ended...), it notifies the main class AutoComplete 
+via the Observer/Observable mechanism. It may then display (or dispose) a list of completions. 
+When the list of completions is displayed, it intercepts special keys being pressed (such as Enter, 
+Escape...) and reacts according to its setting (hide itself, insert the selected completion...).
+</p>
+
 <h2><a name="License">License</a></h2>
 
 <p>This plugin is released under the GNU General Public License version 2