Family context menu with quick reports

svn: r8897

src/plugins/all_events.py

@@ -26,12 +26,14 @@ Display a person's events, both personal and family
 from Simple import SimpleAccess, by_date, SimpleDoc
 from gettext import gettext as _
 from PluginUtils import register_quick_report
-from ReportBase import CATEGORY_QR_PERSON
+from ReportBase import CATEGORY_QR_PERSON, CATEGORY_QR_FAMILY
 
 # define the formatting string once as a constant. Since this is reused
 
-__FMT = "%-15s\t%-15s\t%s"
+__FMT     = "%-15s\t%-15s\t%s"
+__FMT_fam = "%-15s\t%-15s\t%-15s\t%s"
 
+    
 def run(database, document, person):
     """
     Loops through the person events and the family events of any family
@@ -65,6 +67,71 @@ def run(database, document, person):
                                 sdb.event_date(event), 
                                 sdb.event_place(event)))
 
+def run_fam(database, document, family):
+    """
+    Loops through the family events and the events of all parents, displaying 
+    the basic details of the event
+    """
+    
+    sdb = SimpleAccess(database)
+    sdoc = SimpleDoc(document)
+    
+    # get the family events
+    event_list = [(_('Family'), x) for x in sdb.events(family)]
+    
+    # get the events of father and mother
+    fathername = sdb.first_name(sdb.father(family))
+    event_list += [(fathername, x) for x in sdb.events(sdb.father(family))]
+    mothername = sdb.first_name(sdb.mother(family))
+    event_list += [(mothername, x) for x in sdb.events(sdb.mother(family))]
+    
+    # children events
+    event_list_children = []
+    for child in sdb.children(family) :
+        name = sdb.first_name(child)
+        event_list_children += [(name, x) for x in sdb.events(child)]
+        
+    # Sort the events by their date
+    event_list.sort(fam_sort)
+    event_list_children.sort(fam_sort)
+    
+    # display the results
+
+    sdoc.title(_("Sorted events of family\n %s - %s") % 
+                            (sdb.name(sdb.father(family)), 
+                            sdb.name(sdb.mother(family))))
+    sdoc.paragraph("")
+
+    sdoc.header2(__FMT_fam % (_("Family Member"), _("Event Type"), 
+                                _("Event Date"), _("Event Place")))
+
+    for (name, event) in event_list:
+        sdoc.paragraph(__FMT_fam % (name, sdb.event_type(event), 
+                                sdb.event_date(event), 
+                                sdb.event_place(event)))
+    sdoc.paragraph("")
+    sdoc.header1(_("Personal events of the children"))
+    sdoc.header2(__FMT_fam % (_("Family Member"), _("Event Type"), 
+                                _("Event Date"), _("Event Place")))
+    for (name, event) in event_list_children:
+        sdoc.paragraph(__FMT_fam % (name, sdb.event_type(event), 
+                                sdb.event_date(event), 
+                                sdb.event_place(event)))
+                                
+def fam_sort(event1, event2):
+    """
+    Sort function that will compare two events by their dates.
+
+    @param event1: first event
+    @type event1: L{Event}
+    @param event2: second event
+    @type event2: L{Event}
+    @return: Returns -1 if event1 < event2, 0 if they are equal, and
+       1 if they are the same.
+    @rtype: int
+    """
+    return by_date(event1[1],event2[1])
+                                
 #------------------------------------------------------------------------
 #
 # 
@@ -80,3 +147,14 @@ register_quick_report(
     author_name="Donald N. Allingham",
     author_email="don@gramps-project.org"
     )
+    
+register_quick_report(
+    name = 'all_events_fam',
+    category = CATEGORY_QR_FAMILY,
+    run_func = run_fam,
+    translated_name = _("All Events"),
+    status = _("Stable"),
+    description= _("Display the family and family members events."),
+    author_name="B. Malengier",
+    author_email="benny.malengier@gramps-project.org"
+    )