Terminal.Gui.IListDataSource.yml 9.0 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243
  1. ### YamlMime:ManagedReference
  2. items:
  3. - uid: Terminal.Gui.IListDataSource
  4. id: IListDataSource
  5. children:
  6. - Terminal.Gui.IListDataSource.Count
  7. - Terminal.Gui.IListDataSource.IsMarked(System.Int32)
  8. - Terminal.Gui.IListDataSource.Render(System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)
  9. - Terminal.Gui.IListDataSource.Render(Terminal.Gui.ListView,Terminal.Gui.ConsoleDriver,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)
  10. - Terminal.Gui.IListDataSource.SetMark(System.Int32,System.Boolean)
  11. langs:
  12. - csharp
  13. name: IListDataSource
  14. nameWithType: IListDataSource
  15. fullName: Terminal.Gui.IListDataSource
  16. type: Interface
  17. assemblies:
  18. - Terminal.Gui
  19. namespace: Terminal.Gui
  20. summary: Implement this interface to provide your own custom rendering for a list.
  21. syntax:
  22. content: public interface IListDataSource
  23. implements: []
  24. - uid: Terminal.Gui.IListDataSource.Count
  25. id: Count
  26. parent: Terminal.Gui.IListDataSource
  27. langs:
  28. - csharp
  29. name: Count
  30. nameWithType: IListDataSource.Count
  31. fullName: IListDataSource.Count
  32. type: Property
  33. assemblies:
  34. - Terminal.Gui
  35. namespace: Terminal.Gui
  36. summary: Returns the number of elements to display
  37. syntax:
  38. content: public int Count { get; }
  39. return:
  40. type: System.Int32
  41. description: To be added.
  42. overload: Terminal.Gui.IListDataSource.Count*
  43. exceptions: []
  44. - uid: Terminal.Gui.IListDataSource.IsMarked(System.Int32)
  45. id: IsMarked(System.Int32)
  46. parent: Terminal.Gui.IListDataSource
  47. langs:
  48. - csharp
  49. name: IsMarked(Int32)
  50. nameWithType: IListDataSource.IsMarked(Int32)
  51. fullName: IListDataSource.IsMarked(Int32)
  52. type: Method
  53. assemblies:
  54. - Terminal.Gui
  55. namespace: Terminal.Gui
  56. summary: Should return whether the specified item is currently marked.
  57. syntax:
  58. content: public bool IsMarked (int item);
  59. parameters:
  60. - id: item
  61. type: System.Int32
  62. description: Item index.
  63. return:
  64. type: System.Boolean
  65. description: <code>true</code>, if marked, <code>false</code> otherwise.
  66. overload: Terminal.Gui.IListDataSource.IsMarked*
  67. exceptions: []
  68. - uid: Terminal.Gui.IListDataSource.Render(System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)
  69. id: Render(System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)
  70. parent: Terminal.Gui.IListDataSource
  71. langs:
  72. - csharp
  73. name: Render(Boolean, Int32, Int32, Int32, Int32)
  74. nameWithType: IListDataSource.Render(Boolean, Int32, Int32, Int32, Int32)
  75. fullName: IListDataSource.Render(Boolean, Int32, Int32, Int32, Int32)
  76. type: Method
  77. assemblies: []
  78. namespace: Terminal.Gui
  79. summary: This method is invoked to render a specified item, the method should cover the entire provided width.
  80. remarks: The default color will be set before this method is invoked, and will be based on whether the item is selected or not.
  81. syntax:
  82. content: public void Render (bool selected, int item, int col, int line, int width);
  83. parameters:
  84. - id: selected
  85. type: System.Boolean
  86. description: Describes whether the item being rendered is currently selected by the user.
  87. - id: item
  88. type: System.Int32
  89. description: The index of the item to render, zero for the first item and so on.
  90. - id: col
  91. type: System.Int32
  92. description: The column where the rendering will start
  93. - id: line
  94. type: System.Int32
  95. description: The line where the rendering will be done.
  96. - id: width
  97. type: System.Int32
  98. description: The width that must be filled out.
  99. overload: Terminal.Gui.IListDataSource.Render*
  100. exceptions: []
  101. - uid: Terminal.Gui.IListDataSource.Render(Terminal.Gui.ListView,Terminal.Gui.ConsoleDriver,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)
  102. id: Render(Terminal.Gui.ListView,Terminal.Gui.ConsoleDriver,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)
  103. parent: Terminal.Gui.IListDataSource
  104. langs:
  105. - csharp
  106. name: Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32)
  107. nameWithType: IListDataSource.Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32)
  108. fullName: IListDataSource.Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32)
  109. type: Method
  110. assemblies:
  111. - Terminal.Gui
  112. namespace: Terminal.Gui
  113. summary: This method is invoked to render a specified item, the method should cover the entire provided width.
  114. remarks: The default color will be set before this method is invoked, and will be based on whether the item is selected or not.
  115. syntax:
  116. content: public void Render (Terminal.Gui.ListView container, Terminal.Gui.ConsoleDriver driver, bool selected, int item, int col, int line, int width);
  117. parameters:
  118. - id: container
  119. type: Terminal.Gui.ListView
  120. description: To be added.
  121. - id: driver
  122. type: Terminal.Gui.ConsoleDriver
  123. description: To be added.
  124. - id: selected
  125. type: System.Boolean
  126. description: Describes whether the item being rendered is currently selected by the user.
  127. - id: item
  128. type: System.Int32
  129. description: The index of the item to render, zero for the first item and so on.
  130. - id: col
  131. type: System.Int32
  132. description: The column where the rendering will start
  133. - id: line
  134. type: System.Int32
  135. description: The line where the rendering will be done.
  136. - id: width
  137. type: System.Int32
  138. description: The width that must be filled out.
  139. overload: Terminal.Gui.IListDataSource.Render*
  140. exceptions: []
  141. - uid: Terminal.Gui.IListDataSource.SetMark(System.Int32,System.Boolean)
  142. id: SetMark(System.Int32,System.Boolean)
  143. parent: Terminal.Gui.IListDataSource
  144. langs:
  145. - csharp
  146. name: SetMark(Int32, Boolean)
  147. nameWithType: IListDataSource.SetMark(Int32, Boolean)
  148. fullName: IListDataSource.SetMark(Int32, Boolean)
  149. type: Method
  150. assemblies:
  151. - Terminal.Gui
  152. namespace: Terminal.Gui
  153. summary: Flags the item as marked.
  154. syntax:
  155. content: public void SetMark (int item, bool value);
  156. parameters:
  157. - id: item
  158. type: System.Int32
  159. description: Item index.
  160. - id: value
  161. type: System.Boolean
  162. description: If set to <code>true</code> value.
  163. overload: Terminal.Gui.IListDataSource.SetMark*
  164. exceptions: []
  165. references:
  166. - uid: Terminal.Gui.IListDataSource.Count
  167. parent: Terminal.Gui.IListDataSource
  168. isExternal: false
  169. name: Count
  170. nameWithType: IListDataSource.Count
  171. fullName: IListDataSource.Count
  172. - uid: System.Int32
  173. parent: System
  174. isExternal: true
  175. name: Int32
  176. nameWithType: Int32
  177. fullName: System.Int32
  178. - uid: Terminal.Gui.IListDataSource.IsMarked(System.Int32)
  179. parent: Terminal.Gui.IListDataSource
  180. isExternal: false
  181. name: IsMarked(Int32)
  182. nameWithType: IListDataSource.IsMarked(Int32)
  183. fullName: IListDataSource.IsMarked(Int32)
  184. - uid: System.Boolean
  185. parent: System
  186. isExternal: true
  187. name: Boolean
  188. nameWithType: Boolean
  189. fullName: System.Boolean
  190. - uid: Terminal.Gui.IListDataSource.Render(System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)
  191. parent: Terminal.Gui.IListDataSource
  192. isExternal: false
  193. name: Render(Boolean, Int32, Int32, Int32, Int32)
  194. nameWithType: IListDataSource.Render(Boolean, Int32, Int32, Int32, Int32)
  195. fullName: IListDataSource.Render(Boolean, Int32, Int32, Int32, Int32)
  196. - uid: Terminal.Gui.IListDataSource.Render(Terminal.Gui.ListView,Terminal.Gui.ConsoleDriver,System.Boolean,System.Int32,System.Int32,System.Int32,System.Int32)
  197. parent: Terminal.Gui.IListDataSource
  198. isExternal: false
  199. name: Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32)
  200. nameWithType: IListDataSource.Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32)
  201. fullName: IListDataSource.Render(ListView, ConsoleDriver, Boolean, Int32, Int32, Int32, Int32)
  202. - uid: Terminal.Gui.ListView
  203. parent: Terminal.Gui
  204. isExternal: false
  205. name: ListView
  206. nameWithType: ListView
  207. fullName: Terminal.Gui.ListView
  208. - uid: Terminal.Gui.ConsoleDriver
  209. parent: Terminal.Gui
  210. isExternal: false
  211. name: ConsoleDriver
  212. nameWithType: ConsoleDriver
  213. fullName: Terminal.Gui.ConsoleDriver
  214. - uid: Terminal.Gui.IListDataSource.SetMark(System.Int32,System.Boolean)
  215. parent: Terminal.Gui.IListDataSource
  216. isExternal: false
  217. name: SetMark(Int32, Boolean)
  218. nameWithType: IListDataSource.SetMark(Int32, Boolean)
  219. fullName: IListDataSource.SetMark(Int32, Boolean)
  220. - uid: Terminal.Gui.IListDataSource.Count*
  221. parent: Terminal.Gui.IListDataSource
  222. isExternal: false
  223. name: Count
  224. nameWithType: IListDataSource.Count
  225. fullName: IListDataSource.Count
  226. - uid: Terminal.Gui.IListDataSource.IsMarked*
  227. parent: Terminal.Gui.IListDataSource
  228. isExternal: false
  229. name: IsMarked
  230. nameWithType: IListDataSource.IsMarked
  231. fullName: IListDataSource.IsMarked
  232. - uid: Terminal.Gui.IListDataSource.Render*
  233. parent: Terminal.Gui.IListDataSource
  234. isExternal: false
  235. name: Render
  236. nameWithType: IListDataSource.Render
  237. fullName: IListDataSource.Render
  238. - uid: Terminal.Gui.IListDataSource.SetMark*
  239. parent: Terminal.Gui.IListDataSource
  240. isExternal: false
  241. name: SetMark
  242. nameWithType: IListDataSource.SetMark
  243. fullName: IListDataSource.SetMark