MessageBox.xml 13 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295
  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, string titleString, Urho.Resources.XmlFile layoutFile, Urho.Resources.XmlFile styleFile);" />
  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></remarks>
  98. </Docs>
  99. </Member>
  100. <Member MemberName="Message">
  101. <MemberSignature Language="C#" Value="public string Message { get; set; }" />
  102. <MemberSignature Language="ILAsm" Value=".property instance string Message" />
  103. <MemberType>Property</MemberType>
  104. <AssemblyInfo>
  105. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  106. </AssemblyInfo>
  107. <ReturnValue>
  108. <ReturnType>System.String</ReturnType>
  109. </ReturnValue>
  110. <Docs>
  111. <summary>
  112. Return message text. Return empty string if there is no message text element.
  113. Or
  114. Set message text. No-ops if there is no message text element.
  115. </summary>
  116. <value>To be added.</value>
  117. <remarks>To be added.</remarks>
  118. </Docs>
  119. </Member>
  120. <Member MemberName="MessageACK">
  121. <MemberSignature Language="C#" Value="public event Action&lt;Urho.Gui.MessageACKEventArgs&gt; MessageACK;" />
  122. <MemberSignature Language="ILAsm" Value=".event class System.Action`1&lt;valuetype Urho.Gui.MessageACKEventArgs&gt; MessageACK" />
  123. <MemberType>Event</MemberType>
  124. <AssemblyInfo>
  125. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  126. </AssemblyInfo>
  127. <ReturnValue>
  128. <ReturnType>System.Action&lt;Urho.Gui.MessageACKEventArgs&gt;</ReturnType>
  129. </ReturnValue>
  130. <Docs>
  131. <summary>To be added.</summary>
  132. <remarks>
  133. <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>
  134. </remarks>
  135. </Docs>
  136. </Member>
  137. <Member MemberName="RegisterObject">
  138. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  139. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  140. <MemberType>Method</MemberType>
  141. <AssemblyInfo>
  142. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  143. </AssemblyInfo>
  144. <ReturnValue>
  145. <ReturnType>System.Void</ReturnType>
  146. </ReturnValue>
  147. <Parameters>
  148. <Parameter Name="context" Type="Urho.Context" />
  149. </Parameters>
  150. <Docs>
  151. <param name="context">To be added.</param>
  152. <summary>
  153. Register object factory.
  154. </summary>
  155. <remarks>To be added.</remarks>
  156. </Docs>
  157. </Member>
  158. <Member MemberName="SubscribeToMessageACK">
  159. <MemberSignature Language="C#" Value="public Urho.Subscription SubscribeToMessageACK (Action&lt;Urho.Gui.MessageACKEventArgs&gt; handler);" />
  160. <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" />
  161. <MemberType>Method</MemberType>
  162. <AssemblyInfo>
  163. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  164. </AssemblyInfo>
  165. <Attributes>
  166. <Attribute>
  167. <AttributeName>System.Obsolete("SubscribeTo API may lead to unxpected behaviour and will be removed in a future version. Use C# event '.MessageACK += ...' instead.")</AttributeName>
  168. </Attribute>
  169. </Attributes>
  170. <ReturnValue>
  171. <ReturnType>Urho.Subscription</ReturnType>
  172. </ReturnValue>
  173. <Parameters>
  174. <Parameter Name="handler" Type="System.Action&lt;Urho.Gui.MessageACKEventArgs&gt;" />
  175. </Parameters>
  176. <Docs>
  177. <param name="handler">The handler to invoke when this event is raised.</param>
  178. <summary>Subscribes to the MessageACK event raised by the MessageBox.</summary>
  179. <returns>Returns an Urho.Subscription that can be used to cancel the subscription.</returns>
  180. <remarks>
  181. <para>This method will override any prior subscription, including those assigned to on event handlers.</para>
  182. <para>This has the advantage that it does a straight connection and returns a handle that is easy to unsubscribe from.</para>
  183. <para>For a more event-like approach, use the <see cref="E:Urho.Gui.MessageBox.MessageACK" /> event.</para>
  184. </remarks>
  185. </Docs>
  186. </Member>
  187. <Member MemberName="Title">
  188. <MemberSignature Language="C#" Value="public string Title { get; set; }" />
  189. <MemberSignature Language="ILAsm" Value=".property instance string Title" />
  190. <MemberType>Property</MemberType>
  191. <AssemblyInfo>
  192. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  193. </AssemblyInfo>
  194. <ReturnValue>
  195. <ReturnType>System.String</ReturnType>
  196. </ReturnValue>
  197. <Docs>
  198. <summary>
  199. Return title text. Return empty string if there is no title text element.
  200. Or
  201. Set title text. No-ops if there is no title text element.
  202. </summary>
  203. <value>To be added.</value>
  204. <remarks>To be added.</remarks>
  205. </Docs>
  206. </Member>
  207. <Member MemberName="Type">
  208. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  209. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  210. <MemberType>Property</MemberType>
  211. <AssemblyInfo>
  212. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  213. </AssemblyInfo>
  214. <ReturnValue>
  215. <ReturnType>Urho.StringHash</ReturnType>
  216. </ReturnValue>
  217. <Docs>
  218. <summary>Urho's type system type.</summary>
  219. <value>StringHash representing the type for this C# type.</value>
  220. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  221. </Docs>
  222. </Member>
  223. <Member MemberName="TypeName">
  224. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  225. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  226. <MemberType>Property</MemberType>
  227. <AssemblyInfo>
  228. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  229. </AssemblyInfo>
  230. <ReturnValue>
  231. <ReturnType>System.String</ReturnType>
  232. </ReturnValue>
  233. <Docs>
  234. <summary>Urho's low-level type name.</summary>
  235. <value>Stringified low-level type name.</value>
  236. <remarks></remarks>
  237. </Docs>
  238. </Member>
  239. <Member MemberName="TypeNameStatic">
  240. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  241. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  242. <MemberType>Property</MemberType>
  243. <AssemblyInfo>
  244. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  245. </AssemblyInfo>
  246. <ReturnValue>
  247. <ReturnType>System.String</ReturnType>
  248. </ReturnValue>
  249. <Docs>
  250. <summary>Urho's low-level type name, accessible as a static method.</summary>
  251. <value>Stringified low-level type name.</value>
  252. <remarks></remarks>
  253. </Docs>
  254. </Member>
  255. <Member MemberName="TypeStatic">
  256. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  257. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  258. <MemberType>Property</MemberType>
  259. <AssemblyInfo>
  260. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  261. </AssemblyInfo>
  262. <Attributes>
  263. <Attribute>
  264. <AttributeName>Preserve</AttributeName>
  265. </Attribute>
  266. </Attributes>
  267. <ReturnValue>
  268. <ReturnType>Urho.StringHash</ReturnType>
  269. </ReturnValue>
  270. <Docs>
  271. <summary>Urho's low-level type, accessible as a static method.</summary>
  272. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  273. <remarks></remarks>
  274. </Docs>
  275. </Member>
  276. <Member MemberName="Window">
  277. <MemberSignature Language="C#" Value="public Urho.Gui.UIElement Window { get; }" />
  278. <MemberSignature Language="ILAsm" Value=".property instance class Urho.Gui.UIElement Window" />
  279. <MemberType>Property</MemberType>
  280. <AssemblyInfo>
  281. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  282. </AssemblyInfo>
  283. <ReturnValue>
  284. <ReturnType>Urho.Gui.UIElement</ReturnType>
  285. </ReturnValue>
  286. <Docs>
  287. <summary>
  288. Return dialog window.
  289. </summary>
  290. <value>To be added.</value>
  291. <remarks>To be added.</remarks>
  292. </Docs>
  293. </Member>
  294. </Members>
  295. </Type>