mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-16 19:44:45 +02:00
eea63d0087
* en/GLib/Timeout.xml : finish the class and Add docs. svn path=/trunk/gtk-sharp/; revision=30330
48 lines
2.3 KiB
XML
48 lines
2.3 KiB
XML
<Type Name="Timeout" FullName="GLib.Timeout">
|
|
<TypeSignature Language="C#" Value="public class Timeout" Maintainer="auto" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>glib-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>Allows the installation of Timeout Handlers on the GLib main loop.</summary>
|
|
<remarks>Use the <see cref="M:GLib.Timeout.Add" /> method to install timeout handlers into the mainloop.</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>System.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="Add">
|
|
<MemberSignature Language="C#" Value="public static uint Add (uint interval, GLib.TimeoutHandler hndlr);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.UInt32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="interval" Type="System.UInt32" />
|
|
<Parameter Name="hndlr" Type="GLib.TimeoutHandler" />
|
|
</Parameters>
|
|
<Docs>
|
|
<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>
|
|
</Type> |