PListFile.xml 8.7 KB

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