mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-26 16:45:35 +00:00
93209fbd15
* en/Gtk/FontSelectionDialog.xml: Doc 1 property * en/Gtk/TargetEntry.xml * en/Gtk/TargetPair.xml * en/Gtk/SelectionData.xml * en/Gtk/SelectionGetArgs.xml * en/Gtk/SelectionNotifyEventArgs.xml * en/Gtk/SelectionRequestEventArgs.xml: Docs for selection-related and DND code. * en/Gtk/Stock.xml: Doc some new items for 2.4 * en/Gtk/ToolButton.xml: Add docs svn path=/trunk/gtk-sharp/; revision=37890
239 lines
8.7 KiB
XML
239 lines
8.7 KiB
XML
<Type Name="SelectionData" FullName="Gtk.SelectionData">
|
|
<TypeSignature Language="C#" Value="public sealed struct SelectionData;" 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>A type to represent data that's selected as part of a drag-and-drop or clipboard operation.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>System.ValueType</BaseTypeName>
|
|
</Base>
|
|
<Interfaces />
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="Free">
|
|
<MemberSignature Language="C#" Value="public void Free ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Releases memory that was used by this object.</summary>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Copy">
|
|
<MemberSignature Language="C#" Value="public Gtk.SelectionData Copy ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.SelectionData</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Copy the object by value.</summary>
|
|
<returns>a <see cref="T:Gtk.SelectionData" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="TargetsIncludeText">
|
|
<MemberSignature Language="C#" Value="public bool TargetsIncludeText ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Assuming that this selection data object holds a list
|
|
of targets, determines if any of the targets in can be used to
|
|
provide text.</summary>
|
|
<returns>a <see cref="T:System.Boolean"/></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Text">
|
|
<MemberSignature Language="C#" Value="public string Text { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.String</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>The text stored in the selection.</summary>
|
|
<param name="value">A <see cref="T:System.String" /></param>
|
|
<returns>A <see cref="T:System.String" />.</returns>
|
|
<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:Gtk.SelectionData" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Format">
|
|
<MemberSignature Language="C#" Value="public int Format { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The unit length of the data in bits.</summary>
|
|
<returns>a <see cref="T:System.Int32" /></returns>
|
|
<remarks>On most systems, this is 8 for a string and 32 for
|
|
an integer.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Length">
|
|
<MemberSignature Language="C#" Value="public int Length { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Int32</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The length of the selected data.</summary>
|
|
<returns>a <see cref="T:System.Int32" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public SelectionData (IntPtr raw);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="raw" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Constructor.</summary>
|
|
<param name="raw">a <see cref="T:System.IntPtr" />, pointer to the underlying C data.</param>
|
|
<returns>a <see cref="T:Gtk.SelectionData" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Data">
|
|
<MemberSignature Language="C#" Value="public byte [] Data { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Byte[]</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The data as a sequence of bytes.</summary>
|
|
<returns>a <see cref="T:System.Byte[]" /></returns>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Set">
|
|
<MemberSignature Language="C#" Value="public void Set (Gdk.Atom type, int format, byte [] data, int length);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="type" Type="Gdk.Atom" />
|
|
<Parameter Name="format" Type="System.Int32" />
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
<Parameter Name="length" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the data for a selection.</summary>
|
|
<param name="type">a <see cref="T:Gdk.Atom" /></param>
|
|
<param name="format">a <see cref="T:System.Int32" />, the number of bits per data unit</param>
|
|
<param name="data">a <see cref="T:System.Byte[]" />, the data to be set</param>
|
|
<param name="length">a <see cref="T:System.Int32" />, the length of the data.</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Set">
|
|
<MemberSignature Language="C#" Value="public void Set (Gdk.Atom type, int format, byte [] data);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="type" Type="Gdk.Atom" />
|
|
<Parameter Name="format" Type="System.Int32" />
|
|
<Parameter Name="data" Type="System.Byte[]" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Sets the data for a selection.</summary>
|
|
<param name="type">a <see cref="T:Gdk.Atom" /></param>
|
|
<param name="format">a <see cref="T:System.Int32" />, the number of bits per data unit</param>
|
|
<param name="data">a <see cref="T:System.Byte[]" />, the data to be set</param>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Selection">
|
|
<MemberSignature Language="C#" Value="public Gdk.Atom Selection { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Atom</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The selected data.</summary>
|
|
<returns>a <see cref="T:Gdk.Atom" /></returns>
|
|
<remarks></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Target">
|
|
<MemberSignature Language="C#" Value="public Gdk.Atom Target { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Atom</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The type of target being used.</summary>
|
|
<returns>a <see cref="T:Gdk.Atom" /></returns>
|
|
<remarks>XXX: Add a list of useful strings for target types.</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>Gets the selection data as an array of targets.</summary>
|
|
<returns>a <see cref="T:Gdk.Atom[]" /></returns>
|
|
<remarks></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Type">
|
|
<MemberSignature Language="C#" Value="public Gdk.Atom Type { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Atom</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>The type of selection data</summary>
|
|
<returns>a <see cref="T:Gdk.Atom" /></returns>
|
|
<remarks>XXX: elaborate on the possible values here.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|