PListFile.xml 7.9 KB

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