QtNfc.pyi 18 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389
  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.QtNfc, except for defaults which are replaced by "...".
  6. """
  7. # mypy: disable-error-code="override, overload-overlap"
  8. # Module `PySide6.QtNfc`
  9. import PySide6.QtNfc
  10. import PySide6.QtCore
  11. import os
  12. import enum
  13. import typing
  14. import collections.abc
  15. from PySide6.QtCore import Signal
  16. from shiboken6 import Shiboken
  17. class QIntList: ...
  18. class QNdefFilter(Shiboken.Object):
  19. class Record(Shiboken.Object):
  20. @typing.overload
  21. def __init__(self, /) -> None: ...
  22. @typing.overload
  23. def __init__(self, Record: PySide6.QtNfc.QNdefFilter.Record, /) -> None: ...
  24. def __copy__(self, /) -> typing.Self: ...
  25. @typing.overload
  26. def __init__(self, /) -> None: ...
  27. @typing.overload
  28. def __init__(self, other: PySide6.QtNfc.QNdefFilter, /) -> None: ...
  29. def __copy__(self, /) -> typing.Self: ...
  30. @typing.overload
  31. def appendRecord(self, record: PySide6.QtNfc.QNdefFilter.Record, /) -> bool: ...
  32. @typing.overload
  33. def appendRecord(self, typeNameFormat: PySide6.QtNfc.QNdefRecord.TypeNameFormat, type: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /, min: int = ..., max: int = ...) -> bool: ...
  34. def clear(self, /) -> None: ...
  35. def match(self, message: PySide6.QtNfc.QNdefMessage | collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> bool: ...
  36. def orderMatch(self, /) -> bool: ...
  37. def recordAt(self, i: int, /) -> PySide6.QtNfc.QNdefFilter.Record: ...
  38. def recordCount(self, /) -> int: ...
  39. def setOrderMatch(self, on: bool, /) -> None: ...
  40. class QNdefMessage(Shiboken.Object):
  41. @typing.overload
  42. def __init__(self, /) -> None: ...
  43. @typing.overload
  44. def __init__(self, message: PySide6.QtNfc.QNdefMessage, /) -> None: ...
  45. @typing.overload
  46. def __init__(self, record: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  47. @typing.overload
  48. def __init__(self, records: collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> None: ...
  49. def __add__(self, l: collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  50. def __copy__(self, /) -> typing.Self: ...
  51. def __eq__(self, other: PySide6.QtNfc.QNdefMessage | collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> bool: ...
  52. def __iadd__(self, l: collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  53. def __lshift__(self, l: collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  54. @typing.overload
  55. def append(self, arg__1: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  56. @typing.overload
  57. def append(self, l: collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> None: ...
  58. def at(self, i: int, /) -> PySide6.QtNfc.QNdefRecord: ...
  59. def back(self, /) -> PySide6.QtNfc.QNdefRecord: ...
  60. def capacity(self, /) -> int: ...
  61. def clear(self, /) -> None: ...
  62. def constData(self, /) -> PySide6.QtNfc.QNdefRecord: ...
  63. def constFirst(self, /) -> PySide6.QtNfc.QNdefRecord: ...
  64. def constLast(self, /) -> PySide6.QtNfc.QNdefRecord: ...
  65. def count(self, /) -> int: ...
  66. def data(self, /) -> PySide6.QtNfc.QNdefRecord: ...
  67. def empty(self, /) -> bool: ...
  68. @typing.overload
  69. def first(self, /) -> PySide6.QtNfc.QNdefRecord: ...
  70. @typing.overload
  71. def first(self, n: int, /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  72. @staticmethod
  73. def fromByteArray(message: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> PySide6.QtNfc.QNdefMessage: ...
  74. @staticmethod
  75. def fromList(list: collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  76. @staticmethod
  77. def fromVector(vector: collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  78. def front(self, /) -> PySide6.QtNfc.QNdefRecord: ...
  79. def insert(self, arg__1: int, arg__2: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  80. def isEmpty(self, /) -> bool: ...
  81. def isSharedWith(self, other: collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> bool: ...
  82. @typing.overload
  83. def last(self, /) -> PySide6.QtNfc.QNdefRecord: ...
  84. @typing.overload
  85. def last(self, n: int, /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  86. def length(self, /) -> int: ...
  87. @staticmethod
  88. def maxSize() -> int: ...
  89. def max_size(self, /) -> int: ...
  90. def mid(self, pos: int, /, len: int = ...) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  91. def move(self, from_: int, to: int, /) -> None: ...
  92. def pop_back(self, /) -> None: ...
  93. def pop_front(self, /) -> None: ...
  94. def prepend(self, arg__1: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  95. def push_back(self, arg__1: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  96. def push_front(self, arg__1: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  97. def remove(self, i: int, /, n: int = ...) -> None: ...
  98. def removeAll(self, arg__1: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  99. def removeAt(self, i: int, /) -> None: ...
  100. def removeFirst(self, /) -> None: ...
  101. def removeLast(self, /) -> None: ...
  102. def removeOne(self, arg__1: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  103. def reserve(self, size: int, /) -> None: ...
  104. def resize(self, size: int, /) -> None: ...
  105. def resizeForOverwrite(self, size: int, /) -> None: ...
  106. def shrink_to_fit(self, /) -> None: ...
  107. def size(self, /) -> int: ...
  108. @typing.overload
  109. def sliced(self, pos: int, /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  110. @typing.overload
  111. def sliced(self, pos: int, n: int, /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  112. def squeeze(self, /) -> None: ...
  113. def swap(self, other: collections.abc.Sequence[PySide6.QtNfc.QNdefRecord], /) -> None: ...
  114. def swapItemsAt(self, i: int, j: int, /) -> None: ...
  115. def takeAt(self, i: int, /) -> PySide6.QtNfc.QNdefRecord: ...
  116. def toByteArray(self, /) -> PySide6.QtCore.QByteArray: ...
  117. def toList(self, /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  118. def toVector(self, /) -> typing.List[PySide6.QtNfc.QNdefRecord]: ...
  119. def value(self, i: int, /) -> PySide6.QtNfc.QNdefRecord: ...
  120. class QNdefNfcIconRecord(PySide6.QtNfc.QNdefRecord):
  121. @typing.overload
  122. def __init__(self, /) -> None: ...
  123. @typing.overload
  124. def __init__(self, QNdefNfcIconRecord: PySide6.QtNfc.QNdefNfcIconRecord, /) -> None: ...
  125. @typing.overload
  126. def __init__(self, other: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  127. def __copy__(self, /) -> typing.Self: ...
  128. def data(self, /) -> PySide6.QtCore.QByteArray: ...
  129. def setData(self, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  130. class QNdefNfcSmartPosterRecord(PySide6.QtNfc.QNdefRecord):
  131. class Action(enum.Enum):
  132. UnspecifiedAction = -1
  133. DoAction = 0x0
  134. SaveAction = 0x1
  135. EditAction = 0x2
  136. @typing.overload
  137. def __init__(self, /) -> None: ...
  138. @typing.overload
  139. def __init__(self, other: PySide6.QtNfc.QNdefNfcSmartPosterRecord, /) -> None: ...
  140. @typing.overload
  141. def __init__(self, other: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  142. def __copy__(self, /) -> typing.Self: ...
  143. def action(self, /) -> PySide6.QtNfc.QNdefNfcSmartPosterRecord.Action: ...
  144. @typing.overload
  145. def addIcon(self, icon: PySide6.QtNfc.QNdefNfcIconRecord | PySide6.QtNfc.QNdefRecord, /) -> None: ...
  146. @typing.overload
  147. def addIcon(self, type: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, data: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  148. @typing.overload
  149. def addTitle(self, text: str, locale: str, encoding: PySide6.QtNfc.QNdefNfcTextRecord.Encoding, /) -> bool: ...
  150. @typing.overload
  151. def addTitle(self, text: PySide6.QtNfc.QNdefNfcTextRecord | PySide6.QtNfc.QNdefRecord, /) -> bool: ...
  152. def hasAction(self, /) -> bool: ...
  153. def hasIcon(self, /, mimetype: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview = ...) -> bool: ...
  154. def hasSize(self, /) -> bool: ...
  155. def hasTitle(self, /, locale: str = ...) -> bool: ...
  156. def hasTypeInfo(self, /) -> bool: ...
  157. def icon(self, /, mimetype: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview = ...) -> PySide6.QtCore.QByteArray: ...
  158. def iconCount(self, /) -> int: ...
  159. def iconRecord(self, index: int, /) -> PySide6.QtNfc.QNdefNfcIconRecord: ...
  160. def iconRecords(self, /) -> typing.List[PySide6.QtNfc.QNdefNfcIconRecord]: ...
  161. @typing.overload
  162. def removeIcon(self, icon: PySide6.QtNfc.QNdefNfcIconRecord | PySide6.QtNfc.QNdefRecord, /) -> bool: ...
  163. @typing.overload
  164. def removeIcon(self, type: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> bool: ...
  165. @typing.overload
  166. def removeTitle(self, locale: str, /) -> bool: ...
  167. @typing.overload
  168. def removeTitle(self, text: PySide6.QtNfc.QNdefNfcTextRecord | PySide6.QtNfc.QNdefRecord, /) -> bool: ...
  169. def setAction(self, act: PySide6.QtNfc.QNdefNfcSmartPosterRecord.Action, /) -> None: ...
  170. def setIcons(self, icons: collections.abc.Sequence[PySide6.QtNfc.QNdefNfcIconRecord], /) -> None: ...
  171. def setPayload(self, payload: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  172. def setSize(self, size: int, /) -> None: ...
  173. def setTitles(self, titles: collections.abc.Sequence[PySide6.QtNfc.QNdefNfcTextRecord], /) -> None: ...
  174. def setTypeInfo(self, type: str, /) -> None: ...
  175. @typing.overload
  176. def setUri(self, url: PySide6.QtNfc.QNdefNfcUriRecord | PySide6.QtNfc.QNdefRecord, /) -> None: ...
  177. @typing.overload
  178. def setUri(self, url: PySide6.QtCore.QUrl | str, /) -> None: ...
  179. def size(self, /) -> int: ...
  180. def title(self, /, locale: str = ...) -> str: ...
  181. def titleCount(self, /) -> int: ...
  182. def titleRecord(self, index: int, /) -> PySide6.QtNfc.QNdefNfcTextRecord: ...
  183. def titleRecords(self, /) -> typing.List[PySide6.QtNfc.QNdefNfcTextRecord]: ...
  184. def typeInfo(self, /) -> str: ...
  185. def uri(self, /) -> PySide6.QtCore.QUrl: ...
  186. def uriRecord(self, /) -> PySide6.QtNfc.QNdefNfcUriRecord: ...
  187. class QNdefNfcTextRecord(PySide6.QtNfc.QNdefRecord):
  188. class Encoding(enum.Enum):
  189. Utf8 = 0x0
  190. Utf16 = 0x1
  191. @typing.overload
  192. def __init__(self, /) -> None: ...
  193. @typing.overload
  194. def __init__(self, QNdefNfcTextRecord: PySide6.QtNfc.QNdefNfcTextRecord, /) -> None: ...
  195. @typing.overload
  196. def __init__(self, other: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  197. def __copy__(self, /) -> typing.Self: ...
  198. def encoding(self, /) -> PySide6.QtNfc.QNdefNfcTextRecord.Encoding: ...
  199. def locale(self, /) -> str: ...
  200. def setEncoding(self, encoding: PySide6.QtNfc.QNdefNfcTextRecord.Encoding, /) -> None: ...
  201. def setLocale(self, locale: str, /) -> None: ...
  202. def setText(self, text: str, /) -> None: ...
  203. def text(self, /) -> str: ...
  204. class QNdefNfcUriRecord(PySide6.QtNfc.QNdefRecord):
  205. @typing.overload
  206. def __init__(self, /) -> None: ...
  207. @typing.overload
  208. def __init__(self, QNdefNfcUriRecord: PySide6.QtNfc.QNdefNfcUriRecord, /) -> None: ...
  209. @typing.overload
  210. def __init__(self, other: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  211. def __copy__(self, /) -> typing.Self: ...
  212. def setUri(self, uri: PySide6.QtCore.QUrl | str, /) -> None: ...
  213. def uri(self, /) -> PySide6.QtCore.QUrl: ...
  214. class QNdefRecord(Shiboken.Object):
  215. class TypeNameFormat(enum.Enum):
  216. Empty = 0x0
  217. NfcRtd = 0x1
  218. Mime = 0x2
  219. Uri = 0x3
  220. ExternalRtd = 0x4
  221. Unknown = 0x5
  222. @typing.overload
  223. def __init__(self, /) -> None: ...
  224. @typing.overload
  225. def __init__(self, other: PySide6.QtNfc.QNdefRecord, /) -> None: ...
  226. @typing.overload
  227. def __init__(self, other: PySide6.QtNfc.QNdefRecord, typeNameFormat: PySide6.QtNfc.QNdefRecord.TypeNameFormat, /) -> None: ...
  228. @typing.overload
  229. def __init__(self, other: PySide6.QtNfc.QNdefRecord, typeNameFormat: PySide6.QtNfc.QNdefRecord.TypeNameFormat, type: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  230. @typing.overload
  231. def __init__(self, typeNameFormat: PySide6.QtNfc.QNdefRecord.TypeNameFormat, type: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  232. def __copy__(self, /) -> typing.Self: ...
  233. def __eq__(self, other: PySide6.QtNfc.QNdefRecord, /) -> bool: ...
  234. def __hash__(self, /) -> int: ...
  235. def __ne__(self, other: PySide6.QtNfc.QNdefRecord, /) -> bool: ...
  236. def clear(self, /) -> None: ...
  237. def id(self, /) -> PySide6.QtCore.QByteArray: ...
  238. def isEmpty(self, /) -> bool: ...
  239. def payload(self, /) -> PySide6.QtCore.QByteArray: ...
  240. def setId(self, id: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  241. def setPayload(self, payload: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  242. def setType(self, type: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  243. def setTypeNameFormat(self, typeNameFormat: PySide6.QtNfc.QNdefRecord.TypeNameFormat, /) -> None: ...
  244. def type(self, /) -> PySide6.QtCore.QByteArray: ...
  245. def typeNameFormat(self, /) -> PySide6.QtNfc.QNdefRecord.TypeNameFormat: ...
  246. class QNearFieldManager(PySide6.QtCore.QObject):
  247. adapterStateChanged : typing.ClassVar[Signal] = ... # adapterStateChanged(QNearFieldManager::AdapterState)
  248. targetDetected : typing.ClassVar[Signal] = ... # targetDetected(QNearFieldTarget*)
  249. targetDetectionStopped : typing.ClassVar[Signal] = ... # targetDetectionStopped()
  250. targetLost : typing.ClassVar[Signal] = ... # targetLost(QNearFieldTarget*)
  251. class AdapterState(enum.Enum):
  252. Offline = 0x1
  253. TurningOn = 0x2
  254. Online = 0x3
  255. TurningOff = 0x4
  256. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  257. def isEnabled(self, /) -> bool: ...
  258. def isSupported(self, /, accessMethod: PySide6.QtNfc.QNearFieldTarget.AccessMethod = ...) -> bool: ...
  259. def setUserInformation(self, message: str, /) -> None: ...
  260. def startTargetDetection(self, accessMethod: PySide6.QtNfc.QNearFieldTarget.AccessMethod, /) -> bool: ...
  261. def stopTargetDetection(self, /, errorMessage: str = ...) -> None: ...
  262. class QNearFieldTarget(PySide6.QtCore.QObject):
  263. disconnected : typing.ClassVar[Signal] = ... # disconnected()
  264. error : typing.ClassVar[Signal] = ... # error(QNearFieldTarget::Error,QNearFieldTarget::RequestId)
  265. ndefMessageRead : typing.ClassVar[Signal] = ... # ndefMessageRead(QNdefMessage)
  266. requestCompleted : typing.ClassVar[Signal] = ... # requestCompleted(QNearFieldTarget::RequestId)
  267. class AccessMethod(enum.Flag):
  268. UnknownAccess = 0x0
  269. NdefAccess = 0x1
  270. TagTypeSpecificAccess = 0x2
  271. AnyAccess = 0xff
  272. class Error(enum.Enum):
  273. NoError = 0x0
  274. UnknownError = 0x1
  275. UnsupportedError = 0x2
  276. TargetOutOfRangeError = 0x3
  277. NoResponseError = 0x4
  278. ChecksumMismatchError = 0x5
  279. InvalidParametersError = 0x6
  280. ConnectionError = 0x7
  281. NdefReadError = 0x8
  282. NdefWriteError = 0x9
  283. CommandError = 0xa
  284. TimeoutError = 0xb
  285. UnsupportedTargetError = 0xc
  286. class RequestId(Shiboken.Object):
  287. @typing.overload
  288. def __init__(self, /) -> None: ...
  289. @typing.overload
  290. def __init__(self, other: PySide6.QtNfc.QNearFieldTarget.RequestId, /) -> None: ...
  291. def __copy__(self, /) -> typing.Self: ...
  292. def __eq__(self, other: PySide6.QtNfc.QNearFieldTarget.RequestId, /) -> bool: ...
  293. def __lt__(self, other: PySide6.QtNfc.QNearFieldTarget.RequestId, /) -> bool: ...
  294. def __ne__(self, other: PySide6.QtNfc.QNearFieldTarget.RequestId, /) -> bool: ...
  295. def isValid(self, /) -> bool: ...
  296. def refCount(self, /) -> int: ...
  297. class Type(enum.Enum):
  298. ProprietaryTag = 0x0
  299. NfcTagType1 = 0x1
  300. NfcTagType2 = 0x2
  301. NfcTagType3 = 0x3
  302. NfcTagType4 = 0x4
  303. NfcTagType4A = 0x5
  304. NfcTagType4B = 0x6
  305. MifareTag = 0x7
  306. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  307. def accessMethods(self, /) -> PySide6.QtNfc.QNearFieldTarget.AccessMethod: ...
  308. def disconnect(self, /) -> bool: ...
  309. def hasNdefMessage(self, /) -> bool: ...
  310. def maxCommandLength(self, /) -> int: ...
  311. def readNdefMessages(self, /) -> PySide6.QtNfc.QNearFieldTarget.RequestId: ...
  312. def requestResponse(self, id: PySide6.QtNfc.QNearFieldTarget.RequestId, /) -> typing.Any: ...
  313. def sendCommand(self, command: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> PySide6.QtNfc.QNearFieldTarget.RequestId: ...
  314. def type(self, /) -> PySide6.QtNfc.QNearFieldTarget.Type: ...
  315. def uid(self, /) -> PySide6.QtCore.QByteArray: ...
  316. def waitForRequestCompleted(self, id: PySide6.QtNfc.QNearFieldTarget.RequestId, /, msecs: int = ...) -> bool: ...
  317. def writeNdefMessages(self, messages: collections.abc.Sequence[PySide6.QtNfc.QNdefMessage], /) -> PySide6.QtNfc.QNearFieldTarget.RequestId: ...
  318. # eof