CustomDockButton.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: Widgets
File: CustomDockButton
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/DockItem.h>
#include <functional>
class QIcon;
class QString;
class QLabel;
 
 
namespace NDEVR
{
    class ContainerWidgetBase;
    class SectionWidget;
    class SectionContent;
    class SectionIconTab;
    class FloatingWidget;
    class TranslatedString;
    class Button;
    /**--------------------------------------------------------------------------------------------------
    \brief A DockItem that represents a button. These can be placed on the Docking widget to add
        functionality. For example, in touch mode we use this class to have a "Add View" button.
    **/
    class NDEVR_WIDGETS_API CustomDockButton : public DockItem
    {
        Q_OBJECT
    public:
        explicit CustomDockButton(const TranslatedString& name, RibbonArea ribbon_area, ContainerWidgetBase* container = nullptr);
        explicit CustomDockButton(const TranslatedString& name, const std::function<void(SectionContent*)>& callback, RibbonArea ribbon_area, ContainerWidgetBase* container = nullptr);
        explicit CustomDockButton(const TranslatedString& name, const std::function<void(SectionContent*)>& callback, ContainerWidgetBase* container = nullptr);
        virtual ~CustomDockButton();
        void showButton(bool show_dock, SectionWidget* section);
        void removeButton();
        virtual void setupDialogButton(Button* button);
        void setCallback(const std::function<void(SectionContent*)>& callback);
        const std::function<void(SectionContent*)>& callback();
    private:
        virtual void createSectionContent() override;
    signals:
        void closedSignal();
    private slots:
        void onCloseButtonClicked();
        void _CustomMenuRequested(const QPoint& pos);
    private:
        std::function<void(SectionContent*)> m_callback;
    };
}