GtkSharp/doc/en/Gnome/CanvasEventArgs.xml
Mike Kestner 0e47e78f96 update docs to 2.8 API and document all new members
svn path=/trunk/gtk-sharp/; revision=54175
2005-12-09 23:12:49 +00:00

46 lines
2.1 KiB
XML

<Type Name="CanvasEventArgs" FullName="Gnome.CanvasEventArgs">
<TypeSignature Language="C#" Value="public class CanvasEventArgs : GLib.SignalArgs" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.8.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>
<summary>Details of events coming from CanvasItems. See <see cref="T:Gnome.CanvasItem" />.</summary>
<remarks>Contains mouse button clicks, motion, enter/leave, and key press events from CanvasItems. Use these to create user interactive items. The x and y coordinates of the event structure have been converted to canvas world coordinates.
<block subset="none" type="note">
<para>To signify that an event has been handled, and stop it from being further emitted, set <see cref="P:GLib.SignalArgs.Retval" /> to true.
</para>
</block></remarks>
</Docs>
<Base>
<BaseTypeName>GLib.SignalArgs</BaseTypeName>
</Base>
<Interfaces />
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasEventArgs ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Public Constructor.</summary>
<remarks>Create a new <see cref="T:Gnome.CanvasEventArgs" /> instance with this constructor if you need to invoke a <see cref="T:Gnome.CanvasEventHandler" /> delegate.</remarks>
</Docs>
</Member>
<Member MemberName="Event">
<MemberSignature Language="C#" Value="public Gdk.Event Event { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Event</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'Gdk.Event'</value>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>