GtkSharp/doc/en/Gtk/Plug.xml

161 lines
7 KiB
XML
Raw Normal View History

<Type Name="Plug" FullName="Gtk.Plug">
<TypeSignature Language="C#" Value="public class Plug : Gtk.Window, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="John Luke" />
<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>Toplevel for embedding into other processes.</summary>
<remarks>
Together with <see cref="T:Gtk.Socket"/>, <see cref="T:Gtk.Plug "/> provides the ability to embed widgets from one process into another process in a fashion that is transparent to the user.
One process creates a <see cref="T:Gtk.Socket"/> widget and, passes the ID of that widgets window to the other process, which then creates a <see cref="T:Gtk.Plug "/> with that window ID.
Any widgets contained in the <see cref="T:Gtk.Plug"/> then will appear inside the first applications window.
</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.Window</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Construct">
<MemberSignature Language="C#" Value="public void Construct (uint socket_id);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="socket_id" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Finish the initialization of <see cref="T:Gtk.Plug"/> for a given <see cref="T:Gtk.Socket"/> identified by socket_id.</summary>
<param name="socket_id">an object of type <see cref="T:System.UInt32"/></param>
<remarks>Finish the initialization of <see cref="T:Gtk.Plug"/> for a given <see cref="T:Gtk.Socket"/> identified by socket_id which is currently displayed on display.
This method will generally only be used by classes deriving from <see cref="T:Gtk.Plug"/>.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual void Finalize ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Disposes the resources associated with the object.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Plug (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 Plug, 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="public Plug (uint socket_id);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="socket_id" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Gtk.Plug"/> widget inside the <see cref="T:Gtk.Socket"/> identified by socket_id.</summary>
<param name="socket_id">an object of type <see cref="System.UInt32"/></param>
<returns>an object of type <see cref="T:Gtk.Plug"/></returns>
<remarks>
Creates a new <see cref="T:Gtk.Plug"/> widget inside the <see cref="T:Gtk.Socket"/> identified by socket_id.
If socket_id is 0, the <see cref="T:Gtk.Plug"/> is left "unplugged" and can later be plugged into a <see cref="T:Gtk.Socket"/> by <see cref="M:Gtk.Socket.AddId(System.UInt32)"/>.
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Plug ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Internal constructor</summary>
<returns>an object of type <see cref="T:Gtk.Plug"/></returns>
<remarks>This is a constructor used by derivative types of <see cref="T:Gtk.Plug" />.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static uint GType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The <see cref="T:GLib.Type"/> for <see cref="T:Gtk.Plug"/> class.</summary>
<returns>The <see cref="T:GLib.Type"/> for the <see cref="T:Gtk.Plug"/> class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public uint Id { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the window ID of a <see cref="T:Gtk.Plug"/> widget.</summary>
<returns>an object of type <see cref="T:System.UInt32"/></returns>
<remarks>Gets the window ID of a <see cref="T:Gtk.Plug"/> widget, which can then be used to embed this window inside another window,
for instance with <see cref="M:Gtk.Socket.AddId(System.UInt32)"/>.</remarks>
</Docs>
</Member>
<Member MemberName="Embedded">
<MemberSignature Language="C#" Value="public event EventHandler Embedded;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Plug (GLib.Type gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.Type" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of <see cref="T:Gtk.Plug"/>, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.Plug" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>