dropdown.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_DROPDOWN_HPP_
#define INCLUDE_FIFECHAN_WIDGETS_DROPDOWN_HPP_
 
// Standard library includes
#include <list>
#include <memory>
 
// Platform config include
#include "fifechan/platform.hpp"
 
// Project headers (subdirs before local)
#include "fifechan/focushandler.hpp"
#include "fifechan/listeners/actionlistener.hpp"
#include "fifechan/listeners/focuslistener.hpp"
#include "fifechan/listeners/keylistener.hpp"
#include "fifechan/listeners/mouselistener.hpp"
#include "fifechan/listeners/selectionlistener.hpp"
#include "fifechan/widget.hpp"
 
namespace fcn
{
    class ListBox;
    class ListModel;
    class ScrollArea;

    class FIFEGUI_API DropDown :
        public ActionListener,
        public KeyListener,
        public MouseListener,
        public FocusListener,
        public SelectionListener,
        public Widget
    {
        public:
            explicit DropDown(
                ListModel* listModel = nullptr, ScrollArea* scrollArea = nullptr, ListBox* listBox = nullptr);
 
            ~DropDown() override;
 
            DropDown(DropDown const &)            = delete;
            DropDown& operator=(DropDown const &) = delete;
            DropDown(DropDown&&)                  = delete;
            DropDown& operator=(DropDown&&)       = delete;

            int getSelected() const;

            void setSelected(int selected);

            void setListModel(ListModel* listModel);

            ListModel* getListModel() const;

            void adjustHeight();

            void addSelectionListener(SelectionListener* selectionListener);

            void removeSelectionListener(SelectionListener* selectionListener);
 
            // Inherited from Widget
 
            using Widget::resizeToContent;
 
            void resizeToContent(bool recursion = true) override;
            void adjustSize() override;
            void draw(Graphics* graphics) override;

            void setBaseColor(Color const & color) override;

            void setBackgroundColor(Color const & color) override;

            void setForegroundColor(Color const & color) override;

            void setFont(Font* font) override;

            void setSelectionColor(Color const & color) override;
 
            // Inherited from Container
 
            Rectangle getChildrenArea() override;
 
            // Inherited from FocusListener
 
            void focusLost(Event const & event) override;
 
            // Inherited from ActionListener
 
            void action(ActionEvent const & actionEvent) override;
 
            // Inherited from DeathListener

            virtual void death(Event const & event);
 
            // Inherited from KeyListener
 
            void keyPressed(KeyEvent& keyEvent) override;
 
            // Inherited from MouseListener
 
            void mousePressed(MouseEvent& mouseEvent) override;
 
            void mouseReleased(MouseEvent& mouseEvent) override;
 
            void mouseWheelMovedUp(MouseEvent& mouseEvent) override;
 
            void mouseWheelMovedDown(MouseEvent& mouseEvent) override;
 
            void mouseDragged(MouseEvent& mouseEvent) override;
 
            // Inherited from SelectionListener
 
            void valueChanged(SelectionEvent const & event) override;
 
        protected:
            virtual void drawButton(Graphics* graphics);

            virtual void dropDown();

            virtual void foldUp();

            void distributeValueChangedEvent();

            bool mDroppedDown{false};

            bool mPushed{false};

            int mFoldedUpHeight{0};

            std::unique_ptr<ScrollArea> mOwnedScrollArea;

            std::unique_ptr<ListBox> mOwnedListBox;

            ScrollArea* mScrollArea;

            ListBox* mListBox;

            bool mInternalScrollArea{false};

            bool mInternalListBox{false};

            bool mIsDragged{false};

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

            SelectionListenerList mSelectionListeners;

            using SelectionListenerIterator = SelectionListenerList::iterator;
    };
} // namespace fcn
 
#endif // INCLUDE_FIFECHAN_WIDGETS_DROPDOWN_HPP_