294 lines
9.9 KiB
Python
294 lines
9.9 KiB
Python
#
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
|
#
|
|
# Copyright (C) 2002-2003 Donald N. Allingham
|
|
#
|
|
# This program is free software; you can redistribute it and/or modify
|
|
# it under the terms of the GNU General Public License as published by
|
|
# the Free Software Foundation; either version 2 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# This program is distributed in the hope that it will be useful,
|
|
# but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
# GNU General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program; if not, write to the Free Software
|
|
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
|
|
#
|
|
|
|
# $Id$
|
|
|
|
"""
|
|
Adds autocompletion to a GtkEntry box, using the passed list of
|
|
strings as the possible completions. This work was adapted from code
|
|
written by David Hampton.
|
|
"""
|
|
|
|
__author__ = "David R. Hampton, Donald N. Allingham"
|
|
__version__ = "$Revision$"
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# python modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
import string
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# GNOME modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
import gtk
|
|
import gobject
|
|
|
|
_t = type(u'')
|
|
|
|
def patch(n):
|
|
if type(n) != _t:
|
|
return (unicode(n).lower(),unicode(n))
|
|
else:
|
|
return (n.lower(),n)
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# AutoCompBase
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class AutoCompBase:
|
|
|
|
def __init__(self,widget,plist,source=None):
|
|
"""
|
|
Creates a autocompleter for the specified GNOME/GTK widget, using the
|
|
list of strings as the completion values. The AutoCompBase class
|
|
should never be instantiated on its own. Instead, classes should be
|
|
derived from it.
|
|
|
|
widget - widget instance the completer is assocated with
|
|
plist - List of completion strings
|
|
source - If not None, uses the completion values of an already existing AutoCompBase instance
|
|
"""
|
|
if source:
|
|
self.nlist = source.nlist
|
|
else:
|
|
self.nlist = []
|
|
self.nlist = map(patch,plist)
|
|
self.nlist.sort()
|
|
self.nl = "xzsdkdjecsc"
|
|
self.l = 0
|
|
self.t = type(u' ')
|
|
|
|
def insert_text(self,entry,new_text,new_text_len,i_dont_care):
|
|
"""
|
|
Sets up a delayed (0.005 sec) handler for text completion. Text
|
|
completion cannot be handled directly in this routine because, for
|
|
some reason, the select_region() function doesn't work when called
|
|
from signal handlers. Go figure.
|
|
|
|
Thanks to iain@nodata.demon.co.uk (in mail from 1999) for the idea
|
|
to use a timer to get away from the problems with signal handlers
|
|
and the select_region function.
|
|
"""
|
|
|
|
# One time setup to clear selected region when user moves on
|
|
if (not entry.get_data("signal_set")):
|
|
entry.set_data("signal_set",1)
|
|
entry.connect("focus-out-event", self.lost_focus, entry)
|
|
|
|
# Nuke the current timer if the user types fast enough
|
|
timer = entry.get_data("timer");
|
|
if (timer):
|
|
gtk.timeout_remove(timer)
|
|
|
|
# Setup a callback timer so we can operate outside of a signal handler
|
|
timer = gtk.timeout_add(5, self.timer_callback, entry)
|
|
entry.set_data("timer", timer);
|
|
|
|
def lost_focus(self,entry,a,b):
|
|
"""
|
|
The entry box entry field lost focus. Go clear any selection. Why
|
|
this form of a select_region() call works in a signal handler and
|
|
the other form doesn't is a mystery.
|
|
"""
|
|
gtk.Editable.select_region(entry,0, 0)
|
|
|
|
def timer_callback(self,entry):
|
|
"""
|
|
Perfroms the actual task of completion. This method should be
|
|
overridden in all subclasses
|
|
"""
|
|
pass
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# AutoCombo
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class AutoCombo(AutoCompBase):
|
|
"""
|
|
Allows allow completion of the GtkCombo widget with the entries
|
|
in the passed string list. This class updates the drop down window
|
|
with the values that currently match the substring in the text box.
|
|
"""
|
|
|
|
def __init__(self,widget,plist,source=None):
|
|
"""
|
|
Creates a autocompleter for the a GtkCombo widget, using the
|
|
list of strings as the completion values. The
|
|
|
|
widget - GtkCombo instance the completer is assocated with
|
|
plist - List of completion strings
|
|
source - If not None, uses the completion values of an already existing
|
|
AutoCompBase instance
|
|
"""
|
|
AutoCompBase.__init__(self,widget,plist,source)
|
|
self.entry = widget
|
|
widget.entry.connect("insert-text",self.insert_text)
|
|
self.vals = [""]
|
|
self.inb = 0
|
|
if plist and len(plist) < 250:
|
|
widget.set_popdown_strings(plist)
|
|
else:
|
|
widget.set_popdown_strings([""])
|
|
widget.get_children()[1].hide()
|
|
|
|
def setval(self,widget):
|
|
"""Callback task called on the button release"""
|
|
|
|
self.inb = 0
|
|
text = unicode(self.entry.entry.get_text())
|
|
if self.nl == string.lower(text):
|
|
gtk.Editable.set_position(self.entry.entry,self.l)
|
|
gtk.Editable.select_region(self.entry.entry,self.l,-1)
|
|
|
|
def build_list(self,widget):
|
|
"""Internal task that builds the popdown strings. This task is called when the
|
|
combo button that activates the dropdown menu is pressed
|
|
"""
|
|
self.inb = 1
|
|
|
|
if self.vals and len(self.vals) < 250:
|
|
if self.vals[0] == "":
|
|
self.entry.set_popdown_strings([unicode(self.entry.entry.get_text())])
|
|
else:
|
|
self.entry.set_popdown_strings(self.vals)
|
|
else:
|
|
self.entry.set_popdown_strings([""])
|
|
|
|
return 1
|
|
|
|
def timer_callback(self,entry):
|
|
"""
|
|
The workhorse routine of file completion. This routine grabs the
|
|
current text of the entry box, and grubs through the list item
|
|
looking for any case insensitive matches. This routine relies on
|
|
public knowledge of the GtkEntry data structure, not on any private
|
|
data.
|
|
"""
|
|
# Clear any timer
|
|
timer = entry.get_data("timer");
|
|
if timer:
|
|
gtk.timeout_remove(timer)
|
|
|
|
if self.inb == 1:
|
|
return
|
|
|
|
# Get the user's text
|
|
typed = unicode(entry.get_text())
|
|
if (not typed):
|
|
return
|
|
if type(typed) != self.t:
|
|
typed = unicode(typed)
|
|
|
|
typed_lc = string.lower(typed)
|
|
|
|
if typed_lc == self.nl:
|
|
return
|
|
|
|
self.l = len(typed_lc)
|
|
|
|
self.vals = []
|
|
|
|
# Walk the GtkList in the entry box
|
|
for nl,n in self.nlist:
|
|
# If typed text is a substring of the label text, then fill in
|
|
# the entry field with the full text (and correcting
|
|
# capitalization), and then select all the characters that
|
|
# don't match. With the user's next keystroke these will be
|
|
# replaced if they are incorrect.
|
|
if nl[0:self.l] == typed_lc:
|
|
self.vals.append(n)
|
|
|
|
if len(self.vals) > 0:
|
|
n = self.vals[0]
|
|
self.nl = string.lower(n)
|
|
entry.set_text(n)
|
|
# Select non-matching text from the end to the beginning:
|
|
# this preserves the visibility of the portion being typed.
|
|
ln = len(n)
|
|
gtk.Editable.set_position(entry,ln-1)
|
|
gtk.Editable.select_region(entry,ln,self.l)
|
|
else:
|
|
self.vals = [""]
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# AutoEntry
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class AutoEntry(AutoCompBase):
|
|
"""
|
|
Allows allow completion of the GtkEntry widget with the entries
|
|
in the passed string list.
|
|
"""
|
|
def __init__(self,widget,plist,source=None):
|
|
AutoCompBase.__init__(self,widget,plist,source)
|
|
self.entry = widget
|
|
self.entry.connect("insert-text",self.insert_text)
|
|
|
|
def timer_callback(self,entry):
|
|
"""
|
|
The workhorse routine of file completion. This routine grabs the
|
|
current text of the entry box, and grubs through the list item
|
|
looking for any case insensitive matches. This routine relies on
|
|
public knowledge of the GtkEntry data structure, not on any private
|
|
data.
|
|
"""
|
|
# Clear any timer
|
|
timer = entry.get_data("timer");
|
|
if (timer):
|
|
gtk.timeout_remove(timer)
|
|
|
|
# Get the user's text
|
|
typed = unicode(entry.get_text())
|
|
|
|
if type(typed) != self.t:
|
|
typed = unicode(typed)
|
|
|
|
if (not typed):
|
|
return
|
|
typed_lc = string.lower(typed)
|
|
|
|
if typed_lc == self.nl:
|
|
return
|
|
|
|
self.l = len(typed_lc)
|
|
|
|
# Walk the GtkList in the entry box
|
|
for nl,n in self.nlist:
|
|
# If typed text is a substring of the label text, then fill in
|
|
# the entry field with the full text (and correcting
|
|
# capitalization), and then select all the characters that
|
|
# don't match. With the user's next keystroke these will be
|
|
# replaced if they are incorrect.
|
|
if nl[0:self.l] == typed_lc:
|
|
self.nl = nl
|
|
entry.set_text(n)
|
|
gtk.Editable.set_position(entry,self.l)
|
|
gtk.Editable.select_region(entry,self.l, -1)
|
|
return
|
|
|
|
|