* en/Gtk/Timeout.xml: documented
svn path=/trunk/gtk-sharp/; revision=17611
This commit is contained in:
parent
8f546e62c4
commit
9f14df277e
2 changed files with 24 additions and 23 deletions
|
@ -1,6 +1,7 @@
|
||||||
2003-08-25 John Luke <jluke@cfl.rr.com>
|
2003-08-25 John Luke <jluke@cfl.rr.com>
|
||||||
|
|
||||||
* en/Gtk/Layout.xml: mostly documented
|
* en/Gtk/Layout.xml: mostly documented
|
||||||
|
* en/Gtk/Timeout.xml: documented
|
||||||
|
|
||||||
2003-08-18 John Luke <jluke@cfl.rr.com>
|
2003-08-18 John Luke <jluke@cfl.rr.com>
|
||||||
|
|
||||||
|
|
|
@ -1,5 +1,5 @@
|
||||||
<Type Name="Timeout" FullName="Gtk.Timeout">
|
<Type Name="Timeout" FullName="Gtk.Timeout">
|
||||||
<TypeSignature Language="C#" Value="public class Timeout" Maintainer="auto" />
|
<TypeSignature Language="C#" Value="public class Timeout" Maintainer="John Luke" />
|
||||||
<AssemblyInfo>
|
<AssemblyInfo>
|
||||||
<AssemblyName>gtk-sharp</AssemblyName>
|
<AssemblyName>gtk-sharp</AssemblyName>
|
||||||
<AssemblyPublicKey />
|
<AssemblyPublicKey />
|
||||||
|
@ -9,8 +9,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>Registers a method to be called periodically.</summary>
|
||||||
<remarks>To be added</remarks>
|
<remarks></remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
<Base>
|
<Base>
|
||||||
<BaseTypeName>System.Object</BaseTypeName>
|
<BaseTypeName>System.Object</BaseTypeName>
|
||||||
|
@ -25,15 +25,15 @@
|
||||||
<ReturnType>System.UInt32</ReturnType>
|
<ReturnType>System.UInt32</ReturnType>
|
||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters>
|
<Parameters>
|
||||||
<Parameter Name="interval" Type="System.UInt32" />
|
<Parameter Name="interval" Type="System.UInt32" />
|
||||||
<Parameter Name="function" Type="Gtk.Function" />
|
<Parameter Name="function" Type="Gtk.Function" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Registers a <paramref name="function" /> to be called periodically.</summary>
|
||||||
<param name="interval">a <see cref="T:System.UInt32" /></param>
|
<param name="interval">a <see cref="T:System.UInt32" /></param>
|
||||||
<param name="function">a <see cref="T:Gtk.Function" /></param>
|
<param name="function">a <see cref="T:Gtk.Function" /></param>
|
||||||
<returns>a <see cref="T:System.UInt32" /></returns>
|
<returns>a <see cref="T:System.UInt32" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>The <paramref name="function" /> will be called repeatedly after <paramref name="interval" /> milliseconds until it returns <see langword="false" /> at which point the <see cref="T:Gtk.Timeout" /> is destroyed and will not be called again.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="AddFull">
|
<Member MemberName="AddFull">
|
||||||
|
@ -43,21 +43,21 @@
|
||||||
<ReturnType>System.UInt32</ReturnType>
|
<ReturnType>System.UInt32</ReturnType>
|
||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters>
|
<Parameters>
|
||||||
<Parameter Name="interval" Type="System.UInt32" />
|
<Parameter Name="interval" Type="System.UInt32" />
|
||||||
<Parameter Name="function" Type="Gtk.Function" />
|
<Parameter Name="function" Type="Gtk.Function" />
|
||||||
<Parameter Name="marshal" Type="Gtk.CallbackMarshal" />
|
<Parameter Name="marshal" Type="Gtk.CallbackMarshal" />
|
||||||
<Parameter Name="data" Type="System.IntPtr" />
|
<Parameter Name="data" Type="System.IntPtr" />
|
||||||
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
|
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Registers a <paramref name="function" /> to be called periodically.</summary>
|
||||||
<param name="interval">a <see cref="T:System.UInt32" /></param>
|
<param name="interval">a <see cref="T:System.UInt32" /></param>
|
||||||
<param name="function">a <see cref="T:Gtk.Function" /></param>
|
<param name="function">a <see cref="T:Gtk.Function" /></param>
|
||||||
<param name="marshal">a <see cref="T:Gtk.CallbackMarshal" /></param>
|
<param name="marshal">a <see cref="T:Gtk.CallbackMarshal" /></param>
|
||||||
<param name="data">a <see cref="T:System.IntPtr" /></param>
|
<param name="data">a <see cref="T:System.IntPtr" /></param>
|
||||||
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
|
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
|
||||||
<returns>a <see cref="T:System.UInt32" /></returns>
|
<returns>a <see cref="T:System.UInt32" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>The <paramref name="function" /> will be called repeatedly after <paramref name="interval" /> milliseconds until it returns <see langword="false" /> at which point the <see cref="T:Gtk.Timeout" /> is destroyed and will not be called again.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName="Remove">
|
<Member MemberName="Remove">
|
||||||
|
@ -67,12 +67,12 @@
|
||||||
<ReturnType>System.Void</ReturnType>
|
<ReturnType>System.Void</ReturnType>
|
||||||
</ReturnValue>
|
</ReturnValue>
|
||||||
<Parameters>
|
<Parameters>
|
||||||
<Parameter Name="timeout_handler_id" Type="System.UInt32" />
|
<Parameter Name="timeout_handler_id" Type="System.UInt32" />
|
||||||
</Parameters>
|
</Parameters>
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Removes the given timeout destroying all information about it.</summary>
|
||||||
<param name="timeout_handler_id">a <see cref="T:System.UInt32" /></param>
|
<param name="timeout_handler_id">a <see cref="T:System.UInt32" /></param>
|
||||||
<remarks>To be added</remarks>
|
<remarks></remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
<Member MemberName=".ctor">
|
<Member MemberName=".ctor">
|
||||||
|
@ -81,9 +81,9 @@
|
||||||
<ReturnValue />
|
<ReturnValue />
|
||||||
<Parameters />
|
<Parameters />
|
||||||
<Docs>
|
<Docs>
|
||||||
<summary>To be added</summary>
|
<summary>Internal Constructor</summary>
|
||||||
<returns>a <see cref="T:Gtk.Timeout" /></returns>
|
<returns>a <see cref="T:Gtk.Timeout" /></returns>
|
||||||
<remarks>To be added</remarks>
|
<remarks>This should not be called directly by typical applications.</remarks>
|
||||||
</Docs>
|
</Docs>
|
||||||
</Member>
|
</Member>
|
||||||
</Members>
|
</Members>
|
||||||
|
|
Loading…
Reference in a new issue