GtkSharp/doc/en/Gtk/Image.xml

757 lines
33 KiB
XML
Raw Normal View History

<Type Name="Image" FullName="Gtk.Image">
<TypeSignature Language="C#" Maintainer="Jaime&#xA; Anguiano Olarra" Value="public class Image : Gtk.Misc" />
<TypeSignature Language="ILAsm" Value=".class public auto ansi beforefieldinit Image extends Gtk.Misc" />
<AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
</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>
<Base>
<BaseTypeName>Gtk.Misc</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Docs>
<summary>
<see cref="T:Gtk.Widget" /> used to display an image. </summary>
<remarks>
<see cref="T:Gtk.Image" /> can be used as a container for a <see cref="T:Gdk.Pixbuf" />
or a <see cref="T:Gdk.PixbufAnimation" /> to get custom interfaces.
<see cref="T:Gtk.Image" /> cannot launch events, it is necessary to
include it inside an <see cref="T:Gtk.EventBox" /> for that purpose.
</remarks>
</Docs>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor() cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>Default parameterless constructor.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (Gdk.Pixbuf pixbuf);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Gdk.Pixbuf pixbuf) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
</Parameters>
<Docs>
<param name="pixbuf">
<see cref="T:Gdk.Pixbuf" /> to be
displayed by the Image.</param>
<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>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (Gdk.PixbufAnimation animation);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Gdk.PixbufAnimation animation) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="animation" Type="Gdk.PixbufAnimation" />
</Parameters>
<Docs>
<param name="animation">
<see cref="T:Gdk.PixbufAnimation" />
to be displayed by the Image.
</param>
<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>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (IntPtr raw);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<param name="raw">Pointer to the C object.</param>
<summary>Internal constructor</summary>
<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 (System.IO.Stream stream);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.IO.Stream stream) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="stream" Type="System.IO.Stream" />
</Parameters>
<Docs>
<param name="stream">a <see cref="T:System.IO.Stream" /></param>
<summary>Loads an image from a <see cref="T:System.IO.Stream" />.</summary>
<remarks>
This is equivalent to calling <see cref="C:Gdk.Pixbuf(System.IO.Stream)" />
or <see cref="C:Gdk.PixbufAnimation(System.IO.Stream)" /> and then creating
an <see cref="T:Gtk.Image" /> from the resulting pixbuf.
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (string filename);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string filename) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="filename" Type="System.String" />
</Parameters>
<Docs>
<param name="filename">
<see langword="string" /> representing
the path to the image file.</param>
<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>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (GLib.IIcon icon, Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class GLib.IIcon icon, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Constructor</MemberType>
<Parameters>
<Parameter Name="icon" Type="GLib.IIcon" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<param name="icon">To be added.</param>
<param name="size">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (Gtk.IconSet icon_set, Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class Gtk.IconSet icon_set, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="icon_set" Type="Gtk.IconSet" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<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>
<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>
<remarks />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (System.Reflection.Assembly assembly, string resource);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(class System.Reflection.Assembly assembly, string resource) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="assembly" Type="System.Reflection.Assembly" />
<Parameter Name="resource" Type="System.String" />
</Parameters>
<Docs>
<param name="assembly">The <see cref="T:System.Reflection.Assembly" /> that contains the image.
<para>
If the value is <see langword="null" />, the image will be looked up on the calling assembly.</para></param>
<param name="resource">The name given as the resource in the assembly</param>
<summary>Loads an image embedded in an assembly</summary>
<remarks>
This is equivalent to calling
<see cref="C:Gdk.Pixbuf(System.Reflection.Assembly,System.String)" /> or
<see cref="C:Gdk.PixbufAnimation(System.Reflection.Assembly,System.String)" />
and then creating an <see cref="T:Gtk.Image" /> from the resulting pixbuf.
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public Image (string stock_id, Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig specialname rtspecialname instance void .ctor(string stock_id, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="stock_id" Type="System.String" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<param name="stock_id">
<see langword="string" /> identifier
for the <see cref="T:Gtk.Stock" />.</param>
<param name="size">
<see cref="T:Gtk.IconSize" /> used by the Image.</param>
<summary>This constructor is used to create an instance of
<see cref="T:Gtk.Image" /> containing the <see cref="T:Gtk.Stock" />
represented by the <see langword="string" /> passed to it and with the
size represented by the <see cref="T:Gtk.IconSize" /> passed.</summary>
<remarks />
</Docs>
</Member>
<Member MemberName="Animation">
<MemberSignature Language="C#" Value="public Gdk.PixbufAnimation Animation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gdk.PixbufAnimation Animation" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gdk.PixbufAnimation</ReturnType>
</ReturnValue>
<Docs>
<summary>Get the animation for this image.</summary>
<value>an object of type <see cref="T:Gdk.PixbufAnimation" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="Clear">
<MemberSignature Language="C#" Value="public void Clear ();" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void Clear() cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>Resets the image to be empty.</summary>
<remarks />
<since version="Gtk# 2.6" />
</Docs>
</Member>
<Member MemberName="File">
<MemberSignature Language="C#" Value="public string File { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string File" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("file")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The file this image was loaded from.</summary>
<value>an object of type <see cref="T:System.String" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="FromAnimation">
<MemberSignature Language="C#" Value="public Gdk.PixbufAnimation FromAnimation { set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gdk.PixbufAnimation FromAnimation" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Use the Animation property instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gdk.PixbufAnimation</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Causes the Image object to display the given animation (or display nothing, if you set the animation to <see langword="null" />).</summary>
<value>an object of type <see cref="T:Gdk.PixbufAnimation" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="FromFile">
<MemberSignature Language="C#" Value="public string FromFile { set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string FromFile" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Use the File property instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>
<p>Creates a new <see cref="T:Gtk.Image" /> displaying the file <paramref name="filename" /> If the file
isn't found or can't be loaded, the resulting Image will
display a "broken image" icon. This function never returns <see langword="null" />,
it always returns a valid Image widget.
If the file contains an animation, the image will contain an
animation.</p>
<p>If you need to detect failures to load the file, use
<see cref="M:Gdk.Pixbuf" /> to load the file yourself, then create
the Image from the pixbuf. (Or for animations, use
<see cref="M:Gdk.PixbufAnimation" />).</p>
<p>The storage type (<see cref="P:Gtk.Image.StorageType" />) of the returned
image is not defined, it will be whatever is appropriate for
displaying the file.</p>
</summary>
<value>an object of type <see cref="T:System.String" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="FromPixbuf">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf FromPixbuf { set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gdk.Pixbuf FromPixbuf" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>System.Obsolete("Use the Pixbuf property instead")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Creates a <see cref="T:Gtk.Image" /> displaying <see cref="T:Gdk.Pixbuf" />.</summary>
<value>an object of type <see cref="T:Gdk.Pixbuf" /></value>
<remarks>Creates a <see cref="T:Gtk.Image" /> displaying <see cref="T:Gdk.Pixbuf" />.</remarks>
</Docs>
</Member>
<Member MemberName="GetIcon">
<MemberSignature Language="C#" Value="public void GetIcon (out GLib.IIcon gicon, out Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetIcon(class GLib.IIcon gicon, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="gicon" Type="GLib.IIcon&amp;" RefType="out" />
<Parameter Name="size" Type="Gtk.IconSize&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="gicon">To be added.</param>
<param name="size">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="GetIconName">
<MemberSignature Language="C#" Value="public void GetIconName (out string icon_name, out Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetIconName(string icon_name, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="icon_name" Type="System.String&amp;" RefType="out" />
<Parameter Name="size" Type="Gtk.IconSize&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="icon_name">To be added.</param>
<param name="size">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
</Docs>
</Member>
<Member MemberName="GetIconSet">
<MemberSignature Language="C#" Value="public void GetIconSet (out Gtk.IconSet icon_set, out Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetIconSet(class Gtk.IconSet icon_set, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="icon_set" Type="Gtk.IconSet&amp;" RefType="out" />
<Parameter Name="size" Type="Gtk.IconSize&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="icon_set">the <see cref="T:Gtk.IconSet" /></param>
<param name="size">the icon size, a <see cref="T:Gtk.IconSize" /></param>
<summary>Get the icon set and size, if this image is using an icon set</summary>
<remarks>If the <see cref="T:Gtk.Image" /> is displaying an image from an icon set, this method can be used to retrieve the icon set and the size.</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="GetStock">
<MemberSignature Language="C#" Value="public void GetStock (out string stock_id, out Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void GetStock(string stock_id, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="stock_id" Type="System.String&amp;" RefType="out" />
<Parameter Name="size" Type="Gtk.IconSize&amp;" RefType="out" />
</Parameters>
<Docs>
<param name="stock_id">the stock item name</param>
<param name="size">the stock item size, a <see cref="T:Gtk.IconSize" /></param>
<summary>Get the stock item name and size, if this is a stock image</summary>
<remarks>
If the <see cref="T:Gtk.Image" /> is displaying a stock image, this method can be used to retrieve the stock item name and the size.
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="GType">
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; }" />
<MemberSignature Language="ILAsm" Value=".property valuetype GLib.GType GType" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>GLib.GType</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>GType Property.</summary>
<value>a <see cref="T:GLib.GType" /></value>
<remarks>Returns the native <see cref="T:GLib.GType" /> value for <see cref="T:Gtk.Image" />.</remarks>
</Docs>
</Member>
<Member MemberName="Icon">
<MemberSignature Language="C#" Value="public GLib.IIcon Icon { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class GLib.IIcon Icon" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("gicon")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>GLib.IIcon</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="IconName">
<MemberSignature Language="C#" Value="public string IconName { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string IconName" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("icon-name")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.String" /></value>
<remarks>To be added</remarks>
<since version="Gtk# 2.6" />
</Docs>
</Member>
<Member MemberName="IconSet">
<MemberSignature Language="C#" Value="public Gtk.IconSet IconSet { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gtk.IconSet IconSet" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("icon-set")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gtk.IconSet</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Gets or sets the <see cref="T:Gtk.Iconset" />
associated to the Image.</summary>
<value>
<see cref="T:Gtk.Iconset" /> that the Image contains.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="IconSize">
<MemberSignature Language="C#" Value="public int IconSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 IconSize" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("icon-size")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The size (dimension on a side) for a square icon.</summary>
<value>an object of type <see cref="T:System.Int32" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="LoadFromResource">
<MemberSignature Language="C#" Value="public static Gtk.Image LoadFromResource (string resource);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gtk.Image LoadFromResource(string resource) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Image</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="resource" Type="System.String" />
</Parameters>
<Docs>
<param name="resource">the name of the resource</param>
<summary>Loads an image from a resource file.</summary>
<returns>a <see cref="T:Gtk.Image" /></returns>
<remarks>
This load an image from a resource in the calling assembly. This is
equivalent to using the
<see cref="C:Gtk.Image(System.Reflection.Assembly, System.String)" />
constructor with a <see langword="null" /> assembly.
</remarks>
<since version="Gtk# 2.4" />
</Docs>
</Member>
<Member MemberName="NewFromIconName">
<MemberSignature Language="C#" Value="public static Gtk.Image NewFromIconName (string icon_name, Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public static hidebysig class Gtk.Image NewFromIconName(string icon_name, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>Gtk.Image</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="icon_name" Type="System.String" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<param name="icon_name">a <see cref="T:System.String" /></param>
<param name="size">a <see cref="T:System.Int32" /></param>
<summary>To be added</summary>
<returns>a <see cref="T:Gtk.Image" /></returns>
<remarks>To be added</remarks>
<since version="Gtk# 2.6" />
</Docs>
</Member>
<Member MemberName="Pixbuf">
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Pixbuf { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gdk.Pixbuf Pixbuf" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("pixbuf")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gdk.Pixbuf</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Gets or sets the <see cref="T:Gdk.Pixbuf" />
associated to the Image.</summary>
<value>
<see cref="T:Gtk.Pixbuf" /> that the Image contains.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="PixbufAnimation">
<MemberSignature Language="C#" Value="public Gdk.PixbufAnimation PixbufAnimation { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance class Gdk.PixbufAnimation PixbufAnimation" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("pixbuf-animation")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gdk.PixbufAnimation</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Gets or sets the <see cref="T:Gdk.PixbufAnimation" />
associated to the Image.</summary>
<value>
<see cref="T:Gtk.PixbufAnimation" /> that the Image contains.</value>
<remarks />
</Docs>
</Member>
<Member MemberName="PixelSize">
<MemberSignature Language="C#" Value="public int PixelSize { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance int32 PixelSize" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("pixel-size")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<value>a <see cref="T:System.Int32" /></value>
<remarks>To be added</remarks>
<since version="Gtk# 2.6" />
</Docs>
</Member>
<Member MemberName="SetFromIcon">
<MemberSignature Language="C#" Value="public void SetFromIcon (GLib.IIcon icon, Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetFromIcon(class GLib.IIcon icon, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="icon" Type="GLib.IIcon" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<param name="icon">To be added.</param>
<param name="size">To be added.</param>
<summary>To be added.</summary>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
<Member MemberName="SetFromIconName">
<MemberSignature Language="C#" Value="public void SetFromIconName (string icon_name, Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetFromIconName(string icon_name, valuetype Gtk.IconSize size) cil managed" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="icon_name" Type="System.String" />
<Parameter Name="size" Type="Gtk.IconSize" />
</Parameters>
<Docs>
<param name="icon_name">a <see cref="T:System.String" /></param>
<param name="size">a <see cref="T:System.Int32" /></param>
<summary>To be added</summary>
<remarks>To be added</remarks>
<since version="Gtk# 2.6" />
</Docs>
</Member>
<Member MemberName="SetFromIconSet">
<MemberSignature Language="C#" Value="public void SetFromIconSet (Gtk.IconSet icon_set, Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetFromIconSet(class Gtk.IconSet icon_set, valuetype Gtk.IconSize size) cil managed" />
<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>
<param name="icon_set">an object of type <see cref="T:Gtk.IconSet" /></param>
<param name="size">an object of type <see cref="T:Gtk.IconSize" /></param>
<summary>Creates a <see cref="T:Gtk.Image" /> displaying an <see cref="T:Gtk.IconSet" />.</summary>
<remarks>
Creates a <see cref="T:Gtk.Image" /> displaying an <see cref="T:Gtk.IconSet" />.
Sample stock sizes are <see cref="F:Gtk.IconSize.Menu" />, <see cref="F:Gtk.IconSize.SmallToolbar" />.
Instead of using this function, usually it is better to create a <see cref="T:Gtk.IconFactory" />, put your <see cref="T:Gtk.IconSet" /> in the <see cref="T:Gtk.IconFactory" />,
add the <see cref="T:Gtk.IconFactory" /> to the list of default factories with <see cref="M:Gtk.IconFactory.AddDefault()" />, and then use <see cref="M:Gtk.Image.SetFromStock(System.String,Gtk.IconSize)" />.
This will allow themes to override the icon you ship with your application.
</remarks>
</Docs>
</Member>
<Member MemberName="SetFromStock">
<MemberSignature Language="C#" Value="public void SetFromStock (string stock_id, Gtk.IconSize size);" />
<MemberSignature Language="ILAsm" Value=".method public hidebysig instance void SetFromStock(string stock_id, valuetype Gtk.IconSize size) cil managed" />
<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>
<param name="stock_id">an object of type <see cref="T:System.String" /></param>
<param name="size">an object of type <see cref="T:Gtk.IconSize" /></param>
<summary>Creates a <see cref="T:Gtk.Image" /> displaying a stock icon.</summary>
<remarks>
Creates a <see cref="T:Gtk.Image" /> displaying a stock icon.
Sample stock icon names are <see cref="P:Gtk.Stock.Open" />, <see cref="P:Gtk.Stock.Ok" />.
Sample stock sizes are <see cref="F:Gtk.IconSize.Menu" />, <see cref="F:Gtk.IconSize.SmallToolbar" />.
If the stock icon name is not known, a "broken image" icon will be displayed instead.
You can register your own stock icon names, see <see cref="M:Gtk.IconFactory.AddDefault()" /> and <see cref="M:Gtk.IconFactory.Add(System.String,Gtk.IconSet)" />.
</remarks>
</Docs>
</Member>
<Member MemberName="Stock">
<MemberSignature Language="C#" Value="public string Stock { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance string Stock" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("stock")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>A stock item name, if this is a stock image.</summary>
<value>an object of type <see cref="T:System.String" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="StorageType">
<MemberSignature Language="C#" Value="public Gtk.ImageType StorageType { get; }" />
<MemberSignature Language="ILAsm" Value=".property instance valuetype Gtk.ImageType StorageType" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("storage-type")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>Gtk.ImageType</ReturnType>
</ReturnValue>
<Docs>
<summary>The type of representation being used by the
<see cref="T:Gtk.Image" />
to store image data. If the Image has no image data,
the return value will be <see cref="P:Gtk.ImageType.Empty" />.
</summary>
<value>an object of type <see cref="T:Gtk.ImageType" /></value>
<remarks />
</Docs>
</Member>
<Member MemberName="UseFallback">
<MemberSignature Language="C#" Value="public bool UseFallback { get; set; }" />
<MemberSignature Language="ILAsm" Value=".property instance bool UseFallback" />
<MemberType>Property</MemberType>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("use-fallback")</AttributeName>
</Attribute>
</Attributes>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added.</summary>
<value>To be added.</value>
<remarks>To be added.</remarks>
<since version="Gtk# 3.0" />
</Docs>
</Member>
</Members>
</Type>