CLayoutManager.h

/*
╔══════════════════════════════════════════════════════════════════════════════╗
║                       SIMPLY POWERFUL TOOLKIT (SPTK)                         ║
╟──────────────────────────────────────────────────────────────────────────────╢
║  copyright            © 1999-2022 Alexey Parshin. All rights reserved.       ║
║  email                alexeyp@gmail.com                                      ║
╚══════════════════════════════════════════════════════════════════════════════╝
┌──────────────────────────────────────────────────────────────────────────────┐
│   This library is free software; you can redistribute it and/or modify it    │
│   under the terms of the GNU Library General Public License as published by  │
│   the Free Software Foundation; either version 2 of the License, or (at your │
│   option) any later version.                                                 │
│                                                                              │
│   This library is distributed in the hope that it will be useful, but        │
│   WITHOUT ANY WARRANTY; without even the implied warranty of                 │
│   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Library   │
│   General Public License for more details.                                   │
│                                                                              │
│   You should have received a copy of the GNU Library General Public License  │
│   along with this library; if not, write to the Free Software Foundation,    │
│   Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA.               │
│                                                                              │
│   Please report all bugs and problems to alexeyp@gmail.com.                  │
└──────────────────────────────────────────────────────────────────────────────┘
*/
 
#pragma once
 
#include <map>
#include <sptk5/Exception.h>
#include <sptk5/gui/CFrame.h>
#include <sptk5/gui/CLayoutClient.h>
#include <sptk5/xdoc/Node.h>
#include <string>
 
class Fl_Image;
 
namespace sptk {
 
using createControlCallback = CLayoutClient* (*) (const xdoc::SNode& node);
 
using createControlCallbackMap = std::map<std::string, createControlCallback>;
 
using CWidgetNamesMap = std::map<std::string, Fl_Widget*>;
 
enum class CLayoutGrowMode : uint8_t
{
    LGM_NONE = 0,
 
    LGM_HORIZONTAL_GROW = 1,
 
    LGM_VERTICAL_GROW = 2,
 
    LGM_AUTO_GROW = 3
 
};
 
class SP_EXPORT CLayoutManager
    : public CLayoutClient
{
    friend class CLayoutManagerInitializer;
 
protected:
    int m_layoutSpacing;
 
    CLayoutGrowMode m_layoutGrowMode;
 
    Fl_Group* m_group;
 
    CFrame* m_frame;
 
    bool m_frameDrawBackground;
 
    bool m_noXml;
 
 
    static std::map<std::string, Fl_Boxtype> m_boxTypeNames;
 
    static createControlCallbackMap controlCreator;
 
 
    bool autoLayout(int x, int y, int& w, int& h, bool resizeWidgets) const;
 
    virtual void paintBackground();
 
public:
    CLayoutManager(Fl_Group* group, int layoutSize, CLayoutAlign ca);
 
    ~CLayoutManager() override = default;
 
    virtual void clear();
 
    int layoutSpacing() const
    {
        return m_layoutSpacing;
    }
 
    void layoutSpacing(int ls)
    {
        m_layoutSpacing = ls;
    }
 
    void layoutGrowMode(CLayoutGrowMode gm = CLayoutGrowMode::LGM_AUTO_GROW)
    {
        m_layoutGrowMode = gm;
    }
 
    CLayoutGrowMode layoutGrowMode() const
    {
        return m_layoutGrowMode;
    }
 
    void relayout();
 
    void frame(CFrame* frame, bool drawBackground = true)
    {
        m_frame = frame;
        m_frameDrawBackground = drawBackground;
    }
 
    const CFrame* frame() const
    {
        return m_frame;
    }
 
    uint32_t frameWidth() const;
 
    virtual void loadLayout(const xdoc::SNode& node, CLayoutXMLmode xmlMode);
 
    virtual void saveLayout(const xdoc::SNode& node, CLayoutXMLmode xmlMode) const;
 
    void nameIndex(CWidgetNamesMap& index, bool recursive, bool clean = true) const;
 
    bool noXml() const
    {
        return m_noXml;
    }
 
    void noXml(bool noXml)
    {
        m_noXml = noXml;
    }
 
    static void registerControl(std::string typeName, createControlCallback creator) noexcept;
 
    static const std::map<std::string, Fl_Boxtype>& boxTypeNames();
};
} // namespace sptk