GtkSharp/doc/en/Gnome/InteractFunction.xml
Martin Willemoes Hansen 671e97d5c9 Used the params keyword with the parameter descriptions
svn path=/trunk/gtk-sharp/; revision=17048
2003-08-04 12:17:17 +00:00

51 lines
2.1 KiB
XML

<Type Name="InteractFunction" FullName="Gnome.InteractFunction">
<TypeSignature Language="C#" Value="public sealed delegate void InteractFunction (Gnome.Client client, int key, Gnome.DialogType dialog_type);" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<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>
<Docs>
<summary>
Used when the <see cref="T:Gnome.Client" /> wishes to interact with the user at
the session manager's convenience (usually during shutdown and restarts).
</summary>
<param name="client">The <see cref="T:Gnome.Client" /> instance doing the interaction.</param>
<param name="key">A unique key.</param>
<param name="dialog_type">The <see cref="T:Gnome.DialogType" /> that should be used to do the interaction.</param>
<param name="data">Application specific data that was specified at the time the callback was set up.</param>
<remarks>
<para>
All other <see cref="T:Gnome.Client" />s are blocked from interacting with the user until the
key is released via a call to <see cref="M:Gnome.Global.InteractionKeyReturn(int,bool)" />.
</para>
<para>
Although the function is not obliged to respect the passed in <see cref="T:Gnome.DialogType" />,
it is bad form not to do so.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>System.ICloneable</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.Runtime.Serialization.ISerializable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members />
<Parameters>
<Parameter Name="client" Type="Gnome.Client" />
<Parameter Name="key" Type="System.Int32" />
<Parameter Name="dialog_type" Type="Gnome.DialogType" />
</Parameters>
<ReturnValue><ReturnType>System.Void</ReturnType></ReturnValue>
</Type>