Skip to content

PythonQt.QtCore.QTimer · declarations 001

Back to PythonQt.QtCore.QTimer

active instance-attribute

active: Any

Qt 5 reference:

active : const bool

This boolean property is true if the timer is running; otherwise false.

This property was introduced in Qt 4.3.

Access functions:

bool isActive() const

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#active

destroyed

destroyed(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QTimer.destroyed; argument details are not documented.

interval instance-attribute

interval: int

Qt 5 reference:

interval : int

This property holds the timeout interval in milliseconds

The default value for this property is 0. A QTimer with a timeout interval of 0 will time out as soon as all the events in the window system's event queue have been processed.

Setting the interval of an active timer changes its timerId().

Access functions:

int interval() const
void setInterval(int msec)

See also singleShot.

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#interval

isActive

isActive() -> bool

X.isActive() -> bool

Supplemental documentation: Qt 5 reference:

bool QTimer::isActive() const

Returns true if the timer is running (pending); otherwise returns false.

Note: Getter function for property active.

Upstream PySide2 reference signatures (binding differences may apply):

isActive(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#isActive

isSingleShot

isSingleShot() -> bool

X.isSingleShot() -> bool

Upstream PySide2 reference signatures (binding differences may apply):

isSingleShot(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#isSingleShot

killTimer

killTimer(id: Any) -> None

X.killTimer(id)

Upstream PySide2 reference signatures (binding differences may apply):

killTimer(self, arg__1: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#killTimer

objectNameChanged

objectNameChanged(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QTimer.objectNameChanged; argument details are not documented.

remainingTime instance-attribute

remainingTime: int

Qt 5 reference:

remainingTime : const int

This property holds the remaining time in milliseconds

Returns the timer's remaining value in milliseconds left until the timeout. If the timer is inactive, the returned value will be -1. If the timer is overdue, the returned value will be 0.

This property was introduced in Qt 5.0.

Access functions:

int remainingTime() const

See also interval.

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#remainingTime

setInterval

setInterval(msec: int) -> None

X.setInterval(msec)

Upstream PySide2 reference signatures (binding differences may apply):

setInterval(self, msec: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#setInterval

setSingleShot

setSingleShot(singleShot: bool) -> None

X.setSingleShot(singleShot)

Upstream PySide2 reference signatures (binding differences may apply):

setSingleShot(self, singleShot: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#setSingleShot

setTimerType

setTimerType(atype: Any) -> None

X.setTimerType(atype)

Upstream PySide2 reference signatures (binding differences may apply):

setTimerType(self, atype: PySide2.QtCore.Qt.TimerType) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#setTimerType

singleShot

singleShot(msec: Any, timerType: Any, receiver: Any, member: Any) -> None

X.singleShot(msec, timerType, receiver, member)

Supplemental documentation: Qt 5 reference:

singleShot : bool

This property holds whether the timer is a single-shot timer

A single-shot timer fires only once, non-single-shot timers fire every interval milliseconds.

The default value for this property is false.

Access functions:

bool isSingleShot() const
void setSingleShot(bool singleShot)

See also interval and singleShot().

[static] void QTimer::singleShot(int msec, const QObject *receiver, const char *member)

This is an overloaded function.

This static function calls a slot after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The receiver is the receiving object and the member is the slot. The time interval is given in the duration object msec.

Note: This function is reentrant.

This function was introduced in Qt 5.8.

See also setSingleShot() and start().

[static] void QTimer::singleShot(int msec, Qt::TimerType timerType, const QObject *receiver, const char *member)

This is an overloaded function.

This static function calls a slot after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The receiver is the receiving object and the member is the slot. The time interval is given in the duration object msec. The timerType affects the accuracy of the timer.

Note: This function is reentrant.

This function was introduced in Qt 5.8.

See also start().

[static] template \<typename PointerToMemberFunction> void QTimer::singleShot(int msec, const QObject *receiver, PointerToMemberFunction method)

This is an overloaded function.

This static function calls a member function of a QObject after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The receiver is the receiving object and the method is the member function. The time interval is msec milliseconds.

If receiver is destroyed before the interval occurs, the method will not be called. The function will be run in the thread of receiver. The receiver's thread must have a running Qt event loop.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template \<typename PointerToMemberFunction> void QTimer::singleShot(int msec, Qt::TimerType timerType, const QObject *receiver, PointerToMemberFunction method)

This is an overloaded function.

This static function calls a member function of a QObject after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The receiver is the receiving object and the method is the member function. The time interval is msec milliseconds. The timerType affects the accuracy of the timer.

If receiver is destroyed before the interval occurs, the method will not be called. The function will be run in the thread of receiver. The receiver's thread must have a running Qt event loop.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template \<typename Functor> void QTimer::singleShot(int msec, Functor functor)

This is an overloaded function.

This static function calls functor after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The time interval is msec milliseconds.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template \<typename Functor> void QTimer::singleShot(int msec, Qt::TimerType timerType, Functor functor)

This is an overloaded function.

This static function calls functor after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The time interval is msec milliseconds. The timerType affects the accuracy of the timer.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template \<typename Functor, int> void QTimer::singleShot(int msec, const QObject *context, Functor functor)

This is an overloaded function.

This static function calls functor after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The time interval is msec milliseconds.

If context is destroyed before the interval occurs, the method will not be called. The function will be run in the thread of context. The context's thread must have a running Qt event loop.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

[static] template \<typename Functor, int> void QTimer::singleShot(int msec, Qt::TimerType timerType, const QObject *context, Functor functor)

This is an overloaded function.

This static function calls functor after a given time interval.

It is very convenient to use this function because you do not need to bother with a timerEvent or create a local QTimer object.

The time interval is msec milliseconds. The timerType affects the accuracy of the timer.

If context is destroyed before the interval occurs, the method will not be called. The function will be run in the thread of context. The context's thread must have a running Qt event loop.

Note: This function is reentrant.

This function was introduced in Qt 5.4.

See also start().

Upstream PySide2 reference signatures (binding differences may apply):

singleShot(arg__1: int, arg__2: typing.Callable) -> None
singleShot(msec: int, receiver: PySide2.QtCore.QObject, member: str) -> None
singleShot(msec: int, timerType: PySide2.QtCore.Qt.TimerType, receiver: PySide2.QtCore.QObject, member: str) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#singleShot

start

start(msec: Any) -> None

X.start(msec)

Supplemental documentation: Qt 5 reference:

[slot] void QTimer::start()

This function overloads start().

Starts or restarts the timer with the timeout specified in interval.

If the timer is already running, it will be stopped and restarted.

If singleShot is true, the timer will be activated only once.

[slot] void QTimer::start(int msec)

This is an overloaded function.

Starts or restarts the timer with a timeout of duration msec milliseconds.

If the timer is already running, it will be stopped and restarted.

If singleShot is true, the timer will be activated only once.

This function was introduced in Qt 5.8.

Upstream PySide2 reference signatures (binding differences may apply):

start(self) -> None
start(self, msec: int) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#start

stop

stop() -> None

X.stop()

Supplemental documentation: Qt 5 reference:

[slot] void QTimer::stop()

Stops the timer.

See also start().

Upstream PySide2 reference signatures (binding differences may apply):

stop(self) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#stop

timeout

timeout(*args: Any, **kwargs: Any) -> Any

Native PythonQt.QtCore.QTimer.timeout; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QTimer::timeout()

This signal is emitted when the timer times out.

Note: This is a private signal. It can be used in signal connections but cannot be emitted by the user.

See also interval, start(), and stop().

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#timeout

timerEvent

timerEvent(arg__1: Any) -> None

X.timerEvent(arg__1)

Supplemental documentation: Qt 5 reference:

[override virtual protected] void QTimer::timerEvent(QTimerEvent *e)

Reimplements: QObject::timerEvent(QTimerEvent *event).

Upstream PySide2 reference signatures (binding differences may apply):

timerEvent(self, arg__1: PySide2.QtCore.QTimerEvent) -> None

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#timerEvent

timerId

timerId() -> int

X.timerId() -> int

Supplemental documentation: Qt 5 reference:

int QTimer::timerId() const

Returns the ID of the timer if the timer is running; otherwise returns -1.

Upstream PySide2 reference signatures (binding differences may apply):

timerId(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#timerId

timerType instance-attribute

timerType: Any

Qt 5 reference:

timerType : Qt::TimerType

controls the accuracy of the timer

The default value for this property is Qt::CoarseTimer.

Access functions:

Qt::TimerType timerType() const
void setTimerType(Qt::TimerType atype)

See also Qt::TimerType.

Source: https://doc.qt.io/archives/qt-5.15/qtimer.html#timerType