2003-12-08 John Luke <jluke@cfl.rr.com>

* en/Art/Rgba.xml: update
	* en/Gnome/FileEntry.xml: documented

svn path=/trunk/gtk-sharp/; revision=20910
This commit is contained in:
John Luke 2003-12-08 23:56:58 +00:00
parent 968230bd25
commit 2b16d16574
3 changed files with 205 additions and 116 deletions

View File

@ -1,3 +1,8 @@
2003-12-08 John Luke <jluke@cfl.rr.com>
* en/Art/Rgba.xml: update
* en/Gnome/FileEntry.xml: documented
2003-12-04 John Luke <jluke@cfl.rr.com>
* All: run updater

View File

@ -2,7 +2,8 @@
<TypeSignature Language="C#" Value="public class Rgba" Maintainer="auto" />
<AssemblyInfo>
<AssemblyName>art-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
@ -29,5 +30,72 @@
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RgbaComposite">
<MemberSignature Language="C#" Value="public static void RgbaComposite (out byte dst, out byte src, int n);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="dst" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="src" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="n" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="dst">a <see cref="T:System.Byte&amp;" /></param>
<param name="src">a <see cref="T:System.Byte&amp;" /></param>
<param name="n">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="RunAlpha">
<MemberSignature Language="C#" Value="public static void RunAlpha (out byte buf, byte r, byte g, byte b, int alpha, int n);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buf" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="r" Type="System.Byte" />
<Parameter Name="g" Type="System.Byte" />
<Parameter Name="b" Type="System.Byte" />
<Parameter Name="alpha" Type="System.Int32" />
<Parameter Name="n" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="buf">a <see cref="T:System.Byte&amp;" /></param>
<param name="r">a <see cref="T:System.Byte" /></param>
<param name="g">a <see cref="T:System.Byte" /></param>
<param name="b">a <see cref="T:System.Byte" /></param>
<param name="alpha">a <see cref="T:System.Int32" /></param>
<param name="n">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
<Member MemberName="FillRun">
<MemberSignature Language="C#" Value="public static void FillRun (out byte buf, byte r, byte g, byte b, int n);" />
<MemberType>Method</MemberType>
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
<Parameters>
<Parameter Name="buf" Type="System.Byte&amp;" RefType="out" />
<Parameter Name="r" Type="System.Byte" />
<Parameter Name="g" Type="System.Byte" />
<Parameter Name="b" Type="System.Byte" />
<Parameter Name="n" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="buf">a <see cref="T:System.Byte&amp;" /></param>
<param name="r">a <see cref="T:System.Byte" /></param>
<param name="g">a <see cref="T:System.Byte" /></param>
<param name="b">a <see cref="T:System.Byte" /></param>
<param name="n">a <see cref="T:System.Int32" /></param>
<remarks>To be added</remarks>
</Docs>
</Member>
</Members>
</Type>

View File

@ -1,16 +1,17 @@
<Type Name="FileEntry" FullName="Gnome.FileEntry">
<TypeSignature Language="C#" Value="public class FileEntry : Gtk.VBox, Editable, IWrapper, Implementor, IWrapper, IWrapper, IDisposable" Maintainer="auto" />
<TypeSignature Language="C#" Value="public class FileEntry : Gtk.VBox, Editable, IWrapper, Implementor, IDisposable" Maintainer="John Luke" />
<AssemblyInfo>
<AssemblyName>gnome-sharp</AssemblyName>
<AssemblyPublicKey></AssemblyPublicKey>
<AssemblyPublicKey>
</AssemblyPublicKey>
<AssemblyVersion>0.0.0.0</AssemblyVersion>
<AssemblyCulture>neutral</AssemblyCulture>
<Attributes />
</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>A widget for selecting a file or directory.</summary>
<remarks>A <see cref="T:Gnome.FileEntry" /> contains a <see cref="T:Gnome.Entry" /> and a browse dialog.</remarks>
</Docs>
<Base>
<BaseTypeName>Gtk.VBox</BaseTypeName>
@ -25,12 +26,6 @@
<Interface>
<InterfaceName>Atk.Implementor</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
<Interface>
<InterfaceName>System.IDisposable</InterfaceName>
</Interface>
@ -48,10 +43,10 @@
<Parameter Name="end" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start">To be added: an object of type 'int'</param>
<param name="end">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Select the text of the <see cref="T:Gtk.Entry" /> between <paramref name="start" /> and <paramref name="end" />.</summary>
<param name="start">an object of type <see cref="T:System.Int32" /></param>
<param name="end">an object of type <see cref="T:System.Int32" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetChars">
@ -65,11 +60,11 @@
<Parameter Name="end_pos" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start_pos">To be added: an object of type 'int'</param>
<param name="end_pos">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Gets the text of the <see cref="T:Gtk.Entry" /> between <paramref name="start_pos" /> and <paramref name="end_pos" />.</summary>
<param name="start_pos">an object of type <see cref="T:System.Int32" /></param>
<param name="end_pos">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DeleteText">
@ -83,10 +78,10 @@
<Parameter Name="end_pos" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start_pos">To be added: an object of type 'int'</param>
<param name="end_pos">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Deletes the text of the <see cref="T:Gtk.Entry" /> between <paramref name="start_pos" /> and <paramref name="end_pos" />.</summary>
<param name="start_pos">an object of type <see cref="T:System.Int32" /></param>
<param name="end_pos">an object of type <see cref="T:System.Int32" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CopyClipboard">
@ -98,7 +93,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="DeleteSelection">
@ -110,7 +105,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetSelectionBounds">
@ -125,10 +120,10 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="start">To be added: an object of type 'int&amp;'</param>
<param name="end">To be added: an object of type 'int&amp;'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<param name="start">an object of type <see cref="T:System.Int32" /></param>
<param name="end">an object of type <see cref="T:System.Int32" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="CutClipboard">
@ -140,7 +135,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="PasteClipboard">
@ -152,7 +147,7 @@
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Construct">
@ -166,10 +161,10 @@
<Parameter Name="browse_dialog_title" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="history_id">To be added: an object of type 'string'</param>
<param name="browse_dialog_title">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
<summary>Construct a <see cref="T:Gnome.FileEntry" />.</summary>
<param name="history_id">an object of type <see cref="T:System.String" /></param>
<param name="browse_dialog_title">an object of type <see cref="T:System.String" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="GetFullPath">
@ -182,10 +177,10 @@
<Parameter Name="file_must_exist" Type="System.Boolean" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="file_must_exist">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Gets the full absolute path of the file from the entry.</summary>
<param name="file_must_exist">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.String" /></returns>
<remarks>If <paramref name="file_must_exist" /> is <see langword="false" />, nothing is tested and the path is returned. If <paramref name="file_must_exist" /> is <see langword="true" />, then the path is only returned if the path actually exists. In case the entry is a directory entry (see <see cref="P:Gnome.FileEntry.DirectoryEntry" />), then if the path exists and is a directory then it is returned; if not, it is assumed it was a file so we try to strip it, and try again. It allocates memory for the returned string.</remarks>
</Docs>
</Member>
<Member MemberName="Finalize">
@ -225,11 +220,12 @@
<Parameter Name="browse_dialog_title" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="history_id">To be added: an object of type 'string'</param>
<param name="browse_dialog_title">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'Gnome.FileEntry'</returns>
<remarks>To be added</remarks>
<summary>Creates a new <see cref="T:Gnome.FileEntry" />.</summary>
<param name="history_id">an object of type <see cref="T:System.String" /></param>
<param name="browse_dialog_title">an object of type <see cref="T:System.String" /></param>
<returns>an object of type <see cref="T:Gnome.FileEntry" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -238,9 +234,9 @@
<ReturnValue />
<Parameters />
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.FileEntry'</returns>
<remarks>To be added</remarks>
<summary>Internal constructor</summary>
<returns>an object of type <see cref="T:Gnome.FileEntry" /></returns>
<remarks>This is a constructor used by derivative types of <see cref="T:Gnome.FileEntry" />. This is not typically used by C# code.</remarks>
</Docs>
</Member>
<Member MemberName="GType">
@ -250,8 +246,8 @@
<ReturnType>System.UInt32</ReturnType>
</ReturnValue>
<Docs>
<summary>The GLib Type for Gnome.FileEntry</summary>
<returns>The GLib Type for the Gnome.FileEntry class.</returns>
<summary>The <see cref="T:GLib.Type" /> for <see cref="T:Gnome.FileEntry" /></summary>
<returns>The <see cref="T:GLib.Type" /> for the <see cref="T:Gnome.FileEntry" /> class.</returns>
<remarks />
</Docs>
</Member>
@ -261,12 +257,14 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the <see cref="Gtk.Entry" /> should be editable by the user.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Position">
@ -275,12 +273,14 @@
<ReturnValue>
<ReturnType>System.Int32</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'int'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<summary>The cursor position in the <see cref="T:Gtk.Entry" />.</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>
</remarks>
</Docs>
</Member>
<Member MemberName="Title">
@ -289,12 +289,14 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Set the title of the browse dialog.</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>The new title will go into effect the next time the browse button is pressed.
</remarks>
</Docs>
</Member>
<Member MemberName="GtkEntry">
@ -304,9 +306,10 @@
<ReturnType>Gtk.Entry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gtk.Entry'</returns>
<remarks>To be added</remarks>
<summary>The associated <see cref="T:Gtk.Entry" />.</summary>
<returns>an object of type <see cref="T:Gtk.Entry" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="Modal">
@ -315,12 +318,14 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether the browse dialog is modal.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="DefaultPath">
@ -329,12 +334,14 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Set the default path of browse dialog.</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>The default path is only used if the entry is empty or if the current path of the entry is not an absolute path, in which case the default path is prepended to it before the dialog is started.
</remarks>
</Docs>
</Member>
<Member MemberName="Filename">
@ -343,12 +350,14 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The value of the internal <see cref="T:Gnome.Entry" />.</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>
</remarks>
</Docs>
</Member>
<Member MemberName="BrowseDialogTitle">
@ -357,12 +366,14 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>Title of the browse dialog.</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>
</remarks>
</Docs>
</Member>
<Member MemberName="DirectoryEntry">
@ -371,12 +382,14 @@
<ReturnValue>
<ReturnType>System.Boolean</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'bool'</param>
<returns>To be added: an object of type 'bool'</returns>
<remarks>To be added</remarks>
<summary>Whether this is a directory only entry.</summary>
<param name="value">an object of type <see cref="T:System.Boolean" /></param>
<returns>an object of type <see cref="T:System.Boolean" /></returns>
<remarks>If <see langword="true" />, then <see cref="M:Gnome.FileEntry.GetFullPath(System.Boolean)" /> will check for the file being a directory, and the browse dialog will have the file list disabled.
</remarks>
</Docs>
</Member>
<Member MemberName="HistoryId">
@ -385,12 +398,14 @@
<ReturnValue>
<ReturnType>System.String</ReturnType>
</ReturnValue>
<Parameters></Parameters>
<Parameters>
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="value">To be added: an object of type 'string'</param>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<summary>The ID for the associated history.</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>
</remarks>
</Docs>
</Member>
<Member MemberName="GnomeEntry">
@ -400,9 +415,10 @@
<ReturnType>Gnome.Entry</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'Gnome.Entry'</returns>
<remarks>To be added</remarks>
<summary>The associated <see cref="T:Gnome.Entry" />.</summary>
<returns>an object of type <see cref="T:Gnome.Entry" /></returns>
<remarks>
</remarks>
</Docs>
</Member>
<Member MemberName="TextInserted">
@ -413,8 +429,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when text is inserted into the <see cref="T:Gtk.Entry" />.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="TextDeleted">
@ -425,8 +441,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when text is deleted into the <see cref="T:Gtk.Entry" />.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Changed">
@ -437,8 +453,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the text is changed into the <see cref="T:Gtk.Entry" />.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="BrowseClicked">
@ -449,8 +465,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the browse button is clicked.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="Activated">
@ -461,8 +477,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Emitted when the <see cref="T:Gtk.Entry" /> is activated.</summary>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName="InsertText">
@ -476,10 +492,10 @@
<Parameter Name="position" Type="System.Int32&amp;" RefType="ref" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="new_text">To be added: an object of type 'string'</param>
<param name="position">To be added: an object of type 'int&amp;'</param>
<remarks>To be added</remarks>
<summary>Inserts into the <see cref="T:Gtk.Entry" /> <paramref name="new_text" /> at <paramref name="position" />.</summary>
<param name="new_text">an object of type <see cref="T:System.String" /></param>
<param name="position">an object of type <see cref="T:System.Int32" /></param>
<remarks></remarks>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -499,4 +515,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>