GtkSharp/doc/en/Gtk/RetrieveSurroundingHandler.xml
John Luke 8855f7a5a7 add some automatic docs for the new stuff
svn path=/trunk/gtk-sharp/; revision=43452
2005-04-22 17:20:16 +00:00

40 lines
No EOL
1.9 KiB
XML

<Type Name="RetrieveSurroundingHandler" FullName="Gtk.RetrieveSurroundingHandler">
<TypeSignature Language="C#" Maintainer="auto" Value="public sealed delegate void RetrieveSurroundingHandler (object o, Gtk.RetrieveSurroundingArgs args);" />
<AssemblyInfo>
<AssemblyName>gtk-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>Event handler.</summary>
<remarks>
<para>The <see cref="M:Gtk.IMContext.RetrieveSurrounding" /> event utilizes this delegate:</para>
<para>Event data is passed via the <see cref="T:Gtk.RetrieveSurroundingArgs" /> parameter.</para>
<para>To attach a <see cref="T:Gtk.RetrieveSurroundingHandler" /> to an event, add the RetrieveSurroundingHandler instance to the event. The methods referenced by the RetrieveSurroundingHandler instance are invoked whenever the event is raised, until the RetrieveSurroundingHandler is removed from the event.</para>
<para>
Handlers of this class should set the input method surrounding context by calling <see cref="T:Gtk.IMContext.SetSurrounding" />. The method returns %TRUE if the signal was handled by the callback.
</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="o" Type="System.Object" />
<Parameter Name="args" Type="Gtk.RetrieveSurroundingArgs" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>