button.hpp

// SPDX-License-Identifier: LGPL-2.1-or-later OR BSD-3-Clause
// SPDX-FileCopyrightText: 2004 - 2008 Olof Naessén and Per Larsson
// SPDX-FileCopyrightText: 2013 - 2026 Fifengine contributors
 
#ifndef INCLUDE_FIFECHAN_WIDGETS_BUTTON_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_BUTTON_HPP_
 
// Standard library includes
#include <string>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/events/mouseevent.hpp"
#include "fifechan/graphics.hpp"
#include "fifechan/listeners/focuslistener.hpp"
#include "fifechan/listeners/keylistener.hpp"
#include "fifechan/listeners/mouselistener.hpp"
#include "fifechan/listeners/widgetlistener.hpp"
#include "fifechan/widget.hpp"
 
namespace fcn
{
    class FIFEGUI_API Button :
        public Widget,
        public MouseListener,
        public KeyListener,
        public FocusListener,
        public WidgetListener
    {
        public:
            Button();

            explicit Button(std::string caption);
 
            ~Button() override;
 
            Button(Button const &)            = delete;
            Button& operator=(Button const &) = delete;
            Button(Button&&)                  = delete;
            Button& operator=(Button&&)       = delete;

            void setCaption(std::string const & caption);

            std::string const & getCaption() const;

            void setActive(bool state);

            bool isActive() const;

            void setAlignment(Graphics::Alignment alignment);

            Graphics::Alignment getAlignment() const;

            void setDownXOffset(int offset);

            int getDownXOffset() const;

            void setDownYOffset(int offset);

            int getDownYOffset() const;

            void setDownOffset(int x, int y);
 
            // Inherited from Widget
 
            using Widget::resizeToContent;
 
            void resizeToContent(bool recursion = true) override;
            void adjustSize() override;
            void draw(Graphics* graphics) override;
            void fontChanged() override;
 
            // Inherited from FocusListener
 
            void focusLost(Event const & event) override;
 
            // Inherited from MouseListener
 
            void mousePressed(MouseEvent& mouseEvent) override;
            void mouseReleased(MouseEvent& mouseEvent) override;
            void mouseEntered(MouseEvent& mouseEvent) override;
            void mouseExited(MouseEvent& mouseEvent) override;
            void mouseDragged(MouseEvent& mouseEvent) override;
 
            // Inherited from KeyListener
 
            void keyPressed(KeyEvent& keyEvent) override;
            void keyReleased(KeyEvent& keyEvent) override;
 
            // Inherited from WidgetListener
 
            void ancestorHidden(Event const & e) override;
 
        protected:
            virtual void adjustSizeImpl(); // cppcheck-suppress virtualCallInConstructor

            virtual bool isPressed() const;

            std::string mCaption;

            bool mHasMouse{false};

            bool mKeyPressed{false};

            bool mMousePressed{false};

            bool mState{true};

            Graphics::Alignment mAlignment{Graphics::Alignment::Center};

            int mXOffset{1};

            int mYOffset{1};
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_BUTTON_HPP_