ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Contributions from chris@turchin.net

Browse source 
svn path=/trunk/gtk-sharp/; revision=30463
This commit is contained in:
Miguel de Icaza 2004-06-27 14:47:17 +00:00
parent 5cd817ccb7
commit 661358be51
5 changed files with 156 additions and 47 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

26
doc/en/GLib/FileUtils.xml
View file

@ -10,8 +10,8 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>A simple file IO utility class</summary>
<remarks>To be added</remarks> <remarks>Contains a single static method GetFileContents(string filename) which returns the contents of a text file as a string.</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.Object</BaseTypeName> <BaseTypeName>System.Object</BaseTypeName>
@ -29,10 +29,24 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Returns a string containing the contents of the text file passed as the 'filename' parameter.</summary>
<param name="filename">an object of type <see cref="T:System.String" /></param> <param name="filename">The file GetFileContents() should retrieve its result from. An object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns> <returns>Returns the contents of a text file. An object of type <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks>
<example>
<code lang="C#">
using System;
class Test
{
public static void Main(string[] args)
{
Console.WriteLine(GLib.FileUtils.GetFileContents(args[0]));
}
}
</code>
</example>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

143
doc/en/GLib/GType.xml
View file

@ -10,8 +10,42 @@
</AssemblyInfo> </AssemblyInfo>
<ThreadSafetyStatement /> <ThreadSafetyStatement />
<Docs> <Docs>
<summary>To be added</summary> <summary>The GLib Runtime type identification and management system. The GType API is the foundation of the GObject system. It provides the facilities for registering and managing all fundamental data types, user-defined object and interface types. </summary>
<remarks>To be added</remarks> <remarks>
<example>
<code lang="C#">
using System;
using Gtk;
public class MagrittesWindow : Window {
static GLib.GType gtype;
Button button;
public static new GLib.GType GType
{
get
{
if (gtype == GLib.GType.Invalid)
gtype = RegisterGType (typeof (MagrittesWindow));
return gtype;
}
}
public MagrittesWindow() : base (GType)
{
button = new Button("This is not a button");
button.Clicked += new EventHandler(button_Clicked);
this.Title = "This is not a Window";
this.SetDefaultSize (400, 300);
this.DeleteEvent += new DeleteEventHandler (MyWindow_Delete);
this.Add(button);
this.ShowAll ();
}
/* elided for brevity */
</code>
</example>
</remarks>
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>System.ValueType</BaseTypeName> <BaseTypeName>System.ValueType</BaseTypeName>
@ -28,8 +62,28 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.Invalid
<remarks>To be added</remarks> </summary>
<remarks>
<example>
<code lang="C#">
public class MyWindow : Window {
static GLib.GType gtype;
Button button;
public static new GLib.GType GType
{
get
{
if (gtype == GLib.GType.Invalid)
gtype = RegisterGType (typeof (MyWindow));
return gtype;
}
}
/* Rest elided for clarity */
</code>
</example>
</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="None"> <Member MemberName="None">
@ -41,8 +95,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.None</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="String"> <Member MemberName="String">
@ -54,8 +108,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.String</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Boolean"> <Member MemberName="Boolean">
@ -67,8 +121,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.Boolean.</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Int"> <Member MemberName="Int">
@ -80,8 +134,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.Int</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Double"> <Member MemberName="Double">
@ -93,8 +147,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.Double</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Float"> <Member MemberName="Float">
@ -106,8 +160,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.Float</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Char"> <Member MemberName="Char">
@ -119,8 +173,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.Char</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="UInt"> <Member MemberName="UInt">
@ -132,8 +186,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.UInt</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Object"> <Member MemberName="Object">
@ -145,8 +199,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.Object</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Pointer"> <Member MemberName="Pointer">
@ -158,8 +212,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.Pointer</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Boxed"> <Member MemberName="Boxed">
@ -171,8 +225,8 @@
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>A field of type GType.Boxed</summary>
<remarks>To be added</remarks> <remarks>Sample see: GLib.GType.Invalid.</remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Equals"> <Member MemberName="Equals">
@ -185,7 +239,10 @@
<Parameter Name="o" Type="System.Object" /> <Parameter Name="o" Type="System.Object" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>
<para>Determines whether the current instance and a specified
<see cref="T:System.Object" /> represent the same value.</para>
</summary>
<param name="o">a <see cref="T:System.Object" /></param> <param name="o">a <see cref="T:System.Object" /></param>
<returns>a <see cref="T:System.Boolean" /></returns> <returns>a <see cref="T:System.Boolean" /></returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -199,9 +256,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Generates a hash code for the current instance.</summary>
<returns>a <see cref="T:System.Int32" /></returns> <returns>a <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ToString"> <Member MemberName="ToString">
@ -212,9 +269,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary> Manufactures a human-readable text string that describes an instance of the class.</summary>
<returns>a <see cref="T:System.String" /></returns> <returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -225,10 +282,26 @@
<Parameter Name="val" Type="System.IntPtr" /> <Parameter Name="val" Type="System.IntPtr" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructor for GType. Primarily used in generated wrappers for gtk objects.</summary>
<param name="val">a <see cref="T:System.IntPtr" /></param> <param name="val">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:GLib.GType" /></returns> <returns>a <see cref="T:GLib.GType" /></returns>
<remarks>To be added</remarks> <remarks>Generated code from gnome/generated/About.cs:
<example>
<code lang="C#">
[DllImport("gnomeui-2")]
static extern IntPtr gnome_about_get_type();
public static new GLib.GType GType {
get {
IntPtr raw_ret = gnome_about_get_type();
GLib.GType ret = new GLib.GType(raw_ret);
return ret;
}
}
</code>
</example></remarks>
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Val"> <Member MemberName="Val">
@ -239,9 +312,9 @@
</ReturnValue> </ReturnValue>
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Read only property retrieves the <see cref="T:System.IntPtr" /> representing the GType object in question.</summary>
<returns>a <see cref="T:System.IntPtr" /></returns> <returns>a <see cref="T:System.IntPtr" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

15
doc/en/GLib/List.xml
View file

@ -139,10 +139,21 @@
<Parameter Name="element_type" Type="System.Type" /> <Parameter Name="element_type" Type="System.Type" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Constructs a list of objects of a given type.</summary>
<param name="element_type">a <see cref="T:System.Type" /></param> <param name="element_type">a <see cref="T:System.Type" /></param>
<returns>a <see cref="T:GLib.List" /></returns> <returns>a <see cref="T:GLib.List" /></returns>
<remarks>To be added</remarks> <remarks>
<example>
<code lang="C#">
Gtk.Widget a = new Gtk.Widget((IntPtr) 0);
Gtk.Widget b = new Gtk.Widget((IntPtr) 0);
GLib.List l = new GLib.List (typeof (Gtk.Widget));
l.Append (a.Handle);
l.Append (b.Handle);
</code>
</example>
</remarks>
</Docs> </Docs>
</Member> </Member>
</Members> </Members>

11
doc/en/GLib/Log.xml
View file

@ -12,6 +12,17 @@
<Docs> <Docs>
<summary>Message logging functions.</summary> <summary>Message logging functions.</summary>
<remarks> <remarks>
<example>
<code lang="C#">
//Some common logging methods.
// Print the messages for the NULL domain
LogFunc logFunc = new LogFunc (Log.PrintLogFunction);
Log.SetLogHandler (null, LogLevelFlags.All, logFunc);
// Print messages and stack trace for Gtk critical messages
logFunc = new LogFunc (Log.PrintTraceLogFunction);
Log.SetLogHandler ("Gtk", LogLevelFlags.Critical, logFunc);
</code>
</example>
</remarks> </remarks>
<example> <example>
<code language="C#"> <code language="C#">

8
doc/en/Gtk/Combo.xml
View file

@ -203,7 +203,7 @@ class ComboSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Does nothing. ---- To get out ----</summary> <summary>Does nothing. ---- REMOVE ---- See EnableArrowKeys.</summary>
<param name="value">To be added: an object of type 'bool'</param> <param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns> <returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -218,7 +218,7 @@ class ComboSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Specifies if the arrow (cursor) keys can be used to step through the items in the list.</summary> <summary>Specifies if the arrow (cursor) keys can be used to step through the items in the list. See also EnableArrowKeys.</summary>
<param name="value">an object of type <see cref="T:Gtk.Boolean" /></param> <param name="value">an object of type <see cref="T:Gtk.Boolean" /></param>
<returns> <returns>
<see langword="true" /> if the arrow keys can be used to step through the items in the list.</returns> <see langword="true" /> if the arrow keys can be used to step through the items in the list.</returns>
@ -234,7 +234,7 @@ class ComboSample
<Parameters> <Parameters>
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>See EnableArrowKeys</summary>
<param name="value">To be added: an object of type 'bool'</param> <param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns> <returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks> <remarks>To be added</remarks>
@ -329,7 +329,7 @@ class ComboSample
<Parameter Name="gtype" Type="GLib.GType" /> <Parameter Name="gtype" Type="GLib.GType" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Protected Constructor.</summary> <summary>Protected contstructor.</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param> <param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gtk.Combo" /></returns> <returns>a <see cref="T:Gtk.Combo" /></returns>
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks> <remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>