gramps/gramps/gui/spell.py
John Ralls 58c2b11013 [r21968]GrampsLocale: Remove get_translation()
Only one base translation per locale. To set up a different locale
on any axis (locale, domain, directory, or languages) instantiate a
secondary locale by calling GrampsLocale() with the appropriate
arguments.

svn: r21985
2013-04-13 14:37:34 +00:00

160 lines
5.5 KiB
Python

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2005-2006 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$
"""
Provide an interface to the gtkspell interface. This requires
python-gnome-extras package. If the gtkspell package is not
present, we default to no spell checking.
"""
#-------------------------------------------------------------------------
#
# Python classes
#
#-------------------------------------------------------------------------
#-------------------------------------------------------------------------
#
# Set up logging
#
#-------------------------------------------------------------------------
import logging
LOG = logging.getLogger(".Spell")
#-------------------------------------------------------------------------
#
# GTK libraries
#
#-------------------------------------------------------------------------
from gi.repository import Gtk
from gi import Repository
from gramps.gen.const import GRAMPS_LOCALE as glocale
_ = glocale.translation.gettext
HAVE_GTKSPELL = False
# Attempting to import gtkspell gives an error dialog if gtkspell is not
# available so test first and log just a warning to the console instead.
repository = Repository.get_default()
if repository.enumerate_versions("GtkSpell"):
try:
from gi.repository import GtkSpell as Gtkspell
HAVE_GTKSPELL = True
except:
pass
elif repository.enumerate_versions("Gtkspell"):
try:
from gi.repository import Gtkspell
HAVE_GTKSPELL = True
except:
pass
if not HAVE_GTKSPELL:
LOG.warning(_("GtkSpell not loaded. "
"Spell checking will not be available.\n"
"To build it for Gramps see http://www.gramps-project.org/"
"wiki/index.php?title=GEPS_029:_GTK3-GObject_introspection_"
"Conversion#Spell_Check_Install"))
#-------------------------------------------------------------------------
#
# GRAMPS classes
#
#-------------------------------------------------------------------------
from gramps.gen.config import config
#-------------------------------------------------------------------------
#
# Constants
#
#-------------------------------------------------------------------------
class Spell(object):
"""Attach a gtkspell instance to the passed TextView instance.
"""
_spellcheck_options = {'off': _('Off')}
if HAVE_GTKSPELL:
_spellcheck_options['on'] = _('On')
def __init__(self, textview):
self.textview = textview
if HAVE_GTKSPELL and config.get('behavior.spellcheck'):
self.spellcheck = 'on'
else:
self.spellcheck = 'off'
self._active_spellcheck = 'off'
self.__real_set_active_spellcheck(self.spellcheck)
# Private
def __real_set_active_spellcheck(self, spellcheck_code):
"""Set active spellcheck by its code."""
if self._active_spellcheck == 'off':
if spellcheck_code == 'off':
return
else:
try:
#transfer full GTK object, so assign to an attribute!
if Gtkspell._namespace == "Gtkspell":
self.gtkspell_spell = Gtkspell.Spell.new()
elif Gtkspell._namespace == "GtkSpell":
self.gtkspell_spell = Gtkspell.Checker.new()
success = self.gtkspell_spell.attach(self.textview)
self._active_spellcheck = spellcheck_code
except:
# attaching the spellchecker will fail if
# the language does not exist
# and presumably if there is no dictionary
LOG.warn(_("Spelling checker could not be attached to TextView"))
else:
if spellcheck_code == 'on':
return
else:
if Gtkspell._namespace == "Gtkspell":
self.gtkspell_spell = Gtkspell.Spell.get_from_text_view(self.textview)
elif Gtkspell._namespace == "GtkSpell":
self.gtkspell_spell = Gtkspell.Checker.get_from_text_view(self.textview)
self.gtkspell_spell.detach()
self._active_spellcheck = spellcheck_code
# Public API
def get_all_spellchecks(self):
"""Get the list of installed spellcheck names."""
return list(self._spellcheck_options.values())
def set_active_spellcheck(self, spellcheck):
"""Set active spellcheck by it's name."""
for code, name in list(self._spellcheck_options.items()):
if name == spellcheck:
self.__real_set_active_spellcheck(code)
return
def get_active_spellcheck(self):
"""Get the name of the active spellcheck."""
return self._spellcheck_options[self._active_spellcheck]