gramps/src/Editors/_EditEvent.py
2009-05-21 17:19:50 +00:00

339 lines
13 KiB
Python

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2007 Donald N. Allingham
# Copyright (C) 2009 Gary Burton
#
# 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$
#-------------------------------------------------------------------------
#
# Python modules
#
#-------------------------------------------------------------------------
from TransUtils import sgettext as _
#-------------------------------------------------------------------------
#
# GTK/Gnome modules
#
#-------------------------------------------------------------------------
import gtk
#-------------------------------------------------------------------------
#
# gramps modules
#
#-------------------------------------------------------------------------
import const
import Config
import gen.lib
import GrampsDisplay
from _EditPrimary import EditPrimary
from ObjectEntries import PlaceEntry
from glade import Glade
from QuestionDialog import ErrorDialog
from DisplayTabs import (SourceEmbedList, NoteTab, GalleryTab,
EventBackRefList, AttrEmbedList)
from widgets import (MonitoredEntry, PrivacyButton,
MonitoredDataType, MonitoredDate)
#-------------------------------------------------------------------------
#
# Constants
#
#-------------------------------------------------------------------------
WIKI_HELP_PAGE = '%s_-_Entering_and_Editing_Data:_Detailed_-_part_2' % const.URL_MANUAL_PAGE
WIKI_HELP_SEC = _('manual|Editing_Information_About_Events')
#-------------------------------------------------------------------------
#
# EditEvent class
#
#-------------------------------------------------------------------------
class EditEvent(EditPrimary):
def __init__(self, dbstate, uistate, track, event, callback=None):
EditPrimary.__init__(self, dbstate, uistate, track,
event, dbstate.db.get_event_from_handle,
dbstate.db.get_event_from_gramps_id)
self._init_event()
def _init_event(self):
self.commit_event = self.db.commit_event
def empty_object(self):
return gen.lib.Event()
def get_menu_title(self):
if self.obj.get_handle():
event_name = self.obj.get_description()
if not event_name:
event_name = str(self.obj.get_type())
dialog_title = _('Event: %s') % event_name
else:
dialog_title = _('New Event')
return dialog_title
def get_custom_events(self):
return self.dbstate.db.get_person_event_types() + \
self.dbstate.db.get_family_event_types()
def _local_init(self):
self.width_key = Config.EVENT_WIDTH
self.height_key = Config.EVENT_HEIGHT
self.top = Glade()
self.set_window(self.top.toplevel, None,
self.get_menu_title())
self.place = self.top.get_object('place')
self.share_btn = self.top.get_object('select_place')
self.add_del_btn = self.top.get_object('add_del_place')
def _connect_signals(self):
self.top.get_object('button111').connect('clicked', self.close)
self.top.get_object('button126').connect('clicked', self.help_clicked)
self.ok_button = self.top.get_object('ok')
self.ok_button.set_sensitive(not self.db.readonly)
self.ok_button.connect('clicked', self.save)
def _setup_fields(self):
# place, select_place, add_del_place
self.place_field = PlaceEntry(self.dbstate, self.uistate, self.track,
self.top.get_object("place"),
self.obj.set_place_handle,
self.obj.get_place_handle,
self.add_del_btn, self.share_btn)
self.descr_field = MonitoredEntry(self.top.get_object("event_description"),
self.obj.set_description,
self.obj.get_description,
self.db.readonly)
self.gid = MonitoredEntry(self.top.get_object("gid"),
self.obj.set_gramps_id,
self.obj.get_gramps_id, self.db.readonly)
self.priv = PrivacyButton( self.top.get_object("private"),
self.obj, self.db.readonly)
self.event_menu = MonitoredDataType(self.top.get_object("personal_events"),
self.obj.set_type,
self.obj.get_type,
custom_values=self.get_custom_events())
self.date_field = MonitoredDate(self.top.get_object("date_entry"),
self.top.get_object("date_stat"),
self.obj.get_date_object(),
self.uistate, self.track,
self.db.readonly)
def _create_tabbed_pages(self):
"""
Create the notebook tabs and inserts them into the main
window.
"""
notebook = gtk.Notebook()
self.source_list = SourceEmbedList(self.dbstate,
self.uistate,
self.track,
self.obj)
self._add_tab(notebook, self.source_list)
self.note_list = NoteTab(self.dbstate,
self.uistate,
self.track,
self.obj.get_note_list(),
notetype=gen.lib.NoteType.EVENT)
self._add_tab(notebook, self.note_list)
self.gallery_list = GalleryTab(self.dbstate,
self.uistate,
self.track,
self.obj.get_media_list())
self._add_tab(notebook, self.gallery_list)
self.attr_list = AttrEmbedList(self.dbstate,
self.uistate,
self.track,
self.obj.get_attribute_list())
self._add_tab(notebook, self.attr_list)
handle_list = self.dbstate.db.find_backlink_handles(self.obj.handle)
self.backref_list = EventBackRefList(self.dbstate,
self.uistate,
self.track,
handle_list)
self._add_tab(notebook, self.backref_list)
self._setup_notebook_tabs(notebook)
notebook.show_all()
self.top.get_object('vbox').pack_start(notebook, True)
self.track_ref_for_deletion("source_list")
self.track_ref_for_deletion("note_list")
self.track_ref_for_deletion("gallery_list")
self.track_ref_for_deletion("attr_list")
self.track_ref_for_deletion("backref_list")
def _cleanup_on_exit(self):
self.backref_list.close()
def build_menu_names(self, event):
return (_('Edit Event'), self.get_menu_title())
def help_clicked(self, obj):
"""Display the relevant portion of GRAMPS manual"""
GrampsDisplay.help(webpage=WIKI_HELP_PAGE, section=WIKI_HELP_SEC)
def save(self, *obj):
self.ok_button.set_sensitive(False)
if self.object_is_empty():
ErrorDialog(_("Cannot save event"),
_("No data exists for this event. Please "
"enter data or cancel the edit."))
self.ok_button.set_sensitive(True)
return
(uses_dupe_id, id) = self._uses_duplicate_id()
if uses_dupe_id:
prim_object = self.get_from_gramps_id(id)
name = prim_object.get_description()
msg1 = _("Cannot save event. ID already exists.")
msg2 = _("You have attempted to use the existing GRAMPS ID with "
"value %(id)s. This value is already used by '"
"%(prim_object)s'. Please enter a different ID or leave "
"blank to get the next available ID value.") % {
'id' : id, 'prim_object' : name }
ErrorDialog(msg1, msg2)
self.ok_button.set_sensitive(True)
return
t = self.obj.get_type()
if t.is_custom() and str(t) == '':
ErrorDialog(
_("Cannot save event"),
_("The event type cannot be empty"))
self.ok_button.set_sensitive(True)
return
if not self.obj.handle:
trans = self.db.transaction_begin()
self.db.add_event(self.obj, trans)
self.db.transaction_commit(trans, _("Add Event"))
else:
orig = self.get_from_handle(self.obj.handle)
if cmp(self.obj.serialize(), orig.serialize()):
trans = self.db.transaction_begin()
if not self.obj.get_gramps_id():
self.obj.set_gramps_id(self.db.find_next_event_gramps_id())
self.commit_event(self.obj, trans)
self.db.transaction_commit(trans, _("Edit Event"))
if self.callback:
self.callback(self.obj)
self.close()
def data_has_changed(self):
"""
A date comparison can fail incorrectly because we have made the
decision to store entered text in the date. However, there is no
entered date when importing from a XML file, so we can get an
incorrect fail.
"""
if self.db.readonly:
return False
elif self.obj.handle:
orig = self.get_from_handle(self.obj.handle)
if orig:
cmp_obj = orig
else:
cmp_obj = self.empty_object()
return cmp(cmp_obj.serialize(True)[1:],
self.obj.serialize(True)[1:]) != 0
else:
cmp_obj = self.empty_object()
return cmp(cmp_obj.serialize(True)[1:],
self.obj.serialize()[1:]) != 0
class EditPersonEvent(EditEvent):
def __init__(self, dbstate, uistate, track, event, callback=None):
EditEvent.__init__(self, dbstate, uistate, track, event, callback)
def _init_event(self):
self.commit_event = self.db.commit_personal_event
def get_custom_events(self):
return self.dbstate.db.get_person_event_types()
class EditFamilyEvent(EditEvent):
def __init__(self, dbstate, uistate, track, event, callback=None):
EditEvent.__init__(self, dbstate, uistate, track, event, callback)
def _init_event(self):
self.commit_event = self.db.commit_family_event
def get_custom_events(self):
return self.dbstate.db.get_family_event_types()
#-------------------------------------------------------------------------
#
# Delete Query class
#
#-------------------------------------------------------------------------
class DelEventQuery(object):
def __init__(self, dbstate, uistate, event, person_list, family_list):
self.event = event
self.db = dbstate.db
self.uistate = uistate
self.person_list = person_list
self.family_list = family_list
def query_response(self):
trans = self.db.transaction_begin()
self.db.disable_signals()
ev_handle_list = [self.event.get_handle()]
for handle in self.person_list:
person = self.db.get_person_from_handle(handle)
person.remove_handle_references('Event', ev_handle_list)
self.db.commit_person(person, trans)
for handle in self.family_list:
family = self.db.get_family_from_handle(handle)
family.remove_handle_references('Event', ev_handle_list)
self.db.commit_family(family, trans)
self.db.enable_signals()
self.db.remove_event(self.event.get_handle(), trans)
self.db.transaction_commit(
trans,_("Delete Event (%s)") % self.event.get_gramps_id())