GtkSharp/doc/en/Atk/Relation.xml

175 lines
6.6 KiB
XML
Raw Normal View History

<Type Name="Relation" FullName="Atk.Relation">
<TypeSignature Language="C#" Maintainer="auto" Value="public class Relation : GLib.Object" />
<AssemblyInfo>
<AssemblyName>atk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.0.0.0</AssemblyVersion>
</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>An <see cref="T:Atk.Relation" /> describes a relation between an object and one or more other objects.</summary>
<remarks>
<para>
An <see cref="T:Atk.Relation" /> describes a relation between an object and
one or more other objects.
</para>
<para>
The actual relations that an object has with other objects are
defined as an <see cref="T:Atk.RelationSet" />, which is a set of
<see cref="T:Atk.Relations" />.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Relation (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>
<remarks>
<para>This is an internal constructor, and should not be used by user code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName="TypeForName">
<MemberSignature Language="C#" Value="public static Atk.RelationType TypeForName (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.RelationType</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Atk.RelationType" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="TypeGetName">
<MemberSignature Language="C#" Value="public static string TypeGetName (Atk.RelationType type);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="type" Type="Atk.RelationType" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">a <see cref="T:Atk.RelationType" /></param>
<returns>a <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="TypeRegister">
<MemberSignature Language="C#" Value="public static Atk.RelationType TypeRegister (string name);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Atk.RelationType</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="name" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="name">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Atk.RelationType" /></returns>
<remarks>To be added</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>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Atk.Relation" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Relation (GLib.GType gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="GLib.GType" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">a <see cref="T:GLib.GType" /></param>
<remarks>This is a constructor used by derivative types of <see cref="T:Atk.Relation" /> that would have their own GLib.GType assigned to it. This is not typically used by C# code.</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete(Message=null, IsError=False)</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Relation (Atk.Object[] targets, Atk.RelationType relationship);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="targets" Type="Atk.Object[]" />
<Parameter Name="relationship" Type="Atk.RelationType" />
</Parameters>
<Docs>
<summary>Creates a new <see cref="T:Atk.Relation" /> with the provided information.</summary>
<param name="targets">an array of <see cref="T:Atk.Object" /></param>
<param name="relationship">an <see cref="T:Atk.RelationType" /> for the relation.</param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="RelationType">
<MemberSignature Language="C#" Value="public Atk.RelationType RelationType { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Atk.RelationType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Gets the type of relation.</summary>
<value>The type of this relation</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property(Name="relation_type")</AttributeName>
</Attribute>
</Attributes></Member>
<Member MemberName="AddTarget">
<MemberSignature Language="C#" Value="public void AddTarget (Atk.Object target);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="target" Type="Atk.Object" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="target">a <see cref="T:Atk.Object" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>