.. include:: headings.inc



.. _TextCompleterSimple:

==========================================================================================================================================
|phoenix_title|  **TextCompleterSimple**
==========================================================================================================================================

A simpler base class for custom completer objects.          

This class may be simpler to use than the base :ref:`TextCompleter`  as it allows to implement only a single virtual method instead of two of them (at the price of storing all completions in a temporary array). 

Here is a simple example of a custom completer that completes the names of some chess pieces. Of course, as the total list here has only four items it would have been much simpler to just specify the array containing all the completions in this example but the same approach could be used when the total number of completions is much higher provided the number of possibilities for each word is still relatively small: ::

        class MyTextCompleter(wx.TextCompleterSimple):

            def __init__(self):

                wx.TextCompleterSimple.__init__(self)                
        

            def GetCompletions(self, prefix, res):
            
                firstWord = prefix.split()[0]
                
                if firstWord == "white":                
                    res.append("white pawn")
                    res.append("white rook")
                
                elif firstWord == "black":                
                    res.append("black king")
                    res.append("black queen")
        
                else:                
                    res.append("white")
                    res.append("black")

                    
        # Later on...
        text = wx.TextCtrl(parent, wx.ID_ANY, 'My Text')
        text.AutoComplete(MyTextCompleter)







         



.. versionadded:: 2.9.2 
     







|

|class_hierarchy| Inheritance Diagram
=====================================

Inheritance diagram for class **TextCompleterSimple**

.. raw:: html

   <p class="graphviz">
   <img src="_static/images/inheritance/TextCompleterSimple_inheritance.png" alt="Inheritance diagram of TextCompleterSimple" usemap="#dummy" class="inheritance"/>
   <map id="dummy" name="dummy"> <area shape="rect" id="node1" href="TextCompleterSimple.html" title="A simpler base class for custom completer objects." alt="" coords="180,5,353,35"/> <area shape="rect" id="node2" href="TextCompleter.html" title="Base class for custom text completer objects." alt="" coords="5,5,131,35"/> </map> 
   </p>

|


|method_summary| Methods Summary
================================

================================================================================ ================================================================================
:meth:`~TextCompleterSimple.GetCompletions`                                      Pure virtual method returning all possible completions for the given prefix.
================================================================================ ================================================================================


|


|api| Class API
===============
   

.. class:: TextCompleterSimple(TextCompleter)

   A simpler base class for custom completer objects.



   .. method:: GetCompletions(self, prefix, res)

      Pure virtual method returning all possible completions for the given prefix.                  

      The custom completer should examine the provided prefix and return all the possible completions for it in the output array `res`. 

      Please notice that the returned values should start with the prefix, otherwise they will be simply ignored, making adding them to the array in the first place useless. 

      Notice that this function may be called from thread other than main one (this is currently always the case under MSW) so the appropriate synchronization mechanism should be used to protect the shared data. 




      :param `prefix`: The possibly empty prefix that the user had already entered.   
      :type `prefix`: string
      :param `res`: Initially empty array that should be filled with all possible completions (possibly none if there are no valid possibilities starting with the given prefix).   
      :type `res`: list of strings