GtkSharp/doc/en/Gtk/Plug.xml

226 lines
9.5 KiB
XML
Raw Normal View History

<Type Name="Plug" FullName="Gtk.Plug">
<TypeSignature Language="C#" Maintainer="John Luke" Value="public class Plug : Gtk.Window" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Plug extends Gtk.Window" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Base>
<BaseTypeName>Gtk.Window</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<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>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Plug ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Protected constructor.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Plug (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">Pointer to the C object.</param>
<summary>Internal constructor</summary>
<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 (ulong socket_id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(unsigned int64 socket_id) cil managed" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="socket_id" Type="System.UInt64" />
</Parameters>
<Docs>
<param name="socket_id">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Plug (Gdk.Display display, ulong socket_id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Gdk.Display display, unsigned int64 socket_id) cil managed" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="display" Type="Gdk.Display" />
<Parameter Name="socket_id" Type="System.UInt64" />
</Parameters>
<Docs>
<param name="display">To be added.</param>
<param name="socket_id">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="Construct">
<MemberSignature Language="C#" Value="public void Construct (ulong socket_id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Construct(unsigned int64 socket_id) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="socket_id" Type="System.UInt64" />
</Parameters>
<Docs>
<param name="socket_id">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="ConstructForDisplay">
<MemberSignature Language="C#" Value="public void ConstructForDisplay (Gdk.Display display, ulong socket_id);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void ConstructForDisplay(class Gdk.Display display, unsigned int64 socket_id) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="display" Type="Gdk.Display" />
<Parameter Name="socket_id" Type="System.UInt64" />
</Parameters>
<Docs>
<param name="display">To be added.</param>
<param name="socket_id">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="Embedded">
<MemberSignature Language="C#" Value="public event EventHandler Embedded;" />
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler Embedded" />
<MemberType>Event</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Signal("embedded")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.EventHandler</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Raised when the plug window is reparented to the socket window.</summary>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.Plug" />.</remarks>
</Docs>
</Member>
<Member MemberName="Id">
<MemberSignature Language="C#" Value="public ulong Id { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance unsigned int64 Id" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt64</ReturnType>
</ReturnValue>
<Docs>
<summary>Gets the window ID of a <see cref="T:Gtk.Plug" /> widget.</summary>
<value>an object of type <see cref="T:System.UInt32" /></value>
<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="IsEmbedded">
<MemberSignature Language="C#" Value="public bool IsEmbedded { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool IsEmbedded" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("embedded")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>IsEmbedded property.</summary>
<value>If <see langword="true" />, the plus is embedded in a socket.</value>
<remarks />
<since version="Gtk# 2.12" />
</Docs>
</Member>
<Member MemberName="OnEmbedded">
<MemberSignature Language="C#" Value="protected virtual void OnEmbedded ();" />
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnEmbedded() cil managed" />
<MemberType>Method</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverrideEmbedded", Type=typeof(Gtk.Plug))</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Default handler for the <see cref="M:Gtk.Plug.Embedded" /> event.</summary>
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Plug.Embedded" /> event.</remarks>
</Docs>
</Member>
<Member MemberName="SocketWindow">
<MemberSignature Language="C#" Value="public Gdk.Window SocketWindow { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gdk.Window SocketWindow" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("socket-window")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gdk.Window</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
</Members>
</Type>