PanelChannelsEditorFactory.hpp

Go to the documentation of this file.

#ifndef IV_UI_PANELS_EDITOR_PANELCHANNELSEDITORFACTORY_HPP
#define IV_UI_PANELS_EDITOR_PANELCHANNELSEDITORFACTORY_HPP
 
#include "channels/AbstractChannel.hpp"
#include "core/defines.hpp"
#include "ui/gui/CDialog.hpp"
#include "ui/gui/CList.hpp"
 
#include <memory>
#include <vector>
 
namespace iv::panels::channels
{
 
class PanelChannelsEditorFactory
{
public:
    struct ChannelSelectionParams
    {
        enum class eChannelSelectionType
        {
            Single,
            Multiple
        };
        eChannelSelectionType selectionType {eChannelSelectionType::Single};
 
        bool requiresSelection {false};
        bool hasClearButton {false};
 
        // List of channels
        bool getChannelsFromStaticController {false};
        std::optional<std::shared_ptr<std::vector<std::weak_ptr<iv::channels::AbstractChannel>>>> channels;
 
        // Initial selection
        std::optional<iv::types::channelId> initialSelectedChannelId {std::nullopt};
 
        // Selection callbacks
        std::optional<std::function<void(std::weak_ptr<iv::channels::AbstractChannel>)>> singleSelectionCallback {
                std::nullopt};
        std::optional<std::function<void(std::vector<std::weak_ptr<iv::channels::AbstractChannel>>)>>
                multipleSelectionCallback {std::nullopt};
        bool acceptSelectionWithDoubleClick {false};
 
        // Filter
        std::optional<std::function<bool(std::shared_ptr<iv::channels::AbstractChannel>)>> isChannelVisible {
                std::nullopt};
 
        // Add functionality to the panel
        std::string panelTitle {_("Select Channel")};
        std::optional<std::function<AbstractComponentGUI *(CList *)>> panelAddedFunctionality {std::nullopt};
    };
 
    static AbstractComponentGUI *panelSelectChannel(const ChannelSelectionParams &params);
    static bool runPanelSelectChannel(CDialog *dlgFather, const ChannelSelectionParams &params);
    static AbstractComponentGUI *buttonSelectChannel(const ChannelSelectionParams &params);
 
    static AbstractComponentGUI *
    buttonSelectChannel(std::weak_ptr<iv::channels::AbstractChannel> &channelOut,
                        const std::shared_ptr<std::vector<std::weak_ptr<iv::channels::AbstractChannel>>> &channels);
 
    static AbstractComponentGUI *buttonSelectChannelWithClear(
            std::weak_ptr<iv::channels::AbstractChannel> &channelOut,
            const std::optional<std::function<bool(std::shared_ptr<iv::channels::AbstractChannel>)>> &filter =
                    std::nullopt);
};
 
}// namespace iv::panels::channels
 
#endif//IV_UI_PANELS_EDITOR_PANELCHANNELSEDITORFACTORY_HPP