language-servers/slint
1
0
Fork 0
mirror of https://github.com/slint-ui/slint.git synced 2025-11-03 05:12:55 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Sync python timer docs

Browse source 
Sync with commit 6aff60b38f
This commit is contained in:
Simon Hausmann 2025-03-22 11:58:34 +01:00
parent 072bff8c42
commit fc18b69a65
1 changed files with 8 additions and 9 deletions
Download patch file Download diff file Expand all files Collapse all files

17
api/python/timer.rs
View file

@ -28,18 +28,17 @@ impl From<PyTimerMode> for i_slint_core::timers::TimerMode {
} }
} }
/// Timer is a handle to the timer system that allows triggering a callback to be called /// Timer is a handle to the timer system that triggers a callback after a specified
/// after a specified period of time. /// period of time.
/// ///
/// Use `Timer.start()` to create a timer that can repeat at frequent interval, or /// Use `Timer.start()` to create a timer that that repeatedly triggers a callback, or
/// `Timer.single_shot()` if you just want to call a function with a delay and do not /// [`Timer::single_shot`] to trigger a callback only once.
/// need to be able to stop it.
/// ///
/// The timer will automatically stop when garbage collected. You must keep the Timer object /// The timer will automatically stop when garbage collected. You must keep the Timer object
/// around for as long as you want the timer to keep firing. /// around for as long as you want the timer to keep firing.
/// ///
/// The timer can only be used in the thread that runs the Slint event loop. /// Timers can only be used in the thread that runs the Slint event loop. They don't
/// They will not fire if used in another thread. /// fire if used in another thread.
#[gen_stub_pyclass] #[gen_stub_pyclass]
#[pyclass(name = "Timer", unsendable)] #[pyclass(name = "Timer", unsendable)]
pub struct PyTimer { pub struct PyTimer {
@ -59,7 +58,7 @@ impl PyTimer {
/// ///
/// Arguments: /// Arguments:
/// * `mode`: The timer mode to apply, i.e. whether to repeatedly fire the timer or just once. /// * `mode`: The timer mode to apply, i.e. whether to repeatedly fire the timer or just once.
/// * `interval`: The duration from now until when the timer should fire. And the period of that timer /// * `interval`: The duration from now until when the timer should firethe first time, and subsequently
/// for `TimerMode.Repeated` timers. /// for `TimerMode.Repeated` timers.
/// * `callback`: The function to call when the time has been reached or exceeded. /// * `callback`: The function to call when the time has been reached or exceeded.
fn start( fn start(
@ -79,7 +78,7 @@ impl PyTimer {
Ok(()) Ok(())
} }
/// Starts the timer with the duration, in order for the callback to called when the /// Starts the timer with the duration and the callback to called when the
/// timer fires. It is fired only once and then deleted. /// timer fires. It is fired only once and then deleted.
/// ///
/// Arguments: /// Arguments: