GtkSharp/doc/en/Atk/StateSet.xml
Duncan Mak f3966a2a4c 2003-02-23 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: a Big patch. This adds code-generated documentation
	for internal constructors, the GType property and the Finalized method.

svn path=/trunk/gtk-sharp/; revision=11858
2003-02-23 07:26:30 +00:00

250 lines
No EOL
9.3 KiB
XML

<Type Name="StateSet" FullName="Atk.StateSet">
<TypeSignature Language="C#" Value="public class StateSet : 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="ContainsState">
<MemberSignature Language="C#" Value="public bool ContainsState (Atk.StateType type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Atk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">To be added: an object of type 'Atk.StateType'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="XorSets">
<MemberSignature Language="C#" Value="public Atk.StateSet XorSets (Atk.StateSet compare_set);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.StateSet</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="compare_set" Type="Atk.StateSet" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="compare_set">To be added: an object of type 'Atk.StateSet'</param>
<returns>To be added: an object of type 'Atk.StateSet'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AddState">
<MemberSignature Language="C#" Value="public bool AddState (Atk.StateType type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Atk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">To be added: an object of type 'Atk.StateType'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ContainsStates">
<MemberSignature Language="C#" Value="public bool ContainsStates (Atk.StateType types, int n_types);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="types" Type="Atk.StateType" />
<Parameter Name="n_types" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="types">To be added: an object of type 'Atk.StateType'</param>
<param name="n_types">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AndSets">
<MemberSignature Language="C#" Value="public Atk.StateSet AndSets (Atk.StateSet compare_set);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.StateSet</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="compare_set" Type="Atk.StateSet" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="compare_set">To be added: an object of type 'Atk.StateSet'</param>
<returns>To be added: an object of type 'Atk.StateSet'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RemoveState">
<MemberSignature Language="C#" Value="public bool RemoveState (Atk.StateType type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Atk.StateType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">To be added: an object of type 'Atk.StateType'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="OrSets">
<MemberSignature Language="C#" Value="public Atk.StateSet OrSets (Atk.StateSet compare_set);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.StateSet</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="compare_set" Type="Atk.StateSet" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="compare_set">To be added: an object of type 'Atk.StateSet'</param>
<returns>To be added: an object of type 'Atk.StateSet'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IsEmpty">
<MemberSignature Language="C#" Value="public bool IsEmpty ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="AddStates">
<MemberSignature Language="C#" Value="public void AddStates (Atk.StateType types, int n_types);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="types" Type="Atk.StateType" />
<Parameter Name="n_types" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="types">To be added: an object of type 'Atk.StateType'</param>
<param name="n_types">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ClearStates">
<MemberSignature Language="C#" Value="public void ClearStates ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<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">
<MemberSignature Language="C#" Value="protected StateSet (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 StateSet, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Atk.StateSet" /> 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 StateSet (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 StateSet, 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 StateSet ();" />
<MemberType>Constructor</MemberType>
<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="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.StateSet</summary>
<returns>The GLib TYpe for the Atk.StateSet class.</returns>
<remarks />
</Docs>
</Member>
</Members>
</Type>