GtkSharp/doc/en/Gnome/CanvasPixbuf.xml

356 lines
12 KiB
XML
Raw Normal View History

<Type Name="CanvasPixbuf" FullName="Gnome.CanvasPixbuf">
<TypeSignature Language="C#" Maintainer="auto" Value="public class CanvasPixbuf : Gnome.CanvasItem" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>2.16.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>Pixbuf image canvas item</summary>
<remarks>
<para>
A canvas item for drawing pixbuf images.
</para>
</remarks>
</Docs>
<Base>
<BaseTypeName>Gnome.CanvasItem</BaseTypeName>
</Base>
<Interfaces>
</Interfaces>
<Members>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="public CanvasPixbuf (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 CanvasPixbuf (Gnome.CanvasGroup group);" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters>
<Parameter Name="group" Type="Gnome.CanvasGroup" />
</Parameters>
<Docs>
<summary>Creates a new CanvasPixbuf from <paramref name="group" />.</summary>
<param name="group">an object of type <see cref="T:Gnome.CanvasGroup" /></param>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Height">
<MemberSignature Language="C#" Value="public double Height { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Pixbuf height.</summary>
<value>The height of this item</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("height")</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>The pixbuf image to draw.</summary>
<value>The pixbuf image</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("pixbuf")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="WidthInPixels">
<MemberSignature Language="C#" Value="public bool WidthInPixels { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</summary>
<value>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("width_in_pixels")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Anchor">
<MemberSignature Language="C#" Value="public Gtk.AnchorType Anchor { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>Gtk.AnchorType</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>
Anchor (handle) position within the pixbuf, defaults to
<see cref="F:Gtk.AnchorType.NW" /> (top left hand corner). The anchor is the
point of reference for positioning the image.
</summary>
<value>Anchor (handle) position within the pixbuf</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("anchor")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Width">
<MemberSignature Language="C#" Value="public double Width { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>Pixbuf width.</summary>
<value>The width of the pixbuf</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("width")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="WidthSet">
<MemberSignature Language="C#" Value="public bool WidthSet { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>
Whether or not the <see cref="Gnome.CanvasPixbuf.Width" />
should be used
</summary>
<value>
Whether or not the <see cref="Gnome.CanvasPixbuf.Width" />
should be used
</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("width_set")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="Y">
<MemberSignature Language="C#" Value="public double Y { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The Y coordinate of the position to place the pixbuf</summary>
<value>The Y coordinate of the position to place the pixbuf</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("y")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="X">
<MemberSignature Language="C#" Value="public double X { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Double</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The X coordinate of the position to place the pixbuf</summary>
<value>the X coordinate of the position to place the pixbuf</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("x")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="HeightInPixels">
<MemberSignature Language="C#" Value="public bool HeightInPixels { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>
The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property.
</summary>
<value>
The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property.
</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("height_in_pixels")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="HeightSet">
<MemberSignature Language="C#" Value="public bool HeightSet { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</summary>
<value>
Whether or not the <see cref="Gnome.CanvasPixbuf.Height" />
should be used
</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("height_set")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="XInPixels">
<MemberSignature Language="C#" Value="public bool XInPixels { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</summary>
<value>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("x_in_pixels")</AttributeName>
</Attribute>
</Attributes>
</Member>
<Member MemberName="YInPixels">
<MemberSignature Language="C#" Value="public bool YInPixels { set; get; };" />
<MemberType>Property</MemberType>
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters>
</Parameters>
<Docs>
<summary>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</summary>
<value>The unit used by the <see cref="P:Gnome.CanvasPixbuf.Pixels" /> property</value>
<remarks>
</remarks>
</Docs>
<Attributes>
<Attribute>
<AttributeName>GLib.Property("y_in_pixels")</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:Gnome.CanvasPixbuf" />.</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
<MemberSignature Language="C#" Value="protected CanvasPixbuf (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=".ctor">
<MemberSignature Language="C#" Value="protected CanvasPixbuf ();" />
<MemberType>Constructor</MemberType>
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>