QtStateMachine.pyi 17 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292
  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.QtStateMachine, except for defaults which are replaced by "...".
  6. """
  7. # mypy: disable-error-code="override, overload-overlap"
  8. # Module `PySide6.QtStateMachine`
  9. import PySide6.QtStateMachine
  10. import PySide6.QtCore
  11. import PySide6.QtGui
  12. import enum
  13. import typing
  14. import collections.abc
  15. from PySide6.QtCore import Signal
  16. class QAbstractState(PySide6.QtCore.QObject):
  17. activeChanged : typing.ClassVar[Signal] = ... # activeChanged(bool)
  18. entered : typing.ClassVar[Signal] = ... # entered()
  19. exited : typing.ClassVar[Signal] = ... # exited()
  20. def __init__(self, /, parent: PySide6.QtStateMachine.QState | None = ..., *, active: bool | None = ...) -> None: ...
  21. def active(self, /) -> bool: ...
  22. def event(self, e: PySide6.QtCore.QEvent, /) -> bool: ...
  23. def machine(self, /) -> PySide6.QtStateMachine.QStateMachine: ...
  24. def onEntry(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  25. def onExit(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  26. def parentState(self, /) -> PySide6.QtStateMachine.QState: ...
  27. class QAbstractTransition(PySide6.QtCore.QObject):
  28. targetStateChanged : typing.ClassVar[Signal] = ... # targetStateChanged()
  29. targetStatesChanged : typing.ClassVar[Signal] = ... # targetStatesChanged()
  30. triggered : typing.ClassVar[Signal] = ... # triggered()
  31. class TransitionType(enum.Enum):
  32. ExternalTransition = 0x0
  33. InternalTransition = 0x1
  34. def __init__(self, /, sourceState: PySide6.QtStateMachine.QState | None = ..., *, targetState: PySide6.QtStateMachine.QAbstractState | None = ..., targetStates: collections.abc.Sequence[PySide6.QtStateMachine.QAbstractState] | None = ..., transitionType: PySide6.QtStateMachine.QAbstractTransition.TransitionType | None = ...) -> None: ...
  35. def addAnimation(self, animation: PySide6.QtCore.QAbstractAnimation, /) -> None: ...
  36. def animations(self, /) -> typing.List[PySide6.QtCore.QAbstractAnimation]: ...
  37. def event(self, e: PySide6.QtCore.QEvent, /) -> bool: ...
  38. def eventTest(self, event: PySide6.QtCore.QEvent, /) -> bool: ...
  39. def machine(self, /) -> PySide6.QtStateMachine.QStateMachine: ...
  40. def onTransition(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  41. def removeAnimation(self, animation: PySide6.QtCore.QAbstractAnimation, /) -> None: ...
  42. def setTargetState(self, target: PySide6.QtStateMachine.QAbstractState, /) -> None: ...
  43. def setTargetStates(self, targets: collections.abc.Sequence[PySide6.QtStateMachine.QAbstractState], /) -> None: ...
  44. def setTransitionType(self, type: PySide6.QtStateMachine.QAbstractTransition.TransitionType, /) -> None: ...
  45. def sourceState(self, /) -> PySide6.QtStateMachine.QState: ...
  46. def targetState(self, /) -> PySide6.QtStateMachine.QAbstractState: ...
  47. def targetStates(self, /) -> typing.List[PySide6.QtStateMachine.QAbstractState]: ...
  48. def transitionType(self, /) -> PySide6.QtStateMachine.QAbstractTransition.TransitionType: ...
  49. class QEventTransition(PySide6.QtStateMachine.QAbstractTransition):
  50. @typing.overload
  51. def __init__(self, object: PySide6.QtCore.QObject, type: PySide6.QtCore.QEvent.Type, /, sourceState: PySide6.QtStateMachine.QState | None = ..., *, eventSource: PySide6.QtCore.QObject | None = ..., eventType: PySide6.QtCore.QEvent.Type | None = ...) -> None: ...
  52. @typing.overload
  53. def __init__(self, /, sourceState: PySide6.QtStateMachine.QState | None = ..., *, eventSource: PySide6.QtCore.QObject | None = ..., eventType: PySide6.QtCore.QEvent.Type | None = ...) -> None: ...
  54. def event(self, e: PySide6.QtCore.QEvent, /) -> bool: ...
  55. def eventSource(self, /) -> PySide6.QtCore.QObject: ...
  56. def eventTest(self, event: PySide6.QtCore.QEvent, /) -> bool: ...
  57. def eventType(self, /) -> PySide6.QtCore.QEvent.Type: ...
  58. def onTransition(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  59. def setEventSource(self, object: PySide6.QtCore.QObject, /) -> None: ...
  60. def setEventType(self, type: PySide6.QtCore.QEvent.Type, /) -> None: ...
  61. class QFinalState(PySide6.QtStateMachine.QAbstractState):
  62. def __init__(self, /, parent: PySide6.QtStateMachine.QState | None = ...) -> None: ...
  63. def event(self, e: PySide6.QtCore.QEvent, /) -> bool: ...
  64. def onEntry(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  65. def onExit(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  66. class QHistoryState(PySide6.QtStateMachine.QAbstractState):
  67. defaultStateChanged : typing.ClassVar[Signal] = ... # defaultStateChanged()
  68. defaultTransitionChanged : typing.ClassVar[Signal] = ... # defaultTransitionChanged()
  69. historyTypeChanged : typing.ClassVar[Signal] = ... # historyTypeChanged()
  70. class HistoryType(enum.Enum):
  71. ShallowHistory = 0x0
  72. DeepHistory = 0x1
  73. @typing.overload
  74. def __init__(self, type: PySide6.QtStateMachine.QHistoryState.HistoryType, /, parent: PySide6.QtStateMachine.QState | None = ..., *, defaultState: PySide6.QtStateMachine.QAbstractState | None = ..., defaultTransition: PySide6.QtStateMachine.QAbstractTransition | None = ..., historyType: PySide6.QtStateMachine.QHistoryState.HistoryType | None = ...) -> None: ...
  75. @typing.overload
  76. def __init__(self, /, parent: PySide6.QtStateMachine.QState | None = ..., *, defaultState: PySide6.QtStateMachine.QAbstractState | None = ..., defaultTransition: PySide6.QtStateMachine.QAbstractTransition | None = ..., historyType: PySide6.QtStateMachine.QHistoryState.HistoryType | None = ...) -> None: ...
  77. def defaultState(self, /) -> PySide6.QtStateMachine.QAbstractState: ...
  78. def defaultTransition(self, /) -> PySide6.QtStateMachine.QAbstractTransition: ...
  79. def event(self, e: PySide6.QtCore.QEvent, /) -> bool: ...
  80. def historyType(self, /) -> PySide6.QtStateMachine.QHistoryState.HistoryType: ...
  81. def onEntry(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  82. def onExit(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  83. def setDefaultState(self, state: PySide6.QtStateMachine.QAbstractState, /) -> None: ...
  84. def setDefaultTransition(self, transition: PySide6.QtStateMachine.QAbstractTransition, /) -> None: ...
  85. def setHistoryType(self, type: PySide6.QtStateMachine.QHistoryState.HistoryType, /) -> None: ...
  86. class QIntList: ...
  87. class QKeyEventTransition(PySide6.QtStateMachine.QEventTransition):
  88. @typing.overload
  89. def __init__(self, object: PySide6.QtCore.QObject, type: PySide6.QtCore.QEvent.Type, key: int, /, sourceState: PySide6.QtStateMachine.QState | None = ..., *, modifierMask: PySide6.QtCore.Qt.KeyboardModifier | None = ...) -> None: ...
  90. @typing.overload
  91. def __init__(self, /, sourceState: PySide6.QtStateMachine.QState | None = ..., *, key: int | None = ..., modifierMask: PySide6.QtCore.Qt.KeyboardModifier | None = ...) -> None: ...
  92. def eventTest(self, event: PySide6.QtCore.QEvent, /) -> bool: ...
  93. def key(self, /) -> int: ...
  94. def modifierMask(self, /) -> PySide6.QtCore.Qt.KeyboardModifier: ...
  95. def onTransition(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  96. def setKey(self, key: int, /) -> None: ...
  97. def setModifierMask(self, modifiers: PySide6.QtCore.Qt.KeyboardModifier, /) -> None: ...
  98. class QMouseEventTransition(PySide6.QtStateMachine.QEventTransition):
  99. @typing.overload
  100. def __init__(self, object: PySide6.QtCore.QObject, type: PySide6.QtCore.QEvent.Type, button: PySide6.QtCore.Qt.MouseButton, /, sourceState: PySide6.QtStateMachine.QState | None = ..., *, modifierMask: PySide6.QtCore.Qt.KeyboardModifier | None = ...) -> None: ...
  101. @typing.overload
  102. def __init__(self, /, sourceState: PySide6.QtStateMachine.QState | None = ..., *, button: PySide6.QtCore.Qt.MouseButton | None = ..., modifierMask: PySide6.QtCore.Qt.KeyboardModifier | None = ...) -> None: ...
  103. def button(self, /) -> PySide6.QtCore.Qt.MouseButton: ...
  104. def eventTest(self, event: PySide6.QtCore.QEvent, /) -> bool: ...
  105. def hitTestPath(self, /) -> PySide6.QtGui.QPainterPath: ...
  106. def modifierMask(self, /) -> PySide6.QtCore.Qt.KeyboardModifier: ...
  107. def onTransition(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  108. def setButton(self, button: PySide6.QtCore.Qt.MouseButton, /) -> None: ...
  109. def setHitTestPath(self, path: PySide6.QtGui.QPainterPath, /) -> None: ...
  110. def setModifierMask(self, modifiers: PySide6.QtCore.Qt.KeyboardModifier, /) -> None: ...
  111. class QSignalTransition(PySide6.QtStateMachine.QAbstractTransition):
  112. senderObjectChanged : typing.ClassVar[Signal] = ... # senderObjectChanged()
  113. signalChanged : typing.ClassVar[Signal] = ... # signalChanged()
  114. @typing.overload
  115. def __init__(self, sender: PySide6.QtCore.QObject, signal: bytes | bytearray | memoryview, /, sourceState: PySide6.QtStateMachine.QState | None = ..., *, senderObject: PySide6.QtCore.QObject | None = ...) -> None: ...
  116. @typing.overload
  117. def __init__(self, /, sourceState: PySide6.QtStateMachine.QState | None = ..., *, senderObject: PySide6.QtCore.QObject | None = ..., signal: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview | None = ...) -> None: ...
  118. @typing.overload
  119. def __init__(self, signal: object, /, state: PySide6.QtStateMachine.QState | None = ..., *, senderObject: PySide6.QtCore.QObject | None = ...) -> None: ...
  120. def event(self, e: PySide6.QtCore.QEvent, /) -> bool: ...
  121. def eventTest(self, event: PySide6.QtCore.QEvent, /) -> bool: ...
  122. def onTransition(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  123. def senderObject(self, /) -> PySide6.QtCore.QObject: ...
  124. def setSenderObject(self, sender: PySide6.QtCore.QObject, /) -> None: ...
  125. def setSignal(self, signal: PySide6.QtCore.QByteArray | bytes | bytearray | memoryview, /) -> None: ...
  126. def signal(self, /) -> PySide6.QtCore.QByteArray: ...
  127. class QState(PySide6.QtStateMachine.QAbstractState):
  128. childModeChanged : typing.ClassVar[Signal] = ... # childModeChanged()
  129. errorStateChanged : typing.ClassVar[Signal] = ... # errorStateChanged()
  130. finished : typing.ClassVar[Signal] = ... # finished()
  131. initialStateChanged : typing.ClassVar[Signal] = ... # initialStateChanged()
  132. propertiesAssigned : typing.ClassVar[Signal] = ... # propertiesAssigned()
  133. class ChildMode(enum.Enum):
  134. ExclusiveStates = 0x0
  135. ParallelStates = 0x1
  136. class RestorePolicy(enum.Enum):
  137. DontRestoreProperties = 0x0
  138. RestoreProperties = 0x1
  139. @typing.overload
  140. def __init__(self, childMode: PySide6.QtStateMachine.QState.ChildMode, /, parent: PySide6.QtStateMachine.QState | None = ..., *, initialState: PySide6.QtStateMachine.QAbstractState | None = ..., errorState: PySide6.QtStateMachine.QAbstractState | None = ...) -> None: ...
  141. @typing.overload
  142. def __init__(self, /, parent: PySide6.QtStateMachine.QState | None = ..., *, initialState: PySide6.QtStateMachine.QAbstractState | None = ..., errorState: PySide6.QtStateMachine.QAbstractState | None = ..., childMode: PySide6.QtStateMachine.QState.ChildMode | None = ...) -> None: ...
  143. @typing.overload
  144. def addTransition(self, target: PySide6.QtStateMachine.QAbstractState, /) -> PySide6.QtStateMachine.QAbstractTransition: ...
  145. @typing.overload
  146. def addTransition(self, transition: PySide6.QtStateMachine.QAbstractTransition, /) -> None: ...
  147. @typing.overload
  148. def addTransition(self, sender: PySide6.QtCore.QObject, signal: str, target: PySide6.QtStateMachine.QAbstractState, /) -> PySide6.QtStateMachine.QSignalTransition: ...
  149. @typing.overload
  150. def addTransition(self, signal: object, arg__2: PySide6.QtStateMachine.QAbstractState, /) -> PySide6.QtStateMachine.QSignalTransition: ...
  151. def assignProperty(self, object: PySide6.QtCore.QObject, name: str, value: typing.Any, /) -> None: ...
  152. def childMode(self, /) -> PySide6.QtStateMachine.QState.ChildMode: ...
  153. def errorState(self, /) -> PySide6.QtStateMachine.QAbstractState: ...
  154. def event(self, e: PySide6.QtCore.QEvent, /) -> bool: ...
  155. def initialState(self, /) -> PySide6.QtStateMachine.QAbstractState: ...
  156. def onEntry(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  157. def onExit(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  158. def removeTransition(self, transition: PySide6.QtStateMachine.QAbstractTransition, /) -> None: ...
  159. def setChildMode(self, mode: PySide6.QtStateMachine.QState.ChildMode, /) -> None: ...
  160. def setErrorState(self, state: PySide6.QtStateMachine.QAbstractState, /) -> None: ...
  161. def setInitialState(self, state: PySide6.QtStateMachine.QAbstractState, /) -> None: ...
  162. def transitions(self, /) -> typing.List[PySide6.QtStateMachine.QAbstractTransition]: ...
  163. class QStateMachine(PySide6.QtStateMachine.QState):
  164. runningChanged : typing.ClassVar[Signal] = ... # runningChanged(bool)
  165. started : typing.ClassVar[Signal] = ... # started()
  166. stopped : typing.ClassVar[Signal] = ... # stopped()
  167. class Error(enum.Enum):
  168. NoError = 0x0
  169. NoInitialStateError = 0x1
  170. NoDefaultStateInHistoryStateError = 0x2
  171. NoCommonAncestorForTransitionError = 0x3
  172. StateMachineChildModeSetToParallelError = 0x4
  173. class EventPriority(enum.Enum):
  174. NormalPriority = 0x0
  175. HighPriority = 0x1
  176. class SignalEvent(PySide6.QtCore.QEvent):
  177. def __init__(self, sender: PySide6.QtCore.QObject, signalIndex: int, arguments: collections.abc.Sequence[typing.Any], /) -> None: ...
  178. def arguments(self, /) -> typing.List[typing.Any]: ...
  179. def sender(self, /) -> PySide6.QtCore.QObject: ...
  180. def signalIndex(self, /) -> int: ...
  181. class WrappedEvent(PySide6.QtCore.QEvent):
  182. def __init__(self, object: PySide6.QtCore.QObject, event: PySide6.QtCore.QEvent, /) -> None: ...
  183. def event(self, /) -> PySide6.QtCore.QEvent: ...
  184. def object(self, /) -> PySide6.QtCore.QObject: ...
  185. @typing.overload
  186. def __init__(self, childMode: PySide6.QtStateMachine.QState.ChildMode, /, parent: PySide6.QtCore.QObject | None = ..., *, errorString: str | None = ..., globalRestorePolicy: PySide6.QtStateMachine.QState.RestorePolicy | None = ..., running: bool | None = ..., animated: bool | None = ...) -> None: ...
  187. @typing.overload
  188. def __init__(self, /, parent: PySide6.QtCore.QObject | None = ..., *, errorString: str | None = ..., globalRestorePolicy: PySide6.QtStateMachine.QState.RestorePolicy | None = ..., running: bool | None = ..., animated: bool | None = ...) -> None: ...
  189. def addDefaultAnimation(self, animation: PySide6.QtCore.QAbstractAnimation, /) -> None: ...
  190. def addState(self, state: PySide6.QtStateMachine.QAbstractState, /) -> None: ...
  191. def beginMicrostep(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  192. def beginSelectTransitions(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  193. def cancelDelayedEvent(self, id: int, /) -> bool: ...
  194. def clearError(self, /) -> None: ...
  195. def configuration(self, /) -> typing.Set[PySide6.QtStateMachine.QAbstractState]: ...
  196. def defaultAnimations(self, /) -> typing.List[PySide6.QtCore.QAbstractAnimation]: ...
  197. def endMicrostep(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  198. def endSelectTransitions(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  199. def error(self, /) -> PySide6.QtStateMachine.QStateMachine.Error: ...
  200. def errorString(self, /) -> str: ...
  201. def event(self, e: PySide6.QtCore.QEvent, /) -> bool: ...
  202. def eventFilter(self, watched: PySide6.QtCore.QObject, event: PySide6.QtCore.QEvent, /) -> bool: ...
  203. def globalRestorePolicy(self, /) -> PySide6.QtStateMachine.QState.RestorePolicy: ...
  204. def isAnimated(self, /) -> bool: ...
  205. def isRunning(self, /) -> bool: ...
  206. def onEntry(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  207. def onExit(self, event: PySide6.QtCore.QEvent, /) -> None: ...
  208. def postDelayedEvent(self, event: PySide6.QtCore.QEvent, delay: int, /) -> int: ...
  209. def postEvent(self, event: PySide6.QtCore.QEvent, /, priority: PySide6.QtStateMachine.QStateMachine.EventPriority = ...) -> None: ...
  210. def removeDefaultAnimation(self, animation: PySide6.QtCore.QAbstractAnimation, /) -> None: ...
  211. def removeState(self, state: PySide6.QtStateMachine.QAbstractState, /) -> None: ...
  212. def setAnimated(self, enabled: bool, /) -> None: ...
  213. def setGlobalRestorePolicy(self, restorePolicy: PySide6.QtStateMachine.QState.RestorePolicy, /) -> None: ...
  214. def setRunning(self, running: bool, /) -> None: ...
  215. def start(self, /) -> None: ...
  216. def stop(self, /) -> None: ...
  217. # eof