GtkSharp/doc/en/Gtk/Image.xml
Jaime Anguiano Olarra ddc14873b2 Added some descriptions and info for all the constructors.
svn path=/trunk/gtk-sharp/; revision=14586
2003-05-14 19:22:02 +00:00

535 lines
21 KiB
XML

<Type Name="Image" FullName="Gtk.Image">
<TypeSignature Language="C#" Value="public class Image : Gtk.Misc,
Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Jaime
Anguiano Olarra" />
<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>This <see cref="T:Gtk.Widget" /> is used to display an
image. It can be used as a container for a <see cref="Gdk.Pixbuf" />
or a <see cref="Gdk.PixbufAnimation" /> to get custom interfaces.
<see cref="Gtk.Image" /> cannot launch events, it's neccessary to
include it inside a <see cref="Gtk.EventBox" /> for that purpose.</summary>
<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="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">
<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>Default parameterless constructor.</summary>
<returns>An instance of type <see cref="T:Gtk.Image" /></returns>
<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>This constructor is used to create an instance of <see
cref="Gtk.Image" /> containing the <see cref="T:Gdk.PixbufAnimation"
/> passed to it.</summary>
<param name="animation"><see cref="T:Gdk.PixbufAnimation" />
to be displayed by the Image.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<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>This constructor is used to create an instance of
<see cref="T:Gtk.Image" /> containing the image stored in the
filename whose path is given by the 'filename' parameter.</summary>
<param name="filename"><see langword="string" /> representing
the path to the image file.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<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>This constructor is used to create an instance of
<see cref="T:Gtk.Image" /> containing the <see cref="T:Gtk.IconSet"
/> and using the <see cref="T:Gtk.IconSize" /> passed to it.</summary>
<param name="icon_set"><see cref="T:Gtk.IconSet" /> to be
displayed by the Image.</param>
<param name="size"><see cref="T:Gtk.IconSize" /> to be used by
the Image.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<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>This constructor is used to create an instance of
<see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Image" />
and the <see cref="T:Gdk.Bitmap" /> passed to it.</summary>
<param name="image"><see cref="T:Gdk.Image" /> to be displayed
by the Image.</param>
<param name="mask"><see cref="T:Gdk.Bitmap" /> mask to be used.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<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>This constructor is used to create an instance of
<see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Pixbuf" />
passed to it.</summary>
<param name="pixbuf"><see cref="T:Gdk.Pixbuf" /> to be
displayed by the Image.</param>
<returns>To be added: an object of type 'Gtk.Image'An instance of type <see cref="T:Gtk.Image" />.</returns>
<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>This constructor is used to create an instance of
<see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Pixmap"
/> and the <see cref="Gtk.Bitmap" /> mask passed to it.</summary>
<param name="pixmap"><see cref="T:Gdk.Pixmap" /> displayed by
the Image.</param>
<param name="mask"><see cref="T:Gdk.Bitmap" /> mask used by
the Image.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<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>This constructor is used to create an instance of
<see cref="T:Gtk.Image" /> containing the <see cref="Gtk.Stock" />
represented by the <see langword="string" /> passed to it and with the
size represented by the <see cref="Gtk.IconSize" /> passed.</summary>
<param name="stock_id"><see langword="string" /> identifier
for the <see cref="Gtk.Stock" />.</param>
<param name="size"><see cref="Gtk.IconSize" /> used by the Image.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<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>Gets or sets the <see cref="T:Gdk.Pixbuf" />
associated to the Image.</summary>
<param name="value"><see cref="T:Gdk.Pixbuf" /> that will be
set to the Image.</param>
<returns><see cref="T:Gtk.Pixbuf" /> that the Image contains.</returns>
<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>Gets or sets the <see cref="T:Gtk.Iconset" />
associated to the Image.</summary>
<param name="value"><see cref="T:Gtk.Iconset" /> that will be
set to the Image.</param>
<returns><see cref="T:Gtk.Iconset" /> that the Image contains.</returns>
<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>Gets or sets the <see cref="T:Gdk.PixbufAnimation" />
associated to the Image.</summary>
<param name="value"><see cref="T:Gdk.PixbufAnimation" /> that will be
set to the Image.</param>
<returns><see cref="T:Gtk.PixbufAnimation" /> that the Image contains.</returns>
<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>Gets or sets the <see cref="T:Gdk.Pixmap" />
associated to the Image.</summary>
<param name="value"><see cref="T:Gdk.Pixmap" /> that will be
set to the Image.</param>
<returns><see cref="T:Gtk.Pixmap" /> that the Image contains.</returns>
<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>Gets or sets the <see cref="T:Gdk.Image" />
associated to the Image.</summary>
<param name="value"><see cref="T:Gdk.Image" /> that will be
set to the Image.</param>
<returns><see cref="T:Gdk.Image" /> that the Image contains.</returns>
<remarks />
<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>