2004-06-24 Mike Kestner <mkestner@ximian.com>

* en/GLib/Timeout.xml : finish the class and Add docs.

svn path=/trunk/gtk-sharp/; revision=30330
This commit is contained in:
Mike Kestner 2004-06-24 19:35:28 +00:00
parent 07fc84a409
commit eea63d0087
3 changed files with 19 additions and 9 deletions

View File

@ -1,3 +1,7 @@
2004-06-24 Mike Kestner <mkestner@ximian.com>
* en/GLib/Timeout.xml : finish the class and Add docs.
2004-06-24 Mike Kestner <mkestner@ximian.com>
* en/*/*.xml : add back the enumtype Value__ fields with "Do not use"

View File

@ -11,8 +11,7 @@
<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>Allows the installation of Timeout Handlers on the GLib main loop.</summary>
<remarks>
</remarks>
<remarks>Use the <see cref="M:GLib.Timeout.Add" /> method to install timeout handlers into the mainloop.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
@ -31,11 +30,18 @@
<Parameter Name="hndlr" Type="GLib.TimeoutHandler" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="interval">an object of type <see cref="T:System.UInt32" /></param>
<param name="hndlr">an object of type <see cref="T:GLib.TimeoutHandler" /></param>
<returns>an object of type 'uint'</returns>
<remarks>To be added</remarks>
<summary>Adds a <see cref="T:GLib.TimeoutHandler" /> delegate to the mainloop. </summary>
<param name="interval">the interval in milliseconds between invocations of <paramref name="hndlr" />.</param>
<param name="hndlr">a delegate of type <see cref="T:GLib.TimeoutHandler" /> to invoke every <paramref name="interval" />.</param>
<returns>an id representing the event source of the installed timeout handler.</returns>
<remarks>
<para>
The delegate is invoked after the time period specified by <paramref name="interval" />. The delegate is invoked repeatedly until it returns <see langword="false" />.
</para>
<para>
Invocation of the delegate may be delayed by other event processing, so this mechanism cannot be depended on for accurate timing. The interval to the next timeout is calculated at completion of the preceding timeout. There is no attempt made to "catch up" if an invocation is delayed.
</para>
</remarks>
</Docs>
</Member>
</Members>

View File

@ -74,7 +74,7 @@
<summary>Creates a new vertical scrollbar.</summary>
<param name="adjustment">The <see cref="T:Gtk.Adjustment" /> to use, or <see langword="null" /> to create a new adjustment.</param>
<returns>The new <see cref="T:Gtk.VScrollbar" /></returns>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -105,4 +105,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>