Ryujinx-GtkSharp/doc/en/Atk/Object.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

577 lines
22 KiB
XML

<Type Name="Object" FullName="Atk.Object">
<TypeSignature Language="C#" Value="public class Object : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>atk-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.Object</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="RefAccessibleChild">
<MemberSignature Language="C#" Value="public Atk.Object RefAccessibleChild (int i);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="i" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="i">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ConnectPropertyChangeHandler">
<MemberSignature Language="C#" Value="public uint ConnectPropertyChangeHandler (Atk.PropertyChangeHandler handler);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handler" Type="Atk.PropertyChangeHandler" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handler">To be added: an object of type 'Atk.PropertyChangeHandler'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Initialize">
<MemberSignature Language="C#" Value="public void Initialize (IntPtr data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="data" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="data">To be added: an object of type 'IntPtr'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RefRelationSet">
<MemberSignature Language="C#" Value="public Atk.RelationSet RefRelationSet ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.RelationSet</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Atk.RelationSet'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RemovePropertyChangeHandler">
<MemberSignature Language="C#" Value="public void RemovePropertyChangeHandler (uint handler_id);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="handler_id" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="handler_id">To be added: an object of type 'uint'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NotifyStateChange">
<MemberSignature Language="C#" Value="public void NotifyStateChange (ulong state, bool value);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="state" Type="System.UInt64" />
<Parameter Name="value" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="state">To be added: an object of type 'ulong'</param>
<param name="value">To be added: an object of type 'bool'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RefStateSet">
<MemberSignature Language="C#" Value="public Atk.StateSet RefStateSet ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.StateSet</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Atk.StateSet'</returns>
<remarks>To be added</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" Deprecated="true">
<MemberSignature Language="C#" Value="protected Object (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of Object, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Atk.Object" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</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=".ctor">
<MemberSignature Language="C#" Value="protected Object ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</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 GLib Type for Atk.Object</summary>
<returns>The GLib Type for the Atk.Object class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Parent">
<MemberSignature Language="C#" Value="public Atk.Object Parent { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Atk.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Atk.Object'</param>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Description">
<MemberSignature Language="C#" Value="public string Description { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="MdiZorder">
<MemberSignature Language="C#" Value="public int MdiZorder { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="NAccessibleChildren">
<MemberSignature Language="C#" Value="public int NAccessibleChildren { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Role">
<MemberSignature Language="C#" Value="public Atk.Role Role { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.Role</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Atk.Role" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Atk.Role'</param>
<returns>To be added: an object of type 'Atk.Role'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IndexInParent">
<MemberSignature Language="C#" Value="public int IndexInParent { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Layer">
<MemberSignature Language="C#" Value="public Atk.Layer Layer { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.Layer</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Atk.Layer'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Name">
<MemberSignature Language="C#" Value="public string Name { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyName">
<MemberSignature Language="C#" Value="public string AtkObjectNamePropertyName { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyDescription">
<MemberSignature Language="C#" Value="public string AtkObjectNamePropertyDescription { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyComponentLayer">
<MemberSignature Language="C#" Value="public int AtkObjectNamePropertyComponentLayer { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyTableColumnHeader">
<MemberSignature Language="C#" Value="public Atk.Object AtkObjectNamePropertyTableColumnHeader { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Atk.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Atk.Object'</param>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyValue">
<MemberSignature Language="C#" Value="public double AtkObjectNamePropertyValue { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Double" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'double'</param>
<returns>To be added: an object of type 'double'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyParent">
<MemberSignature Language="C#" Value="public Atk.Object AtkObjectNamePropertyParent { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Atk.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Atk.Object'</param>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyTableRowDescription">
<MemberSignature Language="C#" Value="public string AtkObjectNamePropertyTableRowDescription { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyRole">
<MemberSignature Language="C#" Value="public int AtkObjectNamePropertyRole { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyComponentMdiZorder">
<MemberSignature Language="C#" Value="public int AtkObjectNamePropertyComponentMdiZorder { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyTableCaption">
<MemberSignature Language="C#" Value="public string AtkObjectNamePropertyTableCaption { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyTableSummary">
<MemberSignature Language="C#" Value="public Atk.Object AtkObjectNamePropertyTableSummary { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Atk.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Atk.Object'</param>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyTableColumnDescription">
<MemberSignature Language="C#" Value="public string AtkObjectNamePropertyTableColumnDescription { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AtkObjectNamePropertyTableRowHeader">
<MemberSignature Language="C#" Value="public Atk.Object AtkObjectNamePropertyTableRowHeader { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.Object</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Atk.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Atk.Object'</param>
<returns>To be added: an object of type 'Atk.Object'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PropertyChange">
<MemberSignature Language="C#" Value="public event AtkSharp.PropertyChangeHandler PropertyChange;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="StateChange">
<MemberSignature Language="C#" Value="public event AtkSharp.StateChangeHandler StateChange;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ChildrenChanged">
<MemberSignature Language="C#" Value="public event AtkSharp.ChildrenChangedHandler ChildrenChanged;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="VisibleDataChanged">
<MemberSignature Language="C#" Value="public event EventHandler VisibleDataChanged;" />
<MemberType>Event</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FocusEvent">
<MemberSignature Language="C#" Value="public event AtkSharp.FocusEventHandler FocusEvent;" />
<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 Object (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 Object, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Atk.Object" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>