ryujinx-archive/GtkSharp
2
0
Fork 0
Code Issues Pull requests Actions Packages Projects Releases Wiki Activity

Added some descriptions and info for all the constructors.

Browse source 
svn path=/trunk/gtk-sharp/; revision=14586
This commit is contained in:
Jaime Anguiano Olarra 2003-05-14 19:22:02 +00:00
parent 5d2bf2aee5
commit ddc14873b2
1 changed files with 101 additions and 56 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

153
doc/en/Gtk/Image.xml
View file

@ -1,5 +1,7 @@
<Type Name="Image" FullName="Gtk.Image"> <Type Name="Image" FullName="Gtk.Image">
<TypeSignature Language="C#" Value="public class Image : Gtk.Misc, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" /> <TypeSignature Language="C#" Value="public class Image : Gtk.Misc,
Implementor, IWrapper, IWrapper, IDisposable" Maintainer="Jaime
Anguiano Olarra" />
<AssemblyInfo> <AssemblyInfo>
<AssemblyName>gtk-sharp</AssemblyName> <AssemblyName>gtk-sharp</AssemblyName>
<AssemblyVersion>0.0.0.0</AssemblyVersion> <AssemblyVersion>0.0.0.0</AssemblyVersion>
@ -7,8 +9,12 @@
</AssemblyInfo> </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> <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> <Docs>
<summary>To be added</summary> <summary>This <see cref="T:Gtk.Widget" /> is used to display an
<remarks>To be added</remarks> image. It can be used as a container for a <see cref="Gdk.Pixbuf" />
or a <see cref="Gdk.PixbufAnimation" /> to get custom interfaces.
<see cref="Gtk.Image" /> cannot launch events, it's neccessary to
include it inside a <see cref="Gtk.EventBox" /> for that purpose.</summary>
<remarks />
</Docs> </Docs>
<Base> <Base>
<BaseTypeName>Gtk.Misc</BaseTypeName> <BaseTypeName>Gtk.Misc</BaseTypeName>
@ -131,9 +137,9 @@
<ReturnValue /> <ReturnValue />
<Parameters /> <Parameters />
<Docs> <Docs>
<summary>To be added</summary> <summary>Default parameterless constructor.</summary>
<returns>To be added: an object of type 'Gtk.Image'</returns> <returns>An instance of type <see cref="T:Gtk.Image" /></returns>
<remarks>To be added</remarks> <remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -144,10 +150,13 @@
<Parameter Name="animation" Type="Gdk.PixbufAnimation" /> <Parameter Name="animation" Type="Gdk.PixbufAnimation" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>This constructor is used to create an instance of <see
<param name="animation">To be added: an object of type 'Gdk.PixbufAnimation'</param> cref="Gtk.Image" /> containing the <see cref="T:Gdk.PixbufAnimation"
<returns>To be added: an object of type 'Gtk.Image'</returns> /> passed to it.</summary>
<remarks>To be added</remarks> <param name="animation"><see cref="T:Gdk.PixbufAnimation" />
to be displayed by the Image.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks/>
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -158,10 +167,13 @@
<Parameter Name="filename" Type="System.String" /> <Parameter Name="filename" Type="System.String" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>This constructor is used to create an instance of
<param name="filename">To be added: an object of type 'string'</param> <see cref="T:Gtk.Image" /> containing the image stored in the
<returns>To be added: an object of type 'Gtk.Image'</returns> filename whose path is given by the 'filename' parameter.</summary>
<remarks>To be added</remarks> <param name="filename"><see langword="string" /> representing
the path to the image file.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -173,11 +185,15 @@
<Parameter Name="size" Type="Gtk.IconSize" /> <Parameter Name="size" Type="Gtk.IconSize" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>This constructor is used to create an instance of
<param name="icon_set">To be added: an object of type 'Gtk.IconSet'</param> <see cref="T:Gtk.Image" /> containing the <see cref="T:Gtk.IconSet"
<param name="size">To be added: an object of type 'Gtk.IconSize'</param> /> and using the <see cref="T:Gtk.IconSize" /> passed to it.</summary>
<returns>To be added: an object of type 'Gtk.Image'</returns> <param name="icon_set"><see cref="T:Gtk.IconSet" /> to be
<remarks>To be added</remarks> displayed by the Image.</param>
<param name="size"><see cref="T:Gtk.IconSize" /> to be used by
the Image.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -189,11 +205,14 @@
<Parameter Name="mask" Type="Gdk.Bitmap" /> <Parameter Name="mask" Type="Gdk.Bitmap" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>This constructor is used to create an instance of
<param name="image">To be added: an object of type 'Gdk.Image'</param> <see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Image" />
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param> and the <see cref="T:Gdk.Bitmap" /> passed to it.</summary>
<returns>To be added: an object of type 'Gtk.Image'</returns> <param name="image"><see cref="T:Gdk.Image" /> to be displayed
<remarks>To be added</remarks> by the Image.</param>
<param name="mask"><see cref="T:Gdk.Bitmap" /> mask to be used.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -204,10 +223,13 @@
<Parameter Name="pixbuf" Type="Gdk.Pixbuf" /> <Parameter Name="pixbuf" Type="Gdk.Pixbuf" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>This constructor is used to create an instance of
<param name="pixbuf">To be added: an object of type 'Gdk.Pixbuf'</param> <see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Pixbuf" />
<returns>To be added: an object of type 'Gtk.Image'</returns> passed to it.</summary>
<remarks>To be added</remarks> <param name="pixbuf"><see cref="T:Gdk.Pixbuf" /> to be
displayed by the Image.</param>
<returns>To be added: an object of type 'Gtk.Image'An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -219,11 +241,15 @@
<Parameter Name="mask" Type="Gdk.Bitmap" /> <Parameter Name="mask" Type="Gdk.Bitmap" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>This constructor is used to create an instance of
<param name="pixmap">To be added: an object of type 'Gdk.Pixmap'</param> <see cref="T:Gtk.Image" /> containing the <see cref="T:Gdk.Pixmap"
<param name="mask">To be added: an object of type 'Gdk.Bitmap'</param> /> and the <see cref="Gtk.Bitmap" /> mask passed to it.</summary>
<returns>To be added: an object of type 'Gtk.Image'</returns> <param name="pixmap"><see cref="T:Gdk.Pixmap" /> displayed by
<remarks>To be added</remarks> the Image.</param>
<param name="mask"><see cref="T:Gdk.Bitmap" /> mask used by
the Image.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName=".ctor"> <Member MemberName=".ctor">
@ -235,11 +261,15 @@
<Parameter Name="size" Type="Gtk.IconSize" /> <Parameter Name="size" Type="Gtk.IconSize" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>This constructor is used to create an instance of
<param name="stock_id">To be added: an object of type 'string'</param> <see cref="T:Gtk.Image" /> containing the <see cref="Gtk.Stock" />
<param name="size">To be added: an object of type 'Gtk.IconSize'</param> represented by the <see langword="string" /> passed to it and with the
<returns>To be added: an object of type 'Gtk.Image'</returns> size represented by the <see cref="Gtk.IconSize" /> passed.</summary>
<remarks>To be added</remarks> <param name="stock_id"><see langword="string" /> identifier
for the <see cref="Gtk.Stock" />.</param>
<param name="size"><see cref="Gtk.IconSize" /> used by the Image.</param>
<returns>An instance of type <see cref="T:Gtk.Image" />.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="GType"> <Member MemberName="GType">
@ -340,10 +370,12 @@
<Parameter Name="value" Type="Gdk.Pixbuf" /> <Parameter Name="value" Type="Gdk.Pixbuf" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets or sets the <see cref="T:Gdk.Pixbuf" />
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param> associated to the Image.</summary>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns> <param name="value"><see cref="T:Gdk.Pixbuf" /> that will be
<remarks>To be added</remarks> set to the Image.</param>
<returns><see cref="T:Gtk.Pixbuf" /> that the Image contains.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="IconSize"> <Member MemberName="IconSize">
@ -400,10 +432,12 @@
<Parameter Name="value" Type="Gtk.IconSet" /> <Parameter Name="value" Type="Gtk.IconSet" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets or sets the <see cref="T:Gtk.Iconset" />
<param name="value">To be added: an object of type 'Gtk.IconSet'</param> associated to the Image.</summary>
<returns>To be added: an object of type 'Gtk.IconSet'</returns> <param name="value"><see cref="T:Gtk.Iconset" /> that will be
<remarks>To be added</remarks> set to the Image.</param>
<returns><see cref="T:Gtk.Iconset" /> that the Image contains.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="PixbufAnimation"> <Member MemberName="PixbufAnimation">
@ -416,10 +450,12 @@
<Parameter Name="value" Type="Gdk.PixbufAnimation" /> <Parameter Name="value" Type="Gdk.PixbufAnimation" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets or sets the <see cref="T:Gdk.PixbufAnimation" />
<param name="value">To be added: an object of type 'Gdk.PixbufAnimation'</param> associated to the Image.</summary>
<returns>To be added: an object of type 'Gdk.PixbufAnimation'</returns> <param name="value"><see cref="T:Gdk.PixbufAnimation" /> that will be
<remarks>To be added</remarks> set to the Image.</param>
<returns><see cref="T:Gtk.PixbufAnimation" /> that the Image contains.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="Mask"> <Member MemberName="Mask">
@ -448,10 +484,12 @@
<Parameter Name="value" Type="Gdk.Pixmap" /> <Parameter Name="value" Type="Gdk.Pixmap" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>To be added</summary> <summary>Gets or sets the <see cref="T:Gdk.Pixmap" />
<param name="value">To be added: an object of type 'Gdk.Pixmap'</param> associated to the Image.</summary>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns> <param name="value"><see cref="T:Gdk.Pixmap" /> that will be
<remarks>To be added</remarks> set to the Image.</param>
<returns><see cref="T:Gtk.Pixmap" /> that the Image contains.</returns>
<remarks />
</Docs> </Docs>
</Member> </Member>
<Member MemberName="ImageProp"> <Member MemberName="ImageProp">
@ -464,6 +502,13 @@
<Parameter Name="value" Type="Gdk.Image" /> <Parameter Name="value" Type="Gdk.Image" />
</Parameters> </Parameters>
<Docs> <Docs>
<summary>Gets or sets the <see cref="T:Gdk.Image" />
associated to the Image.</summary>
<param name="value"><see cref="T:Gdk.Image" /> that will be
set to the Image.</param>
<returns><see cref="T:Gdk.Image" /> that the Image contains.</returns>
<remarks />
<summary>To be added</summary> <summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Image'</param> <param name="value">To be added: an object of type 'Gdk.Image'</param>
<returns>To be added: an object of type 'Gdk.Image'</returns> <returns>To be added: an object of type 'Gdk.Image'</returns>