spotlight.h

/*
 * Copyright 2007-2025, RTE (https://www.rte-france.com)
 * See AUTHORS.txt
 * SPDX-License-Identifier: MPL-2.0
 * This file is part of Antares-Simulator,
 * Adequacy and Performance assessment for interconnected energy networks.
 *
 * Antares_Simulator is free software: you can redistribute it and/or modify
 * it under the terms of the Mozilla Public Licence 2.0 as published by
 * the Mozilla Foundation, either version 2 of the License, or
 * (at your option) any later version.
 *
 * Antares_Simulator is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
 * Mozilla Public Licence 2.0 for more details.
 *
 * You should have received a copy of the Mozilla Public Licence 2.0
 * along with Antares_Simulator. If not, see <https://opensource.org/license/mpl-2-0/>.
 */
#ifndef __ANTARES_UI_COMMON_COMPONENT_SPOTLIGHT_SPOTLIGHT_H__
#define __ANTARES_UI_COMMON_COMPONENT_SPOTLIGHT_SPOTLIGHT_H__
 
#include <yuni/yuni.h>
#include "../panel.h"
#include <vector>
#include <yuni/core/event.h>
#include <wx/bitmap.h>
#include <wx/textctrl.h>
#include <wx/combobox.h>
#include <yuni/core/color/rgb.h>
 
#include <memory>
 
namespace Antares::Component
{
class Spotlight final: public Antares::Component::Panel, public Yuni::IEventObserver<Spotlight>
{
public:
    enum Options
    {
        optNone = 0,
        optResultsInAPopup = 1,
        optGroups = 2,
        optAutoResizeParent = 4,
        optNoSearchInput = 8,
        optBkgWhite = 16,
    };
 
    enum
    {
        defaultFlags = optResultsInAPopup | optGroups,
    };
 
// class SearchToken
#include "searchtoken.h"
 
// class IItem / Separator
#include "iitem.h"
#include "separator.h"
#include "text.h"
 
// class IProvider
#include "provider.h"
 
// class NullProvider
#include "null-provider.h"
 
public:
    static void FrameShow(wxWindow* parent,
                          IProvider::Ptr provider,
                          uint flags = optGroups,
                          uint width = 340);
 
    static void FrameClose();
 
public:
 
 
    Spotlight(wxWindow* parent, uint flags = defaultFlags);
    virtual ~Spotlight();
 
 
 
    void search(const Yuni::String& text);
 
    void search(const wxString& text);
 
    void redoResearch();
 
    void resetSearchInput();
 
    void onMapLayerChanged(const wxString* text);
 
    void onMapLayerAdded(const wxString* text);
 
    void onMapLayerRemoved(const wxString* text);
 
    void onMapLayerRenamed(const wxString* text);
 
 
    IProvider::Ptr provider() const;
    void provider(IProvider::Ptr provider);
 
 
    uint itemHeight() const;
    void itemHeight(uint h);
 
public:
    Yuni::Event<void(const IItem::VectorPtr&, const SearchToken::VectorPtr&)> onUpdateItems;
 
    void updateResults();
 
protected:
    void convertRawTextIntoSearchTokenVector(SearchToken::Vector& out, const Yuni::String& text);
 
    void createComponents(Spotlight* parent, bool input, bool results);
 
    void onInputUpdated(wxCommandEvent& evt);
 
    void onComboUpdated(wxCommandEvent& evt);
 
    void resizeParentWindow();
 
protected:
    uint pFlags;
    IProvider::Ptr pDataProvider;
    IItem::VectorPtr pResults;
    SearchToken::VectorPtr pTokens;
    Yuni::String pLastResearch;
    Yuni::Event<void(IProvider::Ptr)> pResetProvider;
    wxComboBox* pLayerFilter;
    wxTextCtrl* pEdit;
    wxWindow* pListbox;
    uint pItemHeight;
 
    // data related to frame
    int pDisplayHandle;
    wxWindow* pLayoutParent;
    // When the mini frame is above the parent control, it should not be resized
    // the frame can be resized if this variable is zero
    bool pAllowFrameResize;
 
    // keeping the sizers for some hide/show Magic depending on the number of layers
    wxBoxSizer* vz;
    wxBoxSizer* hzCombo;
 
}; // class Spotlight
 
} // namespace Antares::Component
 
#include "iitem.hxx"
#include "spotlight.hxx"
 
#endif // __ANTARES_UI_COMMON_COMPONENT_SPOTLIGHT_SPOTLIGHT_H__