GtkSharp/doc/en/Gtk/Clipboard.xml
Duncan Mak efa9acf122 2003-03-06 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: Updated all the docs to match the new API. All the nodes
	that no longer have a corresponding member in the type are now
	marked as deprecated. We'll have to wait for Miguel to implement
	this in the browser to stop displaying them.

	All gtype constructors have been regenerated, because of the
	'uint' to 'GLib.Type' change. However, this patch will preserve
	(well, it was regenerated) the customized text for those GType
	constructors.

	A lot of the 'Finalized' methods are also now marked as
	deprecated, because the classes implement 'Dispose' instead. This
	is a possible place for customized scripts to generate template
	documentation, similar to the GType property and GType constructors.

svn path=/trunk/gtk-sharp/; revision=12270
2003-03-07 01:30:00 +00:00

258 lines
9.7 KiB
XML

<Type Name="Clipboard" FullName="Gtk.Clipboard">
<TypeSignature Language="C#" Value="public class Clipboard : GLib.Opaque, IWrapper" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="clipboard_objects" Deprecated="true">
<MemberSignature Language="C#" Value="public static clipboard_objects;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Collections.Hashtable</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Get">
<MemberSignature Language="C#" Value="public static Gtk.Clipboard Get (Gdk.Atom selection);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Clipboard</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="selection" Type="Gdk.Atom" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="selection">To be added: an object of type 'Gdk.Atom'</param>
<returns>To be added: an object of type 'Gtk.Clipboard'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetText" Deprecated="true">
<MemberSignature Language="C#" Value="public void SetText (string new_text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="new_text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="new_text">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Set">
<MemberSignature Language="C#" Value="public bool Set (Gtk.TargetEntry[] targets, Gtk.ClipboardGetFunc get_func, Gtk.ClipboardClearFunc clear_func, object data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="targets" Type="Gtk.TargetEntry[]" />
<Parameter Name="get_func" Type="Gtk.ClipboardGetFunc" />
<Parameter Name="clear_func" Type="Gtk.ClipboardClearFunc" />
<Parameter Name="data" Type="System.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="targets">To be added: an object of type 'Gtk.TargetEntry[]'</param>
<param name="get_func">To be added: an object of type 'Gtk.ClipboardGetFunc'</param>
<param name="clear_func">To be added: an object of type 'Gtk.ClipboardClearFunc'</param>
<param name="data">To be added: an object of type 'object'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Clear">
<MemberSignature Language="C#" Value="public void Clear ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RequestText">
<MemberSignature Language="C#" Value="public void RequestText (Gtk.ClipboardTextReceivedFunc callback);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="callback" Type="Gtk.ClipboardTextReceivedFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="callback">To be added: an object of type 'Gtk.ClipboardTextReceivedFunc'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetText" Deprecated="true">
<MemberSignature Language="C#" Value="public void SetText (string text, int len);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
<Parameter Name="len" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">To be added: an object of type 'string'</param>
<param name="len">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="WaitIsTextAvailable">
<MemberSignature Language="C#" Value="public bool WaitIsTextAvailable ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RequestContents">
<MemberSignature Language="C#" Value="public void RequestContents (Gdk.Atom target, Gtk.ClipboardReceivedFunc callback);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="target" Type="Gdk.Atom" />
<Parameter Name="callback" Type="Gtk.ClipboardReceivedFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="target">To be added: an object of type 'Gdk.Atom'</param>
<param name="callback">To be added: an object of type 'Gtk.ClipboardReceivedFunc'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="WaitForContents">
<MemberSignature Language="C#" Value="public Gtk.SelectionData WaitForContents (Gdk.Atom target);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.SelectionData</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="target" Type="Gdk.Atom" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="target">To be added: an object of type 'Gdk.Atom'</param>
<returns>To be added: an object of type 'Gtk.SelectionData'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="WaitForText">
<MemberSignature Language="C#" Value="public string WaitForText ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Clipboard (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 Clipboard, 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="protected Clipboard ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Clipboard'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Owner">
<MemberSignature Language="C#" Value="public GLib.Object Owner { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.Object</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'GLib.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="clipboard_objects">
<MemberSignature Language="C#" Value="public static Collections.Hashtable clipboard_objects;" />
<MemberType>Field</MemberType>
<ReturnValue>
<ReturnType>System.Collections.Hashtable</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetText">
<MemberSignature Language="C#" Value="public void SetText (string text);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="text" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="text">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>