Source code for gramps.gui.basesidebar

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2010       Nick Hall
#
# 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, see <https://www.gnu.org/licenses/>.
#


# -------------------------------------------------------------------------
#
# BaseSidebar class
#
# -------------------------------------------------------------------------
[docs] class BaseSidebar: """ The base class for all sidebar plugins. """ def __init__(self, dbstate, uistate): raise NotImplementedError
[docs] def get_top(self): """ Return the top container widget for the GUI. """ raise NotImplementedError
[docs] def view_changed(self, cat_num, view_num): """ Called when the active view is changed. """ raise NotImplementedError
[docs] def active(self, cat_num, view_num): """ Called when the sidebar is made visible. """ pass
[docs] def inactive(self): """ Called when the sidebar is hidden. """ pass