Cyclone-Team/gramps
2
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

part 3 : split basedoc in files, remove Utils dependance, move fontscale in gen,

Browse Source 
update build system


svn: r12603
This commit is contained in:
Benny Malengier
2009-05-31 14:59:56 +00:00
parent 206e9f1aba
commit fb3ec68c6a
63 changed files with 2191 additions and 2521 deletions
Download Patch File Download Diff File Expand all files Collapse all files

238
src/gen/plug/docgen/textdoc.py Normal file
View File

@@ -0,0 +1,238 @@
#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2007 Donald N. Allingham
# Copyright (C) 2002 Gary Shao
# Copyright (C) 2007 Brian G. Matherly
# Copyright (C) 2009 Benny Malengier
# 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: basedoc.py 12591 2009-05-29 22:25:44Z bmcage $
#-------------------------------------------------------------------------
#
# standard python modules
#
#-------------------------------------------------------------------------
#-------------------------------------------------------------------------
#
# GRAMPS modules
#
#-------------------------------------------------------------------------
#-------------------------------------------------------------------------
#
# set up logging
#
#-------------------------------------------------------------------------
import logging
log = logging.getLogger(".textdoc")
#-------------------------------------------------------------------------
#
# IndexMark types
#
#-------------------------------------------------------------------------
INDEX_TYPE_ALP = 0
INDEX_TYPE_TOC = 1
#------------------------------------------------------------------------
#
# IndexMark
#
#------------------------------------------------------------------------
class IndexMark(object):
"""
Defines a mark to be associated with text for indexing.
"""
def __init__(self, key="", itype=INDEX_TYPE_ALP, level=1):
"""
Initialize the object with default values, unless values are specified.
"""
self.key = key
self.type = itype
self.level = level
#------------------------------------------------------------------------
#
# TextDoc
#
#------------------------------------------------------------------------
class TextDoc(object):
"""
Abstract Interface for text document generators. Output formats for
text reports must implment this interface to be used by the report
system.
"""
def page_break(self):
"Forces a page break, creating a new page"
raise NotImplementedError
def start_bold(self):
raise NotImplementedError
def end_bold(self):
raise NotImplementedError
def start_superscript(self):
raise NotImplementedError
def end_superscript(self):
raise NotImplementedError
def start_paragraph(self, style_name, leader=None):
"""
Starts a new paragraph, using the specified style name.
@param style_name: name of the ParagraphStyle to use for the
paragraph.
@param leader: Leading text for a paragraph. Typically used
for numbering.
"""
raise NotImplementedError
def end_paragraph(self):
"Ends the current parsgraph"
raise NotImplementedError
def start_table(self, name, style_name):
"""
Starts a new table.
@param name: Unique name of the table.
@param style_name: TableStyle to use for the new table
"""
raise NotImplementedError
def end_table(self):
"Ends the current table"
raise NotImplementedError
def start_row(self):
"Starts a new row on the current table"
raise NotImplementedError
def end_row(self):
"Ends the current row on the current table"
raise NotImplementedError
def start_cell(self, style_name, span=1):
"""
Starts a new table cell, using the paragraph style specified.
@param style_name: TableCellStyle to use for the cell
@param span: number of columns to span
"""
raise NotImplementedError
def end_cell(self):
"Ends the current table cell"
raise NotImplementedError
def write_text(self, text, mark=None):
"""
Writes the text in the current paragraph. Should only be used after a
start_paragraph and before an end_paragraph.
@param text: text to write.
@param mark: IndexMark to use for indexing (if supported)
"""
raise NotImplementedError
def write_markup(self, text, s_tags):
"""
Writes the text in the current paragraph. Should only be used after a
start_paragraph and before an end_paragraph. Not all backends support
s_tags, then the same happens as with write_text. Backends supporting
write_markup will overwrite this method
@param text: text to write. The text is assumed to be _not_ escaped
@param s_tags: assumed to be list of styledtexttags to apply to the
text
"""
self.write_text(text)
def write_note(self, text, format, style_name):
"""
Writes the note's text and take care of paragraphs,
depending on the format.
@param text: text to write.
@param format: format to use for writing. True for flowed text,
1 for preformatted text.
"""
raise NotImplementedError
def write_styled_note(self, styledtext, format, style_name):
"""
Convenience function to write a styledtext to the cairo doc.
styledtext : assumed a StyledText object to write
format : = 0 : Flowed, = 1 : Preformatted
style_name : name of the style to use for default presentation
overwrite this method if the backend supports styled notes
"""
text = str(styledtext)
self.write_note(text, format, style_name)
def write_text_citation(self, text, mark=None):
"""Method to write text with GRAMPS <super> citation marks"""
if not text:
return
parts = text.split("<super>")
markset = False
for piece in parts:
if not piece:
# a text '<super>text ...' splits as '', 'text..'
continue
piecesplit = piece.split("</super>")
if len(piecesplit) == 2:
self.start_superscript()
self.write_text(piecesplit[0])
self.end_superscript()
if not piecesplit[1]:
#text ended with ' ... </super>'
continue
if not markset:
self.write_text(piecesplit[1], mark)
markset = True
else:
self.write_text(piecesplit[1])
else:
if not markset:
self.write_text(piece, mark)
markset = True
else:
self.write_text(piece)
def add_media_object(self, name, align, w_cm, h_cm):
"""
Add a photo of the specified width (in centimeters)
@param name: filename of the image to add
@param align: alignment of the image. Valid values are 'left',
'right', 'center', and 'single'
@param w_cm: width in centimeters
@param h_cm: height in centimeters
"""
raise NotImplementedError