InitGui.py

# FreeCAD-Beginner-Assistant Addon for FreeCAD
#
# This library is free software; you can redistribute it and/or
# modify it under the terms of the GNU Lesser General Public
# License as published by the Free Software Foundation; either
# version 2.1 of the License, or (at your option) any later version.
#
# This library 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
# Lesser General Public License for more details.
#
# You should have received a copy of the GNU Lesser General Public
# License along with this library; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301 USA

import os

import FreeCAD # noqa
import FreeCADGui # noqa

class AssistantWorkbench(FreeCADGui.Workbench):
    """Purpose and functionality of the AssistantWorkbench."""

    def __init__(self):
        self.__class__.MenuText = "FreeCAD Beginner Assistant"
        self.__class__.ToolTip = "A description of the FreeCAD Beginner Assistant"
        from fba_config import addon_work_dir
        self.__class__.Icon = os.path.join(addon_work_dir, 'icons', 'owl-2.png')

    def Initialize(self):
        """This function is executed when the workbench is first activated.
        It is executed once in a FreeCAD session followed by the Activated function.
        """

        # Import commands for this workbench
        from commands import AnalyseDocumentCommand

        # Adds commands to the Gui using the Command classes
        FreeCADGui.addCommand('Analyse_Document_Command', AnalyseDocumentCommand())
        
        # A list of command names created above
        self.assistantcommands = [
            "Analyse_Document_Command"
        ] 
        
        # Adds the list of commands to a new toolbar
        self.appendToolbar("Assistant Toolbar Commands", self.assistantcommands)

         # Adds the list of commands to a new menu
        self.appendMenu("Assistant Menu Commands", self.assistantcommands)

        FreeCAD.Console.PrintMessage("Initializing FreeCAD Beginner Assistant"+ "\n")
 
    def Activated(self):
        """This function is executed whenever the workbench is activated"""
        FreeCAD.Console.PrintMessage("Activating FreeCAD Beginner Assistant" + "\n")

    def Deactivated(self):
        """This function is executed whenever the workbench is deactivated"""
        FreeCAD.Console.PrintMessage("Deactivating FreeCAD Beginner Assistant" + "\n")

    def ContextMenu(self, recipient):
        """This function is executed whenever the user right-clicks on screen"""
        # "recipient" will be either "view" or "tree"
        # add commands to the context menu
        self.appendContextMenu("assistant commands", self.list) 
        FreeCAD.Console.PrintMessage("Activating FreeCAD Beginner Assistant context menu" + "\n")

    def GetClassName(self): 
        # This function is mandatory if this is a full Python workbench
        # This is not a template, the returned string should be exactly "Gui::PythonWorkbench"
        return "Gui::PythonWorkbench"   

FreeCADGui.addWorkbench(AssistantWorkbench())