1
0
Fork 0
mirror of https://github.com/juce-framework/JUCE.git synced 2026-01-10 23:44:24 +00:00
JUCE/modules/juce_events/timers/juce_TimedCallback.h

64 lines
1.8 KiB
C++

/*
==============================================================================
This file is part of the JUCE library.
Copyright (c) 2022 - Raw Material Software Limited
JUCE is an open source library subject to commercial or open-source
licensing.
By using JUCE, you agree to the terms of both the JUCE 7 End-User License
Agreement and JUCE Privacy Policy.
End User License Agreement: www.juce.com/juce-7-licence
Privacy Policy: www.juce.com/juce-privacy-policy
Or: You may also use this code under the terms of the GPL v3 (see
www.gnu.org/licenses).
JUCE IS PROVIDED "AS IS" WITHOUT ANY WARRANTY, AND ALL WARRANTIES, WHETHER
EXPRESSED OR IMPLIED, INCLUDING MERCHANTABILITY AND FITNESS FOR PURPOSE, ARE
DISCLAIMED.
==============================================================================
*/
namespace juce
{
/** Utility class wrapping a single non-null callback called by a Timer.
You can use the usual Timer functions to start and stop the TimedCallback. Deleting the
TimedCallback will automatically stop the underlying Timer.
With this class you can use the Timer facility without inheritance.
@see Timer
@tags{Events}
*/
class TimedCallback final : private Timer
{
public:
/** Constructor. The passed in callback must be non-null. */
explicit TimedCallback (std::function<void()> callbackIn)
: callback (std::move (callbackIn))
{
jassert (callback);
}
/** Destructor. */
~TimedCallback() noexcept override { stopTimer(); }
using Timer::startTimer;
using Timer::startTimerHz;
using Timer::stopTimer;
using Timer::isTimerRunning;
using Timer::getTimerInterval;
private:
void timerCallback() override { callback(); }
std::function<void()> callback;
};
} // namespace juce