Files
gramps/gramps/plugins/gramplet/todo.py
2013-01-18 22:23:11 +00:00

403 lines
13 KiB
Python

# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2013 Nick Hall
#
# 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$
#
from gramps.gen.plug import Gramplet
from gramps.gui.widgets.styledtexteditor import StyledTextEditor
from gramps.gui.widgets import SimpleButton
from gramps.gen.lib import StyledText, Note, NoteType
from gramps.gen.db import DbTxn
from gramps.gen.const import GRAMPS_LOCALE as glocale
_ = glocale.get_translation().gettext
from gi.repository import Gtk
class ToDo(Gramplet):
"""
Displays the To Do notes for an object.
"""
def init(self):
self.gui.WIDGET = self.build_gui()
self.gui.get_container_widget().remove(self.gui.textview)
self.gui.get_container_widget().add_with_viewport(self.gui.WIDGET)
self.gui.WIDGET.show()
def build_gui(self):
"""
Build the GUI interface.
"""
top = Gtk.VBox(False)
hbox = Gtk.HBox()
self.left = SimpleButton(Gtk.STOCK_GO_BACK, self.left_clicked)
self.left.set_tooltip_text(_('Previous To Do note'))
self.left.set_sensitive(False)
hbox.pack_start(self.left, False, False, 0)
self.right = SimpleButton(Gtk.STOCK_GO_FORWARD, self.right_clicked)
self.right.set_tooltip_text(_('Next To Do note'))
self.right.set_sensitive(False)
hbox.pack_start(self.right, False, False, 0)
self.edit = SimpleButton(Gtk.STOCK_EDIT, self.edit_clicked)
self.edit.set_tooltip_text(_('Edit the selected To Do note'))
self.edit.set_sensitive(False)
hbox.pack_start(self.edit, False, False, 0)
self.new = SimpleButton(Gtk.STOCK_NEW, self.new_clicked)
self.new.set_tooltip_text(_('Add a new To Do note'))
hbox.pack_start(self.new, False, False, 0)
self.page = Gtk.Label()
hbox.pack_end(self.page, False, False, 10)
scrolledwindow = Gtk.ScrolledWindow()
scrolledwindow.set_policy(Gtk.PolicyType.AUTOMATIC,
Gtk.PolicyType.AUTOMATIC)
self.texteditor = StyledTextEditor()
self.texteditor.set_editable(False)
self.texteditor.set_wrap_mode(Gtk.WrapMode.WORD)
scrolledwindow.add(self.texteditor)
top.pack_start(hbox, False, False, 0)
top.pack_start(scrolledwindow, True, True, 0)
top.show_all()
return top
def get_note_list(self, obj):
"""
Get a list of To Do notes for the current object.
"""
note_list = []
for note_handle in obj.get_note_list():
note = self.dbstate.db.get_note_from_handle(note_handle)
if int(note.get_type()) == NoteType.TODO:
note_list.append(note.get_handle())
return note_list
def get_notes(self, obj):
"""
Display the To Do notes for the current object.
"""
self.obj = obj
self.left.set_sensitive(False)
self.right.set_sensitive(False)
self.edit.set_sensitive(False)
self.texteditor.set_text(StyledText())
self.note_list = self.get_note_list(obj)
self.page.set_text('')
if len(self.note_list) > 0:
self.set_has_data(True)
self.edit.set_sensitive(True)
if len(self.note_list) > 1:
self.right.set_sensitive(True)
self.current = 0
self.display_note()
else:
self.set_has_data(False)
def clear_text(self):
self.left.set_sensitive(False)
self.right.set_sensitive(False)
self.edit.set_sensitive(False)
self.texteditor.set_text(StyledText())
self.page.set_text('')
self.current = 0
def display_note(self):
"""
Display the current note.
"""
note_handle = self.note_list[self.current]
note = self.dbstate.db.get_note_from_handle(note_handle)
self.texteditor.set_text(note.get_styledtext())
self.page.set_text(_('%(current)d of %(total)d') %
{'current': self.current + 1,
'total': len(self.note_list)})
def left_clicked(self, button):
"""
Display the previous note.
"""
if self.current > 0:
self.current -= 1
self.right.set_sensitive(True)
if self.current == 0:
self.left.set_sensitive(False)
self.display_note()
def right_clicked(self, button):
"""
Display the next note.
"""
if self.current < len(self.note_list) - 1:
self.current += 1
self.left.set_sensitive(True)
if self.current == len(self.note_list) - 1:
self.right.set_sensitive(False)
self.display_note()
def get_has_data(self, obj):
"""
Return True if the gramplet has data, else return False.
"""
if obj is None:
return False
if self.get_note_list(obj):
return True
return False
def edit_clicked(self, obj):
"""
Edit current To Do note.
"""
from gramps.gui.editors import EditNote
note_handle = self.note_list[self.current]
note = self.dbstate.db.get_note_from_handle(note_handle)
try:
EditNote(self.gui.dbstate, self.gui.uistate, [], note)
except AttributeError:
pass
def new_clicked(self, obj):
"""
Create a new To Do note.
"""
from gramps.gui.editors import EditNote
note = Note()
note.set_type(NoteType.TODO)
try:
EditNote(self.gui.dbstate, self.gui.uistate, [], note, self.created)
except AttributeError:
pass
class PersonToDo(ToDo):
"""
Displays the To Do notes for a person.
"""
def db_changed(self):
self.dbstate.db.connect('person-update', self.update)
def active_changed(self, handle):
self.update()
def update_has_data(self):
active_handle = self.get_active('Person')
active = self.dbstate.db.get_person_from_handle(active_handle)
self.set_has_data(self.get_has_data(active))
def main(self):
active_handle = self.get_active('Person')
active = self.dbstate.db.get_person_from_handle(active_handle)
if active:
self.get_notes(active)
else:
self.clear_text()
self.set_has_data(False)
def created(self, handle):
with DbTxn('Attach Note', self.dbstate.db) as trans:
self.obj.add_note(handle)
self.dbstate.db.commit_person(self.obj, trans)
class EventToDo(ToDo):
"""
Displays the To Do notes for an event.
"""
def db_changed(self):
self.dbstate.db.connect('event-update', self.update)
self.connect_signal('Event', self.update)
def update_has_data(self):
active_handle = self.get_active('Event')
active = self.dbstate.db.get_event_from_handle(active_handle)
self.set_has_data(self.get_has_data(active))
def main(self):
active_handle = self.get_active('Event')
active = self.dbstate.db.get_event_from_handle(active_handle)
if active:
self.get_notes(active)
else:
self.clear_text()
self.set_has_data(False)
def created(self, handle):
with DbTxn('Attach Note', self.dbstate.db) as trans:
self.obj.add_note(handle)
self.dbstate.db.commit_event(self.obj, trans)
class FamilyToDo(ToDo):
"""
Displays the To Do notes for a family.
"""
def db_changed(self):
self.dbstate.db.connect('family-update', self.update)
self.connect_signal('Family', self.update)
def update_has_data(self):
active_handle = self.get_active('Family')
active = self.dbstate.db.get_family_from_handle(active_handle)
self.set_has_data(self.get_has_data(active))
def main(self):
active_handle = self.get_active('Family')
active = self.dbstate.db.get_family_from_handle(active_handle)
if active:
self.get_notes(active)
else:
self.clear_text()
self.set_has_data(False)
def created(self, handle):
with DbTxn('Attach Note', self.dbstate.db) as trans:
self.obj.add_note(handle)
self.dbstate.db.commit_family(self.obj, trans)
class PlaceToDo(ToDo):
"""
Displays the To Do notes for a place.
"""
def db_changed(self):
self.dbstate.db.connect('place-update', self.update)
self.connect_signal('Place', self.update)
def update_has_data(self):
active_handle = self.get_active('Place')
active = self.dbstate.db.get_place_from_handle(active_handle)
self.set_has_data(self.get_has_data(active))
def main(self):
active_handle = self.get_active('Place')
active = self.dbstate.db.get_place_from_handle(active_handle)
if active:
self.get_notes(active)
else:
self.clear_text()
self.set_has_data(False)
def created(self, handle):
with DbTxn('Attach Note', self.dbstate.db) as trans:
self.obj.add_note(handle)
self.dbstate.db.commit_place(self.obj, trans)
class SourceToDo(ToDo):
"""
Displays the To Do notes for a source.
"""
def db_changed(self):
self.dbstate.db.connect('source-update', self.update)
self.connect_signal('Source', self.update)
def update_has_data(self):
active_handle = self.get_active('Source')
active = self.dbstate.db.get_source_from_handle(active_handle)
self.set_has_data(self.get_has_data(active))
def main(self):
active_handle = self.get_active('Source')
active = self.dbstate.db.get_source_from_handle(active_handle)
if active:
self.get_notes(active)
else:
self.clear_text()
self.set_has_data(False)
def created(self, handle):
with DbTxn('Attach Note', self.dbstate.db) as trans:
self.obj.add_note(handle)
self.dbstate.db.commit_source(self.obj, trans)
class CitationToDo(ToDo):
"""
Displays the To Do notes for a Citation.
"""
def db_changed(self):
self.dbstate.db.connect('citation-update', self.update)
self.connect_signal('Citation', self.update)
def update_has_data(self):
active_handle = self.get_active('Citation')
active = self.dbstate.db.get_citation_from_handle(active_handle)
self.set_has_data(self.get_has_data(active))
def main(self):
active_handle = self.get_active('Citation')
active = self.dbstate.db.get_citation_from_handle(active_handle)
if active:
self.get_notes(active)
else:
self.clear_text()
self.set_has_data(False)
def created(self, handle):
with DbTxn('Attach Note', self.dbstate.db) as trans:
self.obj.add_note(handle)
self.dbstate.db.commit_citation(self.obj, trans)
class RepositoryToDo(ToDo):
"""
Displays the To Do notes for a repository.
"""
def db_changed(self):
self.dbstate.db.connect('repository-update', self.update)
self.connect_signal('Repository', self.update)
def update_has_data(self):
active_handle = self.get_active('Repository')
active = self.dbstate.db.get_repository_from_handle(active_handle)
self.set_has_data(self.get_has_data(active))
def main(self):
active_handle = self.get_active('Repository')
active = self.dbstate.db.get_repository_from_handle(active_handle)
if active:
self.get_notes(active)
else:
self.clear_text()
self.set_has_data(False)
def created(self, handle):
with DbTxn('Attach Note', self.dbstate.db) as trans:
self.obj.add_note(handle)
self.dbstate.db.commit_repository(self.obj, trans)
class MediaToDo(ToDo):
"""
Displays the To Do notes for a media object.
"""
def db_changed(self):
self.dbstate.db.connect('media-update', self.update)
self.connect_signal('Media', self.update)
def update_has_data(self):
active_handle = self.get_active('Media')
active = self.dbstate.db.get_object_from_handle(active_handle)
self.set_has_data(self.get_has_data(active))
def main(self):
active_handle = self.get_active('Media')
active = self.dbstate.db.get_object_from_handle(active_handle)
if active:
self.get_notes(active)
else:
self.clear_text()
self.set_has_data(False)
def created(self, handle):
with DbTxn('Attach Note', self.dbstate.db) as trans:
self.obj.add_note(handle)
self.dbstate.db.commit_media_object(self.obj, trans)