QtScxml.pyi 16 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319
  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.QtScxml, except for defaults which are replaced by "...".
  6. """
  7. # mypy: disable-error-code="override, overload-overlap"
  8. # Module `PySide6.QtScxml`
  9. import PySide6.QtScxml
  10. import PySide6.QtCore
  11. import enum
  12. import typing
  13. import collections.abc
  14. from PySide6.QtCore import Signal
  15. from shiboken6 import Shiboken
  16. class QIntList: ...
  17. class QScxmlCompiler(Shiboken.Object):
  18. class Loader(Shiboken.Object):
  19. def __init__(self, /) -> None: ...
  20. def load(self, name: str, baseDir: str, /) -> typing.Tuple[PySide6.QtCore.QByteArray, typing.List[str]]: ...
  21. def __init__(self, xmlReader: PySide6.QtCore.QXmlStreamReader, /) -> None: ...
  22. def compile(self, /) -> PySide6.QtScxml.QScxmlStateMachine: ...
  23. def errors(self, /) -> typing.List[PySide6.QtScxml.QScxmlError]: ...
  24. def fileName(self, /) -> str: ...
  25. def loader(self, /) -> PySide6.QtScxml.QScxmlCompiler.Loader: ...
  26. def setFileName(self, fileName: str, /) -> None: ...
  27. def setLoader(self, newLoader: PySide6.QtScxml.QScxmlCompiler.Loader, /) -> None: ...
  28. class QScxmlCppDataModel(PySide6.QtScxml.QScxmlDataModel):
  29. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  30. def evaluateAssignment(self, id: int, /) -> bool: ...
  31. def evaluateForeach(self, id: int, body: PySide6.QtScxml.QScxmlDataModel.ForeachLoopBody, /) -> bool: ...
  32. def evaluateInitialization(self, id: int, /) -> bool: ...
  33. def hasScxmlProperty(self, name: str, /) -> bool: ...
  34. def inState(self, stateName: str, /) -> bool: ...
  35. def scxmlEvent(self, /) -> PySide6.QtScxml.QScxmlEvent: ...
  36. def scxmlProperty(self, name: str, /) -> typing.Any: ...
  37. def setScxmlEvent(self, scxmlEvent: PySide6.QtScxml.QScxmlEvent, /) -> None: ...
  38. def setScxmlProperty(self, name: str, value: typing.Any, context: str, /) -> bool: ...
  39. def setup(self, initialDataValues: typing.Dict[str, typing.Any], /) -> bool: ...
  40. class QScxmlDataModel(PySide6.QtCore.QObject):
  41. stateMachineChanged : typing.ClassVar[Signal] = ... # stateMachineChanged(QScxmlStateMachine*)
  42. class ForeachLoopBody(Shiboken.Object):
  43. def __init__(self, /) -> None: ...
  44. def run(self, /) -> bool: ...
  45. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ..., *, stateMachine: PySide6.QtScxml.QScxmlStateMachine | None = ...) -> None: ...
  46. @staticmethod
  47. def createScxmlDataModel(pluginKey: str, /) -> PySide6.QtScxml.QScxmlDataModel: ...
  48. def evaluateAssignment(self, id: int, /) -> bool: ...
  49. def evaluateForeach(self, id: int, body: PySide6.QtScxml.QScxmlDataModel.ForeachLoopBody, /) -> bool: ...
  50. def evaluateInitialization(self, id: int, /) -> bool: ...
  51. def evaluateToBool(self, id: int, /) -> bool: ...
  52. def evaluateToString(self, id: int, /) -> str: ...
  53. def evaluateToVariant(self, id: int, /) -> typing.Any: ...
  54. def evaluateToVoid(self, id: int, /) -> bool: ...
  55. def hasScxmlProperty(self, name: str, /) -> bool: ...
  56. def scxmlProperty(self, name: str, /) -> typing.Any: ...
  57. def setScxmlEvent(self, event: PySide6.QtScxml.QScxmlEvent, /) -> None: ...
  58. def setScxmlProperty(self, name: str, value: typing.Any, context: str, /) -> bool: ...
  59. def setStateMachine(self, stateMachine: PySide6.QtScxml.QScxmlStateMachine, /) -> None: ...
  60. def setup(self, initialDataValues: typing.Dict[str, typing.Any], /) -> bool: ...
  61. def stateMachine(self, /) -> PySide6.QtScxml.QScxmlStateMachine: ...
  62. class QScxmlDynamicScxmlServiceFactory(PySide6.QtScxml.QScxmlInvokableServiceFactory):
  63. def __init__(self, invokeInfo: PySide6.QtScxml.QScxmlExecutableContent.InvokeInfo, names: collections.abc.Sequence[int], parameters: collections.abc.Sequence[PySide6.QtScxml.QScxmlExecutableContent.ParameterInfo], /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  64. def invoke(self, parentStateMachine: PySide6.QtScxml.QScxmlStateMachine, /) -> PySide6.QtScxml.QScxmlInvokableService: ...
  65. class QScxmlError(Shiboken.Object):
  66. @typing.overload
  67. def __init__(self, arg__1: PySide6.QtScxml.QScxmlError, /, *, valid: bool | None = ..., fileName: str | None = ..., line: int | None = ..., column: int | None = ..., description: str | None = ...) -> None: ...
  68. @typing.overload
  69. def __init__(self, fileName: str, line: int, column: int, description: str, /, *, valid: bool | None = ...) -> None: ...
  70. @typing.overload
  71. def __init__(self, /, *, valid: bool | None = ..., fileName: str | None = ..., line: int | None = ..., column: int | None = ..., description: str | None = ...) -> None: ...
  72. def __copy__(self, /) -> typing.Self: ...
  73. def column(self, /) -> int: ...
  74. def description(self, /) -> str: ...
  75. def fileName(self, /) -> str: ...
  76. def isValid(self, /) -> bool: ...
  77. def line(self, /) -> int: ...
  78. def toString(self, /) -> str: ...
  79. class QScxmlEvent(Shiboken.Object):
  80. class EventType(enum.Enum):
  81. PlatformEvent = 0x0
  82. InternalEvent = 0x1
  83. ExternalEvent = 0x2
  84. @typing.overload
  85. def __init__(self, other: PySide6.QtScxml.QScxmlEvent, /, *, name: str | None = ..., eventType: PySide6.QtScxml.QScxmlEvent.EventType | None = ..., scxmlType: str | None = ..., sendId: str | None = ..., origin: str | None = ..., originType: str | None = ..., invokeId: str | None = ..., delay: int | None = ..., data: typing.Optional[typing.Any] = ..., errorEvent: bool | None = ..., errorMessage: str | None = ...) -> None: ...
  86. @typing.overload
  87. def __init__(self, /, *, name: str | None = ..., eventType: PySide6.QtScxml.QScxmlEvent.EventType | None = ..., scxmlType: str | None = ..., sendId: str | None = ..., origin: str | None = ..., originType: str | None = ..., invokeId: str | None = ..., delay: int | None = ..., data: typing.Optional[typing.Any] = ..., errorEvent: bool | None = ..., errorMessage: str | None = ...) -> None: ...
  88. def __copy__(self, /) -> typing.Self: ...
  89. def clear(self, /) -> None: ...
  90. def data(self, /) -> typing.Any: ...
  91. def delay(self, /) -> int: ...
  92. def errorMessage(self, /) -> str: ...
  93. def eventType(self, /) -> PySide6.QtScxml.QScxmlEvent.EventType: ...
  94. def invokeId(self, /) -> str: ...
  95. def isErrorEvent(self, /) -> bool: ...
  96. def name(self, /) -> str: ...
  97. def origin(self, /) -> str: ...
  98. def originType(self, /) -> str: ...
  99. def scxmlType(self, /) -> str: ...
  100. def sendId(self, /) -> str: ...
  101. def setData(self, data: typing.Any, /) -> None: ...
  102. def setDelay(self, delayInMiliSecs: int, /) -> None: ...
  103. def setErrorMessage(self, message: str, /) -> None: ...
  104. def setEventType(self, type: PySide6.QtScxml.QScxmlEvent.EventType, /) -> None: ...
  105. def setInvokeId(self, invokeId: str, /) -> None: ...
  106. def setName(self, name: str, /) -> None: ...
  107. def setOrigin(self, origin: str, /) -> None: ...
  108. def setOriginType(self, originType: str, /) -> None: ...
  109. def setSendId(self, sendId: str, /) -> None: ...
  110. class QScxmlExecutableContent(Shiboken.Object):
  111. class AssignmentInfo(Shiboken.Object):
  112. @typing.overload
  113. def __init__(self, /) -> None: ...
  114. @typing.overload
  115. def __init__(self, AssignmentInfo: PySide6.QtScxml.QScxmlExecutableContent.AssignmentInfo, /) -> None: ...
  116. def __copy__(self, /) -> typing.Self: ...
  117. class EvaluatorInfo(Shiboken.Object):
  118. @typing.overload
  119. def __init__(self, /) -> None: ...
  120. @typing.overload
  121. def __init__(self, EvaluatorInfo: PySide6.QtScxml.QScxmlExecutableContent.EvaluatorInfo, /) -> None: ...
  122. def __copy__(self, /) -> typing.Self: ...
  123. class ForeachInfo(Shiboken.Object):
  124. @typing.overload
  125. def __init__(self, /) -> None: ...
  126. @typing.overload
  127. def __init__(self, ForeachInfo: PySide6.QtScxml.QScxmlExecutableContent.ForeachInfo, /) -> None: ...
  128. def __copy__(self, /) -> typing.Self: ...
  129. class InvokeInfo(Shiboken.Object):
  130. @typing.overload
  131. def __init__(self, /) -> None: ...
  132. @typing.overload
  133. def __init__(self, InvokeInfo: PySide6.QtScxml.QScxmlExecutableContent.InvokeInfo, /) -> None: ...
  134. def __copy__(self, /) -> typing.Self: ...
  135. class ParameterInfo(Shiboken.Object):
  136. @typing.overload
  137. def __init__(self, /) -> None: ...
  138. @typing.overload
  139. def __init__(self, ParameterInfo: PySide6.QtScxml.QScxmlExecutableContent.ParameterInfo, /) -> None: ...
  140. def __copy__(self, /) -> typing.Self: ...
  141. class QScxmlInvokableService(PySide6.QtCore.QObject):
  142. def __init__(self, parentStateMachine: PySide6.QtScxml.QScxmlStateMachine, parent: PySide6.QtScxml.QScxmlInvokableServiceFactory, /, *, id: str | None = ..., name: str | None = ...) -> None: ...
  143. def id(self, /) -> str: ...
  144. def name(self, /) -> str: ...
  145. def parentStateMachine(self, /) -> PySide6.QtScxml.QScxmlStateMachine: ...
  146. def postEvent(self, event: PySide6.QtScxml.QScxmlEvent, /) -> None: ...
  147. def start(self, /) -> bool: ...
  148. class QScxmlInvokableServiceFactory(PySide6.QtCore.QObject):
  149. def __init__(self, invokeInfo: PySide6.QtScxml.QScxmlExecutableContent.InvokeInfo, names: collections.abc.Sequence[int], parameters: collections.abc.Sequence[PySide6.QtScxml.QScxmlExecutableContent.ParameterInfo], /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  150. def invoke(self, parentStateMachine: PySide6.QtScxml.QScxmlStateMachine, /) -> PySide6.QtScxml.QScxmlInvokableService: ...
  151. def invokeInfo(self, /) -> PySide6.QtScxml.QScxmlExecutableContent.InvokeInfo: ...
  152. def names(self, /) -> typing.List[int]: ...
  153. def parameters(self, /) -> typing.List[PySide6.QtScxml.QScxmlExecutableContent.ParameterInfo]: ...
  154. class QScxmlNullDataModel(PySide6.QtScxml.QScxmlDataModel):
  155. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  156. def evaluateAssignment(self, id: int, /) -> bool: ...
  157. def evaluateForeach(self, id: int, body: PySide6.QtScxml.QScxmlDataModel.ForeachLoopBody, /) -> bool: ...
  158. def evaluateInitialization(self, id: int, /) -> bool: ...
  159. def evaluateToBool(self, id: int, /) -> bool: ...
  160. def evaluateToString(self, id: int, /) -> str: ...
  161. def evaluateToVariant(self, id: int, /) -> typing.Any: ...
  162. def evaluateToVoid(self, id: int, /) -> bool: ...
  163. def hasScxmlProperty(self, name: str, /) -> bool: ...
  164. def scxmlProperty(self, name: str, /) -> typing.Any: ...
  165. def setScxmlEvent(self, event: PySide6.QtScxml.QScxmlEvent, /) -> None: ...
  166. def setScxmlProperty(self, name: str, value: typing.Any, context: str, /) -> bool: ...
  167. def setup(self, initialDataValues: typing.Dict[str, typing.Any], /) -> bool: ...
  168. class QScxmlStateMachine(PySide6.QtCore.QObject):
  169. dataModelChanged : typing.ClassVar[Signal] = ... # dataModelChanged(QScxmlDataModel*)
  170. finished : typing.ClassVar[Signal] = ... # finished()
  171. initialValuesChanged : typing.ClassVar[Signal] = ... # initialValuesChanged(QVariantMap)
  172. initializedChanged : typing.ClassVar[Signal] = ... # initializedChanged(bool)
  173. invokedServicesChanged : typing.ClassVar[Signal] = ... # invokedServicesChanged(QList<QScxmlInvokableService*>)
  174. loaderChanged : typing.ClassVar[Signal] = ... # loaderChanged(QScxmlCompiler::Loader*)
  175. log : typing.ClassVar[Signal] = ... # log(QString,QString)
  176. reachedStableState : typing.ClassVar[Signal] = ... # reachedStableState()
  177. runningChanged : typing.ClassVar[Signal] = ... # runningChanged(bool)
  178. tableDataChanged : typing.ClassVar[Signal] = ... # tableDataChanged(QScxmlTableData*)
  179. def __init__(self, metaObject: PySide6.QtCore.QMetaObject, /, parent: PySide6.QtCore.QObject | None = ..., *, running: bool | None = ..., initialized: bool | None = ..., dataModel: PySide6.QtScxml.QScxmlDataModel | None = ..., initialValues: typing.Optional[typing.Dict[str, typing.Any]] = ..., invokedServices: collections.abc.Sequence[PySide6.QtScxml.QScxmlInvokableService] | None = ..., sessionId: str | None = ..., name: str | None = ..., invoked: bool | None = ..., parseErrors: collections.abc.Sequence[PySide6.QtScxml.QScxmlError] | None = ..., loader: PySide6.QtScxml.QScxmlCompiler.Loader | None = ..., tableData: PySide6.QtScxml.QScxmlTableData | None = ...) -> None: ...
  180. def activeStateNames(self, /, compress: bool = ...) -> typing.List[str]: ...
  181. def cancelDelayedEvent(self, sendId: str, /) -> None: ...
  182. def connectToEvent(self, scxmlEventSpec: str, receiver: PySide6.QtCore.QObject, method: bytes | bytearray | memoryview, /, type: PySide6.QtCore.Qt.ConnectionType = ...) -> PySide6.QtCore.QMetaObject.Connection: ...
  183. def connectToState(self, scxmlStateName: str, receiver: PySide6.QtCore.QObject, method: bytes | bytearray | memoryview, /, type: PySide6.QtCore.Qt.ConnectionType = ...) -> PySide6.QtCore.QMetaObject.Connection: ...
  184. def dataModel(self, /) -> PySide6.QtScxml.QScxmlDataModel: ...
  185. @staticmethod
  186. def fromData(data: PySide6.QtCore.QIODevice, /, fileName: str = ...) -> PySide6.QtScxml.QScxmlStateMachine: ...
  187. @staticmethod
  188. def fromFile(fileName: str, /) -> PySide6.QtScxml.QScxmlStateMachine: ...
  189. def init(self, /) -> bool: ...
  190. def initialValues(self, /) -> typing.Dict[str, typing.Any]: ...
  191. def invokedServices(self, /) -> typing.List[PySide6.QtScxml.QScxmlInvokableService]: ...
  192. @typing.overload
  193. def isActive(self, scxmlStateName: str, /) -> bool: ...
  194. @typing.overload
  195. def isActive(self, stateIndex: int, /) -> bool: ...
  196. def isDispatchableTarget(self, target: str, /) -> bool: ...
  197. def isInitialized(self, /) -> bool: ...
  198. def isInvoked(self, /) -> bool: ...
  199. def isRunning(self, /) -> bool: ...
  200. def loader(self, /) -> PySide6.QtScxml.QScxmlCompiler.Loader: ...
  201. def name(self, /) -> str: ...
  202. def parseErrors(self, /) -> typing.List[PySide6.QtScxml.QScxmlError]: ...
  203. def sessionId(self, /) -> str: ...
  204. def setDataModel(self, model: PySide6.QtScxml.QScxmlDataModel, /) -> None: ...
  205. def setInitialValues(self, initialValues: typing.Dict[str, typing.Any], /) -> None: ...
  206. def setLoader(self, loader: PySide6.QtScxml.QScxmlCompiler.Loader, /) -> None: ...
  207. def setRunning(self, running: bool, /) -> None: ...
  208. def setTableData(self, tableData: PySide6.QtScxml.QScxmlTableData, /) -> None: ...
  209. def start(self, /) -> None: ...
  210. def stateNames(self, /, compress: bool = ...) -> typing.List[str]: ...
  211. def stop(self, /) -> None: ...
  212. @typing.overload
  213. def submitEvent(self, event: PySide6.QtScxml.QScxmlEvent, /) -> None: ...
  214. @typing.overload
  215. def submitEvent(self, eventName: str, /) -> None: ...
  216. @typing.overload
  217. def submitEvent(self, eventName: str, data: typing.Any, /) -> None: ...
  218. def tableData(self, /) -> PySide6.QtScxml.QScxmlTableData: ...
  219. class QScxmlStaticScxmlServiceFactory(PySide6.QtScxml.QScxmlInvokableServiceFactory):
  220. def __init__(self, metaObject: PySide6.QtCore.QMetaObject, invokeInfo: PySide6.QtScxml.QScxmlExecutableContent.InvokeInfo, nameList: collections.abc.Sequence[int], parameters: collections.abc.Sequence[PySide6.QtScxml.QScxmlExecutableContent.ParameterInfo], /, parent: PySide6.QtCore.QObject | None = ...) -> None: ...
  221. def invoke(self, parentStateMachine: PySide6.QtScxml.QScxmlStateMachine, /) -> PySide6.QtScxml.QScxmlInvokableService: ...
  222. class QScxmlTableData(Shiboken.Object):
  223. def __init__(self, /) -> None: ...
  224. def assignmentInfo(self, assignmentId: int, /) -> PySide6.QtScxml.QScxmlExecutableContent.AssignmentInfo: ...
  225. def dataNames(self, /) -> typing.Tuple[typing.List[int], int]: ...
  226. def evaluatorInfo(self, evaluatorId: int, /) -> PySide6.QtScxml.QScxmlExecutableContent.EvaluatorInfo: ...
  227. def foreachInfo(self, foreachId: int, /) -> PySide6.QtScxml.QScxmlExecutableContent.ForeachInfo: ...
  228. def initialSetup(self, /) -> int: ...
  229. def instructions(self, /) -> typing.List[int]: ...
  230. def name(self, /) -> str: ...
  231. def serviceFactory(self, id: int, /) -> PySide6.QtScxml.QScxmlInvokableServiceFactory: ...
  232. def stateMachineTable(self, /) -> typing.List[int]: ...
  233. def string(self, id: int, /) -> str: ...
  234. # eof