ToolTip.xml 9.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220
  1. <Type Name="ToolTip" FullName="Urho.ToolTip">
  2. <TypeSignature Language="C#" Value="public class ToolTip : Urho.UIElement" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit ToolTip extends Urho.UIElement" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.UIElement</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Tooltip %UI element.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public ToolTip (IntPtr handle);" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Parameters>
  27. <Parameter Name="handle" Type="System.IntPtr" />
  28. </Parameters>
  29. <Docs>
  30. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  31. <summary>Constructs a new instance of ToolTip, given a raw pointer to an unmanaged object</summary>
  32. <remarks>
  33. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  34. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  35. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  36. </remarks>
  37. </Docs>
  38. </Member>
  39. <Member MemberName=".ctor">
  40. <MemberSignature Language="C#" Value="public ToolTip (Urho.Context context);" />
  41. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  42. <MemberType>Constructor</MemberType>
  43. <AssemblyInfo>
  44. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  45. </AssemblyInfo>
  46. <Parameters>
  47. <Parameter Name="context" Type="Urho.Context" />
  48. </Parameters>
  49. <Docs>
  50. <param name="context">The context that this object will be attached to.</param>
  51. <summary>Creates an instance of ToolTip that is attached to an execution context.</summary>
  52. <remarks>
  53. <para>This creates an instance of ToolTip attached to the specified execution context.</para>
  54. </remarks>
  55. </Docs>
  56. </Member>
  57. <Member MemberName=".ctor">
  58. <MemberSignature Language="C#" Value="public ToolTip (Urho.UrhoObjectFlag emptyFlag);" />
  59. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  60. <MemberType>Constructor</MemberType>
  61. <AssemblyInfo>
  62. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  63. </AssemblyInfo>
  64. <Parameters>
  65. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  66. </Parameters>
  67. <Docs>
  68. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  69. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  70. <remarks>
  71. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  72. <para>This essentially circumvents the default path that creates a new object and sets the handle and does not call RegisterObject on the target, you must do this on your own constructor.</para>
  73. <para>You would typically chain to this constructor from your own, and then set the handle to the unmanaged object from your code, and then register your object.</para>
  74. </remarks>
  75. </Docs>
  76. </Member>
  77. <Member MemberName="BaseType">
  78. <MemberSignature Language="C#" Value="public override Urho.StringHash BaseType { get; }" />
  79. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash BaseType" />
  80. <MemberType>Property</MemberType>
  81. <AssemblyInfo>
  82. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  83. </AssemblyInfo>
  84. <ReturnValue>
  85. <ReturnType>Urho.StringHash</ReturnType>
  86. </ReturnValue>
  87. <Docs>
  88. <summary>Urho's type system base type.</summary>
  89. <value>StringHash representing the base type for this Urho type.</value>
  90. <remarks>This returns the Urho type system base type and is surfaced for low-level Urho code.</remarks>
  91. </Docs>
  92. </Member>
  93. <Member MemberName="Delay">
  94. <MemberSignature Language="C#" Value="public float Delay { get; set; }" />
  95. <MemberSignature Language="ILAsm" Value=".property instance float32 Delay" />
  96. <MemberType>Property</MemberType>
  97. <AssemblyInfo>
  98. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  99. </AssemblyInfo>
  100. <ReturnValue>
  101. <ReturnType>System.Single</ReturnType>
  102. </ReturnValue>
  103. <Docs>
  104. <summary>
  105. Return the delay in seconds until the tooltip shows once hovering.
  106. Or
  107. Set the delay in seconds until the tooltip shows once hovering. Set zero to use the default from the UI subsystem.
  108. </summary>
  109. <value>To be added.</value>
  110. <remarks>To be added.</remarks>
  111. </Docs>
  112. </Member>
  113. <Member MemberName="RegisterObject">
  114. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  115. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  116. <MemberType>Method</MemberType>
  117. <AssemblyInfo>
  118. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  119. </AssemblyInfo>
  120. <ReturnValue>
  121. <ReturnType>System.Void</ReturnType>
  122. </ReturnValue>
  123. <Parameters>
  124. <Parameter Name="context" Type="Urho.Context" />
  125. </Parameters>
  126. <Docs>
  127. <param name="context">To be added.</param>
  128. <summary>
  129. Register object factory.
  130. </summary>
  131. <remarks>To be added.</remarks>
  132. </Docs>
  133. </Member>
  134. <Member MemberName="Type">
  135. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  136. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  137. <MemberType>Property</MemberType>
  138. <AssemblyInfo>
  139. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  140. </AssemblyInfo>
  141. <ReturnValue>
  142. <ReturnType>Urho.StringHash</ReturnType>
  143. </ReturnValue>
  144. <Docs>
  145. <summary>Urho's type system type.</summary>
  146. <value>StringHash representing the type for this C# type.</value>
  147. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  148. </Docs>
  149. </Member>
  150. <Member MemberName="TypeName">
  151. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  152. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  153. <MemberType>Property</MemberType>
  154. <AssemblyInfo>
  155. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  156. </AssemblyInfo>
  157. <ReturnValue>
  158. <ReturnType>System.String</ReturnType>
  159. </ReturnValue>
  160. <Docs>
  161. <summary>Urho's low-level type name.</summary>
  162. <value>Stringified low-level type name.</value>
  163. <remarks></remarks>
  164. </Docs>
  165. </Member>
  166. <Member MemberName="TypeNameStatic">
  167. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  168. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  169. <MemberType>Property</MemberType>
  170. <AssemblyInfo>
  171. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  172. </AssemblyInfo>
  173. <ReturnValue>
  174. <ReturnType>System.String</ReturnType>
  175. </ReturnValue>
  176. <Docs>
  177. <summary>Urho's low-level type name, accessible as a static method.</summary>
  178. <value>Stringified low-level type name.</value>
  179. <remarks></remarks>
  180. </Docs>
  181. </Member>
  182. <Member MemberName="TypeStatic">
  183. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  184. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  185. <MemberType>Property</MemberType>
  186. <AssemblyInfo>
  187. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  188. </AssemblyInfo>
  189. <ReturnValue>
  190. <ReturnType>Urho.StringHash</ReturnType>
  191. </ReturnValue>
  192. <Docs>
  193. <summary>To be added.</summary>
  194. <value>To be added.</value>
  195. <remarks>To be added.</remarks>
  196. </Docs>
  197. </Member>
  198. <Member MemberName="Update">
  199. <MemberSignature Language="C#" Value="public override void Update (float timeStep);" />
  200. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance void Update(float32 timeStep) cil managed" />
  201. <MemberType>Method</MemberType>
  202. <AssemblyInfo>
  203. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  204. </AssemblyInfo>
  205. <ReturnValue>
  206. <ReturnType>System.Void</ReturnType>
  207. </ReturnValue>
  208. <Parameters>
  209. <Parameter Name="timeStep" Type="System.Single" />
  210. </Parameters>
  211. <Docs>
  212. <param name="timeStep">To be added.</param>
  213. <summary>
  214. Perform UI element update.
  215. </summary>
  216. <remarks>To be added.</remarks>
  217. </Docs>
  218. </Member>
  219. </Members>
  220. </Type>