GtkSharp/doc/en/Gnome/CanvasPixbuf.xml
John Luke 0a5c79b320 2003-10-13 John Luke <jluke@cfl.rr.com>
* en/*/*.xml: fix finalize signature (override not virtual)

svn path=/trunk/gtk-sharp/; revision=18998
2003-10-13 22:55:58 +00:00

320 lines
12 KiB
XML

<Type Name="CanvasPixbuf" FullName="Gnome.CanvasPixbuf">
<TypeSignature Language="C#" Value="public class CanvasPixbuf : Gnome.CanvasItem, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gnome-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>Pixbuf image canvas item</summary>
<remarks>
<para>
A canvas item for drawing pixbuf images.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasItem</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 CanvasPixbuf (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 CanvasPixbuf, 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 CanvasPixbuf ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.CanvasPixbuf'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasPixbuf (Gnome.CanvasGroup group);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="group">To be added: an object of type 'Gnome.CanvasGroup'</param>
<returns>To be added: an object of type 'Gnome.CanvasPixbuf'</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 Gnome.CanvasPixbuf</summary>
<returns>The GLib Type for the Gnome.CanvasPixbuf class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public double Height { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>Pixbuf height.</summary>
<param name="value">the height of this item</param>
<returns>the height of this item</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Pixbuf">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Pixbuf { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>The pixbuf image to draw.</summary>
<param name="value">The pixbuf image to draw.</param>
<returns>the pixbuf image</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WidthInPixels">
<MemberSignature Language="C#" Value="public bool WidthInPixels { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</summary>
<param name="value">
<see langword="true" /> if it is in pixel units, <see langword="false" /> for canvas world units.
</param>
<returns>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Anchor">
<MemberSignature Language="C#" Value="public Gtk.AnchorType Anchor { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.AnchorType</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>
Anchor (handle) position within the pixbuf, defaults to
<see cref="F:Gtk.AnchorType.NW" /> (top left hand corner). The anchor is the
point of reference for positioning the image.
</summary>
<param name="value">anchor (handle) position within the pixbuf</param>
<returns>Anchor (handle) position within the pixbuf</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public double Width { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>Pixbuf width.</summary>
<param name="value">Pixbuf width</param>
<returns>the pixbuf's width</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="WidthSet">
<MemberSignature Language="C#" Value="public bool WidthSet { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>
Whether or not the <see cref="Gnome.CanvasPixbuf.Width" />
should be used
</summary>
<param name="value">
<see langword="true" /> if the <see cref="Gnome.CanvasPixbuf.Width" /> parameter is set and
should be used as the pixbuf width, <see langword="false" /> to use the actual
width of the image.
</param>
<returns>
Whether or not the <see cref="Gnome.CanvasPixbuf.Width" />
should be used
</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Y">
<MemberSignature Language="C#" Value="public double Y { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>The y coordinate of the position to place the pixbuf</summary>
<param name="value">Y coordinate</param>
<returns>the y coordinate of the position to place the pixbuf</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="X">
<MemberSignature Language="C#" Value="public double X { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>The x coordinate of the position to place the pixbuf</summary>
<param name="value">X coordinate</param>
<returns>the x coordinate of the position to place the pixbuf</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HeightInPixels">
<MemberSignature Language="C#" Value="public bool HeightInPixels { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</summary>
<param name="value">
<see langword="true" /> if the <see cref="Gnome.CanvasPixbuf.Height" /> parameter is set and
should be used as the pixbuf width, <see langword="false" /> to use the actual
width of the image.
</param>
<returns>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="HeightSet">
<MemberSignature Language="C#" Value="public bool HeightSet { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</summary>
<param name="value">
<see langword="true" /> if the <see cref="Gnome.CanvasPixbuf.Height" /> parameter is set and
should be used as the pixbuf width, <see langword="false" /> to use the actual
width of the image.
</param>
<returns>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="XInPixels">
<MemberSignature Language="C#" Value="public bool XInPixels { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</summary>
<param name="value">
<see langword="true" /> if it is in pixel units, <see langword="false" /> for canvas world units.
</param>
<returns>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="YInPixels">
<MemberSignature Language="C#" Value="public bool YInPixels { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Docs>
<summary>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</summary>
<param name="value">
<see langword="true" /> if it is in pixel units, <see langword="false" /> for canvas world units.
</param>
<returns>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CanvasPixbuf (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 CanvasPixbuf, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gnome.CanvasPixbuf" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>