EditableList.h

Go to the documentation of this file.

// Copyright (c) 2025 Dave R. Smith.
// Malena Framework — Licensed under PolyForm Noncommercial 1.0.0; commercial use requires a paid license. See LICENSE.
 
#ifndef MALENA_EDITABLELIST_H
#define MALENA_EDITABLELIST_H
 
#pragma once
 
#include <Malena/Core/malena_export.h>
#include <Malena/Core/Core.h>
#include <Malena/Graphics/Layouts/Panel.h>
#include <Malena/Graphics/Controls/ScrollPane.h>
#include <Malena/Graphics/Controls/RectangleButton.h>
#include <functional>
#include <memory>
#include <string>
#include <vector>
 
namespace ml
{
    class MALENA_API EditableList : public Panel
    {
    public:
        enum class SelectionMode { None, Single, Multi };

        using ContentFactory = std::function<std::unique_ptr<Core>()>;
 
        EditableList();
        ~EditableList() override;   // out-of-line for the pimpl-style Row
 
        // ── Configuration ──────────────────────────────────────────────────────
        void setSelectionMode(SelectionMode mode);
        void setContentFactory(ContentFactory factory);
        void setPlaceholder(const std::string& text);   // default TextInput content
        void setShowActions(bool show);                 // per-row delete button
        void setShowAddButton(bool show);
        void setAddButtonLabel(const std::string& label);
        void setMinRows(int n);
        void setMaxRows(int n);
        void setRowHeight(float h);
 
        // ── Rows ────────────────────────────────────────────────────────────────
        int  addRow();                                  // append; returns its index
        void removeRow(int index);
        void clearRows();
        [[nodiscard]] int   rowCount() const;
        [[nodiscard]] Core* contentAt(int index) const; // the row's content widget
 
        // ── Selection ─────────────────────────────────────────────────────────--
        void setSelected(int index, bool selected);
        [[nodiscard]] std::vector<int> selectedIndices() const;
 
        // ── Text convenience (default TextInput content) ─────────────────────────
        void setValues(const std::vector<std::string>& values,
                       const std::vector<int>& selected = {});
        [[nodiscard]] std::vector<std::string> values() const;
 
        // ── Callbacks ─────────────────────────────────────────────────────────--
        void onChange(std::function<void()> cb);
 
        // ── Layout ────────────────────────────────────────────────────────────--
        void setPosition(const sf::Vector2f& pos) override;
        void setSize(const sf::Vector2f& size);
        void setVisible(bool visible) override;
 
    protected:
        // Rows live in the ScrollPane (not this Panel's child list), so mirror the
        // enabled state onto them here — fires on both direct and cascade paths.
        void onEnabledChanged(bool enabled) override;
 
    private:
        struct Row;                                      // defined in the .cpp
 
        std::unique_ptr<Core> makeContent() const;       // factory or default TextInput
        void   relayout();
        void   onSelectorClicked(Row* row);
        void   refreshSelectors();
        int    indexOf(const Row* row) const;
        void   fireChange() const;
 
        ScrollPane                        _scroll{ 10.f, 10.f };
        RectangleButton                   _addBtn;
        std::vector<std::unique_ptr<Row>> _rows;
 
        SelectionMode  _mode          = SelectionMode::Single;
        ContentFactory _contentFactory;
        std::string    _placeholder;
        std::string    _addLabel      = "+ Add";
        bool           _showActions   = true;
        bool           _showAdd       = true;
        int            _minRows        = 0;
        int            _maxRows        = 100;
        float          _rowHeight      = 34.f;
 
        std::function<void()> _onChange;
    };
 
} // namespace ml
 
#endif // MALENA_EDITABLELIST_H