54 lines
1.7 KiB
Python
54 lines
1.7 KiB
Python
#
|
|
# Gramps - a GTK+/GNOME based genealogy program
|
|
#
|
|
# Copyright (C) 2007-2008 Brian G. Matherly
|
|
# Copyright (C) 2008 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$
|
|
|
|
"""
|
|
Option class representing a block of text.
|
|
"""
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# gramps modules
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
from gen.plug.menu import Option
|
|
|
|
#-------------------------------------------------------------------------
|
|
#
|
|
# TextOption class
|
|
#
|
|
#-------------------------------------------------------------------------
|
|
class TextOption(Option):
|
|
"""
|
|
This class describes an option that is a multi-line string.
|
|
"""
|
|
def __init__(self, label, value):
|
|
"""
|
|
@param label: A friendly label to be applied to this option.
|
|
Example: "Page header"
|
|
@type label: string
|
|
@param value: An initial value for this option.
|
|
Example: "Generated by GRAMPS\nCopyright 2007"
|
|
@type value: string
|
|
@return: nothing
|
|
"""
|
|
Option.__init__(self, label, value)
|