CButton.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 <sptk5/gui/CIcon.h>
#include <sptk5/gui/CLayoutClient.h>
#include <sptk5/gui/CThemes.h>
#include <sptk5/sptk.h>
#include <string>
 
#include <FL/Fl_Button.H>
 
class Fl_Image;
 
namespace sptk {
 
enum class CButtonKind : uint32_t
{
    UNDEFINED_BUTTON = 0,         
    OK_BUTTON = 1,                
    CANCEL_BUTTON = 2,            
    NO_BUTTON = 4,                
    ADD_BUTTON = 8,               
    DELETE_BUTTON = 0x10,         
    EDIT_BUTTON = 0x20,           
    BROWSE_BUTTON = 0x40,         
    REFRESH_BUTTON = 0x80,        
    CALENDAR_BUTTON = 0x100,      
    OPEN_BUTTON = 0x200,          
    PRINT_BUTTON = 0x400,         
    SAVE_BUTTON = 0x800,          
    SAVE_AS_BUTTON = 0x1000,      
    COPY_BUTTON = 0x2000,         
    LEFT_BUTTON = 0x4000,         
    NEW_BUTTON = 0x8000,          
    NEXT_BUTTON = 0x10000,        
    PRINTER_BUTTON = 0x20000,     
    PRIOR_BUTTON = 0x40000,       
    RIGHT_BUTTON = 0x80000,       
    SEARCH_BUTTON = 0x100000,     
    SEND_BUTTON = 0x200000,       
    STEPLEFT_BUTTON = 0x400000,   
    STEPRIGHT_BUTTON = 0x800000,  
    VIEW_BUTTON = 0x1000000,      
    HOME_BUTTON = 0x2000000,      
    CONFIGURE_BUTTON = 0x4000000, 
    EXEC_BUTTON = 0x8000000,      
    STOP_BUTTON = 0x10000000,     
    EXIT_BUTTON = 0x20000000,     
    HELP_BUTTON = 0x40000000,     
    MAX_BUTTON = 0x40000001       
};
 
class SP_EXPORT CBaseButton
    : public Fl_Button
    , public CLayoutClient
{
    friend class CThemes;
 
    bool m_default;                                     
    CThemeButtonType m_type;                            
    CButtonKind m_kind {CButtonKind::UNDEFINED_BUTTON}; 
    Fl_Image* m_image {nullptr};                        
    CIconSize m_iconSize {CIconSize::IS_LARGE_ICON};    
 
    static void drawFocusLine(int xs, int ys, int xe, int ye);
 
protected:
    void image(CButtonKind buttonKind, CIconSize iconSize, String label = "");
 
    void draw() override;
 
    void drawFocus(bool usingTheme);
 
    int handle(int event) override;
 
    bool preferredSize(int& w, int& h) override;
 
    CBaseButton(CButtonKind kind, CLayoutAlign layoutAlign = CLayoutAlign::RIGHT, bool is_small = false,
                const char* label = nullptr, CThemeButtonType tbt = THM_BUTTON_NORMAL);
 
    CBaseButton(const char* label = nullptr, CLayoutAlign layoutAlign = CLayoutAlign::RIGHT,
                CThemeButtonType tbt = THM_BUTTON_NORMAL);
 
#ifdef __COMPATIBILITY_MODE__
    CBaseButton(CButtonKind kind, int x, int y, int w, const char* l = 0, CThemeButtonType tbt = THM_BUTTON_NORMAL);
#endif
 
public:
    void defaultButton(bool defaultBtn);
 
    bool defaultButton() const
    {
        return m_default;
    }
 
    String className() const override
    {
        return "button";
    }
 
    virtual void buttonImage(CButtonKind bkind, CIconSize iconSize = CIconSize::IS_LARGE_ICON)
    {
        image(bkind, iconSize, label());
    }
 
    virtual void buttonImage(Fl_Image* image)
    {
        m_image = image;
    }
 
    virtual const Fl_Image* buttonImage() const
    {
        return m_image;
    }
 
    const String& label() const override
    {
        return m_label;
    }
 
    void label(const String& lbl) override
    {
        m_label = lbl;
    }
};
 
class SP_EXPORT CButton
    : public CBaseButton
{
public:
#ifdef __COMPATIBILITY_MODE__
    CButton(CButtonKind kind, int x, int y, int w, const char* label = 0, CThemeButtonType tbt = THM_BUTTON_NORMAL)
        : CBaseButton(kind, x, y, w, label, tbt)
    {
    }
#endif
 
    CButton(CButtonKind kind, CLayoutAlign layoutAlign = CLayoutAlign::RIGHT, const char* label = "",
            CThemeButtonType tbt = THM_BUTTON_NORMAL)
        : CBaseButton(kind, layoutAlign, false, label, tbt)
    {
    }
 
    CButton(const char* label = "", CLayoutAlign layoutAlign = CLayoutAlign::RIGHT,
            CThemeButtonType tbt = THM_BUTTON_NORMAL)
        : CBaseButton(label, layoutAlign, tbt)
    {
    }
 
    static CLayoutClient* creator(const xdoc::SNode& node);
 
    void load(const std::shared_ptr<xdoc::Node>& node, CLayoutXMLmode xmlMode) override
    {
        load(node);
    }
 
    void load(const xdoc::SNode& node) override;
 
    void save(const std::shared_ptr<xdoc::Node>& node, CLayoutXMLmode lm = CLayoutXMLmode::LAYOUT) const override;
};
 
class SP_EXPORT CSmallButton
    : public CBaseButton
{
public:
#ifdef __COMPATIBILITY_MODE__
    CSmallButton(CButtonKind kind, int x, int y, int w, const char* label = 0)
        : CBaseButton(kind, x, y, w, label, THM_BUTTON_COMBO)
    {
    }
#endif
 
    CSmallButton(CButtonKind kind, CLayoutAlign layoutAlign = CLayoutAlign::RIGHT, const char* label = nullptr)
        : CBaseButton(kind, layoutAlign, true, label, THM_BUTTON_COMBO)
    {
    }
};
} // namespace sptk