QtNovelUI/libSplitView/splitview_interface.h

#ifndef SPLITVIEW_INTERFACE_H
#define SPLITVIEW_INTERFACE_H

#include <QtCore/qglobal.h>

#if defined(SPLITVIEW_LIBRARY)
#  define SPLITVIEW_EXPORT Q_DECL_EXPORT
#else
#  define SPLITVIEW_EXPORT Q_DECL_IMPORT
#endif

#include <QWidget>

namespace split_frame {
    class SplitView;
    class ResManager;

    /**
     * @brief 面板分割方向
     */
    enum class SplitType { SPLIT_H = 0, SPLIT_V = 1 };
    /**
     * @brief 临时视图贴附方位
     */
    enum class DockType { LEFT = 0, RIGHT = 1, TOP = 2, BOTTOM = 3 };

    /**
     * @brief 视图资源基类
     */
    class ViewRes {
    public:
        virtual ~ViewRes() = default;
        /**
         * @brief 资源管理实例
         * @return
         */
        virtual ResManager *splitManager() const = 0;

        /**
         * @brief 父资源实例
         * @return
         */
        virtual ViewRes *parentRes() const = 0;
        virtual void setParentRes(ViewRes *inst) = 0;

        /**
         * @brief 视图组件
         * @return
         */
        virtual QWidget *widget() const = 0;

        /**
         * @brief 可以被回收
         */
        virtual bool canRetrieve() const = 0;

        /**
         * @brief 可以被关闭
         */
        virtual bool canClose() const = 0;

        /**
         * @brief canReplace
         * @return
         */
        virtual bool canReplace() const = 0;
    };

    /**
     * @brief 视图展示接口
     */
    class ViewBase : public ViewRes {
    public:
        virtual ~ViewBase() = default;

        /**
         * @brief 视图图标
         * @return
         */
        virtual QIcon icon() const = 0;
        /**
         * @brief 视图标题
         * @return
         */
        virtual QString title() const = 0;

        /**
         * @brief 获取外形尺寸
         * @return
         */
        virtual QSizeF viewSize() const = 0;
        /**
         * @brief 重新设置外形尺寸
         * @param outline
         */
        virtual void resizeView(const QSizeF &outline) = 0;
    };

    /**
     * @brief 分裂视图规划和约束组件
     */
    class SplitView : public ViewBase {
    public:
        virtual ~SplitView() = default;

        /**
         * @brief 替换子视图
         * @param view
         * @param old
         */
        virtual void replaceComp(ViewBase *view, ViewBase *old) = 0;

        /**
         * @brief 设置分割信息
         * @param type
         * @param pos
         * @param width
         */
        virtual void setSplitInfo(SplitType type, float pos, float width) = 0;

        /**
         * @brief 获取子视图列表和分割方式
         * @return
         */
        virtual std::tuple<ViewBase *, ViewBase *, SplitType> child() const = 0;
        /**
         * @brief 分隔符的宽度
         * @return
         */
        virtual float splitterWidth() const = 0;
        /**
         * @brief 获取分隔符位置：百分比表示
         * @return
         */
        virtual float splitterPos() const = 0;
    };

    /**
     * @brief 视图自由状态监听器
     */
    class FreedomViewsListener {
    public:
        virtual ~FreedomViewsListener() = default;
        /**
         * @brief 闲置视图增加
         * @param ins
         */
        virtual void freedomAppended(ViewBase *ins) = 0;
        /**
         * @brief 闲置视图减少
         * @param ins
         */
        virtual void freedomRemoved(ViewBase *ins) = 0;
    };

    /**
     * @brief 资源管理器接口
     */
    class ResManager {
    public:
        virtual ~ResManager() = default;

        virtual void addListener(FreedomViewsListener *lsn) = 0;
        virtual void removeListener(FreedomViewsListener *lsn) = 0;

        /**
         * @brief 在系统中移除指定视图
         * @param inst
         */
        virtual void removePresentView(ViewBase *inst) = 0;
        /**
         * @brief 在系统中添加指定视图
         * @param inst
         */
        virtual void appendPresentView(ViewBase *inst) = 0;

        /**
         * @brief 回收视图显示，转换视图为自由（闲置）状态
         * @param inst
         */
        virtual void doRetrieve(ViewRes *inst);

        /**
         * @brief 回收视图，清除内存实例
         */
        virtual void doClose(ViewRes *inst) = 0;

        /**
         * @brief 替换指定视图
         * @param view
         * @param old
         */
        virtual void doReplace(ViewRes *view, ViewRes *old) = 0;
    };

} // namespace SplitFrame

#endif // SPLITVIEW_INTERFACE_H