GtkSharp/doc/en/Gtk/Init.xml
Mike Kestner 0e47e78f96 update docs to 2.8 API and document all new members
svn path=/trunk/gtk-sharp/; revision=54175
2005-12-09 23:12:49 +00:00

62 lines
2.7 KiB
XML

<Type Name="Init" FullName="Gtk.Init">
<TypeSignature Language="C#" Value="public class Init" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.8.0.0</AssemblyVersion>
</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>An object that gets invoked at the beginning of an application but before the application main loop starts. It's used largely for application setup--- for example, reading RC files.</summary>
<remarks />
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName="Add">
<MemberSignature Language="C#" Value="public static void Add (Gtk.Function function);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="function" Type="Gtk.Function" />
</Parameters>
<Docs>
<summary>Registers a function to be called when the mainloop is started. </summary>
<param name="function">a <see cref="T:Gtk.Function" /></param>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Init ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Check">
<MemberSignature Language="C#" Value="public static bool Check (ref string[] argv);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="argv" Type="System.String[]&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>Initializes Gtk# for operation, probes window system.</summary>
<param name="argv">The command line arguments passed in. Changed if any arguments were handled.</param>
<returns>True if the toolkit initialized correctly, false otherwise. </returns>
<remarks>Aside from the arguments, this function behaves in the same way as <see cref="T:Gtk.Application.InitCheck" />. By returning whether or not the toolkit initialized correctly, it allows the application to fall back to a non-GUI interface, should the developer be so inclined to write one.
</remarks>
</Docs>
</Member>
</Members>
</Type>