* src/Report.py (CommandLineReport.parse_option_str):

Fix PluginMgr lists.
* src/plugins/CustomBookText.py: Convert to new scheme.
* src/plugins/FamilyGroup.py: Switch from handle to id for spouse.
* src/plugins/SimpleBookTitle.py: Cleanups.


svn: r3884
This commit is contained in:
Alex Roitman
2005-01-08 20:19:06 +00:00
parent 41ef57a252
commit 6141ffb14b
5 changed files with 176 additions and 249 deletions

View File

@@ -1,6 +1,6 @@
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2003 Donald N. Allingham
# Copyright (C) 2003-2005 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
@@ -17,10 +17,24 @@
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
#
#
# Written by Alex Roitman,
# largely based on the SimpleBookTitle.py by Don Allingham
# $Id$
#------------------------------------------------------------------------
#
# python modules
#
#------------------------------------------------------------------------
from gettext import gettext as _
#------------------------------------------------------------------------
#
# gtk
#
#------------------------------------------------------------------------
import gtk
#------------------------------------------------------------------------
#
@@ -29,11 +43,8 @@
#------------------------------------------------------------------------
import Report
import BaseDoc
import Errors
from QuestionDialog import ErrorDialog
from gettext import gettext as _
import gtk
import const
import ReportOptions
#------------------------------------------------------------------------
#
@@ -42,32 +53,30 @@ import gtk
#------------------------------------------------------------------------
class CustomText(Report.Report):
def __init__(self,database,person,top_text,middle_text,bottom_text,doc,output,newpage=0):
self.map = {}
self.database = database
self.start = person
self.top_text = top_text
self.middle_text = middle_text
self.bottom_text = bottom_text
self.doc = doc
self.newpage = newpage
if output:
self.standalone = 1
self.doc.open(output)
self.doc.init()
else:
self.standalone = 0
self.sref_map = {}
self.sref_index = 1
def __init__(self,database,person,options_class):
"""
Creates CustomText object that produces the report.
def setup(self):
pass
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.
top - Text on the top.
mid - Text in the middle.
bot - Text on the bottom.
"""
Report.Report.__init__(self,database,person,options_class)
self.top_text = options_class.handler.options_dict['top']
self.middle_text = options_class.handler.options_dict['mid']
self.bottom_text = options_class.handler.options_dict['bot']
def write_report(self):
if self.newpage:
self.doc.page_break()
self.doc.start_paragraph('CBT-Initial')
self.doc.write_text(self.top_text)
self.doc.end_paragraph()
@@ -80,216 +89,133 @@ class CustomText(Report.Report):
self.doc.write_text(self.bottom_text)
self.doc.end_paragraph()
if self.standalone:
self.doc.close()
def _make_default_style(default_style):
"""Make the default output style for the Custom Text report."""
font = BaseDoc.FontStyle()
font.set(face=BaseDoc.FONT_SANS_SERIF,size=12,bold=0,italic=0)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
para.set_alignment(BaseDoc.PARA_ALIGN_CENTER)
para.set(pad=0.5)
para.set_description(_('The style used for the first portion of the custom text.'))
default_style.add_style("CBT-Initial",para)
font = BaseDoc.FontStyle()
font.set(face=BaseDoc.FONT_SANS_SERIF,size=12,bold=0,italic=0)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
para.set(pad=0.5)
para.set_alignment(BaseDoc.PARA_ALIGN_CENTER)
para.set_description(_('The style used for the middle portion of the custom text.'))
default_style.add_style("CBT-Middle",para)
font = BaseDoc.FontStyle()
font.set(face=BaseDoc.FONT_SANS_SERIF,size=12,bold=0,italic=0)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
para.set_alignment(BaseDoc.PARA_ALIGN_CENTER)
para.set(pad=0.5)
para.set_description(_('The style used for the last portion of the custom text.'))
default_style.add_style("CBT-Final",para)
#------------------------------------------------------------------------
#
# Set up sane defaults for the book_item
#
#
#------------------------------------------------------------------------
_style_file = "custom_text.xml"
_style_name = "default"
class CustomTextOptions(ReportOptions.ReportOptions):
_person_handle = ""
_top_text = ""
_middle_text = ""
_bottom_text = ""
"""
Defines options and provides handling interface.
"""
_options = ( _person_handle, _top_text, _middle_text, _bottom_text )
def __init__(self,name,person_id=None):
ReportOptions.ReportOptions.__init__(self,name,person_id)
def set_new_options(self):
# Options specific for this report
self.options_dict = {
'top' : '',
'mid' : '',
'bot' : '',
}
self.options_help = {
'top' : ("=str","Initial Text",
"Whatever String You Wish"),
'mid' : ("=str","Middle Text",
"Whatever String You Wish"),
'bot' : ("=str","Final Text",
"Whatever String You Wish"),
}
#------------------------------------------------------------------------
#
# Book Item Options dialog
#
#------------------------------------------------------------------------
class CustomTextDialog(Report.BareReportDialog):
def add_user_options(self,dialog):
dialog.setup_center_person = dialog.setup_paper_frame
dialog.notebook = gtk.Notebook()
dialog.notebook.set_border_width(6)
dialog.window.vbox.add(dialog.notebook)
def __init__(self,database,person,opt,stl):
top_sw = gtk.ScrolledWindow()
middle_sw = gtk.ScrolledWindow()
bottom_sw = gtk.ScrolledWindow()
self.options = opt
self.db = database
if self.options[0]:
self.person = self.db.get_person_from_handle(self.options[0])
else:
self.person = person
self.style_name = stl
Report.BareReportDialog.__init__(self,database,self.person)
self.top_text = self.options[1]
self.middle_text = self.options[2]
self.bottom_text = self.options[3]
self.top_text_view.get_buffer().set_text(self.top_text)
self.middle_text_view.get_buffer().set_text(self.middle_text)
self.bottom_text_view.get_buffer().set_text(self.bottom_text)
self.notebook.set_size_request(450,300)
self.new_person = None
self.window.run()
#------------------------------------------------------------------------
#
# Customization hooks
#
#------------------------------------------------------------------------
def make_default_style(self):
_make_default_style(self.default_style)
def get_title(self):
"""The window title for this dialog"""
return "%s - GRAMPS Book" % (_("Custom Text"))
def get_header(self, name):
"""The header line at the top of the dialog contents"""
return _("Custom Text for GRAMPS Book")
def get_stylesheet_savefile(self):
"""Where to save styles for this report."""
return _style_file
def setup_center_person(self):
pass
def setup_report_options_frame(self):
self.notebook = gtk.Notebook()
self.notebook.set_border_width(6)
self.window.vbox.add(self.notebook)
def add_user_options(self):
self.top_sw = gtk.ScrolledWindow()
self.middle_sw = gtk.ScrolledWindow()
self.bottom_sw = gtk.ScrolledWindow()
self.top_sw.set_policy(gtk.POLICY_AUTOMATIC,gtk.POLICY_AUTOMATIC)
self.middle_sw.set_policy(gtk.POLICY_AUTOMATIC,gtk.POLICY_AUTOMATIC)
self.bottom_sw.set_policy(gtk.POLICY_AUTOMATIC,gtk.POLICY_AUTOMATIC)
top_sw.set_policy(gtk.POLICY_AUTOMATIC,gtk.POLICY_AUTOMATIC)
middle_sw.set_policy(gtk.POLICY_AUTOMATIC,gtk.POLICY_AUTOMATIC)
bottom_sw.set_policy(gtk.POLICY_AUTOMATIC,gtk.POLICY_AUTOMATIC)
self.top_text_view = gtk.TextView()
self.top_text_view.get_buffer().set_text(self.options_dict['top'])
self.middle_text_view = gtk.TextView()
self.middle_text_view.get_buffer().set_text(self.options_dict['mid'])
self.bottom_text_view = gtk.TextView()
self.bottom_text_view.get_buffer().set_text(self.options_dict['bot'])
self.top_sw.add_with_viewport(self.top_text_view)
self.middle_sw.add_with_viewport(self.middle_text_view)
self.bottom_sw.add_with_viewport(self.bottom_text_view)
self.add_frame_option(_('Initial Text'),"",self.top_sw)
self.add_frame_option(_('Middle Text'),"",self.middle_sw)
self.add_frame_option(_('Final Text'),"",self.bottom_sw)
top_sw.add_with_viewport(self.top_text_view)
middle_sw.add_with_viewport(self.middle_text_view)
bottom_sw.add_with_viewport(self.bottom_text_view)
def parse_report_options_frame(self):
"""Parse the report options frame of the dialog.
Save the user selected choices for later use."""
dialog.add_frame_option(_('Initial Text'),"",top_sw)
dialog.add_frame_option(_('Middle Text'),"",middle_sw)
dialog.add_frame_option(_('Final Text'),"",bottom_sw)
# call the parent task to handle normal options
Report.BareReportDialog.parse_report_options_frame(self)
def parse_user_options(self,dialog):
"""
Parses the custom options that we have added.
"""
self.options_dict['top'] = unicode(
self.top_text_view.get_buffer().get_text(
self.top_text_view.get_buffer().get_start_iter(),
self.top_text_view.get_buffer().get_end_iter(),
gtk.FALSE
)
).replace('\n',' ')
# get values from the widgets
self.top_text = self.top_text_view.get_buffer().get_text(
self.top_text_view.get_buffer().get_start_iter(),
self.top_text_view.get_buffer().get_end_iter(),
gtk.FALSE)
self.middle_text = self.middle_text_view.get_buffer().get_text(
self.middle_text_view.get_buffer().get_start_iter(),
self.middle_text_view.get_buffer().get_end_iter(),
gtk.FALSE)
self.bottom_text = self.bottom_text_view.get_buffer().get_text(
self.bottom_text_view.get_buffer().get_start_iter(),
self.bottom_text_view.get_buffer().get_end_iter(),
gtk.FALSE)
self.options_dict['mid'] = unicode(
self.middle_text_view.get_buffer().get_text(
self.middle_text_view.get_buffer().get_start_iter(),
self.middle_text_view.get_buffer().get_end_iter(),
gtk.FALSE
)
).replace('\n',' ')
def on_cancel(self, obj):
pass
self.options_dict['bot'] = unicode(
self.bottom_text_view.get_buffer().get_text(
self.bottom_text_view.get_buffer().get_start_iter(),
self.bottom_text_view.get_buffer().get_end_iter(),
gtk.FALSE
)
).replace('\n',' ')
def on_ok_clicked(self, obj):
"""The user is satisfied with the dialog choices. Parse all options
and close the window."""
def make_default_style(self,default_style):
"""Make the default output style for the Custom Text report."""
font = BaseDoc.FontStyle()
font.set(face=BaseDoc.FONT_SANS_SERIF,size=12,bold=0,italic=0)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
para.set_alignment(BaseDoc.PARA_ALIGN_CENTER)
para.set(pad=0.5)
para.set_description(_('The style used for the first portion of the custom text.'))
default_style.add_style("CBT-Initial",para)
# Preparation
self.parse_style_frame()
self.parse_report_options_frame()
if self.new_person:
self.person = self.new_person
self.options = ( self.person.get_handle(),
self.top_text, self.middle_text, self.bottom_text )
self.style_name = self.selected_style.get_name()
font = BaseDoc.FontStyle()
font.set(face=BaseDoc.FONT_SANS_SERIF,size=12,bold=0,italic=0)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
para.set(pad=0.5)
para.set_alignment(BaseDoc.PARA_ALIGN_CENTER)
para.set_description(_('The style used for the middle portion of the custom text.'))
default_style.add_style("CBT-Middle",para)
#------------------------------------------------------------------------
#
# Function to write Book Item
#
#------------------------------------------------------------------------
def write_book_item(database,person,doc,options,newpage=0):
"""Write the Title Page using options set.
All user dialog has already been handled and the output file opened."""
try:
if options[0]:
person = database.get_person_from_handle(options[0])
top_text = options[1]
middle_text = options[2]
bottom_text = options[3]
return CustomText(database, person,
top_text, middle_text, bottom_text, doc, None, newpage )
except Errors.ReportError, msg:
(m1,m2) = msg.messages()
ErrorDialog(m1,m2)
except Errors.FilterError, msg:
(m1,m2) = msg.messages()
ErrorDialog(m1,m2)
except:
import DisplayTrace
DisplayTrace.DisplayTrace()
font = BaseDoc.FontStyle()
font.set(face=BaseDoc.FONT_SANS_SERIF,size=12,bold=0,italic=0)
para = BaseDoc.ParagraphStyle()
para.set_font(font)
para.set_alignment(BaseDoc.PARA_ALIGN_CENTER)
para.set(pad=0.5)
para.set_description(_('The style used for the last portion of the custom text.'))
default_style.add_style("CBT-Final",para)
#------------------------------------------------------------------------
#
#
#
#------------------------------------------------------------------------
from PluginMgr import register_book_item
# (name,category,options_dialog,write_book_item,options,style_name,style_file,make_default_style)
register_book_item(
_("Custom Text"),
_("Text"),
CustomTextDialog,
write_book_item,
_options,
_style_name,
_style_file,
_make_default_style
)
from PluginMgr import register_report
register_report(
name = 'custom_text',
category = const.CATEGORY_TEXT,
report_class = CustomText,
options_class = CustomTextOptions,
modes = Report.MODE_BKI,
translated_name = _("Custom Text"),
)