QCustomDockWidget.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: QCustomDockWidget
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/UUID.h>
#include <NDEVR/Buffer.h>
#include <NDEVR/DockItem.h>
#include <NDEVR/ContainerWidget.h>
#include <NDEVR/PopupInfo.h>
#include <QFrame>
#include <QPointer>
class QIcon;
class QString;
class QLabel;
 
 
namespace NDEVR
{
    enum DropArea;
    enum class RibbonArea;
    class ContainerWidgetBase;
    class SectionWidget;
    class SectionContent;
    class SectionIconTab;
    class FloatingWidget;
    class Button;
    /**--------------------------------------------------------------------------------------------------
    \brief Provides a wrapper for a widget that can be docked inside a Container or floated as a 
        top-level window within the application.
    **/
    class NDEVR_WIDGETS_API QCustomDockWidget : public DockItem
    {
        Q_OBJECT
    public:
        explicit QCustomDockWidget(RibbonArea ribbon_area, ContainerWidgetBase* container = nullptr);
        explicit QCustomDockWidget(QWidget* main_widget, RibbonArea ribbon_area, ContainerWidgetBase* container = nullptr);
        explicit QCustomDockWidget(QWidget* main_widget, ContainerWidgetBase* container = nullptr);
        virtual ~QCustomDockWidget();
        void setMainWidget(QWidget* widget);
        QWidget* mainWidget() { return m_main_widget; }
        QString windowTitle() const;
        void setSize(QSize size);
        SectionContent* content() const { return m_section_content; }
        void showDock(bool show_dock);
        void removeDock(bool delete_when_finished);
        bool isVisible() const;
        void setupButton(Button* button);
        void showDockFullscreen(bool show_dock, const PopupInfo& start_location = PopupInfo());
        void showDock(bool show_dock, DropArea area, SectionWidget* section);
        void showDock(bool show_dock, const PopupInfo& start_location, SectionWidget* section = nullptr);
        void showDock(bool show_dock, const PopupInfo& start_location, const PopupInfo& end_location, SectionWidget* section = nullptr);
        QSize sizeHint() const;
        void setSizeHint(const QSize& size);
        bool isDockFullscreen() const;
        virtual void setDockSelected(bool selected) override;
        virtual void setIcon(const QIcon& icon) override;
        QIcon icon() const;
        virtual void setTitle(const TranslatedString& title) override;
        virtual void setupDialogButton(Button* button);
        virtual void removeButton(Button* button);
        void setWindowFlags(Qt::WindowFlags type);
        void setWindowFlag(Qt::WindowType type, bool on = true);
        int width() const;
        int height() const;
        void setVisible(bool visible);
        void setAllowAutoHideTitle(bool allow_auto_hide);
    public slots:
        void highlightDock(bool highlight);
        void setIconSlot(const QIcon& icon);
        void setTitleSlot(const QString& title);
    signals:
        void closedSignal();
        void minimizedSignal();
        void fullscreenSignal(bool is_fullscreen);
        void dockSelectedSignal(bool);
        void windowTitleChanged(const TranslatedString& new_title);
        void windowIconChanged(const QIcon& icon);
    protected slots:
        void onFullscreenButtonClicked(bool fullscreen);
        void onCloseButtonClicked();
    protected:
        virtual void createSectionContent() override;
    protected:
        QPointer<QWidget> m_main_widget;
        Buffer<Button*> m_buttons_to_add;
        bool m_highlight_dock;
        QSize m_size_hint;
    };
 
    template<class t_type>
    class DockWidget : public QCustomDockWidget
    {
    public:
        DockWidget(ContainerWidgetBase* container = nullptr)
            : QCustomDockWidget(new t_type(), container)
        {}
        DockWidget(t_type* child, ContainerWidgetBase* container = nullptr)
            : QCustomDockWidget(child, container)
        {}
        DockWidget(t_type* child, RibbonArea ribbon_area, ContainerWidgetBase* container = nullptr)
            : QCustomDockWidget(child, ribbon_area, container)
        {}
        t_type& widget() const
        {
            return *dynamic_cast<t_type*>(m_main_widget.data());
        }
    };
}