PListFile.xml 10 KB

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