Source code for openalea.oalab.gui.help

# -*- python -*-
#
#       OpenAlea.OALab: Multi-Paradigm GUI
#
#       Copyright 2013 INRIA - CIRAD - INRA
#
#       File author(s): Julien Coste <julien.coste@inria.fr>
#
#       File contributor(s):
#
#       Distributed under the Cecill-C License.
#       See accompanying file LICENSE.txt or copy at
#           http://www.cecill.info/licences/Licence_CeCILL-C_V1-en.html
#
#       OpenAlea WebSite : http://openalea.gforge.inria.fr
#
###############################################################################
__revision__ = ""

from openalea.vpltk.qt import QtGui, QtCore
import resources_rc # do not remove this import else icon are not drawn
import webbrowser

default_text2 = """
<H1>Welcome in OpenAlea Laboratory.</H1>

To begin, <b>choose your lab</b> or open an existing file or project:
<ul>
<li>  <b>MiniLab</b> is a minimal environnement with only a text editor and a shell.</li>
<li>  <b>3DLab</b> is an environnement to work on 3D Objects.</li>
<li>  <b>PlantLab</b> is an environnement to work on entire plant.</li>
<li>  <b>TissueLab</b>is an environnement to work on tissue part of plants.</li>
<li>  Open an existing project.</li>
<li>  Restore previous session.</li>
</ul>
"""

default_text = """
<H1>Welcome in OpenAlea Laboratory.</H1>

<p>
This lab permit to create and execute virtual experiments that use different modelling paradigms.
</p>
<p>
To begin, you can work in this temporary project, write code, execute it...
If you want to save your project, please use "<b>Save As</b>" button in "<b>Project</b>" menu to rename/move your project.
</p>
<p>
Examples of project are available in pressing "<b>Open</b>" button in "<b>Project</b>" menu.
Then go into "oalab_examples" repository and select a project.
</p>
"""

        
class HelpWidget(QtGui.QTextBrowser):
    """
    Widget which permit to display informations/help.
    Usefull in visualea or LPy.
    """
    def __init__(self, session=None, controller=None, parent=None):
        super(HelpWidget, self).__init__(parent=parent) 
        self.setAccessibleName("HelpWidget")

        actionHelpOpenAlea = QtGui.QAction(QtGui.QIcon(":/images/resources/openalealogo.png"),"OpenAlea", self)
        actionHelpGForge = QtGui.QAction(QtGui.QIcon(":/images/resources/gforge.png"),"Submit Bug", self)
        actionHelpTasks = QtGui.QAction(QtGui.QIcon(":/images/resources/gforge.png"),"See Tasks", self)

        QtCore.QObject.connect(actionHelpOpenAlea, QtCore.SIGNAL('triggered(bool)'),self.openWebsiteOpenalea)
        QtCore.QObject.connect(actionHelpGForge, QtCore.SIGNAL('triggered(bool)'),self.openOALabBugs)
        QtCore.QObject.connect(actionHelpTasks, QtCore.SIGNAL('triggered(bool)'),self.openOALabTasks)

        self._actions = [["Help", "Website", actionHelpOpenAlea, 0],
                         ["Help", "Website", actionHelpGForge, 0]]
        self.setText(default_text)                

    def actions(self):
        return self._actions

    def openWebsiteOpenalea(self):
        self.openWeb('http://openalea.gforge.inria.fr/dokuwiki/doku.php')

    def openOALabBugs(self):
        self.openWeb('https://gforge.inria.fr/tracker/?func=add&group_id=79&atid=13823')    

    def openOALabTasks(self):
        self.openWeb('https://gforge.inria.fr/pm/task.php?group_project_id=6971&group_id=79&func=browse')

    def openWeb(self, url):
        webbrowser.open(url)

    def mainMenu(self):
        """
        :return: Name of menu tab to automatically set current when current widget
        begin current.
        """
        return "Help"