GtkSharp/doc/en/GLib/Object.xml
Duncan Mak f3966a2a4c 2003-02-23 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: a Big patch. This adds code-generated documentation
	for internal constructors, the GType property and the Finalized method.

svn path=/trunk/gtk-sharp/; revision=11858
2003-02-23 07:26:30 +00:00

331 lines
12 KiB
XML

<Type Name="Object" FullName="GLib.Object">
<TypeSignature Language="C#" Value="public class Object : IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="needs_ref">
<MemberSignature Language="C#" Value="protected bool needs_ref;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RegisterGType">
<MemberSignature Language="C#" Value="public static uint RegisterGType (Type t);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="t" Type="System.Type" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="t">To be added: an object of type 'Type'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetObject">
<MemberSignature Language="C#" Value="public static GLib.Object GetObject (IntPtr o);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>GLib.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="o" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="o">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'GLib.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetProperty">
<MemberSignature Language="C#" Value="public void SetProperty (string name, GLib.Value val);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="val" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">To be added: an object of type 'string'</param>
<param name="val">To be added: an object of type 'GLib.Value'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetProperty">
<MemberSignature Language="C#" Value="public void GetProperty (string name, GLib.Value val);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="val" Type="GLib.Value" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">To be added: an object of type 'string'</param>
<param name="val">To be added: an object of type 'GLib.Value'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetData">
<MemberSignature Language="C#" Value="public void SetData (string key, object val);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
<Parameter Name="val" Type="System.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="key">To be added: an object of type 'string'</param>
<param name="val">To be added: an object of type 'object'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetData">
<MemberSignature Language="C#" Value="public object GetData (string key);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="key" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="key">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetHashCode">
<MemberSignature Language="C#" Value="public virtual int GetHashCode ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetGType">
<MemberSignature Language="C#" Value="public uint GetGType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Unref">
<MemberSignature Language="C#" Value="public virtual void Unref ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Ref">
<MemberSignature Language="C#" Value="public virtual void Ref ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DisposeNative">
<MemberSignature Language="C#" Value="protected virtual void DisposeNative ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Dispose">
<MemberSignature Language="C#" Value="public virtual void Dispose ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Object ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'GLib.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Object (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of Object, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Object (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of Object, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:GLib.Object" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for GLib.Object</summary>
<returns>The GLib TYpe for the GLib.Object class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="RefCount">
<MemberSignature Language="C#" Value="public int RefCount { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="EventList">
<MemberSignature Language="C#" Value="protected EventList { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.ComponentModel.EventHandlerList</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type ''</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Handle">
<MemberSignature Language="C#" Value="public virtual IntPtr Handle { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'IntPtr'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Raw">
<MemberSignature Language="C#" Value="protected virtual IntPtr Raw { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'IntPtr'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>