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

2003-03-08 Miguel de Icaza <miguel@ximian.com>

Browse source 
* glib/Idle.cs: Add private constructor.
2003-03-08  Miguel de Icaza  <miguel@ximian.com>

	* en/GLib/IdleHandler.xml: Documeted.

	* en/GLib/List.xml: Documented.

	* en/GLib/Idle.xml: Documented.

svn path=/trunk/gtk-sharp/; revision=12369
This commit is contained in:
Miguel de Icaza 2003-03-09 07:58:52 +00:00
parent d78941e312
commit 032a660b72
5 changed files with 128 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
ChangeLog
View file

@ -1,3 +1,11 @@
2003-03-08 Miguel de Icaza <miguel@ximian.com>
* glib/Idle.cs: Add private constructor.
2003-03-05 Miguel de Icaza <miguel@ximian.com>
* gtk/Bin.cs: Add new property `Child' to GtkBin.
2003-03-06 Mike Kestner <mkestner@speakeasy.net>
* rsvg/Makefile.in : some -L -r magic

9
doc/ChangeLog
View file

@ -1,3 +1,12 @@
2003-03-08 Miguel de Icaza <miguel@ximian.com>
* en/GLib/IdleHandler.xml: Documeted.
* en/GLib/List.xml: Documented.
* en/GLib/Idle.xml: Documented.
2003-03-08 Lee Mallabone <mono-docs@fonicmonkey.net>
* en/Gtk/Table.xml: First draft of table docs. Have left spacing

51
doc/en/GLib/Idle.xml
View file

@ -5,10 +5,15 @@
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<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>
<ThreadSafetyStatement>This function is thread safe.</ThreadSafetyStatement>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Idle handlers for GLib-based main-loops</summary>
<remarks>
GLib provides an implementation of a "main loop" (an event-based
main loop that dispatches requests). The Idle handler class is
used to register a routine to be called when the main loop is
idle.
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -26,21 +31,31 @@
<Parameter Name="hndlr" Type="GLib.IdleHandler" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="hndlr">To be added: an object of type 'GLib.IdleHandler'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Idle ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'GLib.Idle'</returns>
<remarks>To be added</remarks>
<summary>Installs an idle handler for the main loop.</summary>
<param name="hndlr">The delegate method that will be invoked.</param>
<returns>The handler code assigned to this idle handler.</returns>
<remarks>
<para>
This function installs the <paramref name="hndlr"/> as a
handler to be invoked when the GLib mainloop is idle. If
the handler returns <see langword="true"/> the handler is
kept for another round of Idle execution, if <see
langword="false"/> is returned, the handler is removed.
</para>
<para>
This method can be invoked from a differen thread than the
one running the Gtk main loop. The delegate will be
invoked within the context of the Gtk main loop.
</para>
<para>
The thread-safety of this routine can be used to queue
work by a thread to be performed in the context of the
main Gtk thread. Gtk# is thread aware, but not thread
safe; See the <link
location="node:gtk-sharp/programming/threads">Gtk# Thread
Programming</link> for details.
</para>
</remarks>
</Docs>
</Member>
</Members>

12
doc/en/GLib/IdleHandler.xml
View file

@ -7,8 +7,16 @@
</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>
<summary>Delegate to invoke during idle time</summary>
<remarks>
<para>
The handler specified by the delegate will be invoked during
the GLib main loop execution. If the handler returns <see
langword="true"/> the handler is kept for another round of
Idle execution, if <see langword="false"/> is returned, the
handler is removed.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>

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

@ -1,5 +1,5 @@
<Type Name="List" FullName="GLib.List">
<TypeSignature Language="C#" Value="public class List : GLib.ListBase, IDisposable, ICollection, IEnumerable, IWrapper, ICloneable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class List : GLib.ListBase, IDisposable, ICollection, IEnumerable, IWrapper, ICloneable" Maintainer="miguel" />
<AssemblyInfo>
<AssemblyName>glib-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +7,38 @@
</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>
<summary>A list class used by GTK+</summary>
<remarks>
<para>
GLib.List is managed wrapper for the underlying C list
implementation used by Gtk+. Various functions on the Gtk+
API take lists or return lists in this form.
</para>
<para>
The list deals with IntPtr objects, these are pointers into
unmanaged resources.
</para>
<example>
<para>
For example to create a list of widgets, you would use the
following sample:
</para>
<code lang="c#">
GLib.List MakeList (Gtk.Widget a, Gtk.Widget b)
{
GLib.List l = new GLib.List ((IntPtr) 0, typeof (Gtk.Widget));
l.Append (a.Handle);
l.Append (b.Handle);
}
</code>
<para>
The <see cref="T:System.Type"/> argument to the GLib.List
constructor, allows the list enumerator code to return
properly wrapped or demarshalled objects from the unmanaged
world into the managed world.
</para>
</example>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.ListBase</BaseTypeName>
@ -40,9 +70,14 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'object'</returns>
<remarks>To be added</remarks>
<summary>Duplicates the list, shallow copy.</summary>
<returns>The duplicated list</returns>
<remarks>
<para>
Makes a new copy of the list. The individual elements on
the list are not duplicated.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -53,11 +88,21 @@
<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 List, wrapping the C object.</returns>
<summary>Constructs a List</summary>
<param name="raw">A handle to a GLib.List.</param>
<returns>A new insteace instance of List, wrapping the C list.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
<para>
GLib.List objects are constructed by passing an unmanaged
reference to an existing GLib.List, or they can use
"(IntPtr) 0" as an initial value.
</para>
<para>
Using this constructor will not track the type information
of the classes or structures kept in the list. If you
plan on tracking the type information, use the <see
cref="M:GLib.List.List(IntPtr,Type)"/> method.
</para>
</remarks>
</Docs>
</Member>
@ -71,10 +116,20 @@
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of List, wrapping the C object.</returns>
<param name="raw">A handle to a GLib.list</param>
<returns>A new instance of List, wrapping the C list.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
<para>
GLib.List objects are constructed by passing an unmanaged
reference to an existing GLib.List, or they can use
"(IntPtr) 0" as an initial value.
</para>
<para>
Using this constructor will track the type information
of the classes or structures kept in the list. This
information is used by the List enumerator when returning
data.
</para>
</remarks>
</Docs>
</Member>