GtkSharp/doc/en/Gnome/Help.xml
Shane Landrum ab31021a7a 2005-01-07 Shane Landrum <epicene@pobox.com>
* en/Gnome/*: Cleaned up some <param> sections
	to include links to the types they use; edited
	<remarks> sections.


svn path=/trunk/gtk-sharp/; revision=38496
2005-01-07 16:27:42 +00:00

121 lines
5.4 KiB
XML

<Type Name="Help" FullName="Gnome.Help">
<TypeSignature Language="C#" Value="public class Help" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gnome-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>Display application and Gnome system help.</summary>
<remarks>These functions provide a way to display help files that are either installed as part of the main Gnome installation or that are specific to the current application.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Attributes />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Help ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Creates a new <see cref="T:Gnome.Help" /> instance.</summary>
<returns>a <see cref="T:Gnome.Help" /></returns>
<remarks>This is the default constructor for <see cref="T:Gnome.Help" />.</remarks>
</Docs>
</Member>
<Member MemberName="DisplayDesktopOnScreen">
<MemberSignature Language="C#" Value="public static bool DisplayDesktopOnScreen (Gnome.Program program, string doc_id, string file_name, string link_id, Gdk.Screen screen);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="program" Type="Gnome.Program" />
<Parameter Name="doc_id" Type="System.String" />
<Parameter Name="file_name" Type="System.String" />
<Parameter Name="link_id" Type="System.String" />
<Parameter Name="screen" Type="Gdk.Screen" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="program">a <see cref="T:Gnome.Program" /></param>
<param name="doc_id">a <see cref="T:System.String" /></param>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="link_id">a <see cref="T:System.String" /></param>
<param name="screen">a <see cref="T:Gdk.Screen" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisplayOnScreen">
<MemberSignature Language="C#" Value="public static bool DisplayOnScreen (string file_name, string link_id, Gdk.Screen screen);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="file_name" Type="System.String" />
<Parameter Name="link_id" Type="System.String" />
<Parameter Name="screen" Type="Gdk.Screen" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="link_id">a <see cref="T:System.String" /></param>
<param name="screen">a <see cref="T:Gdk.Screen" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisplayUriOnScreen">
<MemberSignature Language="C#" Value="public static bool DisplayUriOnScreen (string help_uri, Gdk.Screen screen);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="help_uri" Type="System.String" />
<Parameter Name="screen" Type="Gdk.Screen" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="help_uri">a <see cref="T:System.String" /></param>
<param name="screen">a <see cref="T:Gdk.Screen" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DisplayWithDocIdOnScreen">
<MemberSignature Language="C#" Value="public static bool DisplayWithDocIdOnScreen (Gnome.Program program, string doc_id, string file_name, string link_id, Gdk.Screen screen);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="program" Type="Gnome.Program" />
<Parameter Name="doc_id" Type="System.String" />
<Parameter Name="file_name" Type="System.String" />
<Parameter Name="link_id" Type="System.String" />
<Parameter Name="screen" Type="Gdk.Screen" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="program">a <see cref="T:Gnome.Program" /></param>
<param name="doc_id">a <see cref="T:System.String" /></param>
<param name="file_name">a <see cref="T:System.String" /></param>
<param name="link_id">a <see cref="T:System.String" /></param>
<param name="screen">a <see cref="T:Gdk.Screen" /></param>
<returns>a <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>