wx_debounced_action.h

Go to the documentation of this file.

/*
 * This program source code file is part of KiCad, a free EDA CAD application.
 *
 * Copyright The KiCad Developers, see AUTHORS.txt for contributors.
 *
 * 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 2
 * 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, see <https://www.gnu.org/licenses/>.
 */
 
#pragma once
 
#include <functional>
 
#include <wx/timer.h>
 

class WX_DEBOUNCED_ACTION : public wxTimer
{
public:
    using ACTION_FN = std::function<void()>;

    WX_DEBOUNCED_ACTION( ACTION_FN aAction, int aDelayMs );

    void Restart();

    void Cancel();

    constexpr static int TEXT_INPUT_DEBOUNCE_MS = 200;
    constexpr static int HOVER_PREVIEW_DEBOUNCE_MS = 400;
 
protected:
    void Notify() override;
 
private:
    ACTION_FN m_action;
    int       m_delayMs;
};