DockItem.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: DockItem
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/RibbonArea.h>
 
#include <NDEVR/UUID.h>
#include <NDEVR/TranslatedString.h>
#include <QObject>
#include <QIcon>
#include <QPointer>
namespace NDEVR
{
    class ContainerWidgetBase;
    class SectionWidget;
    class SectionContent;
    class SectionIconTab;
    class FloatingWidget;
    class Button;
 
    /**--------------------------------------------------------------------------------------------------
    \brief The root class that allows iterface with the NDEVR API Widget Docking system.
    **/
    class NDEVR_WIDGETS_API DockItem : public QObject
    {
    public:
        explicit DockItem(RibbonArea ribbon_area, ContainerWidgetBase* container = nullptr);
        explicit DockItem(ContainerWidgetBase* container = nullptr);
        virtual ~DockItem();
        
        void setRibbonArea(RibbonArea ribbon_area);
        void setDockArea(DropArea drop_area, SectionWidget * section);
        SectionIconTab* titleWidget() const;
        ContainerWidgetBase* container() const;
        SectionWidget* section() const;
        FloatingWidget* floatingWidget() const;
        virtual void setContainer(ContainerWidgetBase* container);
        virtual void swapWith(DockItem* other_widget);
        void setClosable(bool closable);
        void setHidable(bool hidable);
        void setWindowable(bool hidable);
        void setShowTab(bool show_tab);
        void setMoveable(bool movable);
        bool isDocked() const;
        bool isDockVisible() const;
        void setTabFlat(bool flat);
        void moveTabToEnd();
        void moveTabToStart();
        bool isClosable() const { return m_is_closable; }
        bool isHidable() const  { return m_is_hidable; }
        bool isWindowable() const { return m_is_windowable; }
        bool isMovable() const;
        bool showTab() const;
        bool useTabTitle() const;
        virtual void setUseTabTitle(bool use_tab_title);
        virtual void setDockSelected(bool selected);
        bool isDockSelected() const { return m_is_selected; }
        virtual void setIcon(const QIcon& icon);
        virtual void setIconID(const String& icon);
        virtual void setTitle(const TranslatedString& title);
        virtual const TranslatedString& title() const { return m_title; }
    protected:
        virtual void createSectionContent();
        virtual void initialize();
 
        UUID m_uuid;
        SectionIconTab* m_icon_title;
        SectionContent* m_section_content;
        SectionWidget* m_original_section;
        RibbonArea m_prefered_ribbon_area;
 
        QPointer<ContainerWidgetBase> m_container;
        String m_icon_id;
        QIcon m_icon;
        TranslatedString m_title;
        bool m_is_closable;
        bool m_is_windowable;
        bool m_is_hidable;
        bool m_is_movable;
        bool m_is_selected;
        bool m_show_tab;
        bool m_use_tab_title;
    };
}