2004-09-13 Shane Landrum <epicene@pobox.com>

* en/Gtk/Image.xml
	* en/Gtk/ImageAnimationData.xml
	* en/Gtk/ImageImageData.xml
	* en/Gtk/ImagePixbufData.xml
	* en/Gtk/ImagePixmapData.xml
	* en/Gtk/ImageStockData.xml: Image-related class docs.
	* en/Gtk/ItemFactory.xml
	* en/Gtk/ItemFactoryCallback.xml
	* en/Gtk/ItemFactoryCallback1.xml
	* en/Gtk/ItemFactoryEntry.xml: ItemFactory-related class docs.

svn path=/trunk/gtk-sharp/; revision=33796
This commit is contained in:
Shane Landrum 2004-09-13 05:43:28 +00:00
parent 532ae96284
commit c194f95b3c
11 changed files with 111 additions and 88 deletions

View File

@ -1,3 +1,16 @@
2004-09-13 Shane Landrum <epicene@pobox.com>
* en/Gtk/Image.xml
* en/Gtk/ImageAnimationData.xml
* en/Gtk/ImageImageData.xml
* en/Gtk/ImagePixbufData.xml
* en/Gtk/ImagePixmapData.xml
* en/Gtk/ImageStockData.xml: Image-related class docs.
* en/Gtk/ItemFactory.xml
* en/Gtk/ItemFactoryCallback.xml
* en/Gtk/ItemFactoryCallback1.xml
* en/Gtk/ItemFactoryEntry.xml: ItemFactory-related class docs.
2004-09-13 Shane Landrum <epicene@pobox.com>
* en/Gtk/IMContext.xml

View File

@ -336,10 +336,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Causes the Image object to display the given animation (or display nothing, if you set the animation to <see langword="null"/>).</summary>
<param name="value">an object of type <see cref="T:Gdk.PixbufAnimation" /></param>
<returns>an object of type <see cref="T:Gdk.PixbufAnimation" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="FromFile">
@ -351,10 +351,24 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<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>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Stock">
@ -366,10 +380,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>A stock item name, if this is a stock image.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Pixbuf">
@ -400,10 +414,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>The size (dimension on a side) for a square icon.</summary>
<param name="value">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Int32" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="File">
@ -415,10 +429,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>The file this image was loaded from.</summary>
<param name="value">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="StorageType">
@ -428,9 +442,11 @@
<ReturnType>Gtk.ImageType</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>The type of representation being used by the #GtkImage
to store image data. If the Image has no image data,
the return value will be <see cref="P:Gtk.ImageType.Empty"/>.</summary>
<returns>an object of type <see cref="T:Gtk.ImageType" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="IconSet">
@ -480,10 +496,10 @@
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Mask bitmap to use with <see cref="T:Gdk.Image"/> or <see cref="T:Gdk.Pixmap"/></summary>
<param name="value">an object of type <see cref="T:Gdk.Pixmap" /></param>
<returns>an object of type <see cref="T:Gdk.Pixmap" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Pixmap">
@ -514,18 +530,12 @@
<Parameters>
</Parameters>
<Docs>
<summary>Gets or sets the <see cref="T:Gdk.Image" />
associated to the Image.</summary>
<summary>Gets or sets the <see cref="T:Gdk.Image" /> associated with the Image.</summary>
<param name="value">
<see cref="T:Gdk.Image" /> that will be
set to the Image.</param>
<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>
<param name="value">an object of type <see cref="T:Gdk.Image" /></param>
<returns>an object of type <see cref="T:Gdk.Image" /></returns>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="GType">

View File

@ -11,7 +11,7 @@
<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>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -28,7 +28,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="New">
@ -42,9 +42,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ImageAnimationData'</returns>
<remarks>To be added</remarks>
<param name="raw">a <see cref="T:IntPtr"/></param>
<returns>a <see cref="T:Gtk.ImageAnimationData"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="iter">
@ -57,9 +57,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.PixbufAnimationIter'</param>
<returns>To be added: an object of type 'Gdk.PixbufAnimationIter'</returns>
<remarks>To be added</remarks>
<param name="value">a <see cref="T:Gdk.PixbufAnimationIter"/></param>
<returns>a <see cref="T:Gdk.PixbufAnimationIter"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="anim">
@ -72,9 +72,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.PixbufAnimation'</param>
<returns>To be added: an object of type 'Gdk.PixbufAnimation'</returns>
<remarks>To be added</remarks>
<param name="value">a <see cref="T:Gdk.PixbufAnimation"/></param>
<returns>a <see cref="T:Gdk.PixbufAnimation"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="FrameTimeout">
@ -87,8 +87,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -11,7 +11,7 @@
<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>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -28,7 +28,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="New">
@ -42,9 +42,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ImageImageData'</returns>
<remarks>To be added</remarks>
<param name="raw">a <see cref="T:IntPtr"/></param>
<returns>a <see cref="T:Gtk.ImageImageData"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="image">
@ -57,10 +57,10 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Image'</param>
<returns>To be added: an object of type 'Gdk.Image'</returns>
<remarks>To be added</remarks>
<param name="value">a <see cref="T:Gdk.Image"/></param>
<returns>a <see cref="T:Gdk.Image"/></returns>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -11,7 +11,7 @@
<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>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -28,7 +28,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="New">
@ -42,9 +42,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ImagePixbufData'</returns>
<remarks>To be added</remarks>
<param name="raw">a <see cref="T:IntPtr"/></param>
<returns>a <see cref="T:Gtk.ImagePixbufData"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="pixbuf">
@ -57,10 +57,10 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixbuf'</param>
<returns>To be added: an object of type 'Gdk.Pixbuf'</returns>
<remarks>To be added</remarks>
<param name="value">a <see cref="T:Gdk.Pixbuf"/></param>
<returns>a <see cref="T:Gdk.Pixbuf"/></returns>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -11,7 +11,7 @@
<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>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -28,7 +28,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="New">
@ -42,9 +42,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ImagePixmapData'</returns>
<remarks>To be added</remarks>
<param name="raw">a <see cref="T:IntPtr"/></param>
<returns>a <see cref="T:Gtk.ImagePixmapData"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="pixmap">
@ -57,10 +57,10 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'Gdk.Pixmap'</param>
<returns>To be added: an object of type 'Gdk.Pixmap'</returns>
<remarks>To be added</remarks>
<param name="value">a <see cref="T:Gdk.Pixmap"/></param>
<returns>a <see cref="T:Gdk.Pixmap"/></returns>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -11,7 +11,7 @@
<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>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -28,7 +28,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="New">
@ -41,10 +41,10 @@
<Parameter Name="raw" Type="System.IntPtr" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ImageStockData'</returns>
<remarks>To be added</remarks>
<summary>Internal constructor; do not use.</summary>
<param name="raw">a <see cref="T:IntPtr"/>, pointer to the underlying C data.</param>
<returns>a <see cref="T:Gtk.ImageStockData"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="StockId">

View File

@ -457,12 +457,12 @@
<Parameter Name="accel_group" Type="Gtk.AccelGroup" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Basic constructor.</summary>
<param name="container_type">The kind of menu to create; can be <see cref="T:Gtk.MenuBar" />, <see cref="T:Gtk.Menu" />, or <see cref="T:Gtk.OptionMenu" /></param>
<param name="path">the factory path of the new item factory, a string of the form "&lt;name&gt;"</param>
<param name="accel_group">a <see cref="T:Gtk.AccelGroup" /> to which the accelerators for the menu items will be added, or null to create a new one</param>
<returns>a <see cref="T:Gtk.ItemFactory" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -471,9 +471,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Protected constructor.</summary>
<returns>a <see cref="T:Gtk.ItemFactory" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
</Members>

View File

@ -7,8 +7,8 @@
</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>To be added</summary>
<remarks>To be added</remarks>
<summary>Delegate function to be invoked by <see cref="T:Gtk.ItemFactory"/>.</summary>
<remarks>TODO: offer an example.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -28,4 +28,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -7,8 +7,8 @@
</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>To be added</summary>
<remarks>To be added</remarks>
<summary>Delegate function to be invoked by <see cref="T:Gtk.ItemFactory"/>.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -31,4 +31,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -11,7 +11,7 @@
<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>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -28,7 +28,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="New">
@ -42,9 +42,9 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="raw">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'Gtk.ItemFactoryEntry'</returns>
<remarks>To be added</remarks>
<param name="raw">a <see cref="T:IntPtr"/></param>
<returns>a <see cref="T:Gtk.ItemFactoryEntry"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Path">
@ -57,7 +57,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="Accelerator">
@ -70,7 +70,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="CallbackAction">
@ -83,7 +83,7 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName="ItemType">
@ -96,8 +96,8 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>