2003-02-12 02:00:12 +00:00
<Type Name= "Image" FullName= "Gtk.Image" >
2005-05-23 20:41:51 +00:00
<TypeSignature Language= "C#" Maintainer= "Jaime
 Anguiano Olarra" Value= "public class Image : Gtk.Misc" />
2011-11-09 16:01:51 +00:00
<TypeSignature Language= "ILAsm" Value= ".class public auto ansi beforefieldinit Image extends Gtk.Misc" />
2003-02-12 02:00:12 +00:00
<AssemblyInfo >
<AssemblyName > gtk-sharp</AssemblyName>
2003-12-24 01:35:30 +00:00
<AssemblyPublicKey >
</AssemblyPublicKey>
2003-02-12 02:00:12 +00:00
</AssemblyInfo>
2003-02-23 07:26:30 +00:00
<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>
2011-11-09 16:01:51 +00:00
<Base >
<BaseTypeName > Gtk.Misc</BaseTypeName>
</Base>
<Interfaces >
</Interfaces>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-17 06:38:40 +00:00
<summary >
<see cref= "T:Gtk.Widget" /> used to display an image. </summary>
2003-06-12 04:17:57 +00:00
<remarks >
2003-07-17 06:38:40 +00:00
<see cref= "T:Gtk.Image" /> can be used as a container for a <see cref= "T:Gdk.Pixbuf" />
2003-07-08 18:44:29 +00:00
or a <see cref= "T:Gdk.PixbufAnimation" /> to get custom interfaces.
<see cref= "T:Gtk.Image" /> cannot launch events, it is necessary to
2008-04-08 18:23:04 +00:00
include it inside an <see cref= "T:Gtk.EventBox" /> for that purpose.
2003-06-12 04:17:57 +00:00
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
<Members >
2011-11-09 16:01:51 +00:00
<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 />
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Default parameterless constructor.</summary>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<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 />
2003-02-12 02:00:12 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "pixbuf" Type= "Gdk.Pixbuf" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<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 />
2003-02-12 02:00:12 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "animation" Type= "Gdk.PixbufAnimation" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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 />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Image (IntPtr raw);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(native int raw) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "raw" Type= "System.IntPtr" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-02-23 07:26:30 +00:00
<param name= "raw" > Pointer to the C object.</param>
2011-11-09 16:01:51 +00:00
<summary > Internal constructor</summary>
2003-02-23 07:26:30 +00:00
<remarks >
<para > This is an internal constructor, and should not be used by user code.</para>
</remarks>
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
2011-11-09 16:01:51 +00:00
<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" />
2003-02-12 02:00:12 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "stream" Type= "System.IO.Stream" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Image (string filename);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(string filename) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "filename" Type= "System.String" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-17 06:38:40 +00:00
<param name= "filename" >
<see langword= "string" /> representing
2003-05-14 19:22:02 +00:00
the path to the image file.</param>
2011-11-09 16:01:51 +00:00
<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>
2003-05-14 19:22:02 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= ".ctor" >
2013-11-30 15:01:53 +00:00
<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" />
2011-11-09 16:01:51 +00:00
<MemberType > Constructor</MemberType>
<Parameters >
2013-11-30 15:01:53 +00:00
<Parameter Name= "icon" Type= "GLib.IIcon" />
2011-11-09 16:01:51 +00:00
<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>
2003-02-12 02:00:12 +00:00
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Image (Gtk.IconSet icon_set, Gtk.IconSize size);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(class Gtk.IconSet icon_set, valuetype Gtk.IconSize size) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "icon_set" Type= "Gtk.IconSet" />
<Parameter Name= "size" Type= "Gtk.IconSize" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-17 06:38:40 +00:00
<param name= "icon_set" >
<see cref= "T:Gtk.IconSet" /> to be
2003-05-14 19:22:02 +00:00
displayed by the Image.</param>
2003-07-17 06:38:40 +00:00
<param name= "size" >
<see cref= "T:Gtk.IconSize" /> to be used by
2003-05-14 19:22:02 +00:00
the Image.</param>
<summary > This constructor is used to create an instance of
2011-11-09 16:01:51 +00:00
<see cref= "T:Gtk.Image" /> containing the <see cref= "T:Gtk.IconSet" /> and using the <see cref= "T:Gtk.IconSize" /> passed to it.</summary>
2003-05-14 19:22:02 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
2011-11-09 16:01:51 +00:00
<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" />
2003-02-12 02:00:12 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "assembly" Type= "System.Reflection.Assembly" />
<Parameter Name= "resource" Type= "System.String" />
2003-09-17 21:56:59 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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>
2005-06-16 18:56:42 +00:00
<since version= "Gtk# 2.4" />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= ".ctor" >
<MemberSignature Language= "C#" Value= "public Image (string stock_id, Gtk.IconSize size);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig specialname rtspecialname instance void .ctor(string stock_id, valuetype Gtk.IconSize size) cil managed" />
2003-02-12 02:00:12 +00:00
<MemberType > Constructor</MemberType>
<ReturnValue />
<Parameters >
2003-09-17 21:56:59 +00:00
<Parameter Name= "stock_id" Type= "System.String" />
<Parameter Name= "size" Type= "Gtk.IconSize" />
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2003-07-17 06:38:40 +00:00
<param name= "stock_id" >
<see langword= "string" /> identifier
2003-07-08 18:44:29 +00:00
for the <see cref= "T:Gtk.Stock" /> .</param>
2003-07-17 06:38:40 +00:00
<param name= "size" >
<see cref= "T:Gtk.IconSize" /> used by the Image.</param>
2011-11-09 16:01:51 +00:00
<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>
2003-05-14 19:22:02 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "Animation" >
<MemberSignature Language= "C#" Value= "public Gdk.PixbufAnimation Animation { get; set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance class Gdk.PixbufAnimation Animation" />
2003-02-12 02:00:12 +00:00
<MemberType > Property</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > Gdk.PixbufAnimation</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Get the animation for this image.</summary>
<value > an object of type <see cref= "T:Gdk.PixbufAnimation" /> </value>
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<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" />
2003-02-12 02:00:12 +00:00
<MemberType > Property</MemberType>
2011-11-09 16:01:51 +00:00
<Attributes >
<Attribute >
<AttributeName > GLib.Property("file")</AttributeName>
</Attribute>
</Attributes>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.String</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > The file this image was loaded from.</summary>
<value > an object of type <see cref= "T:System.String" /> </value>
2004-11-05 21:25:40 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "FromAnimation" >
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "C#" Value= "public Gdk.PixbufAnimation FromAnimation { set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance class Gdk.PixbufAnimation FromAnimation" />
2003-02-12 02:00:12 +00:00
<MemberType > Property</MemberType>
2011-11-09 16:01:51 +00:00
<Attributes >
<Attribute >
<AttributeName > System.Obsolete("Use the Animation property instead")</AttributeName>
</Attribute>
</Attributes>
2003-02-12 02:00:12 +00:00
<ReturnValue >
<ReturnType > Gdk.PixbufAnimation</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-11-05 21:25:40 +00:00
<summary > Causes the Image object to display the given animation (or display nothing, if you set the animation to <see langword= "null" /> ).</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:Gdk.PixbufAnimation" /> </value>
2004-11-05 21:25:40 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
<Member MemberName= "FromFile" >
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "C#" Value= "public string FromFile { set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance string FromFile" />
2003-02-12 02:00:12 +00:00
<MemberType > Property</MemberType>
2011-11-09 16:01:51 +00:00
<Attributes >
<Attribute >
<AttributeName > System.Obsolete("Use the File property instead")</AttributeName>
</Attribute>
</Attributes>
2003-02-12 02:00:12 +00:00
<ReturnValue >
<ReturnType > System.String</ReturnType>
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2004-09-13 05:43:28 +00:00
<summary >
2004-11-05 21:25:40 +00:00
<p > Creates a new <see cref= "T:Gtk.Image" /> displaying the file <paramref name= "filename" /> If the file
2004-09-13 05:43:28 +00:00
isn't found or can't be loaded, the resulting Image will
2004-11-05 21:25:40 +00:00
display a "broken image" icon. This function never returns <see langword= "null" /> ,
2004-09-13 05:43:28 +00:00
it always returns a valid Image widget.
If the file contains an animation, the image will contain an
animation.</p>
2004-11-05 21:25:40 +00:00
<p > If you need to detect failures to load the file, use
<see cref= "M:Gdk.Pixbuf" /> to load the file yourself, then create
2004-09-13 05:43:28 +00:00
the Image from the pixbuf. (Or for animations, use
2004-11-05 21:25:40 +00:00
<see cref= "M:Gdk.PixbufAnimation" /> ).</p>
<p > The storage type (<see cref= "P:Gtk.Image.StorageType" /> ) of the returned
2004-09-13 05:43:28 +00:00
image is not defined, it will be whatever is appropriate for
displaying the file.</p>
2004-11-05 21:25:40 +00:00
</summary>
2005-05-23 20:41:51 +00:00
<value > an object of type <see cref= "T:System.String" /> </value>
2004-11-05 21:25:40 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "FromPixbuf" >
<MemberSignature Language= "C#" Value= "public Gdk.Pixbuf FromPixbuf { set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance class Gdk.Pixbuf FromPixbuf" />
2003-02-12 02:00:12 +00:00
<MemberType > Property</MemberType>
2011-11-09 16:01:51 +00:00
<Attributes >
<Attribute >
<AttributeName > System.Obsolete("Use the Pixbuf property instead")</AttributeName>
</Attribute>
</Attributes>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > Gdk.Pixbuf</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "GetIcon" >
2013-11-30 15:01:53 +00:00
<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" />
2011-11-09 16:01:51 +00:00
<MemberType > Method</MemberType>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
2013-11-30 15:01:53 +00:00
<Parameter Name= "gicon" Type= "GLib.IIcon&" RefType= "out" />
2011-11-09 16:01:51 +00:00
<Parameter Name= "size" Type= "Gtk.IconSize&" RefType= "out" />
2003-12-24 01:35:30 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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" />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2011-11-09 16:01:51 +00:00
<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>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "icon_name" Type= "System.String&" RefType= "out" />
<Parameter Name= "size" Type= "Gtk.IconSize&" RefType= "out" />
2003-12-24 01:35:30 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2011-11-09 16:01:51 +00:00
<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>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "icon_set" Type= "Gtk.IconSet&" RefType= "out" />
<Parameter Name= "size" Type= "Gtk.IconSize&" RefType= "out" />
2003-12-24 01:35:30 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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" />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2011-11-09 16:01:51 +00:00
<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>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "stock_id" Type= "System.String&" RefType= "out" />
<Parameter Name= "size" Type= "Gtk.IconSize&" RefType= "out" />
2003-12-24 01:35:30 +00:00
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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" />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "GType" >
<MemberSignature Language= "C#" Value= "public static GLib.GType GType { get; }" />
<MemberSignature Language= "ILAsm" Value= ".property valuetype GLib.GType GType" />
2003-02-12 02:00:12 +00:00
<MemberType > Property</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > GLib.GType</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters />
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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>
2003-02-12 02:00:12 +00:00
</Docs>
2011-11-09 16:01:51 +00:00
</Member>
<Member MemberName= "Icon" >
2013-11-30 15:01:53 +00:00
<MemberSignature Language= "C#" Value= "public GLib.IIcon Icon { get; set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance class GLib.IIcon Icon" />
2011-11-09 16:01:51 +00:00
<MemberType > Property</MemberType>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2011-11-09 16:01:51 +00:00
<AttributeName > GLib.Property("gicon")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2013-11-30 15:01:53 +00:00
<ReturnType > GLib.IIcon</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
<Docs >
2011-11-09 16:01:51 +00:00
<summary > To be added.</summary>
<value > To be added.</value>
<remarks > To be added.</remarks>
<since version= "Gtk# 3.0" />
2003-02-12 02:00:12 +00:00
</Docs>
2011-11-09 16:01:51 +00:00
</Member>
<Member MemberName= "IconName" >
<MemberSignature Language= "C#" Value= "public string IconName { get; set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance string IconName" />
<MemberType > Property</MemberType>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2011-11-09 16:01:51 +00:00
<AttributeName > GLib.Property("icon-name")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.String</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters />
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > To be added</summary>
<value > a <see cref= "T:System.String" /> </value>
<remarks > To be added</remarks>
<since version= "Gtk# 2.6" />
2003-07-17 06:38:40 +00:00
</Docs>
2011-11-09 16:01:51 +00:00
</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>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2011-11-09 16:01:51 +00:00
<AttributeName > GLib.Property("icon-set")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
2003-02-12 02:00:12 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > Gtk.IconSet</ReturnType>
2003-02-12 02:00:12 +00:00
</ReturnValue>
2003-12-24 01:35:30 +00:00
<Parameters >
</Parameters>
2003-02-12 02:00:12 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<summary > Gets or sets the <see cref= "T:Gtk.Iconset" />
associated to the Image.</summary>
2005-05-23 20:41:51 +00:00
<value >
2011-11-09 16:01:51 +00:00
<see cref= "T:Gtk.Iconset" /> that the Image contains.</value>
2003-05-14 19:22:02 +00:00
<remarks />
2003-02-12 02:00:12 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "IconSize" >
<MemberSignature Language= "C#" Value= "public int IconSize { get; set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance int32 IconSize" />
2003-12-24 01:35:30 +00:00
<MemberType > Property</MemberType>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2011-11-09 16:01:51 +00:00
<AttributeName > GLib.Property("icon-size")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
2004-12-17 17:55:07 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Int32</ReturnType>
2004-12-17 17:55:07 +00:00
</ReturnValue>
<Parameters >
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<summary > The size (dimension on a side) for a square icon.</summary>
<value > an object of type <see cref= "T:System.Int32" /> </value>
<remarks />
2004-12-17 17:55:07 +00:00
</Docs>
</Member>
2005-04-01 14:54:12 +00:00
<Member MemberName= "LoadFromResource" >
<MemberSignature Language= "C#" Value= "public static Gtk.Image LoadFromResource (string resource);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public static hidebysig class Gtk.Image LoadFromResource(string resource) cil managed" />
2005-04-01 14:54:12 +00:00
<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>
2011-11-09 16:01:51 +00:00
<summary > Loads an image from a resource file.</summary>
2005-04-01 14:54:12 +00:00
<returns > a <see cref= "T:Gtk.Image" /> </returns>
2005-04-21 17:10:54 +00:00
<remarks >
2005-04-01 14:54:12 +00:00
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>
2005-06-16 18:56:42 +00:00
<since version= "Gtk# 2.4" />
2005-04-01 14:54:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<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>
2005-04-01 14:54:12 +00:00
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "icon_name" Type= "System.String" />
<Parameter Name= "size" Type= "Gtk.IconSize" />
2005-04-01 14:54:12 +00:00
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<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" />
2005-04-01 14:54:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<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>
2005-04-01 14:54:12 +00:00
<Parameters >
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<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 />
2005-04-01 14:54:12 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "PixbufAnimation" >
<MemberSignature Language= "C#" Value= "public Gdk.PixbufAnimation PixbufAnimation { get; set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance class Gdk.PixbufAnimation PixbufAnimation" />
2005-04-21 17:10:54 +00:00
<MemberType > Property</MemberType>
2011-11-09 16:01:51 +00:00
<Attributes >
<Attribute >
<AttributeName > GLib.Property("pixbuf-animation")</AttributeName>
</Attribute>
</Attributes>
2005-04-21 17:10:54 +00:00
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > Gdk.PixbufAnimation</ReturnType>
2005-04-21 17:10:54 +00:00
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters >
</Parameters>
2005-04-21 17:10:54 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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 />
2005-04-21 17:10:54 +00:00
</Docs>
2011-11-09 16:01:51 +00:00
</Member>
<Member MemberName= "PixelSize" >
<MemberSignature Language= "C#" Value= "public int PixelSize { get; set; }" />
<MemberSignature Language= "ILAsm" Value= ".property instance int32 PixelSize" />
<MemberType > Property</MemberType>
2005-06-16 18:56:42 +00:00
<Attributes >
2005-05-23 20:41:51 +00:00
<Attribute >
2011-11-09 16:01:51 +00:00
<AttributeName > GLib.Property("pixel-size")</AttributeName>
2005-05-23 20:41:51 +00:00
</Attribute>
2005-06-16 18:56:42 +00:00
</Attributes>
2005-04-21 17:10:54 +00:00
<ReturnValue >
<ReturnType > System.Int32</ReturnType>
</ReturnValue>
<Parameters />
<Docs >
<summary > To be added</summary>
2005-05-23 20:41:51 +00:00
<value > a <see cref= "T:System.Int32" /> </value>
2005-04-21 17:10:54 +00:00
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
2005-06-16 18:56:42 +00:00
</Member>
2011-11-09 16:01:51 +00:00
<Member MemberName= "SetFromIcon" >
2013-11-30 15:01:53 +00:00
<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" />
2005-04-21 17:10:54 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
2011-11-09 16:01:51 +00:00
<ReturnType > System.Void</ReturnType>
2005-04-21 17:10:54 +00:00
</ReturnValue>
<Parameters >
2013-11-30 15:01:53 +00:00
<Parameter Name= "icon" Type= "GLib.IIcon" />
2005-04-21 17:10:54 +00:00
<Parameter Name= "size" Type= "Gtk.IconSize" />
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<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" />
2005-04-21 17:10:54 +00:00
</Docs>
</Member>
<Member MemberName= "SetFromIconName" >
<MemberSignature Language= "C#" Value= "public void SetFromIconName (string icon_name, Gtk.IconSize size);" />
2011-11-09 16:01:51 +00:00
<MemberSignature Language= "ILAsm" Value= ".method public hidebysig instance void SetFromIconName(string icon_name, valuetype Gtk.IconSize size) cil managed" />
2005-04-21 17:10:54 +00:00
<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>
2011-11-09 16:01:51 +00:00
<summary > To be added</summary>
2005-04-21 17:10:54 +00:00
<remarks > To be added</remarks>
2005-06-16 19:27:40 +00:00
<since version= "Gtk# 2.6" />
2005-04-21 17:10:54 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<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" />
2005-09-03 04:11:38 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
<Parameters >
2011-11-09 16:01:51 +00:00
<Parameter Name= "icon_set" Type= "Gtk.IconSet" />
<Parameter Name= "size" Type= "Gtk.IconSize" />
2005-09-03 04:11:38 +00:00
</Parameters>
<Docs >
2011-11-09 16:01:51 +00:00
<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>
2005-09-03 04:11:38 +00:00
</Docs>
</Member>
2011-11-09 16:01:51 +00:00
<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" />
2005-12-09 23:12:49 +00:00
<MemberType > Method</MemberType>
<ReturnValue >
<ReturnType > System.Void</ReturnType>
</ReturnValue>
2011-11-09 16:01:51 +00:00
<Parameters >
<Parameter Name= "stock_id" Type= "System.String" />
<Parameter Name= "size" Type= "Gtk.IconSize" />
</Parameters>
2005-12-09 23:12:49 +00:00
<Docs >
2011-11-09 16:01:51 +00:00
<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>
2005-12-09 23:12:49 +00:00
<remarks />
2011-11-09 16:01:51 +00:00
</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" />
2005-12-09 23:12:49 +00:00
</Docs>
</Member>
2003-02-12 02:00:12 +00:00
</Members>
2011-11-09 16:01:51 +00:00
</Type>