iconprogressbar.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_ICONPROGRESSBAR_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_ICONPROGRESSBAR_HPP_
 
// Standard library includes
#include <string>
#include <vector>
 
// Project headers (subdirs before local)
#include <fifechan/widget.hpp>
 
namespace fcn
{
    class Graphics;
    class Image;

    class FIFEGUI_API IconProgressBar : public Widget
    {
        public:
            enum class Orientation : uint8_t
            {
                Horizontal = 0,
                Vertical
            };

            IconProgressBar();

            IconProgressBar(Image* image, int maxIcons);

            IconProgressBar(std::string const & filename, int maxIcons);
 
            ~IconProgressBar() override;
 
            IconProgressBar(IconProgressBar const &)            = delete;
            IconProgressBar& operator=(IconProgressBar const &) = delete;
            IconProgressBar(IconProgressBar&&)                  = delete;
            IconProgressBar& operator=(IconProgressBar&&)       = delete;

            void draw(Graphics* graphics) override;

            void setOpaque(bool opaque);

            bool isOpaque() const;

            void setImage(Image* image);

            Image const * getImage() const;

            void setMaxIcons(int maxIcons);

            int getMaxIcons() const;

            void setOrientation(Orientation orientation);

            Orientation getOrientation() const;

            void advance();

            void reset();

            void setIconCount(int icons);

            int getIconCount() const;
 
            // Inherited from Widget
 
            using Widget::resizeToContent;
 
            void resizeToContent(bool recursion = true) override;
            void adjustSize() override;
 
        protected:
            void adjustSizeImpl();

            Image const * mImage;

            bool mInternalImage{false};

            int mMaxIcons{0};

            int mIconCounter{0};

            Orientation mOrientation{Orientation::Horizontal};

            bool mOpaque{true};
    };
}; // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_ICONPROGRESSBAR_HPP_