# # Gramps - a GTK+/GNOME based genealogy program # # Copyright (C) 2003-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$ """ Timeline report """ #------------------------------------------------------------------------ # # python modules # #------------------------------------------------------------------------ from TransUtils import sgettext as _ #------------------------------------------------------------------------ # # GNOME/gtk # #------------------------------------------------------------------------ import gtk #------------------------------------------------------------------------ # # GRAMPS modules # #------------------------------------------------------------------------ from PluginUtils import register_report from ReportBase import Report, ReportUtils, ReportOptions, \ CATEGORY_DRAW, MODE_GUI, MODE_BKI, MODE_CLI pt2cm = ReportUtils.pt2cm import BaseDoc from Filters import GenericFilter, Rules import Sort from QuestionDialog import ErrorDialog import NameDisplay #------------------------------------------------------------------------ # # TimeLine # #------------------------------------------------------------------------ class TimeLine(Report): def __init__(self,database,person,options_class): """ Creates the Timeline object that produces the report. The arguments are: database - the GRAMPS database instance person - currently selected person options_class - instance of the Options class for this report This report needs the following parameters (class variables) that come in the options class. filter - Filter to be applied to the people of the database. The option class carries its number, and the function returning the list of filters. sort_func - function used to sort entries, that returns -1/0/1 when given two personal handles (like cmp). The option class carries its number, and the function returning the list of sort functions. """ Report.__init__(self,database,person,options_class) filter_num = options_class.get_filter_number() filters = options_class.get_report_filters(person) self.filter = filters[filter_num] name = NameDisplay.displayer.display_formal(person) self.title = _("Timeline Graph for %s") % name sort_func_num = options_class.handler.options_dict['sortby'] sort_functions = options_class.get_sort_functions(Sort.Sort(database)) self.sort_func = sort_functions[sort_func_num][1] def define_graphics_styles(self): """ Define the graphics styles used by the report. Paragraph definitions have already been defined in the document. The styles used are: TLG-grid - 0.5pt wide line dashed line. Used for the lines that make up the grid. TLG-line - 0.5pt wide line. Used for the line connecting two endpoints and for the birth marker. TLG-solid - 0.5pt line with a black fill color. Used for the date of death marker. TLG-text - Contains the TLG-Name paragraph style used for the individual's name TLG-title - Contains the TLG-Title paragraph style used for the title of the document TLG-label - Contains the TLG-Label paragraph style used for the year label's in the document. """ g = BaseDoc.GraphicsStyle() g.set_line_width(0.5) g.set_color((0,0,0)) self.doc.add_draw_style("TLG-line",g) g = BaseDoc.GraphicsStyle() g.set_line_width(0.5) g.set_color((0,0,0)) g.set_fill_color((0,0,0)) self.doc.add_draw_style("TLG-solid",g) g = BaseDoc.GraphicsStyle() g.set_line_width(0.5) g.set_color((0,0,0)) g.set_fill_color((255,255,255)) self.doc.add_draw_style("open",g) g = BaseDoc.GraphicsStyle() g.set_line_width(0.5) g.set_line_style(BaseDoc.DASHED) g.set_color((0,0,0)) self.doc.add_draw_style("TLG-grid",g) g = BaseDoc.GraphicsStyle() g.set_paragraph_style("TLG-Name") g.set_color((255,255,255)) g.set_fill_color((255,255,255)) g.set_line_width(0) self.doc.add_draw_style("TLG-text",g) g = BaseDoc.GraphicsStyle() g.set_paragraph_style("TLG-Title") g.set_color((255,255,255)) g.set_fill_color((255,255,255)) g.set_line_width(0) g.set_width(self.doc.get_usable_width()) self.doc.add_draw_style("TLG-title",g) g = BaseDoc.GraphicsStyle() g.set_paragraph_style("TLG-Label") g.set_color((255,255,255)) g.set_fill_color((255,255,255)) g.set_line_width(0) self.doc.add_draw_style("TLG-label",g) def write_report(self): (low,high) = self.find_year_range() if low == high: if self.standalone: self.doc.close() ErrorDialog(_("Report could not be created"), _("The range of dates chosen was not valid")) return st_size = self.name_size() font = self.doc.style_list['TLG-Name'].get_font() incr = pt2cm(font.get_size()) pad = incr*.75 x1,x2,y1,y2 = (0,0,0,0) start = st_size+0.5 stop = self.doc.get_usable_width()-0.5 size = (stop-start) self.header = 2.0 self.doc.start_page() index = 1 current = 1; length = len(self.plist) self.plist.sort(self.sort_func) for p_id in self.plist: p = self.database.get_person_from_handle(p_id) b_ref = p.get_birth_ref() if b_ref: birth = self.database.get_event_from_handle(b_ref.ref) b = birth.get_date_object().get_year() else: b = None d_ref = p.get_death_ref() if d_ref: death = self.database.get_event_from_handle(d_ref.ref) d = death.get_date_object().get_year() else: d = None n = p.get_primary_name().get_name() self.doc.draw_text('TLG-text',n,incr+pad,self.header + (incr+pad)*index) y1 = self.header + (pad+incr)*index y2 = self.header + ((pad+incr)*index)+incr y3 = (y1+y2)/2.0 w = 0.05 if b: start_offset = ((float(b-low)/float(high-low)) * (size)) x1 = start+start_offset path = [(x1,y1),(x1+w,y3),(x1,y2),(x1-w,y3)] self.doc.draw_path('TLG-line',path) if d: start_offset = ((float(d-low)/float(high-low)) * (size)) x1 = start+start_offset path = [(x1,y1),(x1+w,y3),(x1,y2),(x1-w,y3)] self.doc.draw_path('TLG-solid',path) if b and d: start_offset = ((float(b-low)/float(high-low)) * size) + w stop_offset = ((float(d-low)/float(high-low)) * size) - w x1 = start+start_offset x2 = start+stop_offset self.doc.draw_line('open',x1,y3,x2,y3) if (y2 + incr) >= self.doc.get_usable_height(): if current != length: self.build_grid(low,high,start,stop) self.doc.end_page() self.doc.start_page() self.build_grid(low,high,start,stop) index = 1 x1,x2,y1,y2 = (0,0,0,0) else: index += 1; current += 1 self.build_grid(low,high,start,stop) self.doc.end_page() def build_grid(self,year_low,year_high,start_pos,stop_pos): """ Draws the grid outline for the chart. Sets the document label, draws the vertical lines, and adds the year labels. Arguments are: year_low - lowest year on the chart year_high - highest year on the chart start_pos - x position of the lowest leftmost grid line stop_pos - x position of the rightmost grid line """ width = self.doc.get_usable_width() title_font = self.doc.style_list['TLG-Title'].get_font() normal_font = self.doc.style_list['TLG-Name'].get_font() label_font = self.doc.style_list['TLG-Label'].get_font() self.doc.center_text('TLG-title',self.title,width/2.0,0) label_y = self.header - (pt2cm(normal_font.get_size())*1.2) top_y = self.header bottom_y = self.doc.get_usable_height() incr = (year_high - year_low)/5 delta = (stop_pos - start_pos)/ 5 for val in range(0,6): year_str = str(year_low + (incr*val)) xpos = start_pos+(val*delta) self.doc.center_text('TLG-label', year_str, xpos, label_y) self.doc.draw_line('TLG-grid', xpos, top_y, xpos, bottom_y) def find_year_range(self): low = 999999 high = -999999 self.plist = self.filter.apply(self.database, self.database.get_person_handles(sort_handles=False)) for p_id in self.plist: p = self.database.get_person_from_handle(p_id) b_ref = p.get_birth_ref() if b_ref: birth = self.database.get_event_from_handle(b_ref.ref) b = birth.get_date_object().get_year() else: b = None d_ref = p.get_death_ref() if d_ref: death = self.database.get_event_from_handle(d_ref.ref) d = death.get_date_object().get_year() else: d = None if b: low = min(low,b) high = max(high,b) if d: low = min(low,d) high = max(high,d) # round the dates to the nearest decade low = int((low/10))*10 high = int(((high+9)/10))*10 # Make sure the difference is a multiple of 50 so all year ranges land # on a decade. low -= 50 - ((high-low) % 50) if low == None: low = high if high == None: high = low return (low,high) def name_size(self): self.plist = self.filter.apply(self.database, self.database.get_person_handles(sort_handles=False)) style_name = self.doc.draw_styles['TLG-text'].get_paragraph_style() font = self.doc.style_list[style_name].get_font() size = 0 for p_id in self.plist: p = self.database.get_person_from_handle(p_id) n = p.get_primary_name().get_name() size = max(self.doc.string_width(font,n),size) return pt2cm(size) #------------------------------------------------------------------------ # # # #------------------------------------------------------------------------ class TimeLineOptions(ReportOptions): """ Defines options and provides handling interface. """ def __init__(self,name,person_id=None): ReportOptions.__init__(self,name,person_id) def set_new_options(self): # Options specific for this report self.options_dict = { 'sortby' : 0, } self.options_help = { 'sortby' : ("=num","Number of a sorting function", [item[0] for item in self.get_sort_functions(Sort.Sort(None))], True), } def enable_options(self): # Semi-common options that should be enabled for this report self.enable_dict = { 'filter' : 0, } def make_default_style(self,default_style): """Make the default output style for the Timeline report.""" f = BaseDoc.FontStyle() f.set_size(10) f.set_type_face(BaseDoc.FONT_SANS_SERIF) p = BaseDoc.ParagraphStyle() p.set_font(f) p.set_description(_("The style used for the person's name.")) default_style.add_style("TLG-Name",p) f = BaseDoc.FontStyle() f.set_size(8) f.set_type_face(BaseDoc.FONT_SANS_SERIF) p = BaseDoc.ParagraphStyle() p.set_font(f) p.set_alignment(BaseDoc.PARA_ALIGN_CENTER) p.set_description(_("The style used for the year labels.")) default_style.add_style("TLG-Label",p) f = BaseDoc.FontStyle() f.set_size(14) f.set_type_face(BaseDoc.FONT_SANS_SERIF) p = BaseDoc.ParagraphStyle() p.set_font(f) p.set_alignment(BaseDoc.PARA_ALIGN_CENTER) p.set_description(_("The style used for the title of the page.")) default_style.add_style("TLG-Title",p) def get_report_filters(self,person): """Set up the list of possible content filters.""" if person: name = person.get_primary_name().get_name() gramps_id = person.get_gramps_id() else: name = 'PERSON' gramps_id = '' all = GenericFilter() all.set_name(_("Entire Database")) all.add_rule(Rules.Person.Everyone([])) des = GenericFilter() des.set_name(_("Descendants of %s") % name) des.add_rule(Rules.Person.IsDescendantOf([gramps_id,1])) ans = GenericFilter() ans.set_name(_("Ancestors of %s") % name) ans.add_rule(Rules.Person.IsAncestorOf([gramps_id,1])) com = GenericFilter() com.set_name(_("People with common ancestor with %s") % name) com.add_rule(Rules.Person.HasCommonAncestorWith([gramps_id])) the_filters = [all,des,ans,com] from Filters import CustomFilters the_filters.extend(CustomFilters.get_filters('Person')) return the_filters def get_sort_functions(self,sort): return [ (_("Birth Date"),sort.by_birthdate), (_("Name"),sort.by_last_name), ] def add_user_options(self,dialog): """ Override the base class add_user_options task to add a menu that allows the user to select the sort method. """ self.sort_menu = gtk.combo_box_new_text() sort_functions = self.get_sort_functions(Sort.Sort(dialog.db)) for item in sort_functions: self.sort_menu.append_text(item[0]) self.sort_menu.set_active(self.options_dict['sortby']) dialog.add_option(_('Sort by'),self.sort_menu) def parse_user_options(self,dialog): """ Parses the custom options that we have added. """ self.options_dict['sortby'] = self.sort_menu.get_active() #------------------------------------------------------------------------ # # # #------------------------------------------------------------------------ register_report( name = 'timeline', category = CATEGORY_DRAW, report_class = TimeLine, options_class = TimeLineOptions, modes = MODE_GUI | MODE_BKI | MODE_CLI, translated_name = _("Timeline Graph"), status = _("Stable"), author_name = "Donald N. Allingham", author_email = "don@gramps-project.org", description = _("Generates a timeline graph.") )