NDEVRRibbon.h

Go to the documentation of this file.

/*--------------------------------------------------------------------------------------------
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
 
    The options for the Ribbon that typically appears on the top of the window or, 
    in touch mode, to the side of the window. Controls the behavior of the ribbon
 
    Author: Tyler Parke
 
    Date: 2023-01-16
    *-----------------------------------------------------------------------------------------------**/
    struct NDEVRRibbonOptions
    {
        enum RibbonVisibleOption
        {
              e_visible
            , e_not_visible
            , e_default
        };
        NDEVRRibbonOptions();
 
        RibbonVisibleOption home_general_visible = RibbonVisibleOption::e_default;//Whether or not to show general settings on the home tab
        RibbonVisibleOption file_actions_visible = RibbonVisibleOption::e_default;//Whether or not to show file settings on the home tab
        RibbonVisibleOption view_actions_visible = RibbonVisibleOption::e_not_visible;//Whether or not to show view actions tab which controls aspects of the UI
        RibbonVisibleOption draw_actions_visible = RibbonVisibleOption::e_default;//Whether or not to show draw actions tab (Note that draw functionality must be enabled)
        RibbonVisibleOption edit_actions_visible = RibbonVisibleOption::e_default;//Whether or not to show draw edit actions tab (Note that draw functionality must be enabled)
        RibbonVisibleOption measure_actions_visible = RibbonVisibleOption::e_default;//Whether or not to show measurement actions tab (Note that measure functionality must be enabled)
        RibbonVisibleOption layers_visible = RibbonVisibleOption::e_default;//Whether or not to show layers (Note that layers functionality must be enabled)
        RibbonVisibleOption main_button_visible = RibbonVisibleOption::e_default;//Whether or not to show rounded main button on the far left. Behavior of this button can be set with setMainButtonCallback
        RibbonVisibleOption save_visible = RibbonVisibleOption::e_default;//Whether or not to show save button
        RibbonVisibleOption save_as_visible = RibbonVisibleOption::e_default;//Whether or not to show save-as button
        RibbonVisibleOption light_theme_visible = RibbonVisibleOption::e_default;//Whether or not to show color theme button which changes how the application looks
        RibbonVisibleOption touch_theme_visible = RibbonVisibleOption::e_default;//When appropriate shows the touch theme button which changes the applicaiton mode of the application
        RibbonVisibleOption reports_visible = RibbonVisibleOption::e_default;//Whether or not to  showreports button which brings up reports manager for creating reports
        RibbonVisibleOption about_visible = RibbonVisibleOption::e_default;//Whether or not to show about button which brings up information about the application such as build number and manuals.
        RibbonVisibleOption project_browser_visible = RibbonVisibleOption::e_default;//Whether or not to show browse button which brings up the native file browser next to the project.
        RibbonVisibleOption log_visible = RibbonVisibleOption::e_default;//Whether or not to show log button to bring up application logs dialog
        RibbonVisibleOption wifi_visible = RibbonVisibleOption::e_default;//Whether or not to show wifi button
        RibbonVisibleOption exit_visible = RibbonVisibleOption::e_default;//Whether or not to show close button which exits the application
        bool showHomeGeneral() const;
        bool showFileActions() const;
        bool showDrawActions() const;
        bool showEditActions() const;
        bool showMeasureActions() const;
        bool showViewActions() const;
        bool showMainButton() const;
        bool showReports() 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: NDEVRRibbon
 
    The Ribbon that typically appears on the top of the window or, in touch mode, to the side of the window.
    Contains high level buttons and widgets for the application.
 
    Author: Tyler Parke
 
    Date: 2023-01-16
    *-----------------------------------------------------------------------------------------------**/
    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();
 
        /**--------------------------------------------------------------------------------------------------
        Fn: void NDEVRRibbon::setMainButtonCallback(const std::function<void(const PopupInfo&)>& main_callback)
 
        Sets a callback for when the round "Main" button is pressed. The default behavior is to open the 
        "About" page. Will revert to default behavior if parameter is null.
 
        Author: Tyler Parke
 
        Date: 2020-05-21
 
        Parameters:
        main_callback -  The callback for when the button is pressed.
         *-----------------------------------------------------------------------------------------------**/
        void setMainButtonCallback(const std::function<void(const PopupInfo&)>& main_callback);
 
        /**--------------------------------------------------------------------------------------------------
        Fn: void NDEVRRibbon::addLeftWidget(QWidget* widget)
 
        Adds a widget to the left of the normal ribbon objects
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Parameters:
        widget -  The widget to be added to the left of the normal ribbon objects
         *-----------------------------------------------------------------------------------------------**/
        void addLeftWidget(QWidget* widget);
 
        /**--------------------------------------------------------------------------------------------------
        Fn: void NDEVRRibbon::addRightWidget(QWidget* widget)
 
        Adds a widget to the right of the normal ribbon objects
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Parameters:
        widget -  The widget to be added to the right of the normal ribbon objects
         *-----------------------------------------------------------------------------------------------**/
        void addRightWidget(QWidget* widget);
 
        /**--------------------------------------------------------------------------------------------------
        Fn: const NDEVRRibbonOptions& NDEVRRibbon::options() const
 
        Gets the active options of the ribbon. Can be copied, modified and set with setRibbonOptions
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Returns: the active ribbon options
         *-----------------------------------------------------------------------------------------------**/
        const NDEVRRibbonOptions& options() const { return m_ribbon_options; };
 
        /**--------------------------------------------------------------------------------------------------
        Fn: void NDEVRRibbon::setRibbonOptions(const NDEVRRibbonOptions& options)
 
        Sets the ribbon options and immidiately refreshes the widget
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Parameters:
        options -  The options to apply to the ribbon
         *-----------------------------------------------------------------------------------------------**/
        void setRibbonOptions(const NDEVRRibbonOptions& options);
 
        /**--------------------------------------------------------------------------------------------------
        Fn: Ribbon* NDEVRRibbon::ribbon() const
 
        Gets the underlying ribbon object used for this widget
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Returns: a copy of the buffer.
         *-----------------------------------------------------------------------------------------------**/
        Ribbon* ribbon() const { return m_ribbon; }
 
        /**--------------------------------------------------------------------------------------------------
        Fn: void NDEVRRibbon::addButtonToGeneralFile(Button* button, bool disable_with_no_project)
 
        Adds a button to the general/home tab. Button is disabled or enabled automatically based on the
        disable_with_no_project flag
 
        Author: Tyler Parke
 
        Date: 2020-05-21
 
        Parameters:
        button -  The button to add to the ribbon
        disable_with_no_project - if true, button will be disabled until a project is loaded or created
         *-----------------------------------------------------------------------------------------------**/
        void addButtonToGeneralHome(Button* button, bool disable_with_no_project);
 
        /**--------------------------------------------------------------------------------------------------
        Fn: void NDEVRRibbon::addButtonToGeneralFile(Button* button, bool disable_with_no_project)
 
        Adds a button to the general/file tab. Button is disabled or enabled automatically based on the 
        disable_with_no_project flag
 
        Author: Tyler Parke
 
        Date: 2020-05-21
 
        Parameters:
        button -  The button to add to the ribbon
        disable_with_no_project - if true, button will be disabled until a project is loaded or created
         *-----------------------------------------------------------------------------------------------**/
        void addButtonToGeneralFile(Button* button, bool disable_with_no_project);
 
        /**--------------------------------------------------------------------------------------------------
        Fn: RibbonGroup* NDEVRRibbon::homeRibbonGroup() const
 
        Gets the ribbon group for objects on the "home" tab
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Returns: the "home" tab ribbon group
         *-----------------------------------------------------------------------------------------------**/
        RibbonGroup* homeRibbonGroup();
 
        /**--------------------------------------------------------------------------------------------------
        Fn: RibbonSubGroup* NDEVRRibbon::homeFileRibbonSubGroup() const
 
        Gets the ribbon sub-group for objects on the "home/file" tab. Note buttons should be generally be 
        added with "addButtonToGeneralFile" and not this function
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Returns: the "home/file" tab ribbon subgroup
         *-----------------------------------------------------------------------------------------------**/
        RibbonSubGroup* homeFileRibbonSubGroup();
 
        /**--------------------------------------------------------------------------------------------------
        Fn: RibbonSubGroup* NDEVRRibbon::homeGeneralRibbonSubGroup() const
 
        Gets the ribbon sub-group for objects on the "home/general" tab. Note buttons should be generally be
        added with "addButtonToGeneralHome" and not this function
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Returns: the "home/general" tab ribbon subgroup
         *-----------------------------------------------------------------------------------------------**/
        RibbonSubGroup* homeGeneralRibbonSubGroup();
 
        /**--------------------------------------------------------------------------------------------------
        Fn: RibbonGroup* NDEVRRibbon::homeRibbonGroup() const
 
        Gets the ribbon group for objects on the "edit" tab
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Returns: the "edit" tab ribbon group
         *-----------------------------------------------------------------------------------------------**/
        RibbonGroup* editRibbonGroup();
 
        /**--------------------------------------------------------------------------------------------------
        Fn: void NDEVRRibbon::setSceneVisible(bool visible)
 
        To be called by WindowManager when a scene is added or removed from the program
 
        Author: Tyler Parke
 
        Date: 2023-01-16
 
        Parameters:
        scene_visible - Whether the scene is visible
         *-----------------------------------------------------------------------------------------------**/
        void setSceneVisible(bool scene_visible);
        
        /**--------------------------------------------------------------------------------------------------
        Fn: void NDEVRRibbon::setup()
 
        To be called by WindowManager when UI is ready to be displayed
 
        Author: Tyler Parke
 
        Date: 2023-01-16
         *-----------------------------------------------------------------------------------------------**/
        void setup();
        
        /**--------------------------------------------------------------------------------------------------
        Fn: void NDEVRRibbon::setMainButtonCallback(const std::function<void(const PopupInfo&)>& main_callback)
 
        Defines whether buttons are layed out horizontally, or vertically. Typically called by windowmanager based
        on application vertical or horizontal mode
 
        Author: Tyler Parke
 
        Date: 2020-05-21
 
        Parameters:
        is_vertical -  Use to set whether or not the ribbon is vertical
         *-----------------------------------------------------------------------------------------------**/
        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 String& 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;
        QTModelManager* m_model_manager;
        WindowManager* m_window_manager;
        MainWindow* m_main_window;
        SnapsEditorWidget* m_snaps_dock;
        LayerWidget* m_layer_tools_dock;
        QWidget* m_main_button_widget;
        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_generate_reports = nullptr;
        Button* m_exit_button = nullptr;
        Button* m_wifi_button = nullptr;
        //Button* m_rotate_ui_button = nullptr;
 
        Buffer<Button*> m_disable_with_no_project_buttons;
        QTResourceListener* m_command_listener;
        QTResourceListener* m_background_listener;
        std::function<void(const PopupInfo&)> m_main_button_callback;
        bool m_is_vertical;
        bool m_scene_visible;
        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;
        };
    };
}