mirror of
https://github.com/Ryujinx/GtkSharp.git
synced 2024-12-28 02:45:47 +00:00
864 lines
34 KiB
XML
864 lines
34 KiB
XML
<Type Name="Image" FullName="Gtk.Image">
|
|
<TypeSignature Language="C#" Maintainer="Jaime
 Anguiano Olarra" Value="public class Image : Gtk.Misc" />
|
|
<AssemblyInfo>
|
|
<AssemblyName>gtk-sharp</AssemblyName>
|
|
<AssemblyPublicKey>
|
|
</AssemblyPublicKey>
|
|
<AssemblyVersion>2.10.0.0</AssemblyVersion>
|
|
</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>
|
|
<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 a <see cref="T:Gtk.EventBox" /> for that purpose.
|
|
</remarks>
|
|
</Docs>
|
|
<Base>
|
|
<BaseTypeName>Gtk.Misc</BaseTypeName>
|
|
</Base>
|
|
<Interfaces>
|
|
</Interfaces>
|
|
<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>Creates a <see cref="T:Gtk.Image" /> displaying an <see cref="T:Gtk.IconSet" />.</summary>
|
|
<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>
|
|
<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="SetFromImage">
|
|
<MemberSignature Language="C#" Value="public void SetFromImage (Gdk.Image gdk_image, Gdk.Pixmap mask);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="gdk_image" Type="Gdk.Image" />
|
|
<Parameter Name="mask" Type="Gdk.Pixmap" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates a <see cref="T:Gtk.Image" /> widget displaying an image with a mask.</summary>
|
|
<param name="gdk_image">an object of type <see cref="T:Gdk.Image" /></param>
|
|
<param name="mask">an object of type <see cref="T:Gdk.Pixmap" /></param>
|
|
<remarks>
|
|
Creates a <see cref="T:Gtk.Image" /> widget displaying an image with a mask.
|
|
A <see cref="T:Gdk.Image" /> is a client-side image buffer in the pixel format of the current display.
|
|
</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</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>Creates a <see cref="T:Gtk.Image" /> displaying a stock icon.</summary>
|
|
<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>
|
|
<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="SetFromPixmap">
|
|
<MemberSignature Language="C#" Value="public void SetFromPixmap (Gdk.Pixmap pixmap, Gdk.Pixmap mask);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pixmap" Type="Gdk.Pixmap" />
|
|
<Parameter Name="mask" Type="Gdk.Pixmap" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Creates a <see cref="T:Gtk.Image" /> widget displaying an image with a mask.</summary>
|
|
<param name="pixmap">an object of type <see cref="T:Gdk.Pixmap" /></param>
|
|
<param name="mask">an object of type <see cref="T:Gdk.Pixmap" /></param>
|
|
<remarks>
|
|
Creates a <see cref="T:Gtk.Image" /> widget displaying an image with a mask.
|
|
A <see cref="T:Gdk.Image" /> is a client-side image buffer in the pixel format of the current display.
|
|
</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<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>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Image (Gdk.Image image, Gdk.Pixmap mask);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="image" Type="Gdk.Image" />
|
|
<Parameter Name="mask" Type="Gdk.Pixmap" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>This constructor is used to create an instance of
|
|
<see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Image" />
|
|
passed to it, masked by the given <see cref="T:Gdk.Pixmap" />.</summary>
|
|
<param name="image">
|
|
<see cref="T:Gdk.Image" /> to be displayed
|
|
by the Image.</param>
|
|
<param name="mask">
|
|
<see cref="T:Gdk.Pixmap" /> mask to be used.</param>
|
|
<remarks />
|
|
<since version="Gtk# 2.4" />
|
|
</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>
|
|
<remarks />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName=".ctor">
|
|
<MemberSignature Language="C#" Value="public Image (Gdk.Pixmap pixmap, Gdk.Pixmap mask);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="pixmap" Type="Gdk.Pixmap" />
|
|
<Parameter Name="mask" Type="Gdk.Pixmap" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>This constructor is used to create an instance of
|
|
<see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Pixmap" /> passed to it,
|
|
masked by the given <see cref="Gdk.Pixmap" />.</summary>
|
|
<param name="pixmap">
|
|
<see cref="T:Gdk.Pixmap" /> displayed by
|
|
the Image.</param>
|
|
<param name="mask">
|
|
<see cref="T:Gdk.Pixmap" /> mask used by
|
|
the Image.</param>
|
|
<remarks />
|
|
<since version="Gtk# 2.4" />
|
|
</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="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>
|
|
<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>
|
|
<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>
|
|
</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="Animation">
|
|
<MemberSignature Language="C#" Value="public Gdk.PixbufAnimation Animation { get; };" />
|
|
<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="FromAnimation">
|
|
<MemberSignature Language="C#" Value="public Gdk.PixbufAnimation FromAnimation { set; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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="Stock">
|
|
<MemberSignature Language="C#" Value="public string Stock { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("stock")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Pixbuf">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixbuf Pixbuf { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("pixbuf")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="IconSize">
|
|
<MemberSignature Language="C#" Value="public int IconSize { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("icon-size")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="File">
|
|
<MemberSignature Language="C#" Value="public string File { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("file")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="StorageType">
|
|
<MemberSignature Language="C#" Value="public Gtk.ImageType StorageType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("storage-type")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="IconSet">
|
|
<MemberSignature Language="C#" Value="public Gtk.IconSet IconSet { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("icon-set")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="PixbufAnimation">
|
|
<MemberSignature Language="C#" Value="public Gdk.PixbufAnimation PixbufAnimation { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("pixbuf-animation")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Mask">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixmap Mask { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixmap</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Mask bitmap to use with <see cref="T:Gdk.Image" /> or <see cref="T:Gdk.Pixmap" /></summary>
|
|
<value>an object of type <see cref="T:Gdk.Pixmap" /></value>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("mask")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Pixmap">
|
|
<MemberSignature Language="C#" Value="public Gdk.Pixmap Pixmap { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Pixmap</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets or sets the <see cref="T:Gdk.Pixmap" />
|
|
associated to the Image.</summary>
|
|
<value>
|
|
<see cref="T:Gtk.Pixmap" /> that the Image contains.</value>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("pixmap")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="ImageProp">
|
|
<MemberSignature Language="C#" Value="public Gdk.Image ImageProp { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gdk.Image</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Gets or sets the <see cref="T:Gdk.Image" /> associated with the Image.</summary>
|
|
<value>
|
|
<see cref="T:Gdk.Image" /> that the Image contains.</value>
|
|
<remarks />
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("image")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="GType">
|
|
<MemberSignature Language="C#" Value="public static GLib.GType GType { get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>GLib.GType</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters />
|
|
<Docs>
|
|
<summary>GType Property.</summary>
|
|
<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=".ctor">
|
|
<MemberSignature Language="C#" Value="protected Image (GLib.GType gtype);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="gtype" Type="GLib.GType" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Protected Constructor.</summary>
|
|
<param name="gtype">a <see cref="T:GLib.GType" /></param>
|
|
<remarks>Chain to this constructor if you have manually registered a native <see cref="T:GLib.GType" /> value for your subclass.</remarks>
|
|
</Docs>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>System.Obsolete</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="Set">
|
|
<MemberSignature Language="C#" Value="public void Set (Gdk.Image val, Gdk.Pixmap mask);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="val" Type="Gdk.Image" />
|
|
<Parameter Name="mask" Type="Gdk.Pixmap" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Same functionality as <see cref="M:Gtk.Image.SetFromImage" />.</summary>
|
|
<param name="val">a <see cref="T:Gdk.Image" /></param>
|
|
<param name="mask">a <see cref="T:Gdk.Pixmap" /></param>
|
|
<remarks>
|
|
</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="Get">
|
|
<MemberSignature Language="C#" Value="public void Get (Gdk.Image val, Gdk.Pixmap mask);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="val" Type="Gdk.Image" />
|
|
<Parameter Name="mask" Type="Gdk.Pixmap" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>
|
|
Gets the <see cref="T:Gdk.Image" /> and mask being
|
|
displayed by the <see cref="T:Gtk.Image" />.
|
|
</summary>
|
|
<param name="val">a <see cref="T:Gdk.Image" /></param>
|
|
<param name="mask">a <see cref="T:Gdk.Pixmap" /></param>
|
|
<remarks>
|
|
The storage type of the image must be
|
|
<see cref="T:Gtk.ImageType.Empty" />.
|
|
or <see cref="T:Gtk.ImageType.Image" />.
|
|
(see <see cref="P:Gtk.Image.StorageType" />).
|
|
</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);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="stock_id" Type="System.String&" RefType="out" />
|
|
<Parameter Name="size" Type="Gtk.IconSize&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Get the stock item name and size, if this is a stock image</summary>
|
|
<param name="stock_id">the stock item name</param>
|
|
<param name="size">the stock item size, a <see cref="T:Gtk.IconSize" /></param>
|
|
<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="GetIconSet">
|
|
<MemberSignature Language="C#" Value="public void GetIconSet (out Gtk.IconSet icon_set, out Gtk.IconSize size);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="icon_set" Type="Gtk.IconSet&" RefType="out" />
|
|
<Parameter Name="size" Type="Gtk.IconSize&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Get the icon set and size, if this image is using an icon set</summary>
|
|
<param name="icon_set">the <see cref="T:Gtk.IconSet" /></param>
|
|
<param name="size">the icon size, a <see cref="T:Gtk.IconSize" /></param>
|
|
<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="GetPixmap">
|
|
<MemberSignature Language="C#" Value="public void GetPixmap (out Gdk.Pixmap pixmap, out Gdk.Pixmap mask);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="pixmap" Type="Gdk.Pixmap&" RefType="out" />
|
|
<Parameter Name="mask" Type="Gdk.Pixmap&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Get the pixmap and mask for an image</summary>
|
|
<param name="pixmap">the <see cref="T:Gdk.Pixmap" /></param>
|
|
<param name="mask">the mask</param>
|
|
<remarks>
|
|
</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetImage">
|
|
<MemberSignature Language="C#" Value="public void GetImage (out Gdk.Image gdk_image, out Gdk.Pixmap mask);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="gdk_image" Type="Gdk.Image&" RefType="out" />
|
|
<Parameter Name="mask" Type="Gdk.Pixmap&" RefType="out" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Get the image data and mask for an image</summary>
|
|
<param name="gdk_image">the image data</param>
|
|
<param name="mask">the mask</param>
|
|
<remarks>
|
|
</remarks>
|
|
<since version="Gtk# 2.4" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="LoadFromResource">
|
|
<MemberSignature Language="C#" Value="public static Gtk.Image LoadFromResource (string resource);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>Gtk.Image</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="resource" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads an image from a resource file.</summary>
|
|
<param name="resource">the name of the resource</param>
|
|
<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=".ctor">
|
|
<MemberSignature Language="C#" Value="public Image (System.IO.Stream stream);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="stream" Type="System.IO.Stream" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads an image from a <see cref="T:System.IO.Stream" />.</summary>
|
|
<param name="stream">a <see cref="T:System.IO.Stream" /></param>
|
|
<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 (System.Reflection.Assembly assembly, string resource);" />
|
|
<MemberType>Constructor</MemberType>
|
|
<ReturnValue />
|
|
<Parameters>
|
|
<Parameter Name="assembly" Type="System.Reflection.Assembly" />
|
|
<Parameter Name="resource" Type="System.String" />
|
|
</Parameters>
|
|
<Docs>
|
|
<summary>Loads an image embedded in an assembly</summary>
|
|
<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>
|
|
<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="IconName">
|
|
<MemberSignature Language="C#" Value="public string IconName { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("icon-name")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="PixelSize">
|
|
<MemberSignature Language="C#" Value="public int PixelSize { set; get; };" />
|
|
<MemberType>Property</MemberType>
|
|
<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>
|
|
<Attributes>
|
|
<Attribute>
|
|
<AttributeName>GLib.Property("pixel-size")</AttributeName>
|
|
</Attribute>
|
|
</Attributes>
|
|
</Member>
|
|
<Member MemberName="NewFromIconName">
|
|
<MemberSignature Language="C#" Value="public static Gtk.Image NewFromIconName (string icon_name, Gtk.IconSize size);" />
|
|
<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>
|
|
<summary>To be added</summary>
|
|
<param name="icon_name">a <see cref="T:System.String" /></param>
|
|
<param name="size">a <see cref="T:System.Int32" /></param>
|
|
<returns>a <see cref="T:Gtk.Image" /></returns>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.6" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="SetFromIconName">
|
|
<MemberSignature Language="C#" Value="public void SetFromIconName (string icon_name, Gtk.IconSize size);" />
|
|
<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>
|
|
<summary>To be added</summary>
|
|
<param name="icon_name">a <see cref="T:System.String" /></param>
|
|
<param name="size">a <see cref="T:System.Int32" /></param>
|
|
<remarks>To be added</remarks>
|
|
<since version="Gtk# 2.6" />
|
|
</Docs>
|
|
</Member>
|
|
<Member MemberName="GetIconName">
|
|
<MemberSignature Language="C#" Value="public void GetIconName (out string icon_name, out Gtk.IconSize size);" />
|
|
<MemberType>Method</MemberType>
|
|
<ReturnValue>
|
|
<ReturnType>System.Void</ReturnType>
|
|
</ReturnValue>
|
|
<Parameters>
|
|
<Parameter Name="icon_name" Type="System.String&" RefType="out" />
|
|
<Parameter Name="size" Type="Gtk.IconSize&" 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="Clear">
|
|
<MemberSignature Language="C#" Value="public void Clear ();" />
|
|
<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>
|
|
</Members>
|
|
</Type>
|