Files
Terminal.Gui/ecmadocs/en/Terminal.Gui/IListDataSource.xml
Miguel de Icaza af05d158e2 Updated docs
2018-02-08 22:36:24 -05:00

114 lines
4.7 KiB
XML

<Type Name="IListDataSource" FullName="Terminal.Gui.IListDataSource">
<TypeSignature Language="C#" Value="public interface IListDataSource" />
<TypeSignature Language="ILAsm" Value=".class public interface auto ansi abstract IListDataSource" />
<AssemblyInfo>
<AssemblyName>Terminal.Gui</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<Interfaces />
<Docs>
<summary>
Implement this interface to provide your own custom rendering for a list.
</summary>
<remarks>To be added.</remarks>
</Docs>
<Members>
<Member MemberName="Count">
<MemberSignature Language="C#" Value="public int Count { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 Count" />
<MemberType>Property</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>
Returns the number of elements to display
</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="IsMarked">
<MemberSignature Language="C#" Value="public bool IsMarked (int item);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance bool IsMarked(int32 item) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="item" Type="System.Int32" />
</Parameters>
<Docs>
<param name="item">Item index.</param>
<summary>
Should return whether the specified item is currently marked.
</summary>
<returns>
<c>true</c>, if marked, <c>false</c> otherwise.</returns>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="Render">
<MemberSignature Language="C#" Value="public void Render (bool selected, int item, int col, int line, int width);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void Render(bool selected, int32 item, int32 col, int32 line, int32 width) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="selected" Type="System.Boolean" />
<Parameter Name="item" Type="System.Int32" />
<Parameter Name="col" Type="System.Int32" />
<Parameter Name="line" Type="System.Int32" />
<Parameter Name="width" Type="System.Int32" />
</Parameters>
<Docs>
<param name="selected">Describes whether the item being rendered is currently selected by the user.</param>
<param name="item">The index of the item to render, zero for the first item and so on.</param>
<param name="col">The column where the rendering will start</param>
<param name="line">The line where the rendering will be done.</param>
<param name="width">The width that must be filled out.</param>
<summary>
This method is invoked to render a specified item, the method should cover the entire provided width.
</summary>
<returns>The render.</returns>
<remarks>
The default color will be set before this method is invoked, and will be based on whether the item is selected or not.
</remarks>
</Docs>
</Member>
<Member MemberName="SetMark">
<MemberSignature Language="C#" Value="public void SetMark (int item, bool value);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig newslot virtual instance void SetMark(int32 item, bool value) cil managed" />
<MemberType>Method</MemberType>
<AssemblyInfo>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
</AssemblyInfo>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="item" Type="System.Int32" />
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<param name="item">Item index.</param>
<param name="value">If set to <c>true</c> value.</param>
<summary>
Flags the item as marked.
</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
</Members>
</Type>