/* Copyright (C) 2014
* Swift Project Community / Contributors
*
* This file is part of swift Project. It is subject to the license terms in the LICENSE file found in the top-level
* directory of this distribution and at http://www.swift-project.org/license.html. No part of swift project,
* including this file, may be copied, modified, propagated, or distributed except according to the terms
* contained in the LICENSE file.
*/

//! \file

#ifndef BLACKGUI_DOCKWIDGETINFOAREA_H
#define BLACKGUI_DOCKWIDGETINFOAREA_H

#include "blackgui/blackguiexport.h"
#include "blackgui/dockwidget.h"

#include <QList>
#include <QObject>

class QMenu;
class QWidget;

namespace BlackGui
{
    //! Forward declarations
    class CInfoArea;
    namespace Components { class CEnableForDockWidgetInfoArea; }

    //! Specialized class for dock widgets serving as info area.
    //! \sa CDockWidgetInfoBar
    //! \sa CInfoArea
    class BLACKGUI_EXPORT CDockWidgetInfoArea : public CDockWidget
    {
        Q_OBJECT

    public:
        //! Constructor
        explicit CDockWidgetInfoArea(QWidget *parent = nullptr);

        //! The parent info area
        const CInfoArea *getParentInfoArea() const;

        //! The parent info area
        CInfoArea *getParentInfoArea();

        //! Is this the selected widget, means it is not floating, and the one selected
        bool isSelectedDockWidget() const;

        //! Visible widget
        bool isVisibleWidget() const;

        //! Contribute to menu
        //! \remarks made public so other classes can nest this submenu
        virtual void addToContextMenu(QMenu *contextMenu) const override;

    protected:
        //! \copydoc CDockWidget::initialFloating
        virtual void initialFloating() override;

    private:
        //! Find all embedded dock widget components. These are components marked as CDockWidgetInfoAreaComponent
        //! \remarks Only directly embedded info area components, not those of nested info areas
        QList<Components::CEnableForDockWidgetInfoArea *> findEmbeddedDockWidgetInfoAreaComponents();

        //! Nested info areas
        QList<CDockWidgetInfoArea *> findNestedInfoAreas();

        //! The parent info areas
        const QList<const CInfoArea *> findParentInfoAreas() const;
    };

} // namespace

#endif // guard