GtkSharp/doc/en/Gdk/Selection.xml

<Type Name="Selection" FullName="Gdk.Selection">
  <TypeSignature Language="C#" Value="public class Selection" 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>Information exchange through the Window Server selection mechanism.</summary>
    <remarks>The X selection mechanism provides a way to transfer arbitrary chunks of data between programs. A selection is a essentially a named clipboard, identified by a string interned as a GdkAtom. By claiming ownership of a selection, an application indicates that it will be responsible for supplying its contents. The most common selections are PRIMARY and CLIPBOARD.
<para>

The contents of a selection can be represented in a number of formats, called targets. Each target is identified by an atom. A list of all possible targets supported by the selection owner can be retrieved by requesting the special target TARGETS. When a selection is retrieved, the data is accompanied by a type (an atom), and a format (an integer, representing the number of bits per item). See Properties and Atoms for more information.
</para><para>
The functions in this section only contain the lowlevel parts of the selection protocol. A considerably more complicated implementation is needed on top of this. GTK+ contains such an implementation in the functions in gtkselection.h and programmers should use those functions instead of the ones presented here. If you plan to implement selection handling directly on top of the functions here, you should refer to the X Inter-client Communication Conventions Manual (ICCCM). 
</para></remarks>
  </Docs>
  <Base>
    <BaseTypeName>System.Object</BaseTypeName>
  </Base>
  <Interfaces />
  <Attributes />
  <Members>
    <Member MemberName="Primary">
      <MemberSignature Language="C#" Value="public static Gdk.Atom Primary;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Atom</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>An Atom representing the PRIMARY selection.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Secondary">
      <MemberSignature Language="C#" Value="public static Gdk.Atom Secondary;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Atom</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The atom for the secondary selection</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="Clipboard">
      <MemberSignature Language="C#" Value="public static Gdk.Atom Clipboard;" />
      <MemberType>Field</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Atom</ReturnType>
      </ReturnValue>
      <Parameters />
      <Docs>
        <summary>The atom representing the clipboard.</summary>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="OwnerSetForDisplay">
      <MemberSignature Language="C#" Value="public static bool OwnerSetForDisplay (Gdk.Display display, Gdk.Window owner, Gdk.Atom selection, uint time_, bool send_event);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="display" Type="Gdk.Display" />
        <Parameter Name="owner" Type="Gdk.Window" />
        <Parameter Name="selection" Type="Gdk.Atom" />
        <Parameter Name="time_" Type="System.UInt32" />
        <Parameter Name="send_event" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Sets the <see cref="T:Gdk.Window" /> owner as the current owner of the selection selection.</summary>
        <param name="display">The <see cref="T:Gdk.Display" /></param>
        <param name="owner">a <see cref="T:Gdk.Window" /> or NULL to indicate that the the owner for the given should be unset.</param>
        <param name="selection">An atom identifying a selection.</param>
        <param name="time_">Timestamp to use when setting the selection. If this is older than the timestamp given last time the owner was set for the given selection, the request will be ignored.</param>
        <param name="send_event"> if TRUE, and the new owner is different from the current owner, the current owner will be sent a SelectionClear event.</param>
        <returns>TRUE if the selection owner was successfully changed to owner, otherwise FALSE.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="SendNotify">
      <MemberSignature Language="C#" Value="public static void SendNotify (uint requestor, Gdk.Atom selection, Gdk.Atom target, Gdk.Atom property, uint time_);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="requestor" Type="System.UInt32" />
        <Parameter Name="selection" Type="Gdk.Atom" />
        <Parameter Name="target" Type="Gdk.Atom" />
        <Parameter Name="property" Type="Gdk.Atom" />
        <Parameter Name="time_" Type="System.UInt32" />
      </Parameters>
      <Docs>
        <summary>Sends a response to SelectionRequest event.</summary>
        <param name="requestor">window to which to deliver response.</param>
        <param name="selection">selection that was requested.</param>
        <param name="target">target that was selected.</param>
        <param name="property">property in which the selection owner stored the data, or GDK_NONE to indicate that the request was rejected.</param>
        <param name="time_">timestamp.</param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="SendNotifyForDisplay">
      <MemberSignature Language="C#" Value="public static void SendNotifyForDisplay (Gdk.Display display, uint requestor, Gdk.Atom selection, Gdk.Atom target, Gdk.Atom property, uint time_);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="display" Type="Gdk.Display" />
        <Parameter Name="requestor" Type="System.UInt32" />
        <Parameter Name="selection" Type="Gdk.Atom" />
        <Parameter Name="target" Type="Gdk.Atom" />
        <Parameter Name="property" Type="Gdk.Atom" />
        <Parameter Name="time_" Type="System.UInt32" />
      </Parameters>
      <Docs>
        <summary>Send a response to SelectionRequest event.</summary>
        <param name="display">The <see cref="T:Gdk.Display" /></param>
        <param name="requestor"> window to which to deliver response.</param>
        <param name="selection"> selection that was requested.</param>
        <param name="target"> target that was selected.</param>
        <param name="property"> property in which the selection owner stored the data, or GDK_NONE to indicate that the request was rejected.</param>
        <param name="time_">timestamp.</param>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
    <Member MemberName="OwnerGetForDisplay">
      <MemberSignature Language="C#" Value="public static Gdk.Window OwnerGetForDisplay (Gdk.Display display, Gdk.Atom selection);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Window</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="display" Type="Gdk.Display" />
        <Parameter Name="selection" Type="Gdk.Atom" />
      </Parameters>
      <Docs>
        <summary>Determine the owner of the given selection.</summary>
        <param name="display">The <see cref="T:Gdk.Display" /> where the selection is</param>
        <param name="selection"> an atom indentifying a selection.</param>
        <returns> if there is a selection owner for this window, and it is a window known to the current process, the <see cref="T:Gdk.Window" /> that owns the selection, otherwise <see langword="null" /></returns>
        <remarks>Note that the return value may be owned by a different process if a foreign window was previously created for that window, but a new foreign window will never be created by this call.</remarks>
      </Docs>
    </Member>
    <Member MemberName="Convert">
      <MemberSignature Language="C#" Value="public static void Convert (Gdk.Window requestor, Gdk.Atom selection, Gdk.Atom target, uint time_);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Void</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="requestor" Type="Gdk.Window" />
        <Parameter Name="selection" Type="Gdk.Atom" />
        <Parameter Name="target" Type="Gdk.Atom" />
        <Parameter Name="time_" Type="System.UInt32" />
      </Parameters>
      <Docs>
        <summary>Retrieves the contents of a selection in a given form.</summary>
        <param name="requestor">The <see cref="T:Gdk.Window" /></param>
        <param name="selection">An atom identifying the selection to get the contents of.</param>
        <param name="target">the form in which to retrieve the selection.</param>
        <param name="time_">the timestamp to use when retrieving the selection. The selection owner may refuse the request if it did not own the selection at the time indicated by the timestamp.</param>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="OwnerSet">
      <MemberSignature Language="C#" Value="public static bool OwnerSet (Gdk.Window owner, Gdk.Atom selection, uint time_, bool send_event);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>System.Boolean</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="owner" Type="Gdk.Window" />
        <Parameter Name="selection" Type="Gdk.Atom" />
        <Parameter Name="time_" Type="System.UInt32" />
        <Parameter Name="send_event" Type="System.Boolean" />
      </Parameters>
      <Docs>
        <summary>Sets the owner of the given selection.</summary>
        <param name="owner">a <see cref="T:Gdk.Window" /> or NULL to indicate that the the owner for the given should be unset.</param>
        <param name="selection">An <see cref="T:Gdk.Atom" /> identifying a selection.</param>
        <param name="time_">timestamp to use when setting the selection. If this is older than the timestamp given last time the owner was set for the given selection, the request will be ignored.</param>
        <param name="send_event">If <see langword="true" />  and the new owner is different from the current owner, the current owner will be sent a SelectionClear event.</param>
        <returns>
          <see langword="true" /> if the selection owner was successfully changed to owner, otherwise <see langword="false" /></returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName="OwnerGet">
      <MemberSignature Language="C#" Value="public static Gdk.Window OwnerGet (Gdk.Atom selection);" />
      <MemberType>Method</MemberType>
      <ReturnValue>
        <ReturnType>Gdk.Window</ReturnType>
      </ReturnValue>
      <Parameters>
        <Parameter Name="selection" Type="Gdk.Atom" />
      </Parameters>
      <Docs>
        <summary>Determines the owner of the given selection.</summary>
        <param name="selection">an atom indentifying a selection.</param>
        <returns>If there is a selection owner for this window, and it is a window known to the current process, the <see cref="T:Gdk.Window" /> that owns the selection, otherwise <see langword="null" />. Note that the return value may be owned by a different process if a foreign window was previously created for that window, but a new foreign window will never be created by this call.</returns>
        <remarks />
      </Docs>
    </Member>
    <Member MemberName=".ctor">
      <MemberSignature Language="C#" Value="public Selection ();" />
      <MemberType>Constructor</MemberType>
      <ReturnValue />
      <Parameters />
      <Docs>
        <summary>To be added</summary>
        <returns>a <see cref="T:Gdk.Selection" /></returns>
        <remarks>To be added</remarks>
      </Docs>
    </Member>
  </Members>
</Type>