GtkSharp/doc/en/Gdk/Pixmap.xml
Duncan Mak efa9acf122 2003-03-06 Duncan Mak <duncan@ximian.com>
* en/*/*.xml: Updated all the docs to match the new API. All the nodes
	that no longer have a corresponding member in the type are now
	marked as deprecated. We'll have to wait for Miguel to implement
	this in the browser to stop displaying them.

	All gtype constructors have been regenerated, because of the
	'uint' to 'GLib.Type' change. However, this patch will preserve
	(well, it was regenerated) the customized text for those GType
	constructors.

	A lot of the 'Finalized' methods are also now marked as
	deprecated, because the classes implement 'Dispose' instead. This
	is a possible place for customized scripts to generate template
	documentation, similar to the GType property and GType constructors.

svn path=/trunk/gtk-sharp/; revision=12270
2003-03-07 01:30:00 +00:00

282 lines
12 KiB
XML

<Type Name="Pixmap" FullName="Gdk.Pixmap">
<TypeSignature Language="C#" Value="public class Pixmap : Gdk.Drawable, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gdk-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>To be added</summary>
<remarks>To be added</remarks>
</Docs>
<Base>
<BaseTypeName>Gdk.Drawable</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="Lookup">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap Lookup (uint anid);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="anid" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="anid">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColormapCreateFromXpm">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpm (Gdk.Window window, Gdk.Colormap colormap, Gdk.Bitmap mask, Gdk.Color transparent_color, string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="colormap" Type="Gdk.Colormap" />
<Parameter Name="mask" Type="Gdk.Bitmap" />
<Parameter Name="transparent_color" Type="Gdk.Color" />
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="colormap">To be added: an object of type 'Gdk.Colormap'</param>
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
<param name="transparent_color">To be added: an object of type 'Gdk.Color'</param>
<param name="filename">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColormapCreateFromXpmD">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpmD (Gdk.Window window, Gdk.Colormap colormap, Gdk.Bitmap mask, Gdk.Color transparent_color, string data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="colormap" Type="Gdk.Colormap" />
<Parameter Name="mask" Type="Gdk.Bitmap" />
<Parameter Name="transparent_color" Type="Gdk.Color" />
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="colormap">To be added: an object of type 'Gdk.Colormap'</param>
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
<param name="transparent_color">To be added: an object of type 'Gdk.Color'</param>
<param name="data">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CreateFromXpmD">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpmD (Gdk.Window window, Gdk.Bitmap mask, Gdk.Color transparent_color, string data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="mask" Type="Gdk.Bitmap" />
<Parameter Name="transparent_color" Type="Gdk.Color" />
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
<param name="transparent_color">To be added: an object of type 'Gdk.Color'</param>
<param name="data">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ForeignNew">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap ForeignNew (uint anid);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="anid" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="anid">To be added: an object of type 'uint'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CreateFromXpm">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpm (Gdk.Window window, Gdk.Bitmap mask, Gdk.Color transparent_color, string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="mask" Type="Gdk.Bitmap" />
<Parameter Name="transparent_color" Type="Gdk.Color" />
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
<param name="transparent_color">To be added: an object of type 'Gdk.Color'</param>
<param name="filename">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CreateFromData">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromData (Gdk.Window window, string data, int width, int height, int depth, Gdk.Color fg, Gdk.Color bg);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="data" Type="System.String" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
<Parameter Name="depth" Type="System.Int32" />
<Parameter Name="fg" Type="Gdk.Color" />
<Parameter Name="bg" Type="Gdk.Color" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</param>
<param name="data">To be added: an object of type 'string'</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>
<param name="depth">To be added: an object of type 'int'</param>
<param name="fg">To be added: an object of type 'Gdk.Color'</param>
<param name="bg">To be added: an object of type 'Gdk.Color'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
<MemberSignature Language="C#" Value="protected virtual 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" Deprecated="true">
<MemberSignature Language="C#" Value="protected Pixmap (uint gtype);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="gtype" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Internal constructor</summary>
<param name="gtype">GLib type for the type</param>
<returns>Creates a new instance of Pixmap, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gdk.Pixmap" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Pixmap (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 Pixmap, 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 Pixmap (Gdk.Window window, int width, int height, int depth);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="window" Type="Gdk.Window" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
<Parameter Name="depth" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="window">To be added: an object of type 'Gdk.Window'</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>
<param name="depth">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Pixmap ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.Pixmap'</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 Gdk.Pixmap</summary>
<returns>The GLib Type for the Gdk.Pixmap class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Pixmap (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 Pixmap, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gdk.Pixmap" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>