PySolFC/pysollib/help.py

## vim:ts=4:et:nowrap
##
##---------------------------------------------------------------------------##
##
## PySol -- a Python Solitaire game
##
## Copyright (C) 2003 Markus Franz Xaver Johannes Oberhumer
## Copyright (C) 2002 Markus Franz Xaver Johannes Oberhumer
## Copyright (C) 2001 Markus Franz Xaver Johannes Oberhumer
## Copyright (C) 2000 Markus Franz Xaver Johannes Oberhumer
## Copyright (C) 1999 Markus Franz Xaver Johannes Oberhumer
## Copyright (C) 1998 Markus Franz Xaver Johannes Oberhumer
## All Rights Reserved.
##
## 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; see the file COPYING.
## If not, write to the Free Software Foundation, Inc.,
## 59 Temple Place - Suite 330, Boston, MA 02111-1307, USA.
##
## Markus F.X.J. Oberhumer
## <markus@oberhumer.com>
## http://www.oberhumer.com/pysol
##
##---------------------------------------------------------------------------##


# imports
import sys, os
import traceback
import Tkinter

# PySol imports
from mfxutil import EnvError
from settings import PACKAGE, PACKAGE_URL
from version import VERSION, FC_VERSION
from pysoltk import tkname, makeHelpToplevel, wm_map, wm_set_icon
from pysoltk import MfxMessageDialog
from pysoltk import tkHTMLViewer
from gamedb import GAME_DB

# /***********************************************************************
# //
# ************************************************************************/

class AboutDialog(MfxMessageDialog):
    def createFrames(self, kw):
        top_frame, bottom_frame = MfxMessageDialog.createFrames(self, kw)
        return top_frame, bottom_frame


def helpAbout(app, timeout=0, sound=1):
    if sound:
        app.audio.playSample("about")
    t = _("A Python Solitaire Game Collection\n")
    if app.miscrandom.random() < 0.8:
        t = _("A World Domination Project\n")
    strings=(_("&Nice"), _("&Credits..."))
    if timeout:
        strings=(_("&Enjoy"),)
    ##version = _("Version %s (%s)\n\n") % (FC_VERSION, VERSION)
    version = _("Version %s\n\n") % FC_VERSION
    d = AboutDialog(app.top, title=_("About ") + PACKAGE, timeout=timeout,
                    text=_('''PySol Fan Club edition
%s%s
Copyright (C) 1998, 1999, 2000, 2001, 2002, 2003
Markus F.X.J. Oberhumer
Copyright (C) 2003 Mt. Hood Playing Card Co.
Copyright (C) 2005 Skomoroh (Fan Club edition)
All Rights Reserved.

PySol is free software distributed under the terms
of the GNU General Public License.

For more information about this application visit
%s''') % (t, version, PACKAGE_URL),
                    image=app.gimages.logos[2],
                    strings=strings, default=0,
                    separatorwidth=2)
    if d.status == 0 and d.button == 1:
        helpCredits(app, sound=sound)
    return d.status


def helpCredits(app, timeout=0, sound=1):
    if sound:
        app.audio.playSample("credits")
    t = ""
    if tkname == "tk": t = "Tcl/Tk, "
    elif tkname == "gnome": t = "PyGTK, "
    elif tkname == "kde": t = "pyKDE, "
    elif tkname == "wx": t = "wxPython, "
    d = MfxMessageDialog(app.top, title=_("Credits"), timeout=timeout,
                         text=PACKAGE+_(''' credits go to:

Volker Weidner for getting me into Solitaire
Guido van Rossum for the initial example program
T. Kirk for lots of contributed games and cardsets
Carl Larsson for the background music
The Gnome AisleRiot team for parts of the documentation
Natascha

The Python, %s, SDL & Linux crews
for making this program possible''') % t,
                  image=app.gimages.logos[3], image_side="right",
                  separatorwidth=2)
    return d.status


# /***********************************************************************
# //
# ************************************************************************/

help_html_viewer = None
help_html_index = None

def helpHTML(app, document, dir_, top=None):
    global help_html_viewer, help_html_index
    if not document:
        return None
    if top is None:
        top = app.top
    try:
        doc = app.dataloader.findFile(document, dir_)
        if help_html_index is None:
            document, dir_ = "index.html", "html"
            help_html_index = app.dataloader.findFile(document, dir_)
    except EnvError:
        d = MfxMessageDialog(app.top, title=PACKAGE + _(" HTML Problem"),
                             text=_("Cannot find help document\n") + document,
                             bitmap="warning")
        return None
    ##print doc, help_html_index
    try:
        viewer = help_html_viewer
        #if viewer.parent.winfo_parent() != top._w:
        #    viewer.destroy()
        #    viewer = None
        viewer.updateHistoryXYView()
        viewer.display(doc, relpath=0)
    except:
        ##traceback.print_exc()
        top = makeHelpToplevel(app, title=PACKAGE+_(" Help"))
        if top.winfo_screenwidth() < 800 or top.winfo_screenheight() < 600:
            #maximized = 1
            top.wm_minsize(300, 150)
        else:
            #maximized = 0
            top.wm_minsize(400, 200)
        try:
            wm_set_icon(top, app.dataloader.findIcon())
        except:
            pass
        viewer = tkHTMLViewer(top, app, help_html_index)
        viewer.display(doc)
    #wm_map(top, maximized=maximized)
    viewer.parent.tkraise()
    help_html_viewer = viewer
    return viewer

def destroy_help():
    try:
        help_html_viewer.destroy()
    except:
        pass