2004-08-29 Shane Landrum <epicene@pobox.com>

* HTML.xml
	* HTMLBeginFlags.xml
	* HTMLClassProperties.xml
	* HTMLCommandType.xml
	* HTMLEditorAPI.xml
	* HTMLEditorEventType.xml
	* HTMLFontStyleShift.xml
	* HTMLParagraphStyle.xml
	* HTMLPrintCallback.xml
	* HTMLStream.xml
	* HTMLStreamCloseFunc.xml
	* HTMLStreamStatus.xml
	* HTMLStreamTypesFunc.xml
	* HTMLStreamWriteFunc.xml: Documented HTML widget and related classes.

svn path=/trunk/gtk-sharp/; revision=32980
This commit is contained in:
Shane Landrum 2004-08-29 06:52:31 +00:00
parent 524450a235
commit e35b797518
15 changed files with 127 additions and 109 deletions

View File

@ -1,3 +1,20 @@
2004-08-29 Shane Landrum <epicene@pobox.com>
* HTML.xml
* HTMLBeginFlags.xml
* HTMLClassProperties.xml
* HTMLCommandType.xml
* HTMLEditorAPI.xml
* HTMLEditorEventType.xml
* HTMLFontStyleShift.xml
* HTMLParagraphStyle.xml
* HTMLPrintCallback.xml
* HTMLStream.xml
* HTMLStreamCloseFunc.xml
* HTMLStreamStatus.xml
* HTMLStreamTypesFunc.xml
* HTMLStreamWriteFunc.xml: Documented HTML widget and related classes.
2004-08-28 Shane Landrum <epicene@pobox.com>
* en/Gtk/HSV.xml: Added docs for color selector.

View File

@ -587,7 +587,7 @@ class X {
<Parameter Name="flags" Type="Gtk.HTMLBeginFlags" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Begins processing HTML.</summary>
<param name="target_frame">an object of type <see cref="T:System.String" /></param>
<param name="content_type">an object of type <see cref="T:System.String" /></param>
<param name="flags">an object of type <see cref="T:Gtk.HTMLBeginFlags" /></param>
@ -650,7 +650,7 @@ class X {
<Parameter Name="to_be_destroyed" Type="Gtk.HTML" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>To be added.</summary>
<param name="to_be_destroyed">an object of type <see cref="T:Gtk.HTML" /></param>
<remarks />
</Docs>
@ -693,7 +693,7 @@ class X {
<Parameter Name="or_mask" Type="Gtk.HTMLFontStyle" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Sets the font style for the widget.</summary>
<param name="and_mask">an object of type <see cref="T:Gtk.HTMLFontStyle" /></param>
<param name="or_mask">an object of type <see cref="T:Gtk.HTMLFontStyle" /></param>
<remarks />
@ -709,9 +709,9 @@ class X {
<Parameter Name="url" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Unrefs an image.</summary>
<param name="url">an object of type <see cref="T:System.String" /></param>
<remarks />
<remarks>(TODO: explain refcounting for images.)</remarks>
</Docs>
</Member>
<Member MemberName="ImageRef">
@ -724,7 +724,7 @@ class X {
<Parameter Name="url" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Refs an image.</summary>
<param name="url">an object of type <see cref="T:System.String" /></param>
<remarks />
</Docs>
@ -791,7 +791,7 @@ class X {
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Unrefs images.</summary>
<remarks />
</Docs>
</Member>
@ -1651,12 +1651,12 @@ class X {
<Parameter Name="footer_print" Type="Gtk.HTMLPrintCallback" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Adds a header and footer to the HTML and prints it using <paramref name="print_context"/>.</summary>
<param name="print_context">a <see cref="T:Gnome.PrintContext" /></param>
<param name="header_height">a <see cref="T:System.Double" /></param>
<param name="footer_height">a <see cref="T:System.Double" /></param>
<param name="header_print">a <see cref="T:Gtk.HTMLPrintCallback" /></param>
<param name="footer_print">a <see cref="T:Gtk.HTMLPrintCallback" /></param>
<param name="header_print">a <see cref="T:Gtk.HTMLPrintCallback" />, a header generation routine</param>
<param name="footer_print">a <see cref="T:Gtk.HTMLPrintCallback" />, a footer generation routine</param>
<remarks />
</Docs>
</Member>
@ -1685,7 +1685,7 @@ class X {
<Parameter Name="print_context" Type="Gnome.PrintContext" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Prints this document using <paramref name="print_context"/>.</summary>
<param name="print_context">a <see cref="T:Gnome.PrintContext" /></param>
<remarks />
</Docs>
@ -2062,7 +2062,7 @@ class X {
<ReturnType>System.IntPtr</ReturnType>
</ReturnValue>
<Docs>
<summary>To be added</summary>
<summary>Sets the indentation level for the widget.</summary>
<returns>a <see cref="T:System.IntPtr" /></returns>
<remarks />
</Docs>

View File

@ -10,8 +10,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>Flags for how to begin processing a chunk of HTML.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -69,4 +69,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,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>A properties class for <see cref="T:Gtk.HTML"/>.</summary>
<remarks>Internal. Do not use.</remarks>
</Docs>
<Base>
<BaseTypeName>GLib.Opaque</BaseTypeName>
@ -20,7 +20,7 @@
<Interface>
<InterfaceName>GLib.IWrapper</InterfaceName>
</Interface>
</Interfaces>
</Interfaces>
<Attributes />
<Members>
<Member MemberName=".ctor">
@ -40,4 +40,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -1181,7 +1181,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Move focus forward one widget.</summary>
<remarks>
</remarks>
</Docs>
@ -1194,7 +1194,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Move focus backward one widget.</summary>
<remarks>
</remarks>
</Docs>
@ -1207,7 +1207,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Popup the context menu.</summary>
<remarks>
</remarks>
</Docs>
@ -1545,7 +1545,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Select a paragraph or more.</summary>
<remarks>
</remarks>
</Docs>
@ -1818,7 +1818,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Grab the keyboard focus.</summary>
<remarks>
</remarks>
</Docs>
@ -2006,4 +2006,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,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>Hooks for an HTML editor. Currently unsupported in Gtk#.</summary>
<remarks>See <see cref="M:Gtk.HTML.SetEditorApi"/>.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -27,8 +27,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>An empty object.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="New">
@ -41,11 +41,11 @@
<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.HTMLEditorAPI'</returns>
<remarks>To be added</remarks>
<summary>Default constructor.</summary>
<param name="raw">A <see cref="T:IntPtr"/>, pointer to the underlying C object.</param>
<returns>A <see cref="T:Gtk.HTMLEditorAPI"/></returns>
<remarks/>
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,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>Enumeration of possible kinds of HTML editing events.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -95,4 +95,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,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>Enumeration for how HTML font styles can be changed.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -37,7 +37,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Bold font style.</summary>
<remarks>
</remarks>
</Docs>
@ -50,7 +50,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Italic font style.</summary>
<remarks>
</remarks>
</Docs>
@ -63,7 +63,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Underlined font style.</summary>
<remarks>
</remarks>
</Docs>
@ -76,7 +76,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Strikeout font style.</summary>
<remarks>
</remarks>
</Docs>
@ -89,7 +89,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Fixed-width font style.</summary>
<remarks>
</remarks>
</Docs>
@ -102,7 +102,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Subscript font style.</summary>
<remarks>
</remarks>
</Docs>
@ -115,7 +115,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Superscript font style.</summary>
<remarks>
</remarks>
</Docs>
@ -134,4 +134,4 @@
</Docs>
</Member>
</Members>
</Type>
</Type>

View File

@ -10,8 +10,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>Enumeration of paragraph styles possible in <see cref="T:Gtk.HTML"/>.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -37,7 +37,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Normal style.</summary>
<remarks>
</remarks>
</Docs>
@ -50,7 +50,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Header 1 style.</summary>
<remarks>
</remarks>
</Docs>
@ -63,7 +63,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Header 2 style.</summary>
<remarks>
</remarks>
</Docs>
@ -76,7 +76,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Header 3 style.</summary>
<remarks>
</remarks>
</Docs>
@ -89,7 +89,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Header 4 style.</summary>
<remarks>
</remarks>
</Docs>
@ -102,7 +102,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Header 5 style.</summary>
<remarks>
</remarks>
</Docs>
@ -115,7 +115,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Header 6 style.</summary>
<remarks>
</remarks>
</Docs>
@ -128,7 +128,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Email address style.</summary>
<remarks>
</remarks>
</Docs>
@ -141,7 +141,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Preformatted text style.</summary>
<remarks>
</remarks>
</Docs>
@ -154,7 +154,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Unnumbered list style.</summary>
<remarks>
</remarks>
</Docs>
@ -167,7 +167,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Roman-numeral numbered list.</summary>
<remarks>
</remarks>
</Docs>
@ -180,7 +180,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Arabic-numbered ordered list.</summary>
<remarks>
</remarks>
</Docs>
@ -193,7 +193,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Greek-lettered ordered list.</summary>
<remarks>
</remarks>
</Docs>
@ -212,4 +212,4 @@
</Docs>
</Member>
</Members>
</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 for printing page framing elements.</summary>
<remarks>Used to print headers and footers in <see cref="M:Gtk.HTML.PrintWithHeaderFooter"/>.</remarks>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -28,4 +28,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -10,8 +10,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>Handles streaming I/O for <see cref="T:Gtk.HTML"/>.</summary>
<remarks>TODO: needs examples.</remarks>
</Docs>
<Base>
<BaseTypeName>System.ValueType</BaseTypeName>
@ -31,10 +31,10 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="html">To be added: an object of type 'Gtk.HTML'</param>
<param name="stream">To be added: an object of type 'Gtk.HTMLStream'</param>
<returns>To be added: an object of type 'Gtk.HTMLStream'</returns>
<remarks>To be added</remarks>
<param name="html">A <see cref="T:Gtk.HTML"/></param>
<param name="stream">A <see cref="T:Gtk.HTMLStream"/></param>
<returns>A <see cref="T:Gtk.HTMLStream"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Write">
@ -47,9 +47,9 @@
<Parameter Name="buffer" Type="System.String" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="buffer">To be added: an object of type 'string'</param>
<remarks>To be added</remarks>
<summary>Writes the HTML out to <paramref name="buffer"/></summary>
<param name="buffer">A <see cref="T:System.String"/></param>
<remarks/>
</Docs>
</Member>
<Member MemberName="Destroy">
@ -60,8 +60,8 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<remarks>To be added</remarks>
<summary>Destroy the stream object and dispose of the memory it uses.</summary>
<remarks/>
</Docs>
</Member>
<Member MemberName="Close">
@ -74,9 +74,9 @@
<Parameter Name="status" Type="Gtk.HTMLStreamStatus" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="status">To be added: an object of type 'Gtk.HTMLStreamStatus'</param>
<remarks>To be added</remarks>
<summary>Close the stream.</summary>
<param name="status">A <see cref="T:Gtk.HTMLStreamStatus"/></param>
<remarks/>
</Docs>
</Member>
<Member MemberName="Vprintf">
@ -91,10 +91,10 @@
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="format">To be added: an object of type 'string'</param>
<param name="ap">To be added: an object of type 'IntPtr'</param>
<returns>To be added: an object of type 'int'</returns>
<remarks>To be added</remarks>
<param name="format">A <see cref="T:System.String"/></param>
<param name="ap">A <see cref="T:IntPtr"/></param>
<returns>A <see cref="T:System.Int32"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName="Write">
@ -108,10 +108,10 @@
<Parameter Name="size" Type="System.Int32" />
</Parameters>
<Docs>
<summary>To be added</summary>
<param name="buffer">To be added: an object of type 'byte []'</param>
<param name="size">To be added: an object of type 'int'</param>
<remarks>To be added</remarks>
<summary>Write the HTML to <paramref name="buffer"/>.</summary>
<param name="buffer">A <see cref="T:byte []"/></param>
<param name="size">A <see cref="T:System.Int32"/></param>
<remarks/>
</Docs>
</Member>
<Member MemberName="Types">
@ -122,8 +122,8 @@
</ReturnValue>
<Docs>
<summary>To be added</summary>
<returns>To be added: an object of type 'string'</returns>
<remarks>To be added</remarks>
<returns>A <see cref="T:System.String"/></returns>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -137,7 +137,7 @@
<summary>To be added</summary>
<param name="raw">a <see cref="T:System.IntPtr" /></param>
<returns>a <see cref="T:Gtk.HTMLStream" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
<Member MemberName=".ctor">
@ -151,14 +151,14 @@
<Parameter Name="close_func" Type="Gtk.HTMLStreamCloseFunc" />
</Parameters>
<Docs>
<summary>To be added</summary>
<summary>Constructor.</summary>
<param name="html">a <see cref="T:Gtk.HTML" /></param>
<param name="type_func">a <see cref="T:Gtk.HTMLStreamTypesFunc" /></param>
<param name="write_func">a <see cref="T:Gtk.HTMLStreamWriteFunc" /></param>
<param name="close_func">a <see cref="T:Gtk.HTMLStreamCloseFunc" /></param>
<returns>a <see cref="T:Gtk.HTMLStream" /></returns>
<remarks>To be added</remarks>
<remarks/>
</Docs>
</Member>
</Members>
</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>A delegate for use with <see cref="T:Gtk.HTMLStream"/>. Meant to be used for closing the stream.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -30,4 +30,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>

View File

@ -10,8 +10,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>An enumeration of possible statuses for an HTML stream.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Enum</BaseTypeName>
@ -37,7 +37,7 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Okay; HTTP result 200</summary>
<remarks>
</remarks>
</Docs>
@ -50,9 +50,10 @@
</ReturnValue>
<Parameters />
<Docs>
<summary>To be added</summary>
<summary>Not okay.</summary>
<remarks>
</remarks>
(TODO: This is for everything non-200? Look up in source.)
</remarks>
</Docs>
</Member>
<Member MemberName="value__">
@ -69,4 +70,4 @@
</Docs>
</Member>
</Members>
</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>A delegate for use with <see cref="T:Gtk.HTMLStream"/>.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -29,4 +29,4 @@
<ReturnValue>
<ReturnType>System.String</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>A delegate for use with <see cref="T:Gtk.HTMLStream"/>. Meant to be used for writing the stream.</summary>
<remarks/>
</Docs>
<Base>
<BaseTypeName>System.Delegate</BaseTypeName>
@ -31,4 +31,4 @@
<ReturnValue>
<ReturnType>System.Void</ReturnType>
</ReturnValue>
</Type>
</Type>