ryujinx/GtkSharp
1
0
Fork 0
mirror of https://github.com/Ryujinx/GtkSharp.git synced 2024-12-26 22:05:35 +00:00
Code Issues Packages Projects Releases Wiki Activity
GtkSharp/doc/en/Gnome/About.xml
John Luke 0b12cb5378 run the updater 
svn path=/trunk/gtk-sharp/; revision=19429
2003-10-28 00:48:23 +00:00

313 lines
13 KiB
XML
Raw Blame History

<Type Name="About" FullName="Gnome.About">
<TypeSignature Language="C#" Value="public class About : Gtk.Dialog, Implementor, IWrapper, IWrapper, IDisposable" 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 author, documenter and translator credits for an application.</summary>
<remarks>
<para>The <see cref="T:Gnome.About" /> widget is used as the standard way of displaying credits in an application.
Typically, it will be called when a user selects the About... option from the Help menu.
With one simple function call, the application can then display all of the appropriate information.</para>
<para>NOTE: The <see cref="T:Gnome.About" /> widget is destroyed automatically when the close event is called. Therefore, it is not possible to use the same <see cref="T:Gnome.About" /> more than once.</para>
<para>Compile the following example with: mcs GnomeAboutSample.cs -r gtk-sharp -r gnome-sharp -r gdk-sharp</para>
</remarks>
<example>
<code language="C#">
using System;
using Gtk;
using GtkSharp;
using Gnome;
class GnomeAboutSample
{
About ab;
Program program;
static void Main(string[] args)
{
new GnomeAboutSample(args);
}
GnomeAboutSample (string[] args)
{
program =
new Program("GnomeAboutSample", "0.1", Gnome.Modules.UI , args);
App app = new App("sample", "sample");
app.SetDefaultSize (250, 250);
app.DeleteEvent += new DeleteEventHandler (on_app_delete);
Button btn = new Button ("Show About");
btn.Clicked += new EventHandler (on_btn_clicked);
app.Contents = btn;
app.ShowAll();
program.Run();
}
private void on_btn_clicked (object obj, EventArgs args)
{
string[] authors = {"The Author", "Co-Author"};
string[] documenters = {"The Documenters", "Another Documenter"};
Gdk.Pixbuf pixbuf = new Gdk.Pixbuf ("MonoIcon.png");
ab = new Gnome.About ("GnomeAboutTest", "0.1", "Copyright", "Comments",
authors, documenters, "translator", pixbuf);
ab.Close += new EventHandler (OnAboutClose);
ab.Response += new ResponseHandler (OnAboutResponse);
ab.Run ();
}
private void OnAboutClose (object o, EventArgs args)
{
Console.WriteLine ("Close Event");
}
private void OnAboutResponse(object o, ResponseArgs args)
{
Console.WriteLine (args.ResponseId);
}
private void on_app_delete (object o, DeleteEventArgs args)
{
program.Quit ();
}
}
</code>
</example>
</Docs>
<Base>
<BaseTypeName>Gtk.Dialog</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Construct">
<MemberSignature Language="C#" Value="public void Construct (string name, string version, string copyright, string comments, string authors, string documenters, string translator_credits, Gdk.Pixbuf logo_pixbuf);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="version" Type="System.String" />
<Parameter Name="copyright" Type="System.String" />
<Parameter Name="comments" Type="System.String" />
<Parameter Name="authors" Type="System.String" />
<Parameter Name="documenters" Type="System.String" />
<Parameter Name="translator_credits" Type="System.String" />
<Parameter Name="logo_pixbuf" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>Construct a credits box for an <see cref="T:Gnome.Application" />.</summary>
<param name="name">an object of type <see cref="T:System.String" /></param>
<param name="version">an object of type <see cref="T:System.String" /></param>
<param name="copyright">an object of type <see cref="T:System.String" /></param>
<param name="comments">an object of type <see cref="T:System.String" /></param>
<param name="authors">an object of type <see cref="T:System.String" /></param>
<param name="documenters">an object of type <see cref="T:System.String" /></param>
<param name="translator_credits">an object of type <see cref="T:System.String" /></param>
<param name="logo_pixbuf">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<remarks>The <paramref name="authors" /> array cannot be empty.</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 the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public About (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 About, 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 About (string name, string version, string copyright, string comments, string [] authors, string [] documenters, string translator_credits, Gdk.Pixbuf logo_pixbuf);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="name" Type="System.String" />
<Parameter Name="version" Type="System.String" />
<Parameter Name="copyright" Type="System.String" />
<Parameter Name="comments" Type="System.String" />
<Parameter Name="authors" Type="System.String []" />
<Parameter Name="documenters" Type="System.String []" />
<Parameter Name="translator_credits" Type="System.String" />
<Parameter Name="logo_pixbuf" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>Creates a new instance of <see cref="Gnome.About" />.</summary>
<param name="name">an object of type <see cref="T:System.String" /></param>
<param name="version">an object of type <see cref="T:System.String" /></param>
<param name="copyright">an object of type <see cref="T:System.String" /></param>
<param name="comments">an object of type <see cref="T:System.String" /></param>
<param name="authors">an object of type <see cref="T:System.String []" /></param>
<param name="documenters">an object of type <see cref="T:System.String []" /></param>
<param name="translator_credits">an object of type <see cref="T:System.String" /></param>
<param name="logo_pixbuf">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gnome.About" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected About ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Creates a new instance of <see cref="T:Gnome.About" /></summary>
<returns>an object of type <see cref="T:Gnome.About" /></returns>
<remarks>This is an internal constructor, and should not be used by user code.</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 <see cref="T:GLib.Type" /> for <see cref="T:Gnome.About" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gnome.About" /> class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>The name of the application.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="TranslatorCredits">
<MemberSignature Language="C#" Value="public string TranslatorCredits { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>The translator for the current locale.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Copyright">
<MemberSignature Language="C#" Value="public string Copyright { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary> The copyright statement of the application.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Logo">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Logo { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary> The logo for the application.</summary>
<param name="value">an object of type <see cref="T:Gdk.Pixbuf" /></param>
<returns>an object of type <see cref="T:Gdk.Pixbuf" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Version">
<MemberSignature Language="C#" Value="public string Version { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>The version string of the application.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Comments">
<MemberSignature Language="C#" Value="public string Comments { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>A short miscellaneous string.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected About (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of About, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gnome.About" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>
Reference in a new issue View git blame Copy permalink