Search Entry Completion

The script shows how to create a search entry box with auto completion function in a GTK3 window.

An entry completion object is defined to handle the auto completion function, it contains a list of words which are used to match with the user input given in the search entry. A subset of words in the list which match with the user input will be shown during input process.

1. Define a search entry box.
2. Define a entry completion object for the search entry box.
3. Define event handler for matched completion.
4. Define a custom match function for the completion: Match partial word of items in a list.

Source Code

---

#!/usr/bin/python import gi gi.require_version('Gtk', '3.0') from gi.repository import Gtk, Gdk class Base: def __init__(self): self.win = Gtk.Window() self.win.set_title("Search Entry with Completion") self.win.set_default_geometry(width=350, height=400) self.win.set_border_width(4) self.win.connect("delete-event", self.WinDelete_event) # # vbox holding all controls mBox = Gtk.VBox(4) mBox.set_homogeneous(False) self.win.add(mBox) # # entry self.sentry = Gtk.SearchEntry() mBox.pack_start(self.sentry,False,True,2) # # liststore for search completion self.srchlstore = Gtk.ListStore(str,int) mL = (('Apple',1), ('Apricot',2), ('Banana',3), ('Blackberry',4), ('Blackcurrant',5), ('Blueberry',6), ('Cherry',7), ('Coconut',8), ('Durian',9), ('Grape',10), ('Lemon',11), ('Lime',12), ('Mango',13), ('Melon',14), ('Orange',15), ('Papaya',16), ('Peach',17), ('Pear',18), ('Pineapple',19), ('Raspberry',20), ('Strawberry',21)) for mi in mL: self.srchlstore.append(mi) self.entrycomp = Gtk.EntryCompletion() self.entrycomp.connect("match-selected", self.MatchSelected) self.entrycomp.set_text_column(0) #self.entrycomp.set_inline_selection(True) self.entrycomp.set_popup_completion(True) self.entrycomp.set_minimum_key_length(3) self.entrycomp.set_model(self.srchlstore) self.entrycomp.set_match_func(self.matchFunc,0) # search result menu self.sentry.set_completion(self.entrycomp) # # status bar self.stsBar = Gtk.Statusbar() mBox.pack_start(self.stsBar,False,True,2) self.win.show_all() # Match function is optional, # By default, the system matches words # starting from the beginning. # # match by substring, not necessary start # from the beginning # eg. 'ppl' matches 'Apple' def matchFunc(self, completion, keyStr, itr, col): mModel = completion.get_model() mt1 = mModel[itr][col] mtext = mt1.lower() if mtext.find(keyStr)>=0: return True return False # Event Handlers # --------------------------------------------------------- # Delete event def WinDelete_event(self, event, data=None): Gtk.main_quit() return False # match selected def MatchSelected(self, completion, model, itr): mstxt = model[itr][completion.get_text_column()] mid = model[itr][1] mMsg = "Id: %d Tag: %s" % (mid,mstxt) self.pushStatus("delTag",mMsg) # push message to status bar def pushStatus(self, pCtxt, pMsg): mctxid = self.stsBar.get_context_id(pCtxt) self.stsBar.push(mctxid, pMsg) def main(): Gtk.main() if __name__ == "__main__": base = Base() main()