IListDataSource.xml 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113
  1. <Type Name="IListDataSource" FullName="Terminal.Gui.IListDataSource">
  2. <TypeSignature Language="C#" Value="public interface IListDataSource" />
  3. <TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IListDataSource" />
  4. <AssemblyInfo>
  5. <AssemblyName>Terminal.Gui</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Interfaces />
  9. <Docs>
  10. <summary>
  11. Implement this interface to provide your own custom rendering for a list.
  12. </summary>
  13. <remarks>To be added.</remarks>
  14. </Docs>
  15. <Members>
  16. <Member MemberName="Count">
  17. <MemberSignature Language="C#" Value="public int Count { get; }" />
  18. <MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
  19. <MemberType>Property</MemberType>
  20. <AssemblyInfo>
  21. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  22. </AssemblyInfo>
  23. <ReturnValue>
  24. <ReturnType>System.Int32</ReturnType>
  25. </ReturnValue>
  26. <Docs>
  27. <summary>
  28. Returns the number of elements to display
  29. </summary>
  30. <value>To be added.</value>
  31. <remarks>To be added.</remarks>
  32. </Docs>
  33. </Member>
  34. <Member MemberName="IsMarked">
  35. <MemberSignature Language="C#" Value="public bool IsMarked (int item);" />
  36. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsMarked(int32 item) cil managed" />
  37. <MemberType>Method</MemberType>
  38. <AssemblyInfo>
  39. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  40. </AssemblyInfo>
  41. <ReturnValue>
  42. <ReturnType>System.Boolean</ReturnType>
  43. </ReturnValue>
  44. <Parameters>
  45. <Parameter Name="item" Type="System.Int32" />
  46. </Parameters>
  47. <Docs>
  48. <param name="item">Item index.</param>
  49. <summary>
  50. Should return whether the specified item is currently marked.
  51. </summary>
  52. <returns>
  53. <c>true</c>, if marked, <c>false</c> otherwise.</returns>
  54. <remarks>To be added.</remarks>
  55. </Docs>
  56. </Member>
  57. <Member MemberName="Render">
  58. <MemberSignature Language="C#" Value="public void Render (bool selected, int item, int col, int line, int width);" />
  59. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Render(bool selected, int32 item, int32 col, int32 line, int32 width) cil managed" />
  60. <MemberType>Method</MemberType>
  61. <AssemblyInfo>
  62. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  63. </AssemblyInfo>
  64. <ReturnValue>
  65. <ReturnType>System.Void</ReturnType>
  66. </ReturnValue>
  67. <Parameters>
  68. <Parameter Name="selected" Type="System.Boolean" />
  69. <Parameter Name="item" Type="System.Int32" />
  70. <Parameter Name="col" Type="System.Int32" />
  71. <Parameter Name="line" Type="System.Int32" />
  72. <Parameter Name="width" Type="System.Int32" />
  73. </Parameters>
  74. <Docs>
  75. <param name="selected">Describes whether the item being rendered is currently selected by the user.</param>
  76. <param name="item">The index of the item to render, zero for the first item and so on.</param>
  77. <param name="col">The column where the rendering will start</param>
  78. <param name="line">The line where the rendering will be done.</param>
  79. <param name="width">The width that must be filled out.</param>
  80. <summary>
  81. This method is invoked to render a specified item, the method should cover the entire provided width.
  82. </summary>
  83. <returns>The render.</returns>
  84. <remarks>
  85. The default color will be set before this method is invoked, and will be based on whether the item is selected or not.
  86. </remarks>
  87. </Docs>
  88. </Member>
  89. <Member MemberName="SetMark">
  90. <MemberSignature Language="C#" Value="public void SetMark (int item, bool value);" />
  91. <MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetMark(int32 item, bool value) cil managed" />
  92. <MemberType>Method</MemberType>
  93. <AssemblyInfo>
  94. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  95. </AssemblyInfo>
  96. <ReturnValue>
  97. <ReturnType>System.Void</ReturnType>
  98. </ReturnValue>
  99. <Parameters>
  100. <Parameter Name="item" Type="System.Int32" />
  101. <Parameter Name="value" Type="System.Boolean" />
  102. </Parameters>
  103. <Docs>
  104. <param name="item">Item index.</param>
  105. <param name="value">If set to <c>true</c> value.</param>
  106. <summary>
  107. Flags the item as marked.
  108. </summary>
  109. <remarks>To be added.</remarks>
  110. </Docs>
  111. </Member>
  112. </Members>
  113. </Type>