mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-09-16 11:34:47 +02:00
197 lines
10 KiB
XML
197 lines
10 KiB
XML
<Type Name="Socket" FullName="Gtk.Socket">
|
|
<TypeSignature Language="C#" Maintainer="John Luke" Value="public class Socket : Gtk.Container" />
|
|
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Socket extends Gtk.Container" />
|
|
<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.Container</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
</Interfaces>
|
|
<Docs>
|
|
<summary>Container for widgets from other processes.</summary>
|
|
<remarks>
|
|
<para>Together with <see cref="T:Gtk.Plug" />, <see cref="T:Gtk.Socket" /> 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 window ID of that widget 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.</para>
|
|
<para>The window ID of the <see cref="T:Gtk.Socket" /> is obtained by using <see cref="M:Gtk.Socket.GetId()" />. Before using this function, the socket must have been realized, and therefore, have been added to its parent.</para>
|
|
<example>
|
|
<code language="C#">
|
|
Gtk.Socket socket = new Gtk.Socket;
|
|
socket.Show ();
|
|
parent.Add (socket);
|
|
Console.WriteLine ("The ID of the sockets window is {0}", socket.Id);
|
|
</code>
|
|
</example>
|
|
<para>Note that if you pass the window ID of the socket to another process that will create a plug in the socket, you must make sure that the socket widget is not destroyed until that plug is created. Violating this rule will cause unpredictable consequences, the most likely consequence being that the plug will appear as a separate toplevel window. You can check if the plug has been created by examining the plug_window field of the <see cref="T:Gtk.Socket" /> structure. If this field is non-<see langword="null" />, then the plug has been successfully created inside of the socket.</para>
|
|
<para>When Gtk# is notified that the embedded window has been destroyed, then it will destroy the socket as well. You should always, therefore, be prepared for your sockets to be destroyed at any time when the main event loop is running.</para>
|
|
<para>The communication between a <see cref="T:Gtk.Socket" /> and a <see cref="T:Gtk.Plug" /> follows the XEmbed protocol. This protocol has also been implemented in other toolkits, e.g. Qt, allowing the same level of integration when embedding a Qt widget in GTK or vice versa.</para>
|
|
<para>A socket can also be used to swallow arbitrary pre-existing top-level windows using <see cref="M:Gtk.Socket.Steal()" />, though the integration when this is done will not be as close as between a <see cref="T:Gtk.Plug" /> and a <see cref="T:Gtk.Socket" />.</para>
|
|
</remarks>
|
|
</Docs>
|
|
<Members>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Socket ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default constructor</summary>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Socket (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="AddId">
|
|
<MemberSignature Language="C#" Value="public void AddId (ulong window);" />
|
|
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void AddId(unsigned int64 window) cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="window" Type="System.UInt64" />
|
|
</Parameters>
|
|
<Docs>
|
|
<param name="window">To be added.</param>
|
|
<summary>To be added.</summary>
|
|
<remarks>To be added.</remarks>
|
|
<since version="Gtk# 3.0" />
|
|
</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.Socket" />.</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>The window ID of a <see cref="T:Gtk.Socket" /> widget.</summary>
|
|
<value>an object of type <see cref="T:System.UInt32" /></value>
|
|
<remarks>This can be used to create a client embedded inside the socket, for instance with <see cref="C:Gtk.Plug()" />. The <see cref="T:Gtk.Socket" /> must have already be added into a toplevel window before you can make this call.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnPlugAdded">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnPlugAdded ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance void OnPlugAdded() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverridePlugAdded", Type=typeof(Gtk.Socket))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.Socket.PlugAdded" /> event.</summary>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Socket.PlugAdded" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnPlugRemoved">
|
|
<MemberSignature Language="C#" Value="protected virtual bool OnPlugRemoved ();" />
|
|
<MemberSignature Language="ILAsm" Value=".method familyhidebysig newslot virtual instance bool OnPlugRemoved() cil managed" />
|
|
<MemberType>Method</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.DefaultSignalHandler(ConnectionMethod="OverridePlugRemoved", Type=typeof(Gtk.Socket))</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Default handler for the <see cref="M:Gtk.Socket.PlugRemoved" /> event.</summary>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>Override this method in a subclass to provide a default handler for the <see cref="M:Gtk.Socket.PlugRemoved" /> event.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PlugAdded">
|
|
<MemberSignature Language="C#" Value="public event EventHandler PlugAdded;" />
|
|
<MemberSignature Language="ILAsm" Value=".event class System.EventHandler PlugAdded" />
|
|
<MemberType>Event</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal("plug-added")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>This event is emitted when a client is successfully added to the socket.</summary>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PlugRemoved">
|
|
<MemberSignature Language="C#" Value="public event Gtk.PlugRemovedHandler PlugRemoved;" />
|
|
<MemberSignature Language="ILAsm" Value=".event class Gtk.PlugRemovedHandler PlugRemoved" />
|
|
<MemberType>Event</MemberType>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Signal("plug-removed")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.PlugRemovedHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>This event is emitted when a client is removed from the socket.</summary>
|
|
<remarks>The default action is to destroy the <see cref="T:Gtk.Socket" /> widget, so if you want to reuse it you must add a signal handler that returns <see langword="true" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="PlugWindow">
|
|
<MemberSignature Language="C#" Value="public Gdk.Window PlugWindow { get; }" />
|
|
<MemberSignature Language="ILAsm" Value=".property instance class Gdk.Window PlugWindow" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|