GtkSharp/doc/en/Gdk/Image.xml
Mike Kestner b939f1f390 2005-06-16 Mike Kestner <mkestner@novell.com>
* en/*/*.xml : run the versionator to add since elements for 2.4.

svn path=/trunk/gtk-sharp/; revision=46100
2005-06-16 18:56:42 +00:00

324 lines
12 KiB
XML

<Type Name="Image" FullName="Gdk.Image">
<TypeSignature Language="C#" Maintainer="auto" Value="public class Image : GLib.Object" />
<AssemblyInfo>
<AssemblyName>gdk-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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Object</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName="PutPixel">
<MemberSignature Language="C#" Value="public void PutPixel (int x, int y, uint pixel);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
<Parameter Name="pixel" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">To be added: an object of type 'int'</param>
<param name="y">To be added: an object of type 'int'</param>
<param name="pixel">To be added: an object of type 'uint'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GetPixel">
<MemberSignature Language="C#" Value="public uint GetPixel (int x, int y);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="x">To be added: an object of type 'int'</param>
<param name="y">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (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=".ctor">
<MemberSignature Language="C#" Value="public Image (Gdk.ImageType type, Gdk.Visual visual, int width, int height);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="type" Type="Gdk.ImageType" />
<Parameter Name="visual" Type="Gdk.Visual" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="type">To be added: an object of type 'Gdk.ImageType'</param>
<param name="visual">To be added: an object of type 'Gdk.Visual'</param>
<param name="width">To be added: an object of type 'int'</param>
<param name="height">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Colormap">
<MemberSignature Language="C#" Value="public Gdk.Colormap Colormap { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Colormap</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<value>To be added: an object of type 'Gdk.Colormap'</value>
<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:Gdk.Image" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Image (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:Gdk.Image" /> 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="Get">
<MemberSignature Language="C#" Value="public static Gdk.Image Get (Gdk.Drawable drawable, int x, int y, int width, int height);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Image</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="x" Type="System.Int32" />
<Parameter Name="y" Type="System.Int32" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="x">a <see cref="T:System.Int32" /></param>
<param name="y">a <see cref="T:System.Int32" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<returns>a <see cref="T:Gdk.Image" /></returns>
<remarks>To be added</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Unref">
<MemberSignature Language="C#" Value="public void Unref ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Ref">
<MemberSignature Language="C#" Value="public Gdk.Image Ref ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Image</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>a <see cref="T:Gdk.Image" /></returns>
<remarks>To be added</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Bpp">
<MemberSignature Language="C#" Value="public ushort Bpp { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The number of bytes per pixel.</summary>
<value>a <see cref="T:System.UInt16" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Bpl">
<MemberSignature Language="C#" Value="public ushort Bpl { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The number of bytes per line of the image.</summary>
<value>a <see cref="T:System.UInt16" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Depth">
<MemberSignature Language="C#" Value="public ushort Depth { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The image depth (ie, the number of bits per pixel).</summary>
<value>a <see cref="T:System.UInt16" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="ByteOrder">
<MemberSignature Language="C#" Value="public Gdk.ByteOrder ByteOrder { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.ByteOrder</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The image byte order.</summary>
<value>a <see cref="T:Gdk.ByteOrder" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="BitsPerPixel">
<MemberSignature Language="C#" Value="public ushort BitsPerPixel { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.UInt16</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The number of bits per pixel.</summary>
<value>a <see cref="T:System.UInt16" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public int Width { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The width of the image in pixels.</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Visual">
<MemberSignature Language="C#" Value="public Gdk.Visual Visual { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Visual</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The image's <see cref="T:Gdk.Visual" />.</summary>
<value>a <see cref="T:Gdk.Visual" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Type">
<MemberSignature Language="C#" Value="public Gdk.ImageType Type { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.ImageType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The image's <see cref="T:Gdk.ImageType" /></summary>
<value>a <see cref="T:Gdk.ImageType" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public int Height { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>The height of the image in pixels.</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
</Members>
</Type>