MessageBox.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299
  1. <Type Name="MessageBox" FullName="Urho.Gui.MessageBox">
  2. <TypeSignature Language="C#" Value="public class MessageBox : Urho.UrhoObject" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit MessageBox extends Urho.UrhoObject" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.UrhoObject</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Message box dialog.
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public MessageBox (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. <Attributes>
  27. <Attribute>
  28. <AttributeName>Preserve</AttributeName>
  29. </Attribute>
  30. </Attributes>
  31. <Parameters>
  32. <Parameter Name="handle" Type="System.IntPtr" />
  33. </Parameters>
  34. <Docs>
  35. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  36. <summary>Constructs a new instance of Urho.Gui.MessageBox, given a raw pointer to an unmanaged object</summary>
  37. <remarks>
  38. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  39. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  40. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  41. </remarks>
  42. </Docs>
  43. </Member>
  44. <Member MemberName=".ctor">
  45. <MemberSignature Language="C#" Value="protected MessageBox (Urho.UrhoObjectFlag emptyFlag);" />
  46. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  47. <MemberType>Constructor</MemberType>
  48. <AssemblyInfo>
  49. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  50. </AssemblyInfo>
  51. <Attributes>
  52. <Attribute>
  53. <AttributeName>Preserve</AttributeName>
  54. </Attribute>
  55. </Attributes>
  56. <Parameters>
  57. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  58. </Parameters>
  59. <Docs>
  60. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  61. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  62. <remarks>
  63. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  64. <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>
  65. <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>
  66. </remarks>
  67. </Docs>
  68. </Member>
  69. <Member MemberName=".ctor">
  70. <MemberSignature Language="C#" Value="public MessageBox (Urho.Context context, string messageString = &quot;&quot;, string titleString = &quot;&quot;, Urho.Resources.XmlFile layoutFile = null, Urho.Resources.XmlFile styleFile = null);" />
  71. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context, string messageString, string titleString, class Urho.Resources.XmlFile layoutFile, class Urho.Resources.XmlFile styleFile) cil managed" />
  72. <MemberType>Constructor</MemberType>
  73. <AssemblyInfo>
  74. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  75. </AssemblyInfo>
  76. <Attributes>
  77. <Attribute>
  78. <AttributeName>Preserve</AttributeName>
  79. </Attribute>
  80. </Attributes>
  81. <Parameters>
  82. <Parameter Name="context" Type="Urho.Context" />
  83. <Parameter Name="messageString" Type="System.String" />
  84. <Parameter Name="titleString" Type="System.String" />
  85. <Parameter Name="layoutFile" Type="Urho.Resources.XmlFile" />
  86. <Parameter Name="styleFile" Type="Urho.Resources.XmlFile" />
  87. </Parameters>
  88. <Docs>
  89. <param name="context">The context that this object will be attached to.</param>
  90. <param name="messageString">To be added.</param>
  91. <param name="titleString">To be added.</param>
  92. <param name="layoutFile">To be added.</param>
  93. <param name="styleFile">To be added.</param>
  94. <summary>
  95. <para>Constructs a new instance of Urho.Gui.MessageBox linked to a specific <see cref="T:Urho.Context" />.</para>
  96. </summary>
  97. <remarks>
  98. </remarks>
  99. </Docs>
  100. </Member>
  101. <Member MemberName="Message">
  102. <MemberSignature Language="C#" Value="public string Message { get; set; }" />
  103. <MemberSignature Language="ILAsm" Value=".property instance string Message" />
  104. <MemberType>Property</MemberType>
  105. <AssemblyInfo>
  106. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  107. </AssemblyInfo>
  108. <ReturnValue>
  109. <ReturnType>System.String</ReturnType>
  110. </ReturnValue>
  111. <Docs>
  112. <summary>
  113. Return message text. Return empty string if there is no message text element.
  114. Or
  115. Set message text. No-ops if there is no message text element.
  116. </summary>
  117. <value>To be added.</value>
  118. <remarks>To be added.</remarks>
  119. </Docs>
  120. </Member>
  121. <Member MemberName="MessageACK">
  122. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Gui.MessageACKEventArgs&gt; MessageACK;" />
  123. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Gui.MessageACKEventArgs&gt; MessageACK" />
  124. <MemberType>Event</MemberType>
  125. <AssemblyInfo>
  126. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  127. </AssemblyInfo>
  128. <ReturnValue>
  129. <ReturnType>System.Action&lt;Urho.Gui.MessageACKEventArgs&gt;</ReturnType>
  130. </ReturnValue>
  131. <Docs>
  132. <summary>To be added.</summary>
  133. <remarks>
  134. <para>The event can register multiple callbacks and invoke all of them. If this is not desired, and you only need a single shot callback, you can use the <see cref="M:Urho.SubscribeToMessageACK" /> method. That one will force that callback and will ignore any previously set events here.</para>
  135. </remarks>
  136. </Docs>
  137. </Member>
  138. <Member MemberName="RegisterObject">
  139. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  140. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  141. <MemberType>Method</MemberType>
  142. <AssemblyInfo>
  143. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  144. </AssemblyInfo>
  145. <ReturnValue>
  146. <ReturnType>System.Void</ReturnType>
  147. </ReturnValue>
  148. <Parameters>
  149. <Parameter Name="context" Type="Urho.Context" />
  150. </Parameters>
  151. <Docs>
  152. <param name="context">To be added.</param>
  153. <summary>
  154. Register object factory.
  155. </summary>
  156. <remarks>To be added.</remarks>
  157. </Docs>
  158. </Member>
  159. <Member MemberName="SubscribeToMessageACK">
  160. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToMessageACK (Action&lt;Urho.Gui.MessageACKEventArgs&gt; handler);" />
  161. <MemberSignature Language="ILAsm" Value=".method public hidebysig instance class Urho.Subscription SubscribeToMessageACK(class System.Action`1&lt;valuetype Urho.Gui.MessageACKEventArgs&gt; handler) cil managed" />
  162. <MemberType>Method</MemberType>
  163. <AssemblyInfo>
  164. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  165. </AssemblyInfo>
  166. <Attributes>
  167. <Attribute>
  168. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.MessageACK += ...' instead.")</AttributeName>
  169. </Attribute>
  170. </Attributes>
  171. <ReturnValue>
  172. <ReturnType>Urho.Subscription</ReturnType>
  173. </ReturnValue>
  174. <Parameters>
  175. <Parameter Name="handler" Type="System.Action&lt;Urho.Gui.MessageACKEventArgs&gt;" />
  176. </Parameters>
  177. <Docs>
  178. <param name="handler">The handler to invoke when this event is raised.</param>
  179. <summary>Subscribes to the MessageACK event raised by the MessageBox.</summary>
  180. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  181. <remarks>
  182. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  183. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  184. <para>For a more event-like approach, use the <see cref="E:Urho.Gui.MessageBox.MessageACK" /> event.</para>
  185. </remarks>
  186. </Docs>
  187. </Member>
  188. <Member MemberName="Title">
  189. <MemberSignature Language="C#" Value="public string Title { get; set; }" />
  190. <MemberSignature Language="ILAsm" Value=".property instance string Title" />
  191. <MemberType>Property</MemberType>
  192. <AssemblyInfo>
  193. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  194. </AssemblyInfo>
  195. <ReturnValue>
  196. <ReturnType>System.String</ReturnType>
  197. </ReturnValue>
  198. <Docs>
  199. <summary>
  200. Return title text. Return empty string if there is no title text element.
  201. Or
  202. Set title text. No-ops if there is no title text element.
  203. </summary>
  204. <value>To be added.</value>
  205. <remarks>To be added.</remarks>
  206. </Docs>
  207. </Member>
  208. <Member MemberName="Type">
  209. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  210. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  211. <MemberType>Property</MemberType>
  212. <AssemblyInfo>
  213. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  214. </AssemblyInfo>
  215. <ReturnValue>
  216. <ReturnType>Urho.StringHash</ReturnType>
  217. </ReturnValue>
  218. <Docs>
  219. <summary>Urho's type system type.</summary>
  220. <value>StringHash representing the type for this C# type.</value>
  221. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  222. </Docs>
  223. </Member>
  224. <Member MemberName="TypeName">
  225. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  226. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  227. <MemberType>Property</MemberType>
  228. <AssemblyInfo>
  229. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  230. </AssemblyInfo>
  231. <ReturnValue>
  232. <ReturnType>System.String</ReturnType>
  233. </ReturnValue>
  234. <Docs>
  235. <summary>Urho's low-level type name.</summary>
  236. <value>Stringified low-level type name.</value>
  237. <remarks>
  238. </remarks>
  239. </Docs>
  240. </Member>
  241. <Member MemberName="TypeNameStatic">
  242. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  243. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  244. <MemberType>Property</MemberType>
  245. <AssemblyInfo>
  246. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  247. </AssemblyInfo>
  248. <ReturnValue>
  249. <ReturnType>System.String</ReturnType>
  250. </ReturnValue>
  251. <Docs>
  252. <summary>Urho's low-level type name, accessible as a static method.</summary>
  253. <value>Stringified low-level type name.</value>
  254. <remarks>
  255. </remarks>
  256. </Docs>
  257. </Member>
  258. <Member MemberName="TypeStatic">
  259. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  260. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  261. <MemberType>Property</MemberType>
  262. <AssemblyInfo>
  263. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  264. </AssemblyInfo>
  265. <Attributes>
  266. <Attribute>
  267. <AttributeName>Preserve</AttributeName>
  268. </Attribute>
  269. </Attributes>
  270. <ReturnValue>
  271. <ReturnType>Urho.StringHash</ReturnType>
  272. </ReturnValue>
  273. <Docs>
  274. <summary>Urho's low-level type, accessible as a static method.</summary>
  275. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  276. <remarks>
  277. </remarks>
  278. </Docs>
  279. </Member>
  280. <Member MemberName="Window">
  281. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement Window { get; }" />
  282. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Gui.UIElement Window" />
  283. <MemberType>Property</MemberType>
  284. <AssemblyInfo>
  285. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  286. </AssemblyInfo>
  287. <ReturnValue>
  288. <ReturnType>Urho.Gui.UIElement</ReturnType>
  289. </ReturnValue>
  290. <Docs>
  291. <summary>
  292. Return dialog window.
  293. </summary>
  294. <value>To be added.</value>
  295. <remarks>To be added.</remarks>
  296. </Docs>
  297. </Member>
  298. </Members>
  299. </Type>