GtkSharp/doc/en/Gtk/Selection.xml

<Type Name="Selection" FullName="Gtk.Selection">
  <TypeSignature Language="C#" Value="public class Selection" Maintainer="auto" />
  <AssemblyInfo>
    <AssemblyName>gtk-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>Object to represent a selection.</summary>
    <remarks />
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <Member MemberName="AddTargets">
      <MemberSignature Language="C#" Value="public static void AddTargets (Gtk.Widget widget, Gdk.Atom selection, Gtk.TargetEntry targets, uint ntargets);" />
      <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>
        <summary>Add targets for this widget.</summary>
        <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>
        <remarks/>
      </Docs>
    </Member>
    <Member MemberName="ClearTargets">
      <MemberSignature Language="C#" Value="public static void ClearTargets (Gtk.Widget widget, Gdk.Atom selection);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="widget" Type="Gtk.Widget" />
        <Parameter Name="selection" Type="Gdk.Atom" />
      </Parameters>
      <Docs>
        <summary>Remove all targets registered for the given selection for the widget.</summary>
        <param name="widget">a <see cref="T:Gtk.Widget" /></param>
        <param name="selection">a <see cref="T:Gdk.Atom" /> representing the selection.</param>
        <remarks/>
      </Docs>
    </Member>
    <Member MemberName="RemoveAll">
      <MemberSignature Language="C#" Value="public static void RemoveAll (Gtk.Widget widget);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="widget" Type="Gtk.Widget" />
      </Parameters>
      <Docs>
        <summary>Removes all handlers and unsets ownership of all 
	  selections for a widget. Called when widget is being
	  destroyed.</summary>
        <param name="widget">a <see cref="T:Gtk.Widget" /></param>
        <remarks/>
      </Docs>
    </Member>
    <Member MemberName="Clear">
      <MemberSignature Language="C#" Value="public static bool Clear (Gtk.Widget widget, Gdk.EventSelection evnt);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="widget" Type="Gtk.Widget" />
        <Parameter Name="evnt" Type="Gdk.EventSelection" />
      </Parameters>
      <Docs>
        <summary>The default handler for the <see cref="E:Gtk.Widget.SelectionClearEvent"/> event. Instead of calling this function, chain up from your <see cref="Gtk.SelectionClearEventHandler"/>. Calling this function from any other context is illegal.</summary>
        <param name="widget">a <see cref="T:Gtk.Widget" /></param>
        <param name="evnt">a <see cref="T:Gdk.EventSelection" /></param>
        <returns>a <see cref="T:System.Boolean" />, true if the event was handled, otherwise false</returns>
        <remarks>This function will be deprecated in future versions of GTK+ and GTK#.</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_);" />
      <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>
        <summary>Request the contents of a selection. When received, 
	  a <see cref="E:Gtk.Widget.SelectionReceived"/> event will 
	  be generated. </summary>
        <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>
        <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="AddTarget">
      <MemberSignature Language="C#" Value="public static void AddTarget (Gtk.Widget widget, Gdk.Atom selection, Gdk.Atom target, uint info);" />
      <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>
        <summary>Add the specified target to the list of supported targets for this selection.</summary>
        <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>
        <remarks>TODO: this could be better-explained.</remarks>
      </Docs>
    </Member>
    <Member MemberName="OwnerSet">
      <MemberSignature Language="C#" Value="public static bool OwnerSet (Gtk.Widget widget, Gdk.Atom selection, uint time_);" />
      <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>
        <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>
        <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>
        <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_);" />
      <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>
        <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>
        <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>
        <returns>a <see cref="T:System.Boolean" />, true if the operation succeeded.</returns>
        <remarks/>
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Selection ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>Public constructor.</summary>
        <returns>a <see cref="T:Gtk.Selection" /></returns>
        <remarks/>
      </Docs>
    </Member>
  </Members>
</Type>