455 lines
17 KiB
XML
455 lines
17 KiB
XML
<Type Name="Object" FullName="Gtk.Object">
|
|
<TypeSignature Language="C#" Value="public class Object : GLib.Object, IWrapper, IDisposable" 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> Base class for the Gtk object hierarchy.</summary>
|
|
<remarks>Base object for the Gtk object hierarchy.
|
|
<para>
|
|
The difference between Gtk.Object and GLib.<see cref="T:GLib.Object" /> is a historical one, and it matters little in Gtk#.
|
|
</para></remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>GLib.Object</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
<Interface>
|
|
<InterfaceName>GLib.IWrapper</InterfaceName>
|
|
</Interface>
|
|
<Interface>
|
|
<InterfaceName>System.IDisposable</InterfaceName>
|
|
</Interface>
|
|
</Interfaces>
|
|
<Attributes />
|
|
<Members>
|
|
<Member MemberName="Destroy">
|
|
<MemberSignature Language="C#" Value="public virtual void Destroy ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Request all holders to the object to release the reference.</summary>
|
|
<remarks>This method is used to notify objects that might hold a reference to this object to release the reference.
|
|
<para>
|
|
This invokes the <see cref="M:Gtk.Object.OnDestroyed" /> method and triggers the <see cref="E:Gtk.OBject.Destroyed" /> event.
|
|
</para><para>
|
|
The object is only destroyed if all the references to the object are released, this is just a mechanism to request that references be released.
|
|
</para></remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Sink">
|
|
<MemberSignature Language="C#" Value="public void Sink ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Removes the floating reference from a <see cref="T:Gtk.Object" />, if it exists; otherwise does
|
|
nothing.
|
|
</summary>
|
|
<remarks>See the <see cref="T:Gtk.Object" /> overview
|
|
documentation at the top of the page.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Finalize">
|
|
<MemberSignature Language="C#" Value="protected override 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 Object (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 Object, 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="UserData">
|
|
<MemberSignature Language="C#" Value="public IntPtr UserData { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Helper property to associate information with an object.</summary>
|
|
<param name="value">The value to store/retrieve</param>
|
|
<returns />
|
|
<remarks>This is not very useful with the Gtk# binding as it is with the C binding. </remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Destroyed">
|
|
<MemberSignature Language="C#" Value="public event EventHandler Destroyed;" />
|
|
<MemberType>Event</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.EventHandler</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Raised to signal that all references to this object should be removed.</summary>
|
|
<remarks>This event is triggered if someone has invoked the <see cref="T:Gtk.Object" />'s <see cref="M:Gtk.Object.Destroy" /> method. It is used to inform that all references to the object must be discarded at this point.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Raw">
|
|
<MemberSignature Language="C#" Value="protected override IntPtr Raw { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>
|
|
Diagnostic method to print the raw object and its reference count
|
|
as debug information.
|
|
</summary>
|
|
<returns>a <see cref="T:System.IntPtr" />, the internal C data underlying this object.</returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="OnDestroyed">
|
|
<MemberSignature Language="C#" Value="protected virtual void OnDestroyed ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Invoked to request that references to the object be released.</summary>
|
|
<remarks>This method is invoked when someone has called the <see cref="T:Gtk.Object's" />'s <see cref="T:Gtk.Object.Destroy" /> method. Any references to the object held should be released at this point.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Object (GLib.GType gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.GType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Protected Constructor.</summary>
|
|
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
|
<returns>a <see cref="T:Gtk.Object" /></returns>
|
|
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</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.Object" />.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Object ();" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Internal.</summary>
|
|
<returns>a <see cref="T:Gtk.Object" /></returns>
|
|
<remarks>Internal constructor.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="IsFloating">
|
|
<MemberSignature Language="C#" Value="public bool IsFloating { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Boolean</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Determines if the object reference is floating.</summary>
|
|
<returns>a <see cref="T:System.Boolean" /></returns>
|
|
<remarks>An object is floating until it is added to a container which claims ownership of the floating reference.</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="AddArgType">
|
|
<MemberSignature Language="C#" Value="public static void AddArgType (string arg_name, GLib.GType arg_type, uint arg_flags, uint arg_id);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="arg_name" Type="System.String" />
|
|
<Parameter Name="arg_type" Type="GLib.GType" />
|
|
<Parameter Name="arg_flags" Type="System.UInt32" />
|
|
<Parameter Name="arg_id" Type="System.UInt32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use in new code.</summary>
|
|
<param name="arg_name">a <see cref="T:System.String" /></param>
|
|
<param name="arg_type">a <see cref="T:GLib.GType" /></param>
|
|
<param name="arg_flags">a <see cref="T:System.UInt32" /></param>
|
|
<param name="arg_id">a <see cref="T:System.UInt32" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Unref">
|
|
<MemberSignature Language="C#" Value="public void Unref ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Ref">
|
|
<MemberSignature Language="C#" Value="public Gtk.Object Ref ();" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Object</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<returns>a <see cref="T:Gtk.Object" /></returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetDataByIdFull">
|
|
<MemberSignature Language="C#" Value="public void SetDataByIdFull (int data_id, IntPtr data, Gtk.DestroyNotify destroy);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="data_id" Type="System.Int32" />
|
|
<Parameter Name="data" Type="System.IntPtr" />
|
|
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="data_id">a <see cref="T:System.Int32" /></param>
|
|
<param name="data">a <see cref="T:System.IntPtr" /></param>
|
|
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetData">
|
|
<MemberSignature Language="C#" Value="public IntPtr GetData (string key);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="key" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="key">a <see cref="T:System.String" /></param>
|
|
<returns>a <see cref="T:System.IntPtr" /></returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Weakunref">
|
|
<MemberSignature Language="C#" Value="public void Weakunref (Gtk.DestroyNotify notify);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="notify" Type="Gtk.DestroyNotify" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RemoveDataById">
|
|
<MemberSignature Language="C#" Value="public void RemoveDataById (int data_id);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="data_id" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="data_id">a <see cref="T:System.Int32" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetDataById">
|
|
<MemberSignature Language="C#" Value="public void SetDataById (int data_id, IntPtr data);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="data_id" Type="System.Int32" />
|
|
<Parameter Name="data" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="data_id">a <see cref="T:System.Int32" /></param>
|
|
<param name="data">a <see cref="T:System.IntPtr" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Weakref">
|
|
<MemberSignature Language="C#" Value="public void Weakref (Gtk.DestroyNotify notify);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="notify" Type="Gtk.DestroyNotify" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="notify">a <see cref="T:Gtk.DestroyNotify" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RemoveNoNotifyById">
|
|
<MemberSignature Language="C#" Value="public void RemoveNoNotifyById (int key_id);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="key_id" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="key_id">a <see cref="T:System.Int32" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RemoveData">
|
|
<MemberSignature Language="C#" Value="public void RemoveData (string key);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="key" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="key">a <see cref="T:System.String" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetDataFull">
|
|
<MemberSignature Language="C#" Value="public void SetDataFull (string key, IntPtr data, Gtk.DestroyNotify destroy);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="key" Type="System.String" />
|
|
<Parameter Name="data" Type="System.IntPtr" />
|
|
<Parameter Name="destroy" Type="Gtk.DestroyNotify" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="key">a <see cref="T:System.String" /></param>
|
|
<param name="data">a <see cref="T:System.IntPtr" /></param>
|
|
<param name="destroy">a <see cref="T:Gtk.DestroyNotify" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetData">
|
|
<MemberSignature Language="C#" Value="public void SetData (string key, IntPtr data);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="key" Type="System.String" />
|
|
<Parameter Name="data" Type="System.IntPtr" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="key">a <see cref="T:System.String" /></param>
|
|
<param name="data">a <see cref="T:System.IntPtr" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetDataById">
|
|
<MemberSignature Language="C#" Value="public IntPtr GetDataById (int data_id);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.IntPtr</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="data_id" Type="System.Int32" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="data_id">a <see cref="T:System.Int32" /></param>
|
|
<returns>a <see cref="T:System.IntPtr" /></returns>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="RemoveNoNotify">
|
|
<MemberSignature Language="C#" Value="public void RemoveNoNotify (string key);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="key" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Deprecated. Do not use.</summary>
|
|
<param name="key">a <see cref="T:System.String" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
</Docs>
|
|
</Member>
|
|
</Members>
|
|
</Type>
|