GtkSharp/doc/en/Gtk/Selection.xml
Mike Kestner 352fc8e849 Run the doc updater
Didn't audit any of this.
2012-03-28 22:10:46 -05:00

181 lines
9.7 KiB
XML

<Type Name="Selection" FullName="Gtk.Selection">
<TypeSignature Language="C#" Value="public class Selection" Maintainer="auto" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Selection extends System.Object" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Base>
<BaseTypeName>System.Object</BaseTypeName>
</Base>
<Interfaces />
<Docs>
<summary>Object to represent a selection.</summary>
<remarks />
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Selection ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Public constructor.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="AddTarget">
<MemberSignature Language="C#" Value="public static void AddTarget (Gtk.Widget widget, Gdk.Atom selection, Gdk.Atom target, uint info);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddTarget(class Gtk.Widget widget, class Gdk.Atom selection, class Gdk.Atom target, unsigned int32 info) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="selection" Type="Gdk.Atom" />
<Parameter Name="target" Type="Gdk.Atom" />
<Parameter Name="info" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="widget">a <see cref="T:Gtk.Widget" />, the widget for which this target applies</param>
<param name="selection">a <see cref="T:Gdk.Atom" />, the selection data</param>
<param name="target">a <see cref="T:Gdk.Atom" /></param>
<param name="info">a <see cref="T:System.UInt32" /></param>
<summary>Add the specified target to the list of supported targets for this selection.</summary>
<remarks>TODO: this could be better-explained.</remarks>
</Docs>
</Member>
<Member MemberName="AddTargets">
<MemberSignature Language="C#" Value="public static void AddTargets (Gtk.Widget widget, Gdk.Atom selection, Gtk.TargetEntry targets, uint ntargets);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void AddTargets(class Gtk.Widget widget, class Gdk.Atom selection, valuetype Gtk.TargetEntry targets, unsigned int32 ntargets) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="selection" Type="Gdk.Atom" />
<Parameter Name="targets" Type="Gtk.TargetEntry" />
<Parameter Name="ntargets" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="selection">a <see cref="T:Gdk.Atom" /></param>
<param name="targets">a <see cref="T:Gtk.TargetEntry" /></param>
<param name="ntargets">a <see cref="T:System.UInt32" /></param>
<summary>Add targets for this widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="ClearTargets">
<MemberSignature Language="C#" Value="public static void ClearTargets (Gtk.Widget widget, Gdk.Atom selection);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void ClearTargets(class Gtk.Widget widget, class Gdk.Atom selection) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="selection" Type="Gdk.Atom" />
</Parameters>
<Docs>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<param name="selection">a <see cref="T:Gdk.Atom" /> representing the selection.</param>
<summary>Remove all targets registered for the given selection for the widget.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Convert">
<MemberSignature Language="C#" Value="public static bool Convert (Gtk.Widget widget, Gdk.Atom selection, Gdk.Atom target, uint time_);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool Convert(class Gtk.Widget widget, class Gdk.Atom selection, class Gdk.Atom target, unsigned int32 time_) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="selection" Type="Gdk.Atom" />
<Parameter Name="target" Type="Gdk.Atom" />
<Parameter Name="time_" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="widget">a <see cref="T:Gtk.Widget" />, the requesting widget</param>
<param name="selection">a <see cref="T:Gdk.Atom" />, the selection to get</param>
<param name="target">a <see cref="T:Gdk.Atom" />, the form of the information ("STRING" for example) (TODO: elaborate possible options)</param>
<param name="time_">a <see cref="T:System.UInt32" />, the time the request is being made</param>
<summary>Request the contents of a selection. When received,
a <see cref="E:Gtk.Widget.SelectionReceived" /> event will
be generated. </summary>
<returns>a <see cref="T:System.Boolean" />, true if the request succeeded, false if it couldn't be processed.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="OwnerSet">
<MemberSignature Language="C#" Value="public static bool OwnerSet (Gtk.Widget widget, Gdk.Atom selection, uint time_);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool OwnerSet(class Gtk.Widget widget, class Gdk.Atom selection, unsigned int32 time_) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="selection" Type="Gdk.Atom" />
<Parameter Name="time_" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="widget">a <see cref="T:Gtk.Widget" /> or <see langword="null" /></param>
<param name="selection">a <see cref="T:Gdk.Atom" /> representing the selection to claim.</param>
<param name="time_">a <see cref="T:System.UInt32" />, a timestamp to use in claiming the selection.</param>
<summary>Claims ownership of a given selection for a particular widget, or if <paramref name="widget" /> is <see langword="null" />, release ownership of the selection.</summary>
<returns>a <see cref="T:System.Boolean" />, true if the operation succeeded.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="OwnerSetForDisplay">
<MemberSignature Language="C#" Value="public static bool OwnerSetForDisplay (Gdk.Display display, Gtk.Widget widget, Gdk.Atom selection, uint time_);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig bool OwnerSetForDisplay(class Gdk.Display display, class Gtk.Widget widget, class Gdk.Atom selection, unsigned int32 time_) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="display" Type="Gdk.Display" />
<Parameter Name="widget" Type="Gtk.Widget" />
<Parameter Name="selection" Type="Gdk.Atom" />
<Parameter Name="time_" Type="System.UInt32" />
</Parameters>
<Docs>
<param name="display">a <see cref="T:Gdk.Display" />, the display where the selection is set.</param>
<param name="widget">a <see cref="T:Gtk.Widget" /> or <see langword="null" /></param>
<param name="selection">a <see cref="T:Gdk.Atom" /> representing the selection to claim.</param>
<param name="time_">a <see cref="T:System.UInt32" />, a timestamp to use in claiming the selection.</param>
<summary>Claims ownership of a given selection on a given display for a particular widget, or if <paramref name="widget" /> is <see langword="null" />, release ownership of the selection.</summary>
<returns>a <see cref="T:System.Boolean" />, true if the operation succeeded.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="RemoveAll">
<MemberSignature Language="C#" Value="public static void RemoveAll (Gtk.Widget widget);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig void RemoveAll(class Gtk.Widget widget) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="widget" Type="Gtk.Widget" />
</Parameters>
<Docs>
<param name="widget">a <see cref="T:Gtk.Widget" /></param>
<summary>Removes all handlers and unsets ownership of all
selections for a widget. Called when widget is being
destroyed.</summary>
<remarks />
</Docs>
</Member>
</Members>
</Type>