1#
2# Gramps - a GTK+/GNOME based genealogy program
3#
4# Copyright (C) 2000-2005  Donald N. Allingham
5#
6# This program is free software; you can redistribute it and/or modify
7# it under the terms of the GNU General Public License as published by
8# the Free Software Foundation; either version 2 of the License, or
9# (at your option) any later version.
10#
11# This program is distributed in the hope that it will be useful,
12# but WITHOUT ANY WARRANTY; without even the implied warranty of
13# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
14# GNU General Public License for more details.
15#
16# You should have received a copy of the GNU General Public License
17# along with this program; if not, write to the Free Software
18# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
19#
20
21"""
22PlaceBase class for Gramps.
23"""
24
25#-------------------------------------------------------------------------
26#
27# PlaceBase class
28#
29#-------------------------------------------------------------------------
30class PlaceBase:
31    """
32    Base class for place-aware objects.
33    """
34    def __init__(self, source=None):
35        """
36        Initialize a PlaceBase.
37
38        If the source is not None, then object is initialized from values of
39        the source object.
40
41        :param source: Object used to initialize the new object
42        :type source: PlaceBase
43        """
44        if source:
45            self.place = source.place
46        else:
47            self.place = ""
48
49    def set_place_handle(self, place_handle):
50        """
51        Set the database handle for :class:`~.place.Place` associated with the
52        object.
53
54        :param place_handle: :class:`~.place.Place` database handle
55        :type place_handle: str
56        """
57        self.place = place_handle
58
59    def get_place_handle(self):
60        """
61        Return the database handle of the :class:`~.place.Place` associated
62        with the :class:`~.event.Event`.
63
64        :returns: :class:`~.place.Place` database handle
65        :rtype: str
66        """
67        return self.place
68