SectionContent.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: SectionContent
Included in API: True
Author(s): Tyler Parke
 *-----------------------------------------------------------------------------------------**/
#pragma once
#include "DLLInfo.h"
#include <NDEVR/ButtonDialog.h>
#include <NDEVR/RibbonArea.h>
#include <NDEVR/UUID.h>
#include <NDEVR/TranslatedString.h>
#include <functional>
class QWidget;
 
namespace NDEVR
{
    class SectionTab;
    class ContainerWidgetBase;
    class FloatingWidget;
    /**--------------------------------------------------------------------------------------------------
    \brief The core container for objects using the NDEVR API Widget Docking system. Contains information
        used to correctly display the content.
    **/
    class NDEVR_WIDGETS_API SectionContent : public ButtonDialog
    {
        friend class ContainerWidgetBase;
    private:
        SectionContent(const SectionContent&) = delete;
        SectionContent(SectionContent&&) noexcept;
        SectionContent& operator=(const SectionContent&) = delete;
    public:
        SectionContent(ContainerWidgetBase* container, SectionTab* title, QWidget* content, RibbonArea prefered_ribbon_area);
        SectionContent(ContainerWidgetBase* container, SectionTab* title, const std::function<void(SectionContent*)>& function, RibbonArea prefered_ribbon_area);
        virtual ~SectionContent();
        void onCheckedClick() override;
        void setContainer(ContainerWidgetBase* container);
        void setSectionWidget(SectionWidget* widget);
        void setFloatingWidget(FloatingWidget* widget);
        const TranslatedString& title() const { return m_title; }
        void setTitle(const TranslatedString& title) { m_title = title; }
        SectionWidget* sectionWidget() const { return m_section_widget; }
        FloatingWidget* floatingWidget() const { return m_floating_widget; }
        UUID uid() const;
        ContainerWidgetBase* containerWidget() const;
        SectionTab* sectionTab() const;
        QWidget* contentWidget() const;
        void setContentWidget(QWidget* widget);
        RibbonArea preferredRibbonArea() const { return m_prefered_ribbon_area; }
        void setPreferredRibbonArea(RibbonArea area);
        const std::function<void(SectionContent*)>& specialCallback() { return m_special_callback; }
        bool hasSpecialCallback() const { return m_special_callback != nullptr; }
        void setSpecialCallback(const std::function<void(SectionContent*)>& callback) { m_special_callback = callback; }
        void runSpecialCallback() { m_special_callback(this); }
        void setAllowHide(bool allow_hide) { m_allow_hide = allow_hide; }
        bool allowHide() const { return m_allow_hide; }
        void setAllowAutoHideTitle(bool allow_hide) { m_allow_auto_hide_title = allow_hide; }
        bool allowAutoHideTitle() const { return m_allow_auto_hide_title; }
        void retranslate();
    private:
        const UUID m_uid;
        ContainerWidgetBase* m_container_widget;
        SectionTab* m_title_widget;
        SectionWidget* m_section_widget;
        FloatingWidget* m_floating_widget;
        std::function<void(SectionContent*)> m_special_callback;
        QWidget* m_widget;
        // Optional attributes
        TranslatedString m_title;
        RibbonArea m_prefered_ribbon_area;
        bool m_allow_hide;
        bool m_allow_auto_hide_title = false;
    };
}