listbox.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_LISTBOX_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_LISTBOX_HPP_
 
// Standard library includes
#include <list>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/listeners/keylistener.hpp"
#include "fifechan/listeners/mouselistener.hpp"
#include "fifechan/listmodel.hpp"
#include "fifechan/widget.hpp"
 
namespace fcn
{
    class SelectionListener;

    class FIFEGUI_API ListBox : public Widget, public MouseListener, public KeyListener
    {
        public:
            ListBox();

            explicit ListBox(ListModel* listModel);
 
            ~ListBox() override = default;
 
            ListBox(ListBox const &)            = delete;
            ListBox& operator=(ListBox const &) = delete;
            ListBox(ListBox&&)                  = delete;
            ListBox& operator=(ListBox&&)       = delete;

            int getSelected() const;

            void setSelected(int selected);

            void setListModel(ListModel* listModel);

            ListModel* getListModel() const;

            bool isWrappingEnabled() const;

            void setWrappingEnabled(bool wrappingEnabled);

            void addSelectionListener(SelectionListener* selectionListener);

            void removeSelectionListener(SelectionListener* selectionListener);

            virtual unsigned int getRowHeight() const;
 
            // Inherited from Widget
 
            using Widget::resizeToContent;
 
            void resizeToContent(bool recursion = true) override;
            void adjustSize() override;
            void draw(Graphics* graphics) override;
 
            void logic() override;
 
            // Inherited from KeyListener
 
            void keyPressed(KeyEvent& keyEvent) override;
 
            // Inherited from MouseListener
 
            void mousePressed(MouseEvent& mouseEvent) override;
 
            void mouseWheelMovedUp(MouseEvent& mouseEvent) override;
 
            void mouseWheelMovedDown(MouseEvent& mouseEvent) override;
 
            void mouseDragged(MouseEvent& mouseEvent) override;
 
        protected:
            void distributeValueChangedEvent();

            int mSelected{-1};

            ListModel* mListModel{nullptr};

            bool mWrappingEnabled{false};

            using SelectionListenerList = std::list<SelectionListener*>;

            SelectionListenerList mSelectionListeners;

            using SelectionListenerIterator = SelectionListenerList::iterator;

            void adjustSizeImpl();
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_LISTBOX_HPP_