gramps/src/Assistant.py

#
# Gramps - a GTK+/GNOME based genealogy program
#
# Copyright (C) 2000-2006  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
# 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$

#-------------------------------------------------------------------------
#
# Standard python modules
#
#-------------------------------------------------------------------------
from gen.ggettext import gettext as _
import os

#-------------------------------------------------------------------------
#
# GTK modules
#
#-------------------------------------------------------------------------
import gtk
import gobject

#-------------------------------------------------------------------------
#
# Gramps modules
#
#-------------------------------------------------------------------------
import const
import ManagedWindow

#-------------------------------------------------------------------------
#
# Constants
#
#-------------------------------------------------------------------------
_gramps_png = os.path.join(const.IMAGE_DIR, "gramps.png")
_splash_jpg = os.path.join(const.IMAGE_DIR, "splash.jpg")
_format = '<span weight="bold" size="xx-large">%s</span>'

#-------------------------------------------------------------------------
#
# Assistant class
#
#-------------------------------------------------------------------------
class Assistant(gtk.Object, ManagedWindow.ManagedWindow):
    """ A tabbed dialog box used to implement Assistant interfaces.
            Deprecated. Please use gtk.Assistant class from now on.
            See eg. example use in ExportAssistant
    """

    __gproperties__ = {}

    __gsignals__ = {
        'page-changed'     : (gobject.SIGNAL_RUN_LAST, 
                              gobject.TYPE_NONE, 
                              (gobject.TYPE_INT, )), 
        'before-page-next' : (gobject.SIGNAL_RUN_LAST, 
                              gobject.TYPE_NONE, 
                              (gobject.TYPE_INT, )), 
        'after-page-next'  : (gobject.SIGNAL_RUN_LAST, 
                              gobject.TYPE_NONE, 
                              (gobject.TYPE_INT, )), 
        'before-page-back' : (gobject.SIGNAL_RUN_LAST, 
                              gobject.TYPE_NONE, 
                              (gobject.TYPE_INT, )), 
        'after-page-back'  : (gobject.SIGNAL_RUN_LAST, 
                              gobject.TYPE_NONE, 
                              (gobject.TYPE_INT, )), 
        'complete'         : (gobject.SIGNAL_RUN_LAST, 
                              gobject.TYPE_NONE, 
                              ())
        }

    def __init__(self, uistate, parent_class, complete, top_title=''):
        gobject.GObject.__init__(self)

        self.top_title = top_title
        if uistate:
            ManagedWindow.ManagedWindow.__init__(self, uistate, [], 
                                                 parent_class)
        else:
            self.uistate = None
        
        self.complete = complete
        self.fg_color = gtk.gdk.color_parse('#7d684a')
        self.bg_color = gtk.gdk.color_parse('#e1dbc5')
        self.logo = gtk.gdk.pixbuf_new_from_file(_gramps_png)
        self.splash = gtk.gdk.pixbuf_new_from_file(_splash_jpg)

        self.current_page = -1
        
        if uistate:
            self.set_window(gtk.Window(), None, self.top_title)
        else:
            self.window = gtk.Window()
            self.close = self.destroy

        titlebox = gtk.HBox()
        self.title_text = []
        
        self.title = gtk.Label('')
        self.title.set_alignment(0, 0.5)
        self.title.set_use_markup(True)

        titlebox.pack_start(self.title, True)
        image = gtk.Image()
        image.set_from_file(_gramps_png)
        titlebox.pack_end(image, False)
        
        self.notebook = gtk.Notebook()
        self.notebook.set_show_border(False)
        self.notebook.set_show_tabs(False)
        
        vbox = gtk.VBox(spacing=6)
        vbox.set_border_width(6)
        hbox = gtk.HButtonBox()
        hbox.set_spacing(6)
        hbox.set_layout(gtk.BUTTONBOX_END)

        self.cancel = gtk.Button(stock=gtk.STOCK_CANCEL)
        self.cancel.connect('clicked', self.close)
        self.back   = gtk.Button(stock=gtk.STOCK_GO_BACK)
        self.back.set_sensitive(False)
        self.back.connect('clicked', self.back_clicked)
        self.next   = gtk.Button(stock=gtk.STOCK_GO_FORWARD)
        self.next.connect('clicked', self.next_clicked)
        self.ok   = gtk.Button(stock=gtk.STOCK_OK)
        self.ok.connect('clicked', self.next_clicked)
        self.ok.set_sensitive(False)
        
        hbox.add(self.cancel)
        hbox.add(self.back)
        hbox.add(self.next)
        hbox.add(self.ok)

        vbox.pack_start(titlebox, False)
        vbox.pack_start(self.notebook, True)
        vbox.pack_start(hbox, False)

        self.window.add(vbox)

    def build_menu_names(self, obj):
        return (self.top_title, None)

    def set_busy_cursor(self, value):
        if value:
            self.window.window.set_cursor(gtk.gdk.Cursor(gtk.gdk.WATCH))
            self.window.set_sensitive(0)
        else:
            self.window.window.set_cursor(None)
            self.window.set_sensitive(1)

        while gtk.events_pending():
            gtk.main_iteration()

    def destroy(self, *obj):
        self.window.emit('delete-event', None)
        self.window.destroy()

    def do_get_property(self, prop):
        """Return the gproperty's value."""
        raise AttributeError, 'unknown property %s' % prop.name

    def do_set_property(self, prop, value):
        """Set the property of writable properties."""
        raise AttributeError, 'unknown or read only property %s' % prop.name

    def get_number_of_pages(self):
        return self.notebook.get_n_pages()

    def update_title(self):
        self.title.set_label(self.title_text[self.current_page])
        self.title.set_use_markup(True)

    def set_buttons(self):
        max_page = self.notebook.get_n_pages()
        if self.current_page == max_page-2:
            self.next.show()
            self.back.show()
            self.cancel.show()
            self.ok.set_sensitive(True)
            self.next.set_sensitive(False)
            self.back.set_sensitive(True)
        elif self.current_page == max_page-1:
            self.next.hide()
            self.back.hide()
            self.cancel.hide()
        elif self.current_page == 0:
            self.next.show()
            self.back.show()
            self.cancel.show()
            self.back.set_sensitive(False)
            self.next.set_sensitive(True)
            self.ok.set_sensitive(False)
        else:
            self.next.show()
            self.back.show()
            self.back.set_sensitive(True)
            self.next.set_sensitive(True)
            self.ok.set_sensitive(False)
            self.cancel.show()
    
    def back_clicked(self, obj):
        self.emit('before-page-back', self.notebook.get_current_page())
        self.current_page -= 1
        self.notebook.set_current_page(self.current_page)
        self.update_title()
        self.set_buttons()
        
        self.emit('after-page-back', self.notebook.get_current_page())
        self.emit('page-changed', self.notebook.get_current_page())

    def next_clicked(self, obj):
        self.emit('before-page-next', self.notebook.get_current_page())
        if self.current_page == self.notebook.get_n_pages()-1:
            self.emit('complete')
            self.complete()
            self.close()
        else:
            self.current_page += 1
            self.notebook.set_current_page(self.current_page)
            self.update_title()
            self.set_buttons()

        self.emit('after-page-next', self.notebook.get_current_page())
        self.emit('page-changed', self.notebook.get_current_page())

    def add_text_page(self, title, text):
        """
        Add page with Gramps logo and given text and title.
        Usually, first page (introduction) and last page (conclusion)
        use this method.
        """
        hbox = self.prepare_text_page(text)
        return self.add_page(title, hbox)

    def insert_text_page(self, title, text, position):
        """
        Add page with Gramps logo and given text and title.
        Usually, first page (introduction) and last page (conclusion)
        use this method.
        """
        hbox = self.prepare_text_page(text)
        return self.insert_page(title, hbox, position)

    def prepare_text_page(self, text):
        hbox = gtk.HBox(spacing=12)
        image = gtk.Image()
        image.set_from_file(_splash_jpg)
        hbox.pack_start(image, False)
        label = gtk.Label(text)
        label.set_line_wrap(True)
        label.set_use_markup(True)
        hbox.add(label)
        hbox.show_all()
        return hbox

    def add_page(self, title, child):
        """
        Add page with the title and child widget.
        Return index number of the new page.
        """
        self.title_text.append(_format % title)
        return self.notebook.append_page(child)

    def insert_page(self, title, child, position):
        """
        Insert page at a given position.
        Returns index number of the new page.
        """
        self.title_text.insert(position, _format % title)
        return self.notebook.insert_page(child, None, position)

    def remove_page(self, position):
        """
        Remove page from a given position.
        """
        self.title_text.pop(position)
        self.notebook.remove_page(position)

    def show(self):
        self.window.show_all()
        self.current_page = 0
        self.notebook.set_current_page(self.current_page)
        self.update_title()
        self.set_buttons()
        self.emit('page-changed', self.notebook.get_current_page())
        if self.uistate:
            ManagedWindow.ManagedWindow.show(self)

if gtk.pygtk_version < (2, 8, 0):
    gobject.type_register(Assistant)

if __name__ == "__main__":

    def complete():
        gtk.main_quit()

    def make_label(table, val, y, x1, x2, x3, x4):
        label = gtk.Label(val)
        label.set_alignment(0, 0.5)
        text = gtk.Entry()
        table.attach(label, x1, x2, y, y+1, gtk.SHRINK|gtk.FILL)
        table.attach(text, x3, x4, y, y+1, gtk.EXPAND|gtk.FILL)
        return text

    a = Assistant(complete)
    a.add_text_page('Getting started', 
                    'Welcome to Gramps, the Genealogical Research '
                    'and Analysis Management Programming System.\n'
                    'Several options and information need to be gathered '
                    'before Gramps is ready to be used. Any of this '
                    'information can be changed in the future in the '
                    'Preferences dialog under the Settings menu.')

    box = gtk.VBox()
    box.set_spacing(12)
    table = gtk.Table(8, 4)
    table.set_row_spacings(6)
    table.set_col_spacings(6)
    
    make_label(table, _('Name:'), 0, 0, 1, 1, 4)
    make_label(table, _('Address:'), 1, 0, 1, 1, 4)
    make_label(table, _('City:'), 2, 0, 1, 1, 2)
    make_label(table, _('State/Province:'), 2, 2, 3, 3, 4)
    make_label(table, _('Country:'), 3, 0, 1, 1, 2)
    make_label(table, _('ZIP/Postal code:'), 3, 2, 3, 3, 4)
    make_label(table, _('Phone:'), 4, 0, 1, 1, 4)
    make_label(table, _('Email:'), 5, 0, 1, 1, 4)
    box.add(table)
    a.add_page('Researcher information', box)

    a.add_text_page('Conclusion title', 'Very long conclusion text here')
    a.show()

    gtk.main()