PListFile.xml 8.8 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203
  1. <Type Name="PListFile" FullName="Urho.Resources.PListFile">
  2. <TypeSignature Language="C#" Value="public class PListFile : Urho.Resources.Resource" />
  3. <TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit PListFile extends Urho.Resources.Resource" />
  4. <AssemblyInfo>
  5. <AssemblyName>Urho</AssemblyName>
  6. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  7. </AssemblyInfo>
  8. <Base>
  9. <BaseTypeName>Urho.Resources.Resource</BaseTypeName>
  10. </Base>
  11. <Interfaces />
  12. <Docs>
  13. <summary>
  14. Property list (plist).
  15. </summary>
  16. <remarks>To be added.</remarks>
  17. </Docs>
  18. <Members>
  19. <Member MemberName=".ctor">
  20. <MemberSignature Language="C#" Value="public PListFile ();" />
  21. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
  22. <MemberType>Constructor</MemberType>
  23. <AssemblyInfo>
  24. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  25. </AssemblyInfo>
  26. <Parameters />
  27. <Docs>
  28. <summary>
  29. <para>Constructs a new instance of Urho.Resources.PListFile which is tied to the <see cref="P:Urho.Application.CurrentContext" />.</para>
  30. </summary>
  31. <remarks>
  32. </remarks>
  33. </Docs>
  34. </Member>
  35. <Member MemberName=".ctor">
  36. <MemberSignature Language="C#" Value="public PListFile (IntPtr handle);" />
  37. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int handle) cil managed" />
  38. <MemberType>Constructor</MemberType>
  39. <AssemblyInfo>
  40. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  41. </AssemblyInfo>
  42. <Parameters>
  43. <Parameter Name="handle" Type="System.IntPtr" />
  44. </Parameters>
  45. <Docs>
  46. <param name="handle">Pointer to the raw unmanaged Urho object.</param>
  47. <summary>Constructs a new instance of Urho.Resources.PListFile, given a raw pointer to an unmanaged object</summary>
  48. <remarks>
  49. <para>This creates a new managed wrapper for the type using the raw pointer to an unmanaged object.</para>
  50. <para>Objects that are created in this fashion get registered with the UrhoSharp runtime.</para>
  51. <para>This is intended to be used by the UrhoSharp runtime, and is not intended to be used by users.</para>
  52. </remarks>
  53. </Docs>
  54. </Member>
  55. <Member MemberName=".ctor">
  56. <MemberSignature Language="C#" Value="public PListFile (Urho.Context context);" />
  57. <MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Urho.Context context) cil managed" />
  58. <MemberType>Constructor</MemberType>
  59. <AssemblyInfo>
  60. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  61. </AssemblyInfo>
  62. <Parameters>
  63. <Parameter Name="context" Type="Urho.Context" />
  64. </Parameters>
  65. <Docs>
  66. <param name="context">The context that this object will be attached to.</param>
  67. <summary>
  68. <para>Constructs a new instance of Urho.Resources.PListFile linked to a specific <see cref="T:Urho.Context" />.</para>
  69. </summary>
  70. <remarks>
  71. </remarks>
  72. </Docs>
  73. </Member>
  74. <Member MemberName=".ctor">
  75. <MemberSignature Language="C#" Value="protected PListFile (Urho.UrhoObjectFlag emptyFlag);" />
  76. <MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor(valuetype Urho.UrhoObjectFlag emptyFlag) cil managed" />
  77. <MemberType>Constructor</MemberType>
  78. <AssemblyInfo>
  79. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  80. </AssemblyInfo>
  81. <Parameters>
  82. <Parameter Name="emptyFlag" Type="Urho.UrhoObjectFlag" />
  83. </Parameters>
  84. <Docs>
  85. <param name="emptyFlag">Pass UrhoObjectFlag.Empty.</param>
  86. <summary>Empty constructor, chain to this constructor when you provide your own constructor that sets the handle field.</summary>
  87. <remarks>
  88. <para>This constructor should be invoked by your code if you provide your own constructor that sets the handle field.</para>
  89. <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>
  90. <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>
  91. </remarks>
  92. </Docs>
  93. </Member>
  94. <Member MemberName="BeginLoad">
  95. <MemberSignature Language="C#" Value="public override bool BeginLoad (Urho.IO.File source);" />
  96. <MemberSignature Language="ILAsm" Value=".method public hidebysig virtual instance bool BeginLoad(class Urho.IO.File source) cil managed" />
  97. <MemberType>Method</MemberType>
  98. <AssemblyInfo>
  99. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  100. </AssemblyInfo>
  101. <ReturnValue>
  102. <ReturnType>System.Boolean</ReturnType>
  103. </ReturnValue>
  104. <Parameters>
  105. <Parameter Name="source" Type="Urho.IO.File" />
  106. </Parameters>
  107. <Docs>
  108. <param name="source">To be added.</param>
  109. <summary>To be added.</summary>
  110. <returns>To be added.</returns>
  111. <remarks>To be added.</remarks>
  112. </Docs>
  113. </Member>
  114. <Member MemberName="RegisterObject">
  115. <MemberSignature Language="C#" Value="public static void RegisterObject (Urho.Context context);" />
  116. <MemberSignature Language="ILAsm" Value=".method public static hidebysig void RegisterObject(class Urho.Context context) cil managed" />
  117. <MemberType>Method</MemberType>
  118. <AssemblyInfo>
  119. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  120. </AssemblyInfo>
  121. <ReturnValue>
  122. <ReturnType>System.Void</ReturnType>
  123. </ReturnValue>
  124. <Parameters>
  125. <Parameter Name="context" Type="Urho.Context" />
  126. </Parameters>
  127. <Docs>
  128. <param name="context">To be added.</param>
  129. <summary>
  130. Register object factory.
  131. </summary>
  132. <remarks>To be added.</remarks>
  133. </Docs>
  134. </Member>
  135. <Member MemberName="Type">
  136. <MemberSignature Language="C#" Value="public override Urho.StringHash Type { get; }" />
  137. <MemberSignature Language="ILAsm" Value=".property instance valuetype Urho.StringHash Type" />
  138. <MemberType>Property</MemberType>
  139. <AssemblyInfo>
  140. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  141. </AssemblyInfo>
  142. <ReturnValue>
  143. <ReturnType>Urho.StringHash</ReturnType>
  144. </ReturnValue>
  145. <Docs>
  146. <summary>Urho's type system type.</summary>
  147. <value>StringHash representing the type for this C# type.</value>
  148. <remarks>This returns the Urho's type and is surfaced for low-level Urho code.</remarks>
  149. </Docs>
  150. </Member>
  151. <Member MemberName="TypeName">
  152. <MemberSignature Language="C#" Value="public override string TypeName { get; }" />
  153. <MemberSignature Language="ILAsm" Value=".property instance string TypeName" />
  154. <MemberType>Property</MemberType>
  155. <AssemblyInfo>
  156. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  157. </AssemblyInfo>
  158. <ReturnValue>
  159. <ReturnType>System.String</ReturnType>
  160. </ReturnValue>
  161. <Docs>
  162. <summary>Urho's low-level type name.</summary>
  163. <value>Stringified low-level type name.</value>
  164. <remarks>
  165. </remarks>
  166. </Docs>
  167. </Member>
  168. <Member MemberName="TypeNameStatic">
  169. <MemberSignature Language="C#" Value="public static string TypeNameStatic { get; }" />
  170. <MemberSignature Language="ILAsm" Value=".property string TypeNameStatic" />
  171. <MemberType>Property</MemberType>
  172. <AssemblyInfo>
  173. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  174. </AssemblyInfo>
  175. <ReturnValue>
  176. <ReturnType>System.String</ReturnType>
  177. </ReturnValue>
  178. <Docs>
  179. <summary>Urho's low-level type name, accessible as a static method.</summary>
  180. <value>Stringified low-level type name.</value>
  181. <remarks>
  182. </remarks>
  183. </Docs>
  184. </Member>
  185. <Member MemberName="TypeStatic">
  186. <MemberSignature Language="C#" Value="public static Urho.StringHash TypeStatic { get; }" />
  187. <MemberSignature Language="ILAsm" Value=".property valuetype Urho.StringHash TypeStatic" />
  188. <MemberType>Property</MemberType>
  189. <AssemblyInfo>
  190. <AssemblyVersion>1.0.0.0</AssemblyVersion>
  191. </AssemblyInfo>
  192. <ReturnValue>
  193. <ReturnType>Urho.StringHash</ReturnType>
  194. </ReturnValue>
  195. <Docs>
  196. <summary>Urho's low-level type, accessible as a static method.</summary>
  197. <value>This returns the Urho's type and is surface for the low-level Urho code.</value>
  198. <remarks>
  199. </remarks>
  200. </Docs>
  201. </Member>
  202. </Members>
  203. </Type>