GtkSharp/doc/en/Gnome/Scores.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

260 lines
10 KiB
XML

<Type Name="Scores" FullName="Gnome.Scores">
<TypeSignature Language="C#" Maintainer="auto" Value="public class Scores : Gtk.Dialog" />
<AssemblyInfo>
<AssemblyName>gnome-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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Dialog</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName="DisplayWithPixmap">
<MemberSignature Language="C#" Value="public static Gtk.Widget DisplayWithPixmap (string pixmap_logo, string app_name, string level, int pos);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pixmap_logo" Type="System.String" />
<Parameter Name="app_name" Type="System.String" />
<Parameter Name="level" Type="System.String" />
<Parameter Name="pos" Type="System.Int32" />
</Parameters>
<Docs>
<summary>
<para>Does all the work of displaying the best scores. It calls <see cref="T:Gnome.Score.GetNotable" /> to retrieve the info, creates the window, and shows it.</para>
</summary>
<param name="pixmap_logo">an object of type <see cref="T:System.String" /><para>Filename of a logo pixmap to display</para></param>
<param name="app_name">an object of type <see cref="T:System.String" /><para>Name of the application, as in <see cref="T:Gnome.Score.Init" />.</para></param>
<param name="level">an object of type <see cref="T:System.String" /><para>Level of the game or NULL.</para></param>
<param name="pos">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'Gtk.Widget'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Scores (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>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Colors">
<MemberSignature Language="C#" Value="public Gdk.Color Colors { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'Gdk.Color'</value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="DefColor">
<MemberSignature Language="C#" Value="public Gdk.Color DefColor { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Color</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:Gdk.Color" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CurrentPlayer">
<MemberSignature Language="C#" Value="public int CurrentPlayer { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="LogoLabelTitle">
<MemberSignature Language="C#" Value="public string LogoLabelTitle { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="LogoPixmap">
<MemberSignature Language="C#" Value="public string LogoPixmap { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="LogoWidget">
<MemberSignature Language="C#" Value="public Gtk.Widget LogoWidget { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.Widget</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:Gtk.Widget" /></value>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetColor">
<MemberSignature Language="C#" Value="public void SetColor (uint n, Gdk.Color col);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="n" Type="System.UInt32" />
<Parameter Name="col" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="n">a <see cref="T:System.UInt32" /></param>
<param name="col">a <see cref="T:Gdk.Color" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetLogoLabel">
<MemberSignature Language="C#" Value="public void SetLogoLabel (string txt, string font, Gdk.Color col);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="txt" Type="System.String" />
<Parameter Name="font" Type="System.String" />
<Parameter Name="col" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="txt">a <see cref="T:System.String" /></param>
<param name="font">a <see cref="T:System.String" /></param>
<param name="col">a <see cref="T:Gdk.Color" /></param>
<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>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gnome.Scores" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Scores (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>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Construct">
<MemberSignature Language="C#" Value="public float Construct (uint n_scores, string names, DateTime times, bool clear);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Single</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="n_scores" Type="System.UInt32" />
<Parameter Name="names" Type="System.String" />
<Parameter Name="times" Type="System.DateTime" />
<Parameter Name="clear" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="n_scores">a <see cref="T:System.UInt32" /></param>
<param name="names">a <see cref="T:System.String" /></param>
<param name="times">a <see cref="T:System.DateTime" /></param>
<param name="clear">a <see cref="T:System.Boolean" /></param>
<returns>a <see cref="T:System.Single" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Scores (uint n_scores, string names, out float scores, DateTime times, bool clear);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="n_scores" Type="System.UInt32" />
<Parameter Name="names" Type="System.String" />
<Parameter Name="scores" Type="System.Single&amp;" RefType="out" />
<Parameter Name="times" Type="System.DateTime" />
<Parameter Name="clear" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="n_scores">a <see cref="T:System.UInt32" /></param>
<param name="names">a <see cref="T:System.String" /></param>
<param name="scores">a <see cref="T:System.Single" /></param>
<param name="times">a <see cref="T:System.DateTime" /></param>
<param name="clear">a <see cref="T:System.Boolean" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Scores ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes>
</Type>