Class: Wx::TextCompleter

Inherits:

Object

• Object
• Wx::TextCompleter

Defined in:

lib/wx/doc/gen/text_entry.rb

Overview

Base class for custom text completer objects.

Custom completer objects used with Wx::TextEntry#auto_complete must derive from this class and implement its pure virtual method returning the completions. You would typically use a custom completer when the total number of completions is too big for performance to be acceptable if all of them need to be returned at once but if they can be generated hierarchically, i.e. only the first component initially, then the second one after the user finished entering the first one and so on. When inheriting from this class you need to implement its two pure virtual methods. This allows returning the results incrementally and may or not be convenient depending on where do they come from. If you prefer to return all the completions at once, you should inherit from TextCompleterSimple instead.

Direct Known Subclasses

TextCompleterSimple

Instance Method Summary

• #get_next ⇒ String (also: #next_)

  Called to retrieve the next completion.

• #start(prefix) ⇒ Boolean

  Function called to start iteration over the completions for the given prefix.

Instance Method Details

#get_next ⇒ String Also known as: next_

Called to retrieve the next completion.

All completions returned by this function should start with the prefix passed to the last call to #start. Notice that, as #start, this method is called from a worker thread context under MSW. The next completion or an empty string to indicate that there are no more of them.

Returns:

• (String)

# File 'lib/wx/doc/gen/text_entry.rb', line 392

def get_next; end

#start(prefix) ⇒ Boolean

Function called to start iteration over the completions for the given prefix.

This function could start a database query, for example, if the results are read from a database. Notice that under some platforms (currently MSW only) it is called from another thread context and so the appropriate synchronization mechanism should be used to access any data also used by the main UI thread.

true to continue with calling #get_next or false to indicate that there are no matches and #get_next shouldn’t be called at all.

Parameters:

• prefix (String) —

  The prefix for which completions are to be generated.

Returns:

• (Boolean)

# File 'lib/wx/doc/gen/text_entry.rb', line 384

def start(prefix) end