GtkSharp/doc/en/Gdk/DragContext.xml

213 lines
8.2 KiB
XML
Raw Normal View History

<Type Name="DragContext" FullName="Gdk.DragContext">
<TypeSignature Language="C#" Value="public class DragContext : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gdk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<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>This holds information about a drag in progress. It is used on both source and destination sides.</summary>
<remarks>None.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected override void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DragContext (IntPtr raw);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="raw">Pointer to the C object.</param>
<returns>An instance of DragContext, wrapping the C object.</returns>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public DragContext ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Default constructor.</summary>
<returns>A new <see cref="T:Gdk.DragContext" /></returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="DragProtocol">
<MemberSignature Language="C#" Value="public Gdk.DragProtocol DragProtocol { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.DragProtocol</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The DND protocol that governs this drag.</summary>
<returns>The DND protocol which governs this drag.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="IsSource">
<MemberSignature Language="C#" Value="public bool IsSource { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>True if the context is used on the source side.</summary>
<returns>True if the context is used on the source side.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="SourceWindow">
<MemberSignature Language="C#" Value="public Gdk.Window SourceWindow { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Window</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The source of this drag.</summary>
<returns>The source <see cref="T:Gdk.Window" /> of this drag.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="DestWindow">
<MemberSignature Language="C#" Value="public Gdk.Window DestWindow { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Window</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The destination window of this drag.</summary>
<returns>The destination window of this drag.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="Targets">
<MemberSignature Language="C#" Value="public Gdk.Atom [] Targets { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Atom[]</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>A list of targets offered by the source.</summary>
<returns>A list of targets offered by the source.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="Actions">
<MemberSignature Language="C#" Value="public Gdk.DragAction Actions { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.DragAction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Various actions proposed by the source when the <see cref="P:Gdk.DragContext.SuggestedAction" /> is <see cref="M:Gdk.DragAction.Ask" /></summary>
<returns>Various actions proposed by the source when the <see cref="P:Gdk.DragContext.SuggestedAction" /> is <see cref="M:Gdk.DragAction.Ask" /></returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="SuggestedAction">
<MemberSignature Language="C#" Value="public Gdk.DragAction SuggestedAction { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.DragAction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The action suggested by the source.</summary>
<returns>The <see cref="T:Gdk.DragAction" /> suggested by the source.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="Action">
<MemberSignature Language="C#" Value="public Gdk.DragAction Action { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.DragAction</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The action chosen by the destination.</summary>
<returns>The <see cref="T:Gdk.DragAction" /> chosen by the destination.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="StartTime">
<MemberSignature Language="C#" Value="public uint StartTime { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>A timestamp, in milliseconds, recording the start time of this drag.</summary>
<returns>A timestamp, in milliseconds, recording the start time of this drag.</returns>
<remarks>None.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<returns>a <see cref="T:GLib.GType" /></returns>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gdk.DragContext" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected DragContext (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<returns>a <see cref="T:Gdk.DragContext" /></returns>
<remarks>This is a constructor used by derivative types of <see cref="T:Gdk.DragContext" /> that would have their own GLib.GType assigned to it. This is not typically used by C# code.</remarks>
</Docs>
</Member>
</Members>
</Type>