Attribute.xml 4.7 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110
  1. <Type Name="Attribute" FullName="Terminal.Gui.Attribute">
  2. <TypeSignature Language="C#" Value="public struct Attribute" />
  3. <TypeSignature Language="ILAsm" Value=".class public sequential ansi sealed beforefieldinit Attribute extends System.ValueType" />
  4. <AssemblyInfo>
  5. <AssemblyName>Terminal.Gui</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>System.ValueType</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Attributes are used as elements that contain both a foreground and a background or platform specific features
  15. </summary>
  16. <remarks>
  17. Attributes are needed to map colors to terminal capabilities that might lack colors, on color
  18. scenarios, they encode both the foreground and the background color and are used in the ColorScheme
  19. class to define color schemes that can be used in your application.
  20. </remarks>
  21. </Docs>
  22. <Members>
  23. <Member MemberName=".ctor">
  24. <MemberSignature Language="C#" Value="public Attribute (int value);" />
  25. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(int32 value) cil managed" />
  26. <MemberType>Constructor</MemberType>
  27. <AssemblyInfo>
  28. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  29. </AssemblyInfo>
  30. <Parameters>
  31. <Parameter Name="value" Type="System.Int32" />
  32. </Parameters>
  33. <Docs>
  34. <param name="value">Value.</param>
  35. <summary>
  36. Initializes a new instance of the <see cref="T:Terminal.Gui.Attribute" /> struct.
  37. </summary>
  38. <remarks>To be added.</remarks>
  39. </Docs>
  40. </Member>
  41. <Member MemberName="Make">
  42. <MemberSignature Language="C#" Value="public static Terminal.Gui.Attribute Make (Terminal.Gui.Color foreground, Terminal.Gui.Color background);" />
  43. <MemberSignature Language="ILAsm" Value=".method public static hidebysig valuetype Terminal.Gui.Attribute Make(valuetype Terminal.Gui.Color foreground, valuetype Terminal.Gui.Color background) cil managed" />
  44. <MemberType>Method</MemberType>
  45. <AssemblyInfo>
  46. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  47. </AssemblyInfo>
  48. <ReturnValue>
  49. <ReturnType>Terminal.Gui.Attribute</ReturnType>
  50. </ReturnValue>
  51. <Parameters>
  52. <Parameter Name="foreground" Type="Terminal.Gui.Color" />
  53. <Parameter Name="background" Type="Terminal.Gui.Color" />
  54. </Parameters>
  55. <Docs>
  56. <param name="foreground">Foreground color to use.</param>
  57. <param name="background">Background color to use.</param>
  58. <summary>
  59. Creates an attribute from the specified foreground and background.
  60. </summary>
  61. <returns>The make.</returns>
  62. <remarks>To be added.</remarks>
  63. </Docs>
  64. </Member>
  65. <Member MemberName="op_Implicit">
  66. <MemberSignature Language="C#" Value="public static Terminal.Gui.Attribute op_Implicit (int v);" />
  67. <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname valuetype Terminal.Gui.Attribute op_Implicit(int32 v) cil managed" />
  68. <MemberType>Method</MemberType>
  69. <AssemblyInfo>
  70. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  71. </AssemblyInfo>
  72. <ReturnValue>
  73. <ReturnType>Terminal.Gui.Attribute</ReturnType>
  74. </ReturnValue>
  75. <Parameters>
  76. <Parameter Name="v" Type="System.Int32" />
  77. </Parameters>
  78. <Docs>
  79. <param name="v">value</param>
  80. <summary>
  81. Implicitly convert an integer value into an attribute
  82. </summary>
  83. <returns>An attribute with the specified integer value.</returns>
  84. <remarks>To be added.</remarks>
  85. </Docs>
  86. </Member>
  87. <Member MemberName="op_Implicit">
  88. <MemberSignature Language="C#" Value="public static int op_Implicit (Terminal.Gui.Attribute c);" />
  89. <MemberSignature Language="ILAsm" Value=".method public static hidebysig specialname int32 op_Implicit(valuetype Terminal.Gui.Attribute c) cil managed" />
  90. <MemberType>Method</MemberType>
  91. <AssemblyInfo>
  92. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  93. </AssemblyInfo>
  94. <ReturnValue>
  95. <ReturnType>System.Int32</ReturnType>
  96. </ReturnValue>
  97. <Parameters>
  98. <Parameter Name="c" Type="Terminal.Gui.Attribute" />
  99. </Parameters>
  100. <Docs>
  101. <param name="c">The attribute to convert</param>
  102. <summary>
  103. Implicit conversion from an attribute to the underlying Int32 representation
  104. </summary>
  105. <returns>The integer value stored in the attribute.</returns>
  106. <remarks>To be added.</remarks>
  107. </Docs>
  108. </Member>
  109. </Members>
  110. </Type>