imagebutton.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_IMAGEBUTTON_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_IMAGEBUTTON_HPP_
 
// Standard library includes
#include <memory>
#include <string>
#include <vector>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/widgets/button.hpp"
 
namespace fcn
{
    class Image;

    class FIFEGUI_API ImageButton : public fcn::Button
    {
        public:
            enum class ImageType : uint8_t
            {
                Up             = 0,
                Down           = 1,
                Hover          = 2,
                Up_Inactive    = 3,
                Down_Inactive  = 4,
                Hover_Inactive = 5
            };
 
            ImageButton();

            explicit ImageButton(std::string const & filename);

            explicit ImageButton(Image const * image);
 
            ImageButton(ImageButton const &)            = delete;
            ImageButton& operator=(ImageButton const &) = delete;
            ImageButton(ImageButton&&)                  = delete;
            ImageButton& operator=(ImageButton&&)       = delete;
 
            ~ImageButton() override;

            void setUpImage(std::string const & filename);

            void setUpImage(Image const * image);

            Image const * getUpImage() const;

            void setDownImage(std::string const & filename);

            void setDownImage(Image const * image);

            Image const * getDownImage() const;

            void setHoverImage(std::string const & filename);

            void setHoverImage(Image const * image);

            Image const * getHoverImage() const;

            void setInactiveUpImage(std::string const & filename);

            void setInactiveUpImage(Image const * image);

            Image const * getInactiveUpImage() const;

            void setInactiveDownImage(std::string const & filename);

            void setInactiveDownImage(Image const * image);

            Image const * getInactiveDownImage() const;

            void setInactiveHoverImage(std::string const & filename);

            void setInactiveHoverImage(Image const * image);

            Image const * getInactiveHoverImage() const;
 
            // Inherited from Widget

            void resizeToContent(bool recursion = true) override;

            void adjustSize() override;

            void draw(fcn::Graphics* graphics) override;
 
        protected:
            void adjustSizeImpl() override; // cppcheck-suppress virtualCallInConstructor

            void setImage(std::string const & filename, ImageType type);

            void setImage(Image const * image, ImageType type);

            std::vector<Image const *> mImages;

            std::vector<std::unique_ptr<Image const>> mOwnedImages;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_IMAGEBUTTON_HPP_