tabs.py

# -*- coding: utf-8 -*-
"""
/***************************************************************************
 BioDispersal
                                 A QGIS plugin
 Computes ecological continuities based on environments permeability
 Generated by Plugin Builder: http://g-sherman.github.io/Qgis-Plugin-Builder/
                             -------------------
        begin                : 2018-04-12
        git sha              : $Format:%H$
        copyright            : (C) 2018 by IRSTEA
        email                : mathieu.chailloux@irstea.fr
 ***************************************************************************/

/***************************************************************************
 *                                                                         *
 *   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.                                   *
 *                                                                         *
 ***************************************************************************/
"""

import os

from .qgis_lib_mc import utils
#import helps
from PyQt5.QtCore import QUrl, QFile, QIODevice, QTextStream
from PyQt5.QtGui import QTextDocument

class TabItem:

    def __init__(self,idx,name,helpFile):
        self.idx = idx
        self.name = name
        self.descr = "TabsLightToolbox"
        self.helpFile = helpFile
        
    def setDescr(self,descr):
        self.descr = descr

    def getHelpFile(self):
        plugin_dir = os.path.dirname(__file__)
        help_dir = os.path.join(plugin_dir,"help")
        helpFile = os.path.join(help_dir,self.helpFile + "-" + utils.curr_language + ".html")
        return helpFile
        
radianceTabItem = TabItem(0,"Radiance","radianceHelp")
blueTabItem = TabItem(1,"Blue","blueHelp")
logTabItem = TabItem(3,"Log","logHelp")
mnsTabItem = TabItem(4,"MNS","mnsHelp")
viewshedTabItem = TabItem(5,"Viewdhed","viewshedHelp")
nbLightVisibilityTabItem = TabItem(6,"NumberLightVisibility","nbLightVisibilityHelp")

class TabConnector:

    def __init__(self,dlg):
        self.tabs = [radianceTabItem,
                     blueTabItem,
                     None, # correspond au menu Visibility Light Sources
                     logTabItem]

        self.tabsVisibility = [mnsTabItem,
                               viewshedTabItem,
                               nbLightVisibilityTabItem]
        self.dlg = dlg
        self.curr_tab = 0
        self.curr_tab_visibility = 0
        self.is_visibility_tab = False
        
    def initGui(self):
        self.dlg.textShortHelp.setOpenLinks(True)
        self.loadNTab(0)
        
    def loadNTab(self,n):
        if n != 2 : # ne correspond pas au menu Visibility Light Sources
            utils.debug("[loadNTab] " + str(n))
            nb_tabs = len(self.tabs)
            self.curr_tab = n
            if n >= nb_tabs:
                utils.internal_error("[loadNTab] loading " + str(n) + " tab but nb_tabs = " + str(nb_tabs))
            else:
                self.is_visibility_tab = False
                self.loadHelpFile()
                #utils.debug("source : " + str(self.dlg.textShortHelp.source()))
        else:
            self.is_visibility_tab = True
            self.loadHelpFile()
        
    def loadNTabVisibility(self,n):
        utils.debug("[loadNTab] " + str(n))
        nb_tabs = len(self.tabsVisibility)
        self.curr_tab_visibility = n
        if n >= nb_tabs:
            utils.internal_error("[loadNTab] loading " + str(n) + " tab but nb_tabs = " + str(nb_tabs))
        else:
            self.is_visibility_tab = True
            self.loadHelpFile()
    
    def loadHelpFile(self):
        if self.is_visibility_tab:
            tabItem = self.tabsVisibility[self.curr_tab_visibility]
        else:
            tabItem = self.tabs[self.curr_tab]
        helpFile = tabItem.getHelpFile()
        utils.debug("Help file = " + str(helpFile))
        utils.checkFileExists(helpFile)
        with open(helpFile) as f:
            msg = f.read()
        self.dlg.textShortHelp.setHtml(msg)
        
    def connectComponents(self):
        self.dlg.tabWidget.currentChanged.connect(self.loadNTab)
        self.dlg.tabWidgetVisibility.currentChanged.connect(self.loadNTabVisibility)