RecencyPulseManager.hpp

/* -*- mode: c++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
 *
 * Copyright (C) 2025 Marco Craveiro <marco.craveiro@gmail.com>
 *
 * This program is free software; you can redistribute it and/or modify it under
 * the terms of the GNU General Public License as published by the Free Software
 * Foundation; either version 3 of the License, or (at your option) any later
 * version.
 *
 * This program 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 GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 *
 */
#ifndef ORES_QT_RECENCY_PULSE_MANAGER_HPP
#define ORES_QT_RECENCY_PULSE_MANAGER_HPP
 
#include <QTimer>
#include <QObject>
#include "ores.qt/export.hpp"
 
namespace ores::qt {
 
class ORES_QT_API RecencyPulseManager final : public QObject {
    Q_OBJECT
 
public:
    explicit RecencyPulseManager(QObject* parent = nullptr,
                                  int pulse_interval_ms = 500,
                                  int max_pulse_cycles = 6);
 
    void start_pulsing();
 
    [[nodiscard]] bool is_pulse_on() const { return pulse_state_; }
 
    [[nodiscard]] bool is_pulsing() const;
 
    void stop_pulsing();
 
signals:
    void pulse_state_changed(bool is_on);
 
    void pulsing_complete();
 
private slots:
    void on_timer_timeout();
 
private:
    QTimer* timer_;
    bool pulse_state_{false};
    int pulse_count_{0};
    int pulse_interval_ms_;
    int max_pulse_cycles_;
};
 
}
 
#endif