docs for new Type initialization and GInterface registration related API

svn path=/trunk/gtk-sharp/; revision=87005
This commit is contained in:
Mike Kestner 2007-10-05 18:55:46 +00:00
parent ccd8bc998d
commit b468823c6e
5 changed files with 210 additions and 0 deletions

View File

@ -0,0 +1,50 @@
<Type Name="GInterfaceAdapter" FullName="GLib.GInterfaceAdapter">
<TypeSignature Language="C#" Value="public abstract class GInterfaceAdapter" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected GInterfaceAdapter ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>Protected Constructor.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public abstract GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Docs>
<summary>GType Property.</summary>
<value>The native GInterface type value.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="InitHandler">
<MemberSignature Language="C#" Value="protected GLib.GInterfaceInitHandler InitHandler { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GInterfaceInitHandler</ReturnType>
</ReturnValue>
<Docs>
<summary>InitHandler Property.</summary>
<value>The Initialization Handler for the Adapter.</value>
<remarks />
</Docs>
</Member>
</Members>
<Docs>
<summary>GInterfaceAdapter abstract class.</summary>
<remarks>The members of this abstract base class are used internally to register GInterfaces with the native type system. They are not useful to application authors.</remarks>
</Docs>
</Type>

View File

@ -0,0 +1,46 @@
<Type Name="GInterfaceAttribute" FullName="GLib.GInterfaceAttribute">
<TypeSignature Language="C#" Value="public sealed class GInterfaceAttribute : Attribute" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.AttributeUsage(System.AttributeTargets.Interface)</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public GInterfaceAttribute (Type adapter_type);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="adapter_type" Type="System.Type" />
</Parameters>
<Docs>
<param name="adapter_type">Adapter type containing registration information.</param>
<summary>Public Constructor.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AdapterType">
<MemberSignature Language="C#" Value="public Type AdapterType { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>Adapter Property.</summary>
<value>A <see cref="T:GLib.GInterfaceAdapter" /> subclass containing registration information for the GInterface.</value>
<remarks />
</Docs>
</Member>
</Members>
<Docs>
<summary>GInterface Attribute.</summary>
<remarks>Identifies an implementation interface corresponding to a native GInterface and provides access to the Adapter type for the interface.</remarks>
</Docs>
</Type>

View File

@ -0,0 +1,23 @@
<Type Name="GInterfaceInitHandler" FullName="GLib.GInterfaceInitHandler">
<TypeSignature Language="C#" Value="public delegate void GInterfaceInitHandler(IntPtr iface_ptr, IntPtr data);" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Parameters>
<Parameter Name="iface_ptr" Type="System.IntPtr" />
<Parameter Name="data" Type="System.IntPtr" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Docs>
<param name="iface_ptr">A native Iface struct pointer to populate.</param>
<param name="data">User data provided at registration time. Always IntPtr.Zero.</param>
<summary>GInterface Initialization Handler.</summary>
<remarks>Only useful for binding authors, and generated binding code.</remarks>
</Docs>
</Type>

View File

@ -0,0 +1,31 @@
<Type Name="IgnoreClassInitializersAttribute" FullName="GLib.IgnoreClassInitializersAttribute">
<TypeSignature Language="C#" Value="public sealed class IgnoreClassInitializersAttribute : Attribute" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.AttributeUsage(System.AttributeTargets.Assembly)</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public IgnoreClassInitializersAttribute ();" />
<MemberType>Constructor</MemberType>
<Parameters />
<Docs>
<summary>Public Constructor.</summary>
<remarks />
</Docs>
</Member>
</Members>
<Docs>
<summary>IgnoreClassInitializers Attribute.</summary>
<remarks>Add this attribute to an assembly which implements GLib.Object subclasses to avoid some reflection memory overhead if your classes do not utilize the <see cref="T:GLib.ClassInitializerAttribute" />.</remarks>
</Docs>
</Type>

View File

@ -0,0 +1,60 @@
<Type Name="TypeInitializerAttribute" FullName="GLib.TypeInitializerAttribute">
<TypeSignature Language="C#" Value="public sealed class TypeInitializerAttribute : Attribute" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
<AssemblyVersion>2.10.0.0</AssemblyVersion>
</AssemblyInfo>
<Base>
<BaseTypeName>System.Attribute</BaseTypeName>
</Base>
<Interfaces />
<Attributes>
<Attribute>
<AttributeName>System.AttributeUsage(System.AttributeTargets.Class)</AttributeName>
</Attribute>
</Attributes>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public TypeInitializerAttribute (Type type, string method_name);" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="type" Type="System.Type" />
<Parameter Name="method_name" Type="System.String" />
</Parameters>
<Docs>
<param name="type">The Type to be Initialized.</param>
<param name="method_name">The method name to invoke.</param>
<summary>Public Constructor.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="MethodName">
<MemberSignature Language="C#" Value="public string MethodName { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>MethodName property.</summary>
<value>The name of a method to invoke at type initialization time.</value>
<remarks>The signature of the method should be void MethodName (GLib.GType, System.Type) and the method should be private static.</remarks>
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Type Type { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Type</ReturnType>
</ReturnValue>
<Docs>
<summary>Type Property.</summary>
<value>The Type which contains the method identified in <see cref="M:GLib.TypeInitializerAttribute.MethodName" />.</value>
<remarks />
</Docs>
</Member>
</Members>
<Docs>
<summary>TypeInitializer Attribute.</summary>
<remarks>Replaces the <see cref="T:GLib.ClassInitializerAttribute" /> to allow for more efficient reflection memory usage.</remarks>
</Docs>
</Type>