GtkSharp/doc/en/Gdk/Image.xml
Dan Winship b6d7f14268 * generator/StructBase.cs: update field-generation logic a bit
* generator/CodeGenerator.cs: add a --glue-includes flag

	* generator/GenerationInfo.cs: Accept glue_includes value from
	Main and output it to the glue_filename.

	* generator/FieldBase.cs (Ignored): handle more ignorable cases.
	(CheckGlue): New method to figure out what kind of glue we'll need
	for a field.
	(GenerateImports): generate appropriate imports per CheckGlue.
	(GenerateGlue): Generate C glue for accessing a struct field;
	either a fully-C-based accessor, or a method to just return the
	field's offset in the struct.
	(Generate): Use the generated glue to read the field.

	* generator/PropertyBase.cs (CType): if the field is a single bit,
	set its type to gboolean.

	* generator/ObjectGen.cs (Generate):
	* generator/OpaqueGen.cs (Generate): Call GenFields.

	* generator/StructField.cs: Use FieldBase's glue-generation code
	to handle bitfields. [#54489]

	* generator/ObjectField.cs: Generates accessors for public fields
	of objects and opaque structs. [#69514]

	* generator/ClassBase.cs (ClassBase): Parse <fields> nodes and
	create ObjectField objects.
	(GenFields): Output field properties
	(IgnoreMethod): Ignore Get/Set methods that duplicate fields

	* generator/Makefile.am (sources): update

	* {gdk,gnome,gtk,pango}/*.metadata: Mark some additional fields as
	public. Rename/retype some fields for consistency with earlier
	hand-coded bindings.

	* {gdk,gnome,gtk,pango}/*.custom: Remove custom methods that can
	now be autogenerated.

	* {gdk,gnome,gtk,pango}/glue/*.c: Remove glue methods that can now
	be autogenerated
	
	* {gdk,glade,gnome,gtk,pango,vte}/Makefile.am
	* {gdk,glade,gnome,gtk,pango,vte}/glue/Makefile.am
	* {gdk,gnome,gtk,pango}/glue/makefile.win32: Update

svn path=/trunk/gtk-sharp/; revision=44563
2005-05-16 14:28:55 +00:00

323 lines
No EOL
12 KiB
XML

<Type Name="Image" FullName="Gdk.Image">
<TypeSignature Language="C#" Value="public class Image : GLib.Object, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gdk-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>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="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="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 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>
<returns>An instance of Image, 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 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>
<returns>To be added: an object of type 'Gdk.Image'</returns>
<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>
<param name="value">To be added: an object of type 'Gdk.Colormap'</param>
<returns>To be added: an object of type 'Gdk.Colormap'</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>
<returns>a <see cref="T:GLib.GType" /></returns>
<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>
<returns>a <see cref="T:Gdk.Image" /></returns>
<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>
</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>
</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>
</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>
</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>
<returns>a <see cref="T:System.UInt16" /></returns>
<remarks></remarks>
</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>
<returns>a <see cref="T:System.UInt16" /></returns>
<remarks></remarks>
</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>
<returns>a <see cref="T:System.UInt16" /></returns>
<remarks></remarks>
</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>
<returns>a <see cref="T:Gdk.ByteOrder" /></returns>
<remarks></remarks>
</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>
<returns>a <see cref="T:System.UInt16" /></returns>
<remarks></remarks>
</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>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks>
</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>
<returns>a <see cref="T:Gdk.Visual" /></returns>
<remarks></remarks>
</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>
<returns>a <see cref="T:Gdk.ImageType" /></returns>
<remarks></remarks>
</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>
<returns>a <see cref="T:System.Int32" /></returns>
<remarks></remarks>
</Docs>
</Member>
</Members>
</Type>