button.h

/*
 * Copyright 2007-2025, RTE (https://www.rte-france.com)
 * See AUTHORS.txt
 * SPDX-License-Identifier: MPL-2.0
 * This file is part of Antares-Simulator,
 * Adequacy and Performance assessment for interconnected energy networks.
 *
 * Antares_Simulator is free software: you can redistribute it and/or modify
 * it under the terms of the Mozilla Public Licence 2.0 as published by
 * the Mozilla Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Antares_Simulator 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
 * Mozilla Public Licence 2.0 for more details.
 *
 * You should have received a copy of the Mozilla Public Licence 2.0
 * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
 */
#ifndef __ANTARES_TOOLBOX_COMPONENTS_BUTTON_BUTTON_H__
#define __ANTARES_TOOLBOX_COMPONENTS_BUTTON_BUTTON_H__
 
#include <yuni/yuni.h>
#include <wx/bitmap.h>
#include <ui/common/component/panel.h>
#include <vector>
 
namespace Antares::Component
{
class Button final: public Panel
{
public:
    using OnClick = Yuni::Bind<void(void*)>;
    using OnPopupMenu = Yuni::Bind<void(Button&, wxMenu&, void*)>;
    using Vector = std::vector<Button*>;
 
    enum ClickBehavior
    {
        clkDefault,
        clkDropdown,
        clkMenu,
    };
 
public:
 
 
    Button(wxWindow* parent, const wxString& caption);
    Button(wxWindow* parent, const wxString& caption, const char* bitmap);
    Button(wxWindow* parent, const wxString& caption, const char* bitmap, const OnClick& onclick);
 
    template<class T>
    Button(wxWindow* parent,
           const wxString& caption,
           const char* bitmap,
           T* object,
           void (T::*method)(void*));
 
    virtual ~Button();
 
 
    const wxString& caption() const;
    void caption(const wxString& rhs);
    void caption(const wxChar* rhs);
 
 
    void image(const char* filename);
 
 
    bool enabled() const;
    void enabled(bool value);
 
 
    void* userdata() const;
    void userdata(void* v);
 
 
    bool dropDown() const;
    void dropDown(bool rhs);
 
 
    bool menu() const;
    void menu(bool rhs);
 
 
    bool pushed() const;
    void pushed(bool v);
 
    bool autoToggle() const;
    void autoToggle(bool v);
 
    void pushedColor(uint r, uint g, uint b);
    void pushedColor(const wxColour& color);
    void pushedColor(const wxWindow* wnd);
 
 
    bool bold() const;
    void bold(bool value);
 
 
    void hover(bool value);
    bool hover() const;
 
    template<class T>
    void onPopupMenu(const T* object, void (T::*method)(Button&, wxMenu&, void*));
    void onPopupMenu(const OnPopupMenu& popup);
 
    template<class T>
    void onClick(const T* object, void (T::*method)(void*));
 
    void disconnectClickEvent();
 
    virtual void onMouseClick() override;
 
    virtual void onMouseEnter() override;
    virtual void onMouseLeave() override;
 
    virtual void onMouseUp(wxMouseEvent& evt) override;
 
protected:
    void loadIconFromResource(const char* filename);
    void precalculateCoordinates();
    void internalClick();
 
    void onDraw(wxPaintEvent& evt);
 
    void onEraseBackground(wxEraseEvent&)
    {
    }
 
    // (may lead to SegV otherwise)
    virtual bool triggerMouseClickEvent() const override
    {
        return false;
    }
 
private:
    wxString pCaption;
    OnClick pOnClick;
    OnPopupMenu pOnPopup;
    void* pUserData;
    wxBitmap* pIcon;
    ClickBehavior pClickBehavior;
 
    int pRecommendedWidth;
    int pMiddleWidth;
    bool pSelected;
    bool pPushed;
    bool pAutoToggle;
    bool pBold;
    bool pHover;
 
    wxColour pColorOverridePushed;
 
    wxSize pCaptionExtent;
    // Event table
    DECLARE_EVENT_TABLE()
 
}; // class Button
 
} // namespace Antares::Component
 
#include "button.hxx"
 
#endif // __ANTARES_TOOLBOX_COMPONENTS_BUTTON_BUTTON_H__