Skip to content

PythonQt.QtCore.QSocketNotifier · declarations 001

Back to PythonQt.QtCore.QSocketNotifier

Exception instance-attribute

Exception: Any

Read instance-attribute

Read: Any

Write instance-attribute

Write: Any

activated

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

Native PythonQt.QtCore.QSocketNotifier.activated; argument details are not documented.

Supplemental documentation: Qt 5 reference:

[signal] void QSocketNotifier::activated(QSocketDescriptor socket, QSocketNotifier::Type type)

This signal is emitted whenever the socket notifier is enabled and a socket event corresponding to its type occurs.

The socket identifier is passed in the socket parameter.

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

Note: Signal activated is overloaded in this class. To connect to this signal by using the function pointer syntax, Qt provides a convenient helper for obtaining the function pointer as shown in this example:

connect(socketNotifier, QOverload<QSocketDescriptor, QSocketNotifier::Type>::of(&QSocketNotifier::activated),
    [=](QSocketDescriptor socket, QSocketNotifier::Type type){ /* ... */ });

This function was introduced in Qt 5.15.

See also type() and socket().

Source: https://doc.qt.io/archives/qt-5.15/qsocketnotifier.html#activated

destroyed

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

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

event

event(arg__1: Any) -> bool

X.event(arg__1) -> bool

Supplemental documentation: Qt 5 reference:

[override virtual protected] bool QSocketNotifier::event(QEvent *e)

Reimplements: QObject::event(QEvent *e).

Upstream PySide2 reference signatures (binding differences may apply):

event(self, arg__1: PySide2.QtCore.QEvent) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qsocketnotifier.html#event

isEnabled

isEnabled() -> bool

X.isEnabled() -> bool

Supplemental documentation: Qt 5 reference:

bool QSocketNotifier::isEnabled() const

Returns true if the notifier is enabled; otherwise returns false.

See also setEnabled().

Upstream PySide2 reference signatures (binding differences may apply):

isEnabled(self) -> bool

Source: https://doc.qt.io/archives/qt-5.15/qsocketnotifier.html#isEnabled

objectNameChanged

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

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

setEnabled

setEnabled(a: Any) -> None

X.setEnabled(a)

Supplemental documentation: Qt 5 reference:

[slot] void QSocketNotifier::setEnabled(bool enable)

If enable is true, the notifier is enabled; otherwise the notifier is disabled.

The notifier is enabled by default, i.e. it emits the activated() signal whenever a socket event corresponding to its type occurs. If it is disabled, it ignores socket events (the same effect as not creating the socket notifier).

Write notifiers should normally be disabled immediately after the activated() signal has been emitted

See also isEnabled() and activated().

Upstream PySide2 reference signatures (binding differences may apply):

setEnabled(self, arg__1: bool) -> None

Source: https://doc.qt.io/archives/qt-5.15/qsocketnotifier.html#setEnabled

socket

socket() -> int

X.socket() -> int

Supplemental documentation: Qt 5 reference:

qintptr QSocketNotifier::socket() const

Returns the socket identifier specified to the constructor.

See also type().

Upstream PySide2 reference signatures (binding differences may apply):

socket(self) -> int

Source: https://doc.qt.io/archives/qt-5.15/qsocketnotifier.html#socket

type

type() -> Any

X.type()

Supplemental documentation: Qt 5 reference:

QSocketNotifier::Type QSocketNotifier::type() const

Returns the socket event type specified to the constructor.

See also socket().

Upstream PySide2 reference signatures (binding differences may apply):

type(self) -> PySide2.QtCore.QSocketNotifier.Type

Source: https://doc.qt.io/archives/qt-5.15/qsocketnotifier.html#type