GtkSharp/doc/en/Gtk/Image.xml

519 lines
20 KiB
XML
Raw Normal View History

<Type Name="Image" FullName="Gtk.Image">
<TypeSignature Language="C#" Value="public class Image : Gtk.Misc, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>gtk-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>Gtk.Misc</BaseTypeName>
</Base>
<Interfaces>
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
</Interfaces>
<Attributes />
<Members>
<Member MemberName="TypeGetType" Deprecated="true">
<MemberSignature Language="C#" Value="public static uint TypeGetType ();" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'uint'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetFromIconSet">
<MemberSignature Language="C#" Value="public void SetFromIconSet (Gtk.IconSet icon_set, Gtk.IconSize size);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="icon_set" Type="Gtk.IconSet" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="icon_set">To be added: an object of type 'Gtk.IconSet'</param>
<param name="size">To be added: an object of type 'Gtk.IconSize'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetFromImage">
<MemberSignature Language="C#" Value="public void SetFromImage (Gdk.Image gdk_image, Gdk.Bitmap mask);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="gdk_image" Type="Gdk.Image" />
<Parameter Name="mask" Type="Gdk.Bitmap" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="gdk_image">To be added: an object of type 'Gdk.Image'</param>
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetFromStock">
<MemberSignature Language="C#" Value="public void SetFromStock (string stock_id, Gtk.IconSize size);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">To be added: an object of type 'string'</param>
<param name="size">To be added: an object of type 'Gtk.IconSize'</param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="SetFromPixmap">
<MemberSignature Language="C#" Value="public void SetFromPixmap (Gdk.Pixmap pixmap, Gdk.Bitmap mask);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="pixmap" Type="Gdk.Pixmap" />
<Parameter Name="mask" Type="Gdk.Bitmap" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixmap">To be added: an object of type 'Gdk.Pixmap'</param>
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
<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 Image (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 Image, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.Image" /> 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 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 ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Image'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (Gdk.PixbufAnimation animation);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="animation" Type="Gdk.PixbufAnimation" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="animation">To be added: an object of type 'Gdk.PixbufAnimation'</param>
<returns>To be added: an object of type 'Gtk.Image'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (string filename);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="filename">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gtk.Image'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (Gtk.IconSet icon_set, Gtk.IconSize size);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="icon_set" Type="Gtk.IconSet" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="icon_set">To be added: an object of type 'Gtk.IconSet'</param>
<param name="size">To be added: an object of type 'Gtk.IconSize'</param>
<returns>To be added: an object of type 'Gtk.Image'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (Gdk.Image image, Gdk.Bitmap mask);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="image" Type="Gdk.Image" />
<Parameter Name="mask" Type="Gdk.Bitmap" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="image">To be added: an object of type 'Gdk.Image'</param>
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
<returns>To be added: an object of type 'Gtk.Image'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (Gdk.Pixbuf pixbuf);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixbuf">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gtk.Image'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (Gdk.Pixmap pixmap, Gdk.Bitmap mask);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="pixmap" Type="Gdk.Pixmap" />
<Parameter Name="mask" Type="Gdk.Bitmap" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="pixmap">To be added: an object of type 'Gdk.Pixmap'</param>
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param>
<returns>To be added: an object of type 'Gtk.Image'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (string stock_id, Gtk.IconSize size);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="stock_id">To be added: an object of type 'string'</param>
<param name="size">To be added: an object of type 'Gtk.IconSize'</param>
<returns>To be added: an object of type 'Gtk.Image'</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 Gtk.Image</summary>
<returns>The GLib Type for the Gtk.Image class.</returns>
<remarks />
</Docs>
</Member>
<Member MemberName="FromPixbuf">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf FromPixbuf { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Animation">
<MemberSignature Language="C#" Value="public Gdk.PixbufAnimation Animation { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.PixbufAnimation</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gdk.PixbufAnimation'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FromAnimation">
<MemberSignature Language="C#" Value="public Gdk.PixbufAnimation FromAnimation { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.PixbufAnimation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gdk.PixbufAnimation" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.PixbufAnimation'</param>
<returns>To be added: an object of type 'Gdk.PixbufAnimation'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FromFile">
<MemberSignature Language="C#" Value="public string FromFile { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Stock">
<MemberSignature Language="C#" Value="public string Stock { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</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>
<Parameter Name="value" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IconSize">
<MemberSignature Language="C#" Value="public int IconSize { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="File">
<MemberSignature Language="C#" Value="public string File { set; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="StorageType">
<MemberSignature Language="C#" Value="public Gtk.ImageType StorageType { get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.ImageType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.ImageType'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="IconSet">
<MemberSignature Language="C#" Value="public Gtk.IconSet IconSet { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.IconSet</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gtk.IconSet" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gtk.IconSet'</param>
<returns>To be added: an object of type 'Gtk.IconSet'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="PixbufAnimation">
<MemberSignature Language="C#" Value="public Gdk.PixbufAnimation PixbufAnimation { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.PixbufAnimation</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gdk.PixbufAnimation" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.PixbufAnimation'</param>
<returns>To be added: an object of type 'Gdk.PixbufAnimation'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Mask">
<MemberSignature Language="C#" Value="public Gdk.Pixmap Mask { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gdk.Pixmap" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixmap'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="Pixmap">
<MemberSignature Language="C#" Value="public Gdk.Pixmap Pixmap { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Pixmap</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gdk.Pixmap" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixmap'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="ImageProp">
<MemberSignature Language="C#" Value="public Gdk.Image ImageProp { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.Image</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="value" Type="Gdk.Image" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Image'</param>
<returns>To be added: an object of type 'Gdk.Image'</returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected Image (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 Image, using the GLib-provided type</returns>
<remarks>
<para>This is a constructor used by derivative types of <see cref="T:Gtk.Image" /> that would have their own GLib type assigned to it. This is not typically used by C# code.</para>
</remarks>
</Docs>
</Member>
</Members>
</Type>