GtkSharp/doc/en/Gdk/Pixmap.xml
Mike Kestner 881f9655f4 updater run for Pixmap changes.
svn path=/trunk/gtk-sharp/; revision=34784
2004-10-07 15:46:51 +00:00

400 lines
19 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>
<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>Offscreen drawable.</summary>
<remarks>Pixmaps are offscreen drawables. They can be drawn upon with the standard drawing primitives, then copied to another drawable (such as a <see cref="T:Gdk.Window" />) with <see cref="M:Gdk.Pixmap.Draw()" />.
<para>
The depth of a pixmap is the number of bits per pixels. Bitmaps are simply pixmaps with a depth of 1. (That is, they are monochrome bitmaps - each pixel can be either on or off).
</para></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>Looks up the <see cref="T:Gdk.Pixmap" /> that wraps the given native pixmap handle.</summary>
<param name="anid"> a native pixmap handle.</param>
<returns> the <see cref="T:Gdk.Window" /> wrapper for the native window, or <see langword="null" /> if there is none.</returns>
<remarks>Looks up the GdkPixmap that wraps the given native pixmap handle.
<para>
For example in the X backend, a native pixmap handle is an Xlib XID.
</para></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>Wraps a native window for the default display in a <see cref="T:Gdk.Pixmap" />. This may fail if the pixmap has been destroyed.</summary>
<param name="anid"> a native pixmap handle.</param>
<returns>The newly-created <see cref="T:Gdk.Pixmap" /> wrapper for the native pixmap or <see langword="null" /> if the pixmap has been destroyed.</returns>
<remarks>Wraps a native window for the default display in a GdkPixmap. This may fail if the pixmap has been destroyed.
<para>
For example in the X backend, a native pixmap handle is an Xlib XID.
</para></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 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="LookupForDisplay">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap LookupForDisplay (Gdk.Display display, uint anid);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="display" Type="Gdk.Display" />
<Parameter Name="anid" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="display">a <see cref="T:Gdk.Display" /></param>
<param name="anid">a <see cref="T:System.UInt32" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ForeignNewForDisplay">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap ForeignNewForDisplay (Gdk.Display display, uint anid);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="display" Type="Gdk.Display" />
<Parameter Name="anid" Type="System.UInt32" />
</Parameters>
<Docs>
<summary>Wraps a native pixmap in a <see cref="T:Gdk.Pixmap" />. This may fail if the pixmap has been destroyed.</summary>
<param name="display">The <see cref="T:Gdk.Display" /> where the pixmap is located.</param>
<param name="anid"> a native pixmap handle.</param>
<returns>The newly-created <see cref="T:Gdk.Pixmap" /> wrapper for the native pixmap or <see langword="null" /> if the pixmap has been destroyed.</returns>
<remarks>Wraps a native pixmap in a GdkPixmap. This may fail if the pixmap has been destroyed.
<para>
For example in the X backend, a native pixmap handle is an Xlib XID.
</para></remarks>
</Docs>
</Member>
<Member MemberName="CreateFromData">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromData (Gdk.Drawable drawable, 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="drawable" Type="Gdk.Drawable" />
<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="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="data">a <see cref="T:System.String" /></param>
<param name="width">a <see cref="T:System.Int32" /></param>
<param name="height">a <see cref="T:System.Int32" /></param>
<param name="depth">a <see cref="T:System.Int32" /></param>
<param name="fg">a <see cref="T:Gdk.Color" /></param>
<param name="bg">a <see cref="T:Gdk.Color" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Pixmap (Gdk.Drawable drawable, int width, int height, int depth);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
<Parameter Name="depth" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Creates a new pixmap with the given size and depth.</summary>
<param name="drawable">A <see cref="T:Gdk.Drawable" />, used to determine default values for the new pixmap.
Can be <see langword="null" /> if <paramref name="depth" /> is specified</param>
<param name="width">The width of the new pixmap in pixels.</param>
<param name="height"> The height of the new pixmap in pixels.</param>
<param name="depth">The depth (number of bits per pixel) of the new pixmap. If -1, and drawable is not <see langword="null" />, the depth of the new pixmap will be equal to that of drawable.</param>
<returns>The new pixmap with the given size and depth</returns>
<remarks>Create a new pixmap with a given size and depth. </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.Pixmap" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Pixmap (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:Gdk.Pixmap" /></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="public Pixmap (Gdk.Drawable drawable, int width, int height);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="width" Type="System.Int32" />
<Parameter Name="height" Type="System.Int32" />
</Parameters>
<Docs>
<summary>Create a new pixmap using a reference drawable for depth.</summary>
<param name="drawable">A <see cref="T:Gdk.Drawable" />, used to determine default values for the new pixmap.</param>
<param name="width">The width of the new pixmap in pixels.</param>
<param name="height">The height of the new pixmap in pixels.</param>
<returns>The new <see cref="T:Gdk.Pixmap" />.</returns>
<remarks>Creates a new pixmap with a given size and depth.</remarks>
</Docs>
</Member>
<Member MemberName="CreateFromXpmD">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpmD (Gdk.Drawable drawable, out Gdk.Bitmap mask, Gdk.Color transparent_color, string data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="mask" Type="Gdk.Bitmap&amp;" RefType="out" />
<Parameter Name="transparent_color" Type="Gdk.Color" />
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<summary>Create a pixmap from XPM data.</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="mask">a <see cref="T:Gdk.Bitmap" /></param>
<param name="transparent_color">a <see cref="T:Gdk.Color" /></param>
<param name="data">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColormapCreateFromXpm">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpm (Gdk.Drawable drawable, Gdk.Colormap colormap, out Gdk.Bitmap mask, Gdk.Color transparent_color, string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="colormap" Type="Gdk.Colormap" />
<Parameter Name="mask" Type="Gdk.Bitmap&amp;" RefType="out" />
<Parameter Name="transparent_color" Type="Gdk.Color" />
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>Create a pixmap from an XPM file using a specific colormap.</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param>
<param name="mask">a <see cref="T:Gdk.Bitmap" /></param>
<param name="transparent_color">a <see cref="T:Gdk.Color" /></param>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CreateFromXpm">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpm (Gdk.Drawable drawable, out Gdk.Bitmap mask, Gdk.Color transparent_color, string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="mask" Type="Gdk.Bitmap&amp;" RefType="out" />
<Parameter Name="transparent_color" Type="Gdk.Color" />
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>Create a pixmap from an XPM file.</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="mask">a <see cref="T:Gdk.Bitmap" /></param>
<param name="transparent_color">a <see cref="T:Gdk.Color" /></param>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColormapCreateFromXpmD">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpmD (Gdk.Drawable drawable, Gdk.Colormap colormap, out Gdk.Bitmap mask, Gdk.Color transparent_color, string data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="colormap" Type="Gdk.Colormap" />
<Parameter Name="mask" Type="Gdk.Bitmap&amp;" RefType="out" />
<Parameter Name="transparent_color" Type="Gdk.Color" />
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<summary>Create a pixmap from XPM data using a colormap.</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param>
<param name="mask">a <see cref="T:Gdk.Bitmap" /></param>
<param name="transparent_color">a <see cref="T:Gdk.Color" /></param>
<param name="data">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColormapCreateFromXpm">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpm (Gdk.Drawable drawable, Gdk.Colormap colormap, string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="colormap" Type="Gdk.Colormap" />
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ColormapCreateFromXpmD">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap ColormapCreateFromXpmD (Gdk.Drawable drawable, Gdk.Colormap colormap, string data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="colormap" Type="Gdk.Colormap" />
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="colormap">a <see cref="T:Gdk.Colormap" /></param>
<param name="data">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CreateFromXpm">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpm (Gdk.Drawable drawable, string filename);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="filename">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="CreateFromXpmD">
<MemberSignature Language="C#" Value="public static Gdk.Pixmap CreateFromXpmD (Gdk.Drawable drawable, string data);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="drawable" Type="Gdk.Drawable" />
<Parameter Name="data" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="drawable">a <see cref="T:Gdk.Drawable" /></param>
<param name="data">a <see cref="T:System.String" /></param>
<returns>a <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>