Mono.Terminal.IMainLoopDriver.yml 6.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209
  1. ### YamlMime:ManagedReference
  2. items:
  3. - uid: Mono.Terminal.IMainLoopDriver
  4. commentId: T:Mono.Terminal.IMainLoopDriver
  5. id: IMainLoopDriver
  6. parent: Mono.Terminal
  7. children:
  8. - Mono.Terminal.IMainLoopDriver.EventsPending(System.Boolean)
  9. - Mono.Terminal.IMainLoopDriver.MainIteration
  10. - Mono.Terminal.IMainLoopDriver.Setup(Mono.Terminal.MainLoop)
  11. - Mono.Terminal.IMainLoopDriver.Wakeup
  12. langs:
  13. - csharp
  14. - vb
  15. name: IMainLoopDriver
  16. nameWithType: IMainLoopDriver
  17. fullName: Mono.Terminal.IMainLoopDriver
  18. type: Interface
  19. source:
  20. remote:
  21. path: Terminal.Gui/MonoCurses/mainloop.cs
  22. branch: docs_tweaks
  23. repo: tig:tig/gui.cs.git
  24. id: IMainLoopDriver
  25. path: ../Terminal.Gui/MonoCurses/mainloop.cs
  26. startLine: 37
  27. assemblies:
  28. - Terminal.Gui
  29. namespace: Mono.Terminal
  30. summary: "\nPublic interface to create your own platform specific main loop driver.\n"
  31. example: []
  32. syntax:
  33. content: public interface IMainLoopDriver
  34. content.vb: Public Interface IMainLoopDriver
  35. modifiers.csharp:
  36. - public
  37. - interface
  38. modifiers.vb:
  39. - Public
  40. - Interface
  41. - uid: Mono.Terminal.IMainLoopDriver.Setup(Mono.Terminal.MainLoop)
  42. commentId: M:Mono.Terminal.IMainLoopDriver.Setup(Mono.Terminal.MainLoop)
  43. id: Setup(Mono.Terminal.MainLoop)
  44. parent: Mono.Terminal.IMainLoopDriver
  45. langs:
  46. - csharp
  47. - vb
  48. name: Setup(MainLoop)
  49. nameWithType: IMainLoopDriver.Setup(MainLoop)
  50. fullName: Mono.Terminal.IMainLoopDriver.Setup(Mono.Terminal.MainLoop)
  51. type: Method
  52. source:
  53. remote:
  54. path: Terminal.Gui/MonoCurses/mainloop.cs
  55. branch: docs_tweaks
  56. repo: tig:tig/gui.cs.git
  57. id: Setup
  58. path: ../Terminal.Gui/MonoCurses/mainloop.cs
  59. startLine: 42
  60. assemblies:
  61. - Terminal.Gui
  62. namespace: Mono.Terminal
  63. summary: "\nInitializes the main loop driver, gets the calling main loop for the initialization.\n"
  64. example: []
  65. syntax:
  66. content: void Setup(MainLoop mainLoop)
  67. parameters:
  68. - id: mainLoop
  69. type: Mono.Terminal.MainLoop
  70. description: Main loop.
  71. content.vb: Sub Setup(mainLoop As MainLoop)
  72. overload: Mono.Terminal.IMainLoopDriver.Setup*
  73. - uid: Mono.Terminal.IMainLoopDriver.Wakeup
  74. commentId: M:Mono.Terminal.IMainLoopDriver.Wakeup
  75. id: Wakeup
  76. parent: Mono.Terminal.IMainLoopDriver
  77. langs:
  78. - csharp
  79. - vb
  80. name: Wakeup()
  81. nameWithType: IMainLoopDriver.Wakeup()
  82. fullName: Mono.Terminal.IMainLoopDriver.Wakeup()
  83. type: Method
  84. source:
  85. remote:
  86. path: Terminal.Gui/MonoCurses/mainloop.cs
  87. branch: docs_tweaks
  88. repo: tig:tig/gui.cs.git
  89. id: Wakeup
  90. path: ../Terminal.Gui/MonoCurses/mainloop.cs
  91. startLine: 47
  92. assemblies:
  93. - Terminal.Gui
  94. namespace: Mono.Terminal
  95. summary: "\nWakes up the mainloop that might be waiting on input, must be thread safe.\n"
  96. example: []
  97. syntax:
  98. content: void Wakeup()
  99. content.vb: Sub Wakeup
  100. overload: Mono.Terminal.IMainLoopDriver.Wakeup*
  101. - uid: Mono.Terminal.IMainLoopDriver.EventsPending(System.Boolean)
  102. commentId: M:Mono.Terminal.IMainLoopDriver.EventsPending(System.Boolean)
  103. id: EventsPending(System.Boolean)
  104. parent: Mono.Terminal.IMainLoopDriver
  105. langs:
  106. - csharp
  107. - vb
  108. name: EventsPending(Boolean)
  109. nameWithType: IMainLoopDriver.EventsPending(Boolean)
  110. fullName: Mono.Terminal.IMainLoopDriver.EventsPending(System.Boolean)
  111. type: Method
  112. source:
  113. remote:
  114. path: Terminal.Gui/MonoCurses/mainloop.cs
  115. branch: docs_tweaks
  116. repo: tig:tig/gui.cs.git
  117. id: EventsPending
  118. path: ../Terminal.Gui/MonoCurses/mainloop.cs
  119. startLine: 54
  120. assemblies:
  121. - Terminal.Gui
  122. namespace: Mono.Terminal
  123. summary: "\nMust report whether there are any events pending, or even block waiting for events.\n"
  124. example: []
  125. syntax:
  126. content: bool EventsPending(bool wait)
  127. parameters:
  128. - id: wait
  129. type: System.Boolean
  130. description: If set to <code>true</code> wait until an event is available, otherwise return immediately.
  131. return:
  132. type: System.Boolean
  133. description: <code>true</code>, if there were pending events, <code>false</code> otherwise.
  134. content.vb: Function EventsPending(wait As Boolean) As Boolean
  135. overload: Mono.Terminal.IMainLoopDriver.EventsPending*
  136. - uid: Mono.Terminal.IMainLoopDriver.MainIteration
  137. commentId: M:Mono.Terminal.IMainLoopDriver.MainIteration
  138. id: MainIteration
  139. parent: Mono.Terminal.IMainLoopDriver
  140. langs:
  141. - csharp
  142. - vb
  143. name: MainIteration()
  144. nameWithType: IMainLoopDriver.MainIteration()
  145. fullName: Mono.Terminal.IMainLoopDriver.MainIteration()
  146. type: Method
  147. source:
  148. remote:
  149. path: Terminal.Gui/MonoCurses/mainloop.cs
  150. branch: docs_tweaks
  151. repo: tig:tig/gui.cs.git
  152. id: MainIteration
  153. path: ../Terminal.Gui/MonoCurses/mainloop.cs
  154. startLine: 59
  155. assemblies:
  156. - Terminal.Gui
  157. namespace: Mono.Terminal
  158. summary: "\nThe interation function.\n"
  159. example: []
  160. syntax:
  161. content: void MainIteration()
  162. content.vb: Sub MainIteration
  163. overload: Mono.Terminal.IMainLoopDriver.MainIteration*
  164. references:
  165. - uid: Mono.Terminal
  166. commentId: N:Mono.Terminal
  167. name: Mono.Terminal
  168. nameWithType: Mono.Terminal
  169. fullName: Mono.Terminal
  170. - uid: Mono.Terminal.IMainLoopDriver.Setup*
  171. commentId: Overload:Mono.Terminal.IMainLoopDriver.Setup
  172. name: Setup
  173. nameWithType: IMainLoopDriver.Setup
  174. fullName: Mono.Terminal.IMainLoopDriver.Setup
  175. - uid: Mono.Terminal.MainLoop
  176. commentId: T:Mono.Terminal.MainLoop
  177. parent: Mono.Terminal
  178. name: MainLoop
  179. nameWithType: MainLoop
  180. fullName: Mono.Terminal.MainLoop
  181. - uid: Mono.Terminal.IMainLoopDriver.Wakeup*
  182. commentId: Overload:Mono.Terminal.IMainLoopDriver.Wakeup
  183. name: Wakeup
  184. nameWithType: IMainLoopDriver.Wakeup
  185. fullName: Mono.Terminal.IMainLoopDriver.Wakeup
  186. - uid: Mono.Terminal.IMainLoopDriver.EventsPending*
  187. commentId: Overload:Mono.Terminal.IMainLoopDriver.EventsPending
  188. name: EventsPending
  189. nameWithType: IMainLoopDriver.EventsPending
  190. fullName: Mono.Terminal.IMainLoopDriver.EventsPending
  191. - uid: System.Boolean
  192. commentId: T:System.Boolean
  193. parent: System
  194. isExternal: true
  195. name: Boolean
  196. nameWithType: Boolean
  197. fullName: System.Boolean
  198. - uid: System
  199. commentId: N:System
  200. isExternal: true
  201. name: System
  202. nameWithType: System
  203. fullName: System
  204. - uid: Mono.Terminal.IMainLoopDriver.MainIteration*
  205. commentId: Overload:Mono.Terminal.IMainLoopDriver.MainIteration
  206. name: MainIteration
  207. nameWithType: IMainLoopDriver.MainIteration
  208. fullName: Mono.Terminal.IMainLoopDriver.MainIteration
  209. shouldSkipMarkup: true