NDEVRRibbon.h

/*--------------------------------------------------------------------------------------------
Copyright (c) 2019, NDEVR LLC
tyler.parke@ndevr.org
  __    __   ____     _____ __     __  _______
 |  \  |  | |  __ \  |  ___|\ \   / / |   __  \
 |   \ |  | | |  \ \ | |___  \ \ / /  |  |__)  |
 |  . \|  | | |__/ / | |___   \ V /   |   _   /
 |  |\    |_|_____/__|_____|___\_/____|  | \  \
 |__| \__________________________________|  \__\
 
Subject to the terms of the Enterprise+ Agreement, NDEVR hereby grants 
Licensee a limited, non-exclusive, non-transferable, royalty-free license 
(without the right to sublicense) to use the API solely for the purpose of 
Licensee's internal development efforts to develop applications for which 
the API was provided.
 
The above copyright notice and this permission notice shall be included in all 
copies or substantial portions of the Software.
 
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR
PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE
FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
 
Library: NDEVR
File: NDEVRRibbon
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/Ribbon.h>
#include <NDEVR/KeyController.h>
namespace NDEVR
{
    enum NDEVRRibbonAction
    {
          e_save_file 
        , e_save_as_file 
        , e_open_project 
        , e_undo 
        , e_redo 
        , e_help 
        , e_settings 
        , e_ribbon_action_size 
    };
    class QTModelManager;
    class QTWindowManager;
    class StatusBar;
    class SnapsEditorWidget;
    class LayerWidget;
    class MainWindow;
    class WindowManager;
    class QTResourceListener;
    class RibbonSubGroup;
    class NDEVRRibbonWidget;

    struct NDEVRRibbonOptions
    {
        enum RibbonVisibleOption
        {
              e_visible 
            , e_not_visible 
            , e_default 
        };
        NDEVRRibbonOptions();
 
        RibbonVisibleOption home_general_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption file_actions_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption view_actions_visible = RibbonVisibleOption::e_not_visible; 
        RibbonVisibleOption draw_actions_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption edit_actions_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption measure_actions_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption layers_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption main_button_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption save_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption save_as_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption light_theme_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption touch_theme_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption about_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption project_browser_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption log_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption wifi_visible = RibbonVisibleOption::e_default; 
        RibbonVisibleOption exit_visible = RibbonVisibleOption::e_default; 
        bool showHomeGeneral() const;
        bool showFileActions() const;
        bool showDrawActions() const;
        bool showEditActions() const;
        bool showMeasureActions() const;
        bool showViewActions() const;
        bool showMainButton() const;
        bool showExit() const;
        bool showLayers() const;
        bool showWifi() const;
        bool showLog() const;
        bool showSave() const;
        bool showSaveAs() const;
        bool showColorTheme() const;
        bool showProjectBrowser() const;
        bool showAbout() const;
        bool showWidgetMode() const;
        static bool ShouldShow(RibbonVisibleOption option, bool default_option);
    };

    class NDEVR_API NDEVRRibbon : public QCustomDockWidget, public BasicKeyController
    {
        Q_OBJECT
    public:
        NDEVRRibbon(MainWindow* window, WindowManager* window_manager, QTModelManager* manager, RibbonArea area);
        NDEVRRibbon(WindowManager* window_manager, QTModelManager* manager, RibbonArea area);
        ~NDEVRRibbon();

        void setMainButtonCallback(const std::function<void(const PopupInfo&)>& main_callback);

        void addLeftWidget(QWidget* widget);

        void addRightWidget(QWidget* widget);

        const NDEVRRibbonOptions& options() const { return m_ribbon_options; };

        void setRibbonOptions(const NDEVRRibbonOptions& options);

        Ribbon* ribbon() const { return m_ribbon; }

        void addButtonToGeneralHome(Button* button, bool disable_with_no_project);

        void addButtonToGeneralFile(Button* button, bool disable_with_no_project);

        RibbonGroup* homeRibbonGroup();

        RibbonSubGroup* homeFileRibbonSubGroup();

        RibbonSubGroup* homeGeneralRibbonSubGroup();

        RibbonGroup* editRibbonGroup();

        void setSceneVisible(bool scene_visible);
        
        void setup();
        
        void setIsVertical(bool is_vertical);
    protected:
        void initializeRibbon();
        void showHome(bool visible);
        void showEdit(bool visible);
        void updateButtonStates();
        void refreshWidget();
        void retranslate();
        virtual bool processKeyEvent(const StringView& id, const KeyEvent& key_event, DesignObjectLookup* lookup, Camera* camera) override;
        void resetKeyControllerToDefaults() override;
        void createEditRibbonGroup();
        void showView(bool visible);
        RibbonGroup* viewRibbonGroup();
        void showDraw(bool visible);
        RibbonGroup* drawRibbonGroup();
        void createDrawRibbonGroup();
        void showMeasure(bool visible);
        RibbonGroup* measureRibbonGroup();
    protected slots:
        void updateUndoRedoSlot(UUID last_command);
        void onClearAllSlot();
    protected:
        Ribbon* m_ribbon = nullptr; 
        QTModelManager* m_model_manager = nullptr; 
        WindowManager* m_window_manager = nullptr; 
        MainWindow* m_main_window = nullptr; 
        SnapsEditorWidget* m_snaps_dock = nullptr; 
        LayerWidget* m_layer_tools_dock = nullptr; 
        QWidget* m_main_button_widget = nullptr; 
        Buffer<QWidget*> m_left_widgets; 
        Buffer<QWidget*> m_right_widgets; 
 
        RibbonGroup* m_home_ribbon_group = nullptr; 
        RibbonGroup* m_view_ribbon_group = nullptr; 
        RibbonGroup* m_edit_ribbon_group = nullptr; 
        RibbonGroup* m_draw_ribbon_group = nullptr; 
        RibbonGroup* m_measure_ribbon_group = nullptr; 
        RibbonSubGroup* m_home_file_subgroup = nullptr; 
        Buffer<Button*> m_buttons_to_add_to_home_file_subgroup; 
        RibbonSubGroup* m_home_general_subgroup = nullptr; 
        Buffer<Button*> m_buttons_to_add_to_home_general_subgroup; 
        Button* m_open_button = nullptr; 
        Button* m_import_file_button = nullptr; 
        Button* m_about_button = nullptr; 
        Button* m_main_icon_button = nullptr; 
        Buffer<Button*> m_window_theme_buttons; 
        Buffer<Button*> m_ui_theme_buttons; 
        Button* m_undo_button = nullptr; 
        Button* m_settings_button = nullptr; 
        Button* m_project_settings_button = nullptr; 
        Button* m_redo_button = nullptr; 
        Buffer<Button*> m_touch_theme_buttons; 
        Button* m_save_button = nullptr; 
        Button* m_save_as_button = nullptr; 
        Button* m_export_button = nullptr; 
        Button* m_log_button = nullptr; 
        Button* m_project_browser = nullptr; 
        Button* m_exit_button = nullptr; 
        Button* m_wifi_button = nullptr; 
        //Button* m_rotate_ui_button = nullptr;
 
        Buffer<QPointer<Button>> m_disable_with_no_project_buttons; 
        QTResourceListener* m_command_listener = nullptr; 
        QTResourceListener* m_background_listener = nullptr; 
        std::function<void(const PopupInfo&)> m_main_button_callback; 
        bool m_is_vertical = false; 
        bool m_scene_visible = false; 
        NDEVRRibbonOptions m_ribbon_options; 
    protected:
        class NDEVRRibbonWidget : public QWidget
        {
        public:
            explicit NDEVRRibbonWidget(QWidget* parent = nullptr);
            void setIsVertical(bool is_vertical) { m_is_vertical = is_vertical; };
            QSize sizeHint() const override;
        protected:
            bool m_is_vertical; 
        };
    };
}