Gui/Workbench.h

Go to the documentation of this file.

/***************************************************************************
 *   Copyright (c) 2004 Werner Mayer <wmayer[at]users.sourceforge.net>     *
 *                                                                         *
 *   This file is part of the FreeCAD CAx development system.              *
 *                                                                         *
 *   This library is free software; you can redistribute it and/or         *
 *   modify it under the terms of the GNU Library General Public           *
 *   License as published by the Free Software Foundation; either          *
 *   version 2 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 Library General Public License for more details.                  *
 *                                                                         *
 *   You should have received a copy of the GNU Library General Public     *
 *   License along with this library; see the file COPYING.LIB. If not,    *
 *   write to the Free Software Foundation, Inc., 59 Temple Place,         *
 *   Suite 330, Boston, MA  02111-1307, USA                                *
 *                                                                         *
 ***************************************************************************/


#ifndef GUI_WORKBENCH_H
#define GUI_WORKBENCH_H

#include <list>
#include <string>
#include <Base/BaseClass.h>
#include <Gui/TaskView/TaskWatcher.h>

namespace Base {
class PyObjectBase;
}

namespace Gui {

class MenuItem;
class ToolBarItem;
class DockWindowItems;
class WorkbenchManager;

class GuiExport Workbench : public Base::BaseClass
{
    TYPESYSTEM_HEADER();

public:
    Workbench();
    virtual ~Workbench();
    std::string name() const;
    void setName(const std::string&);
    PyObject* getPyObject();
    virtual void setupContextMenu(const char* recipient,MenuItem*) const;
    virtual void createMainWindowPopupMenu(MenuItem*) const;
    bool activate();
    void retranslate() const;
    virtual void activated();
    virtual void deactivated();

    void addTaskWatcher(std::vector<Gui::TaskView::TaskWatcher*> &Watcher);
    void removeTaskWatcher(void);

protected:
    virtual MenuItem* setupMenuBar() const=0;
    virtual ToolBarItem* setupToolBars() const=0;
    virtual ToolBarItem* setupCommandBars() const=0;
    virtual DockWindowItems* setupDockWindows() const=0;

private:
    void setupCustomToolbars(ToolBarItem* root, const char* toolbar) const;
    void setupCustomShortcuts() const;

private:
    std::string _name;
};

class GuiExport StdWorkbench : public Workbench
{
    TYPESYSTEM_HEADER();

public:
    StdWorkbench();
    virtual ~StdWorkbench();

public:
    virtual void setupContextMenu(const char* recipient, MenuItem*) const;
    virtual void createMainWindowPopupMenu(MenuItem*) const;

protected:
    virtual MenuItem* setupMenuBar() const;
    virtual ToolBarItem* setupToolBars() const;
    virtual ToolBarItem* setupCommandBars() const;
    virtual DockWindowItems* setupDockWindows() const;
};

class GuiExport BlankWorkbench : public Workbench
{
    TYPESYSTEM_HEADER();

public:
    BlankWorkbench();
    virtual ~BlankWorkbench();

    virtual void setupContextMenu(const char* recipient,MenuItem*) const;
    virtual void activated();
    virtual void deactivated();

protected:
    virtual MenuItem* setupMenuBar() const;
    virtual ToolBarItem* setupToolBars() const;
    virtual ToolBarItem* setupCommandBars() const;
    virtual DockWindowItems* setupDockWindows() const;
};

class GuiExport NoneWorkbench : public StdWorkbench
{
    TYPESYSTEM_HEADER();

public:
    NoneWorkbench();
    virtual ~NoneWorkbench();

    virtual void setupContextMenu(const char* recipient,MenuItem*) const;

protected:
    virtual MenuItem* setupMenuBar() const;
    virtual ToolBarItem* setupToolBars() const;
    virtual ToolBarItem* setupCommandBars() const;
    virtual DockWindowItems* setupDockWindows() const;
};

class GuiExport TestWorkbench : public StdWorkbench
{
    TYPESYSTEM_HEADER();

public:
    TestWorkbench();
    ~TestWorkbench();

protected:
    MenuItem* setupMenuBar() const;
    ToolBarItem* setupToolBars() const;
    ToolBarItem* setupCommandBars() const;
};

class GuiExport PythonWorkbench : public StdWorkbench
{
    TYPESYSTEM_HEADER();

public:
    PythonWorkbench();
    ~PythonWorkbench();
    PyObject* getPyObject();


    void appendMenu(const std::list<std::string>& menu, const std::list<std::string>& items) const;
    void removeMenu(const std::string& menu ) const;
    std::list<std::string> listMenus() const;

    void appendContextMenu(const std::list<std::string>& menu, const std::list<std::string>& items) const;
    void removeContextMenu(const std::string& menu ) const;
    void setupContextMenu(const char* recipient,MenuItem*) const;
    void clearContextMenu();

    void appendToolbar(const std::string& bar, const std::list<std::string>& items) const;
    void removeToolbar(const std::string& bar) const;
    std::list<std::string> listToolbars() const;

    void appendCommandbar(const std::string& bar, const std::list<std::string>& items) const;
    void removeCommandbar(const std::string& bar) const;
    std::list<std::string> listCommandbars() const;

protected:
    MenuItem* setupMenuBar() const;
    ToolBarItem* setupToolBars() const;
    ToolBarItem* setupCommandBars() const;

private:
    MenuItem* _menuBar;
    MenuItem* _contextMenu;
    ToolBarItem* _toolBar;
    ToolBarItem* _commandBar;
    Base::PyObjectBase* _workbenchPy;
};

} // namespace Gui


#endif // GUI_WORKBENCH_H