item.h

Go to the documentation of this file.

// SPDX-FileCopyrightText: 2025 Manuel Schneider
// SPDX-License-Identifier: MIT
 
#pragma once
#include <QStringList>
#include <albert/export.h>
#include <functional>
#include <vector>
 
namespace albert
{
class Icon;
 
class ALBERT_EXPORT Action final
{
public:
 
    // ///
    // /// Constructs an \ref Action with the contents initialized with the data passed.
    // /// \param id_ \copybrief id
    // /// \param text_ \copybrief text
    // /// \param function_ \copybrief function
    // /// \param hide_on_activation_ \copybrief hide_on_activation
    // ///
    // template<typename T1 = QString,
    //          typename T2 = QString,
    //          typename T3 = std::function<void()>>
    // Action(T1 &&id_,
    //        T2 &&text_,
    //        T3 &&function_,
    //        bool hide_on_activation_ = true) noexcept :
    //     id(std::forward<T1>(id_)),
    //     text(std::forward<T2>(text_)),
    //     function(std::forward<T3>(function_)),
    //     hide_on_activation(hide_on_activation_)
    // {}
 
    QString id;
 
    QString text;
 
    std::function<void()> function;
 
    bool hide_on_activation = true;
};
 
 
class ALBERT_EXPORT Item
{
public:
 
    virtual ~Item();
 
    virtual QString id() const = 0;
 
    virtual QString text() const = 0;
 
    virtual QString subtext() const = 0;
 
    virtual QString inputActionText() const;
 
    virtual std::unique_ptr<Icon> icon() const = 0;
 
    virtual std::vector<Action> actions() const;
 
    class Observer
    {
    public:
 
        virtual void notify(const albert::Item *item) = 0;
 
    protected:
 
        virtual ~Observer();
    };
 
    virtual void addObserver(Observer *observer);
 
    virtual void removeObserver(Observer *observer);
 
};
 
namespace detail
{
class ALBERT_EXPORT DynamicItem : public Item
{
public:
 
    DynamicItem();
    ~DynamicItem() override;
 
    void dataChanged() const;
 
    void addObserver(Observer *) override;
    void removeObserver(Observer *) override;
 
private:
 
    class Private;
    std::unique_ptr<Private> d;
 
};
}
 
template<typename T>
concept ItemPtr
    = std::is_base_of_v<Item, typename std::decay_t<T>::element_type>
      && std::same_as<std::shared_ptr<typename std::decay_t<T>::element_type>, std::decay_t<T>>;
 
template<typename R>
concept ItemRange = std::ranges::range<R> && ItemPtr<std::ranges::range_value_t<R>>;
 
}  // namespace albert