docs for new GString marshaler.

svn path=/trunk/gtk-sharp/; revision=34524
This commit is contained in:
Mike Kestner 2004-09-29 17:54:59 +00:00
parent cd85c4b3de
commit cd4f77b03f

84
doc/en/GLib/GString.xml Normal file
View file

@ -0,0 +1,84 @@
<Type Name="GString" FullName="GLib.GString">
<TypeSignature Language="C#" Value="public class GString : IWrapper" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
<AssemblyPublicKey>[00 24 00 00 04 80 00 00 94 00 00 00 06 02 00 00 00 24 00 00 52 53 41 31 00 04 00 00 01 00 01 00 71 EB 6C 55 75 52 9C BF 72 44 F7 A6 EA 05 62 84 F9 EA E0 3B CF F2 CC 13 2C 9C 49 0A B3 09 EA B0 B5 6B CE 44 9D F5 03 D9 C0 A8 1E 52 05 85 CD BE 70 E2 FB 90 43 4B AC 04 FA 62 22 A8 00 98 B7 A1 A7 B3 AF 99 1A 41 23 24 BB 43 25 F6 B8 65 BB 64 EB F6 D1 C2 06 D5 73 2D DF BC 70 A7 38 9E E5 3E 0C 24 6E 32 79 74 1A D0 05 03 E4 98 42 E1 9B F3 7B 19 8B 40 21 26 CB 36 89 C2 EA 64 96 A4 7C B4]</AssemblyPublicKey>
<AssemblyVersion>1.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</AssemblyInfo>
<ThreadSafetyStatement>Gtk# is thread aware, but not thread safe; See the <link location="node:gtk-sharp/programming/threads">Gtk# Thread Programming</link> for details.</ThreadSafetyStatement>
<Docs>
<summary>Internal class for marshaling strings to and from GStrings.</summary>
<remarks>This class is used by the code generator to map GStrings onto managed string parameters and return values. It should not be used by application code.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="PtrToString">
<MemberSignature Language="C#" Value="public static string PtrToString (IntPtr ptr);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="ptr" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Converts a GString pointer to a managed string.</summary>
<param name="ptr">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>This method does not free the GString.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Releases the native GString reference associated with a GLib.GString.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GString (string text);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>Creates a native GString from a managed string.</summary>
<param name="text">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:GLib.GString" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="C#" Value="public virtual IntPtr Handle { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>A pointer to the native GString associated with this object.</summary>
<returns>a <see cref="T:System.IntPtr" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
</Members>
</Type>