GtkSharp/doc/en/Gnome/CanvasClipgroup.xml
Shane Landrum ab31021a7a 2005-01-07 Shane Landrum <epicene@pobox.com>
* en/Gnome/*: Cleaned up some <param> sections
	to include links to the types they use; edited
	<remarks> sections.


svn path=/trunk/gtk-sharp/; revision=38496
2005-01-07 16:27:42 +00:00

155 lines
5.8 KiB
XML

<Type Name="CanvasClipgroup" FullName="Gnome.CanvasClipgroup">
<TypeSignature Language="C#" Value="public class CanvasClipgroup : Gnome.CanvasGroup, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-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>Canvas group that implements clipping</summary>
<remarks>
A canvas group object that clips the view of its children to a
shape defined by a <see cref="T:Gnome.CanvasPathDef" />.
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasGroup</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<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 CanvasClipgroup (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 CanvasClipgroup, 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 CanvasClipgroup (Gnome.CanvasGroup group);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>Create new <see cref="T:Gnome.CanvasClipgroup" /></summary>
<param name="group">
The <see cref="T:Gnome.CanvasGroup" /> that this <see cref="T:Gnome.CanvasClipgroup" />
belongs to.
</param>
<returns>The newly-created <see cref="T:Gnome.Canvas.Clipgroup" /> object</returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Path">
<MemberSignature Language="C#" Value="public IntPtr Path { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Pointer to a GnomeCanvasPathDef structure.</summary>
<param name="value">
Pointer to a <see cref="T:Gnome.CanvasPathDef" /> structure.
</param>
<returns>Pointer to a GnomeCanvasPathDef structure.</returns>
<remarks>
<para>
Pointer to a <see cref="T:Gnome.CanvasPathDef" /> structure. This can be
created by a call to the <see cref="C:Gnome.CanvasPathDef" /> constructor.
</para>
</remarks>
</Docs>
</Member>
<Member MemberName="Wind">
<MemberSignature Language="C#" Value="public Art.WindRule Wind { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Art.WindRule</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Winding rule for defining the clipping intersection rule</summary>
<param name="value">the winding rule</param>
<returns>Winding rule for defining the clipping intersection rule</returns>
<remarks>
</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:Gnome.CanvasClipgroup" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CanvasClipgroup (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:Gnome.CanvasClipgroup" /></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=".ctor">
<MemberSignature Language="C#" Value="protected CanvasClipgroup ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gnome.CanvasClipgroup" /></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>