GtkSharp/doc/en/Gtk/RetrieveSurroundingHandler.xml

33 lines
1.8 KiB
XML
Raw Normal View History

<Type Name="RetrieveSurroundingHandler" FullName="Gtk.RetrieveSurroundingHandler">
<TypeSignature Language="C#" Maintainer="auto" Value="public delegate void RetrieveSurroundingHandler(object o, Gtk.RetrieveSurroundingArgs args);" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>2.6.0.0</AssemblyVersion>
</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>
<param name="o">To be added.</param>
<param name="args">To be added.</param>
<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>
<Members />
<Parameters>
<Parameter Name="o" Type="System.Object" />
<Parameter Name="args" Type="Gtk.RetrieveSurroundingArgs" />
</Parameters>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>