GtkSharp/doc/en/Vte/Reaper.xml
John Luke 70635096fa 2004-12-29 John Luke <john.luke@gmail.com>
* gen-intptr-ctor-docs.cs: docs for Type (IntPtr) ctor
        * gen-gtype-ctor-docs.cs: docs for Type (GType) ctor
        * gen-finalize-docs.cs: docs Finalize methods
        * gen-gtype-docs.cs: docs GType properties, based off
        of gen-vm-docs.cs
        * en/*.xml: run these 4 tools for all the assemblies


svn path=/trunk/gtk-sharp/; revision=38159
2004-12-29 18:36:31 +00:00

137 lines
No EOL
5.5 KiB
XML

<Type Name="Reaper" FullName="Vte.Reaper">
<TypeSignature Language="C#" Value="public class Reaper : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>vte-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.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>A singleton object which catches SIGCHLD signals and converts them into GObject-style "child-exited" signals.</summary>
<remarks>Because an application may need to be notified when child processes exit, and because there is only one SIGCHLD handler, the <see cref="T:Vte.Terminal" /> widget relies on a <see cref="T:Vte.Reaper" /> to watch for SIGCHLD notifications and retrieve the exit status of child processes which have exited.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public static Vte.Reaper Get ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Vte.Reaper</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Finds the address of the global <see cref="T:Vte.Reaper" /> object, creating the object if necessary.</summary>
<returns>a <see cref="T:Vte.Reaper" /></returns>
<remarks>To be added</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>Disposes the resources associated with this <see cref="T:Vte.Reaper" /> object.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="OnChildExited">
<MemberSignature Language="C#" Value="protected virtual void OnChildExited (int p0, int p1);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="p0" Type="System.Int32" />
<Parameter Name="p1" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Default handler for the <see cref="M:Vte.Reaper.ChildExited" /> event.</summary>
<param name="p0">a <see cref="T:System.Int32" /></param>
<param name="p1">a <see cref="T:System.Int32" /></param>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Vte.Reaper.ChildExited" /> event.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Reaper (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Protected Constructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Vte.Reaper" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Reaper (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Vte.Reaper" /></returns>
<remarks>This is not typically used by C# code.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Reaper ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Vte.Reaper" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Vte.Reaper" />.</remarks>
</Docs>
</Member>
<Member MemberName="ChildExited">
<MemberSignature Language="C#" Value="public event Vte.ChildExitedHandler ChildExited;" />
<MemberType>Event</MemberType>
<ReturnValue>
<ReturnType>Vte.ChildExitedHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>