QtRemoteObjects.pyi 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376
  1. # Copyright (C) 2022 The Qt Company Ltd.
  2. # SPDX-License-Identifier: LicenseRef-Qt-Commercial OR LGPL-3.0-only OR GPL-2.0-only OR GPL-3.0-only
  3. """
  4. This file contains the exact signatures for all functions in module
  5. PySide6.QtRemoteObjects, except for defaults which are replaced by "...".
  6. """
  7. # mypy: disable-error-code="override, overload-overlap"
  8. # Module `PySide6.QtRemoteObjects`
  9. import PySide6.QtRemoteObjects
  10. import PySide6.QtCore
  11. import PySide6.QtNetwork
  12. import enum
  13. import typing
  14. import collections.abc
  15. from PySide6.QtCore import Signal
  16. from shiboken6 import Shiboken
  17. class QAbstractItemModelReplica(PySide6.QtCore.QAbstractItemModel):
  18. initialized : typing.ClassVar[Signal] = ... # initialized()
  19. def availableRoles(self, /) -> typing.List[int]: ...
  20. def columnCount(self, /, parent: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex = ...) -> int: ...
  21. def data(self, index: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex, /, role: int = ...) -> typing.Any: ...
  22. def flags(self, index: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex, /) -> PySide6.QtCore.Qt.ItemFlag: ...
  23. def hasChildren(self, /, parent: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex = ...) -> bool: ...
  24. def hasData(self, index: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex, role: int, /) -> bool: ...
  25. def headerData(self, section: int, orientation: PySide6.QtCore.Qt.Orientation, role: int, /) -> typing.Any: ...
  26. def index(self, row: int, column: int, /, parent: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex = ...) -> PySide6.QtCore.QModelIndex: ...
  27. def isInitialized(self, /) -> bool: ...
  28. def multiData(self, index: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex, roleDataSpan: PySide6.QtCore.QModelRoleDataSpan | PySide6.QtCore.QModelRoleData, /) -> None: ...
  29. @typing.overload
  30. def parent(self, /) -> PySide6.QtCore.QObject: ...
  31. @typing.overload
  32. def parent(self, index: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex, /) -> PySide6.QtCore.QModelIndex: ...
  33. def roleNames(self, /) -> typing.Dict[int, PySide6.QtCore.QByteArray]: ...
  34. def rootCacheSize(self, /) -> int: ...
  35. def rowCount(self, /, parent: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex = ...) -> int: ...
  36. def selectionModel(self, /) -> PySide6.QtCore.QItemSelectionModel: ...
  37. def setData(self, index: PySide6.QtCore.QModelIndex | PySide6.QtCore.QPersistentModelIndex, value: typing.Any, /, role: int = ...) -> bool: ...
  38. def setRootCacheSize(self, rootCacheSize: int, /) -> None: ...
  39. class QConnectionAbstractServer(PySide6.QtCore.QObject):
  40. newConnection : typing.ClassVar[Signal] = ... # newConnection()
  41. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  42. def address(self, /) -> PySide6.QtCore.QUrl: ...
  43. def close(self, /) -> None: ...
  44. def configureNewConnection(self, /) -> PySide6.QtRemoteObjects.QtROServerIoDevice: ...
  45. def hasPendingConnections(self, /) -> bool: ...
  46. def listen(self, address: PySide6.QtCore.QUrl | str, /) -> bool: ...
  47. def nextPendingConnection(self, /) -> PySide6.QtRemoteObjects.QtROServerIoDevice: ...
  48. def serverError(self, /) -> PySide6.QtNetwork.QAbstractSocket.SocketError: ...
  49. class QIntList: ...
  50. class QRemoteObjectAbstractPersistedStore(PySide6.QtCore.QObject):
  51. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  52. def restoreProperties(self, repName: str, repSig: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> typing.List[typing.Any]: ...
  53. def saveProperties(self, repName: str, repSig: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, values: collections.abc.Sequence[typing.Any], /) -> None: ...
  54. class QRemoteObjectDynamicReplica(PySide6.QtRemoteObjects.QRemoteObjectReplica): ...
  55. class QRemoteObjectHost(PySide6.QtRemoteObjects.QRemoteObjectHostBase):
  56. hostUrlChanged : typing.ClassVar[Signal] = ... # hostUrlChanged()
  57. @typing.overload
  58. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ..., *, hostUrl: PySide6.QtCore.QUrl | None = ...) -> None: ...
  59. @typing.overload
  60. def __init__(self, address: PySide6.QtCore.QUrl | str, parent: PySide6.QtCore.QObject, /, *, hostUrl: PySide6.QtCore.QUrl | None = ...) -> None: ...
  61. @typing.overload
  62. def __init__(self, address: PySide6.QtCore.QUrl | str, /, registryAddress: PySide6.QtCore.QUrl | str = ..., allowedSchemas: PySide6.QtRemoteObjects.QRemoteObjectHostBase.AllowedSchemas = ..., parent: PySide6.QtCore.QObject | None = ..., *, hostUrl: PySide6.QtCore.QUrl | None = ...) -> None: ...
  63. def hostUrl(self, /) -> PySide6.QtCore.QUrl: ...
  64. def setHostUrl(self, hostAddress: PySide6.QtCore.QUrl | str, /, allowedSchemas: PySide6.QtRemoteObjects.QRemoteObjectHostBase.AllowedSchemas = ...) -> bool: ...
  65. @staticmethod
  66. def setLocalServerOptions(options: PySide6.QtNetwork.QLocalServer.SocketOption, /) -> None: ...
  67. class QRemoteObjectHostBase(PySide6.QtRemoteObjects.QRemoteObjectNode):
  68. class AllowedSchemas(enum.Enum):
  69. BuiltInSchemasOnly = 0x0
  70. AllowExternalRegistration = 0x1
  71. def addHostSideConnection(self, ioDevice: PySide6.QtCore.QIODevice, /) -> None: ...
  72. def disableRemoting(self, remoteObject: PySide6.QtCore.QObject, /) -> bool: ...
  73. @typing.overload
  74. def enableRemoting(self, model: PySide6.QtCore.QAbstractItemModel, name: str, roles: collections.abc.Sequence[int], /, selectionModel: PySide6.QtCore.QItemSelectionModel | None = ...) -> bool: ...
  75. @typing.overload
  76. def enableRemoting(self, object: PySide6.QtCore.QObject, /, name: str = ...) -> bool: ...
  77. def hostUrl(self, /) -> PySide6.QtCore.QUrl: ...
  78. def proxy(self, registryUrl: PySide6.QtCore.QUrl | str, /, hostUrl: PySide6.QtCore.QUrl | str = ...) -> bool: ...
  79. def reverseProxy(self, /) -> bool: ...
  80. def setHostUrl(self, hostAddress: PySide6.QtCore.QUrl | str, /, allowedSchemas: PySide6.QtRemoteObjects.QRemoteObjectHostBase.AllowedSchemas = ...) -> bool: ...
  81. def setName(self, name: str, /) -> None: ...
  82. class QRemoteObjectNode(PySide6.QtCore.QObject):
  83. error : typing.ClassVar[Signal] = ... # error(QRemoteObjectNode::ErrorCode)
  84. heartbeatIntervalChanged : typing.ClassVar[Signal] = ... # heartbeatIntervalChanged(int)
  85. remoteObjectAdded : typing.ClassVar[Signal] = ... # remoteObjectAdded(QRemoteObjectSourceLocation)
  86. remoteObjectRemoved : typing.ClassVar[Signal] = ... # remoteObjectRemoved(QRemoteObjectSourceLocation)
  87. class ErrorCode(enum.Enum):
  88. NoError = 0x0
  89. RegistryNotAcquired = 0x1
  90. RegistryAlreadyHosted = 0x2
  91. NodeIsNoServer = 0x3
  92. ServerAlreadyCreated = 0x4
  93. UnintendedRegistryHosting = 0x5
  94. OperationNotValidOnClientNode = 0x6
  95. SourceNotRegistered = 0x7
  96. MissingObjectName = 0x8
  97. HostUrlInvalid = 0x9
  98. ProtocolMismatch = 0xa
  99. ListenFailed = 0xb
  100. SocketAccessError = 0xc
  101. @typing.overload
  102. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ..., *, registryUrl: PySide6.QtCore.QUrl | None = ..., persistedStore: PySide6.QtRemoteObjects.QRemoteObjectAbstractPersistedStore | None = ..., heartbeatInterval: int | None = ...) -> None: ...
  103. @typing.overload
  104. def __init__(self, registryAddress: PySide6.QtCore.QUrl | str, /, parent: PySide6.QtCore.QObject | None = ..., *, registryUrl: PySide6.QtCore.QUrl | None = ..., persistedStore: PySide6.QtRemoteObjects.QRemoteObjectAbstractPersistedStore | None = ..., heartbeatInterval: int | None = ...) -> None: ...
  105. def acquire(self, arg__1: type, /, name: object | None = ...) -> type: ...
  106. def acquireDynamic(self, name: str, /) -> PySide6.QtRemoteObjects.QRemoteObjectDynamicReplica: ...
  107. def acquireModel(self, name: str, /, action: PySide6.QtRemoteObjects.QtRemoteObjects.InitialAction = ..., rolesHint: collections.abc.Sequence[int] = ...) -> PySide6.QtRemoteObjects.QAbstractItemModelReplica: ...
  108. def addClientSideConnection(self, ioDevice: PySide6.QtCore.QIODevice, /) -> None: ...
  109. def connectToNode(self, address: PySide6.QtCore.QUrl | str, /) -> bool: ...
  110. def heartbeatInterval(self, /) -> int: ...
  111. def instances(self, typeName: str, /) -> typing.List[str]: ...
  112. def lastError(self, /) -> PySide6.QtRemoteObjects.QRemoteObjectNode.ErrorCode: ...
  113. def persistedStore(self, /) -> PySide6.QtRemoteObjects.QRemoteObjectAbstractPersistedStore: ...
  114. def registry(self, /) -> PySide6.QtRemoteObjects.QRemoteObjectRegistry: ...
  115. def registryUrl(self, /) -> PySide6.QtCore.QUrl: ...
  116. def setHeartbeatInterval(self, interval: int, /) -> None: ...
  117. def setName(self, name: str, /) -> None: ...
  118. def setPersistedStore(self, persistedStore: PySide6.QtRemoteObjects.QRemoteObjectAbstractPersistedStore, /) -> None: ...
  119. def setRegistryUrl(self, registryAddress: PySide6.QtCore.QUrl | str, /) -> bool: ...
  120. def timerEvent(self, arg__1: PySide6.QtCore.QTimerEvent, /) -> None: ...
  121. def waitForRegistry(self, /, timeout: int = ...) -> bool: ...
  122. class QRemoteObjectPendingCall(Shiboken.Object):
  123. class Error(enum.Enum):
  124. NoError = 0x0
  125. InvalidMessage = 0x1
  126. @typing.overload
  127. def __init__(self, /) -> None: ...
  128. @typing.overload
  129. def __init__(self, other: PySide6.QtRemoteObjects.QRemoteObjectPendingCall, /) -> None: ...
  130. def error(self, /) -> PySide6.QtRemoteObjects.QRemoteObjectPendingCall.Error: ...
  131. @staticmethod
  132. def fromCompletedCall(returnValue: typing.Any, /) -> PySide6.QtRemoteObjects.QRemoteObjectPendingCall: ...
  133. def isFinished(self, /) -> bool: ...
  134. def returnValue(self, /) -> typing.Any: ...
  135. def waitForFinished(self, /, timeout: int = ...) -> bool: ...
  136. class QRemoteObjectPendingCallWatcher(PySide6.QtCore.QObject, PySide6.QtRemoteObjects.QRemoteObjectPendingCall):
  137. finished : typing.ClassVar[Signal] = ... # finished(QRemoteObjectPendingCallWatcher*)
  138. def __init__(self, call: PySide6.QtRemoteObjects.QRemoteObjectPendingCall, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  139. def isFinished(self, /) -> bool: ...
  140. def waitForFinished(self, /) -> None: ...
  141. class QRemoteObjectRegistry(PySide6.QtRemoteObjects.QRemoteObjectReplica):
  142. remoteObjectAdded : typing.ClassVar[Signal] = ... # remoteObjectAdded(QRemoteObjectSourceLocation)
  143. remoteObjectRemoved : typing.ClassVar[Signal] = ... # remoteObjectRemoved(QRemoteObjectSourceLocation)
  144. def addSource(self, entry: typing.Tuple[str, PySide6.QtRemoteObjects.QRemoteObjectSourceLocationInfo], /) -> None: ...
  145. def initialize(self, /) -> None: ...
  146. def pushToRegistryIfNeeded(self, /) -> None: ...
  147. @staticmethod
  148. def registerMetatypes() -> None: ...
  149. def removeSource(self, entry: typing.Tuple[str, PySide6.QtRemoteObjects.QRemoteObjectSourceLocationInfo], /) -> None: ...
  150. def sourceLocations(self, /) -> typing.Dict[str, PySide6.QtRemoteObjects.QRemoteObjectSourceLocationInfo]: ...
  151. class QRemoteObjectRegistryHost(PySide6.QtRemoteObjects.QRemoteObjectHostBase):
  152. def __init__(self, /, registryAddress: PySide6.QtCore.QUrl | str = ..., parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  153. def setRegistryUrl(self, registryUrl: PySide6.QtCore.QUrl | str, /) -> bool: ...
  154. class QRemoteObjectReplica(PySide6.QtCore.QObject):
  155. initialized : typing.ClassVar[Signal] = ... # initialized()
  156. notified : typing.ClassVar[Signal] = ... # notified()
  157. stateChanged : typing.ClassVar[Signal] = ... # stateChanged(State,State)
  158. class ConstructorType(enum.IntEnum):
  159. DefaultConstructor = 0x0
  160. ConstructWithNode = 0x1
  161. class State(enum.Enum):
  162. Uninitialized = 0x0
  163. Default = 0x1
  164. Valid = 0x2
  165. Suspect = 0x3
  166. SignatureMismatch = 0x4
  167. def __init__(self, /, t: PySide6.QtRemoteObjects.QRemoteObjectReplica.ConstructorType = ..., *, node: PySide6.QtRemoteObjects.QRemoteObjectNode | None = ..., state: PySide6.QtRemoteObjects.QRemoteObjectReplica.State | None = ...) -> None: ...
  168. def initialize(self, /) -> None: ...
  169. def initializeNode(self, node: PySide6.QtRemoteObjects.QRemoteObjectNode, /, name: str = ...) -> None: ...
  170. def isInitialized(self, /) -> bool: ...
  171. def isReplicaValid(self, /) -> bool: ...
  172. def node(self, /) -> PySide6.QtRemoteObjects.QRemoteObjectNode: ...
  173. def persistProperties(self, repName: str, repSig: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, props: collections.abc.Sequence[typing.Any], /) -> None: ...
  174. def propAsVariant(self, i: int, /) -> typing.Any: ...
  175. def retrieveProperties(self, repName: str, repSig: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> typing.List[typing.Any]: ...
  176. def send(self, call: PySide6.QtCore.QMetaObject.Call, index: int, args: collections.abc.Sequence[typing.Any], /) -> None: ...
  177. def sendWithReply(self, call: PySide6.QtCore.QMetaObject.Call, index: int, args: collections.abc.Sequence[typing.Any], /) -> PySide6.QtRemoteObjects.QRemoteObjectPendingCall: ...
  178. def setChild(self, i: int, arg__2: typing.Any, /) -> None: ...
  179. def setNode(self, node: PySide6.QtRemoteObjects.QRemoteObjectNode, /) -> None: ...
  180. def state(self, /) -> PySide6.QtRemoteObjects.QRemoteObjectReplica.State: ...
  181. def waitForSource(self, /, timeout: int = ...) -> bool: ...
  182. class QRemoteObjectSettingsStore(PySide6.QtRemoteObjects.QRemoteObjectAbstractPersistedStore):
  183. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  184. def restoreProperties(self, repName: str, repSig: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> typing.List[typing.Any]: ...
  185. def saveProperties(self, repName: str, repSig: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, values: collections.abc.Sequence[typing.Any], /) -> None: ...
  186. class QRemoteObjectSourceLocationInfo(Shiboken.Object):
  187. @typing.overload
  188. def __init__(self, /) -> None: ...
  189. @typing.overload
  190. def __init__(self, QRemoteObjectSourceLocationInfo: PySide6.QtRemoteObjects.QRemoteObjectSourceLocationInfo, /) -> None: ...
  191. @typing.overload
  192. def __init__(self, typeName_: str, hostUrl_: PySide6.QtCore.QUrl | str, /) -> None: ...
  193. def __copy__(self, /) -> typing.Self: ...
  194. def __eq__(self, other: PySide6.QtRemoteObjects.QRemoteObjectSourceLocationInfo, /) -> bool: ...
  195. def __lshift__(self, stream: PySide6.QtCore.QDataStream, /) -> PySide6.QtCore.QDataStream: ...
  196. def __ne__(self, other: PySide6.QtRemoteObjects.QRemoteObjectSourceLocationInfo, /) -> bool: ...
  197. def __repr__(self, /) -> str: ...
  198. def __rshift__(self, stream: PySide6.QtCore.QDataStream, /) -> PySide6.QtCore.QDataStream: ...
  199. class QtROClientFactory(Shiboken.Object):
  200. def create(self, url: PySide6.QtCore.QUrl | str, /, parent: PySide6.QtCore.QObject | None = ...) -> PySide6.QtRemoteObjects.QtROClientIoDevice: ...
  201. @staticmethod
  202. def instance() -> PySide6.QtRemoteObjects.QtROClientFactory: ...
  203. def isValid(self, url: PySide6.QtCore.QUrl | str, /) -> bool: ...
  204. class QtROClientIoDevice(PySide6.QtRemoteObjects.QtROIoDeviceBase):
  205. setError : typing.ClassVar[Signal] = ... # setError(QRemoteObjectNode::ErrorCode)
  206. shouldReconnect : typing.ClassVar[Signal] = ... # shouldReconnect(QtROClientIoDevice*)
  207. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  208. def connectToServer(self, /) -> None: ...
  209. def deviceType(self, /) -> str: ...
  210. def disconnectFromServer(self, /) -> None: ...
  211. def doDisconnectFromServer(self, /) -> None: ...
  212. def setUrl(self, url: PySide6.QtCore.QUrl | str, /) -> None: ...
  213. def url(self, /) -> PySide6.QtCore.QUrl: ...
  214. class QtROIoDeviceBase(PySide6.QtCore.QObject):
  215. disconnected : typing.ClassVar[Signal] = ... # disconnected()
  216. readyRead : typing.ClassVar[Signal] = ... # readyRead()
  217. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  218. def addSource(self, arg__1: str, /) -> None: ...
  219. def bytesAvailable(self, /) -> int: ...
  220. def close(self, /) -> None: ...
  221. def connection(self, /) -> PySide6.QtCore.QIODevice: ...
  222. def deviceType(self, /) -> str: ...
  223. def doClose(self, /) -> None: ...
  224. def initializeDataStream(self, /) -> None: ...
  225. def isClosing(self, /) -> bool: ...
  226. def isOpen(self, /) -> bool: ...
  227. def read(self, arg__1: PySide6.QtRemoteObjects.QtRemoteObjects.QRemoteObjectPacketTypeEnum, arg__2: str, /) -> bool: ...
  228. def remoteObjects(self, /) -> typing.Set[str]: ...
  229. def removeSource(self, arg__1: str, /) -> None: ...
  230. @typing.overload
  231. def write(self, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  232. @typing.overload
  233. def write(self, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, arg__2: int, /) -> None: ...
  234. class QtROServerFactory(Shiboken.Object):
  235. def create(self, url: PySide6.QtCore.QUrl | str, /, parent: PySide6.QtCore.QObject | None = ...) -> PySide6.QtRemoteObjects.QConnectionAbstractServer: ...
  236. @staticmethod
  237. def instance() -> PySide6.QtRemoteObjects.QtROServerFactory: ...
  238. def isValid(self, url: PySide6.QtCore.QUrl | str, /) -> bool: ...
  239. class QtROServerIoDevice(PySide6.QtRemoteObjects.QtROIoDeviceBase):
  240. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  241. def deviceType(self, /) -> str: ...
  242. class QtRemoteObjects(Shiboken.Object):
  243. class InitialAction(enum.Enum):
  244. FetchRootSize = 0x0
  245. PrefetchData = 0x1
  246. class QRemoteObjectPacketTypeEnum(enum.Enum):
  247. Invalid = 0x0
  248. Handshake = 0x1
  249. InitPacket = 0x2
  250. InitDynamicPacket = 0x3
  251. AddObject = 0x4
  252. RemoveObject = 0x5
  253. InvokePacket = 0x6
  254. InvokeReplyPacket = 0x7
  255. PropertyChangePacket = 0x8
  256. ObjectList = 0x9
  257. Ping = 0xa
  258. Pong = 0xb
  259. @typing.overload
  260. @staticmethod
  261. def copyStoredProperties(mo: PySide6.QtCore.QMetaObject, src: PySide6.QtCore.QDataStream, dst: int, /) -> None: ...
  262. @typing.overload
  263. @staticmethod
  264. def copyStoredProperties(mo: PySide6.QtCore.QMetaObject, src: int, dst: PySide6.QtCore.QDataStream, /) -> None: ...
  265. @typing.overload
  266. @staticmethod
  267. def copyStoredProperties(mo: PySide6.QtCore.QMetaObject, src: int, dst: int, /) -> None: ...
  268. class RepFile:
  269. def __init__(self, content: str, /) -> None: ...
  270. # eof