diff --git a/doc/ChangeLog b/doc/ChangeLog index 95cf0c63f..a81a35b56 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,20 @@ +2004-08-29 Shane Landrum + + * 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 * en/Gtk/HSV.xml: Added docs for color selector. diff --git a/doc/en/Gtk/HTML.xml b/doc/en/Gtk/HTML.xml index 77a39c390..54223442f 100644 --- a/doc/en/Gtk/HTML.xml +++ b/doc/en/Gtk/HTML.xml @@ -587,7 +587,7 @@ class X { - To be added + Begins processing HTML. an object of type an object of type an object of type @@ -650,7 +650,7 @@ class X { - To be added + To be added. an object of type @@ -693,7 +693,7 @@ class X { - To be added + Sets the font style for the widget. an object of type an object of type @@ -709,9 +709,9 @@ class X { - To be added + Unrefs an image. an object of type - + (TODO: explain refcounting for images.) @@ -724,7 +724,7 @@ class X { - To be added + Refs an image. an object of type @@ -791,7 +791,7 @@ class X { - To be added + Unrefs images. @@ -1651,12 +1651,12 @@ class X { - To be added + Adds a header and footer to the HTML and prints it using . a a a - a - a + a , a header generation routine + a , a footer generation routine @@ -1685,7 +1685,7 @@ class X { - To be added + Prints this document using . a @@ -2062,7 +2062,7 @@ class X { System.IntPtr - To be added + Sets the indentation level for the widget. a diff --git a/doc/en/Gtk/HTMLBeginFlags.xml b/doc/en/Gtk/HTMLBeginFlags.xml index 13c3fa4a0..efc61c23e 100644 --- a/doc/en/Gtk/HTMLBeginFlags.xml +++ b/doc/en/Gtk/HTMLBeginFlags.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Flags for how to begin processing a chunk of HTML. + System.Enum @@ -69,4 +69,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLClassProperties.xml b/doc/en/Gtk/HTMLClassProperties.xml index 34a625fdf..ee95add9c 100644 --- a/doc/en/Gtk/HTMLClassProperties.xml +++ b/doc/en/Gtk/HTMLClassProperties.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A properties class for . + Internal. Do not use. GLib.Opaque @@ -20,7 +20,7 @@ GLib.IWrapper - + @@ -40,4 +40,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLCommandType.xml b/doc/en/Gtk/HTMLCommandType.xml index fee6547d3..fbe6ae8b9 100644 --- a/doc/en/Gtk/HTMLCommandType.xml +++ b/doc/en/Gtk/HTMLCommandType.xml @@ -1181,7 +1181,7 @@ - To be added + Move focus forward one widget. @@ -1194,7 +1194,7 @@ - To be added + Move focus backward one widget. @@ -1207,7 +1207,7 @@ - To be added + Popup the context menu. @@ -1545,7 +1545,7 @@ - To be added + Select a paragraph or more. @@ -1818,7 +1818,7 @@ - To be added + Grab the keyboard focus. @@ -2006,4 +2006,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLEditorAPI.xml b/doc/en/Gtk/HTMLEditorAPI.xml index 62b489b11..490241d53 100644 --- a/doc/en/Gtk/HTMLEditorAPI.xml +++ b/doc/en/Gtk/HTMLEditorAPI.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Hooks for an HTML editor. Currently unsupported in Gtk#. + See . System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + An empty object. + @@ -41,11 +41,11 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.HTMLEditorAPI' - To be added + Default constructor. + A , pointer to the underlying C object. + A + - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLEditorEventType.xml b/doc/en/Gtk/HTMLEditorEventType.xml index a1b5ac277..9e587d4c6 100644 --- a/doc/en/Gtk/HTMLEditorEventType.xml +++ b/doc/en/Gtk/HTMLEditorEventType.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Enumeration of possible kinds of HTML editing events. + System.Enum @@ -95,4 +95,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLFontStyleShift.xml b/doc/en/Gtk/HTMLFontStyleShift.xml index 90baa5619..b829a3f15 100644 --- a/doc/en/Gtk/HTMLFontStyleShift.xml +++ b/doc/en/Gtk/HTMLFontStyleShift.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Enumeration for how HTML font styles can be changed. + System.Enum @@ -37,7 +37,7 @@ - To be added + Bold font style. @@ -50,7 +50,7 @@ - To be added + Italic font style. @@ -63,7 +63,7 @@ - To be added + Underlined font style. @@ -76,7 +76,7 @@ - To be added + Strikeout font style. @@ -89,7 +89,7 @@ - To be added + Fixed-width font style. @@ -102,7 +102,7 @@ - To be added + Subscript font style. @@ -115,7 +115,7 @@ - To be added + Superscript font style. @@ -134,4 +134,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLParagraphStyle.xml b/doc/en/Gtk/HTMLParagraphStyle.xml index 49584c911..1e1b9b3f9 100644 --- a/doc/en/Gtk/HTMLParagraphStyle.xml +++ b/doc/en/Gtk/HTMLParagraphStyle.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Enumeration of paragraph styles possible in . + System.Enum @@ -37,7 +37,7 @@ - To be added + Normal style. @@ -50,7 +50,7 @@ - To be added + Header 1 style. @@ -63,7 +63,7 @@ - To be added + Header 2 style. @@ -76,7 +76,7 @@ - To be added + Header 3 style. @@ -89,7 +89,7 @@ - To be added + Header 4 style. @@ -102,7 +102,7 @@ - To be added + Header 5 style. @@ -115,7 +115,7 @@ - To be added + Header 6 style. @@ -128,7 +128,7 @@ - To be added + Email address style. @@ -141,7 +141,7 @@ - To be added + Preformatted text style. @@ -154,7 +154,7 @@ - To be added + Unnumbered list style. @@ -167,7 +167,7 @@ - To be added + Roman-numeral numbered list. @@ -180,7 +180,7 @@ - To be added + Arabic-numbered ordered list. @@ -193,7 +193,7 @@ - To be added + Greek-lettered ordered list. @@ -212,4 +212,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLPrintCallback.xml b/doc/en/Gtk/HTMLPrintCallback.xml index 4af042cec..a02b2ebc3 100644 --- a/doc/en/Gtk/HTMLPrintCallback.xml +++ b/doc/en/Gtk/HTMLPrintCallback.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Delegate for printing page framing elements. + Used to print headers and footers in . System.Delegate @@ -28,4 +28,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLStream.xml b/doc/en/Gtk/HTMLStream.xml index 1d7d83e03..ce80418c8 100644 --- a/doc/en/Gtk/HTMLStream.xml +++ b/doc/en/Gtk/HTMLStream.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + Handles streaming I/O for . + TODO: needs examples. System.ValueType @@ -31,10 +31,10 @@ To be added - To be added: an object of type 'Gtk.HTML' - To be added: an object of type 'Gtk.HTMLStream' - To be added: an object of type 'Gtk.HTMLStream' - To be added + A + A + A + @@ -47,9 +47,9 @@ - To be added - To be added: an object of type 'string' - To be added + Writes the HTML out to + A + @@ -60,8 +60,8 @@ - To be added - To be added + Destroy the stream object and dispose of the memory it uses. + @@ -74,9 +74,9 @@ - To be added - To be added: an object of type 'Gtk.HTMLStreamStatus' - To be added + Close the stream. + A + @@ -91,10 +91,10 @@ To be added - To be added: an object of type 'string' - To be added: an object of type 'IntPtr' - To be added: an object of type 'int' - To be added + A + A + A + @@ -108,10 +108,10 @@ - To be added - To be added: an object of type 'byte []' - To be added: an object of type 'int' - To be added + Write the HTML to . + A + A + @@ -122,8 +122,8 @@ To be added - To be added: an object of type 'string' - To be added + A + @@ -137,7 +137,7 @@ To be added a a - To be added + @@ -151,14 +151,14 @@ - To be added + Constructor. a a a a a - To be added + - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLStreamCloseFunc.xml b/doc/en/Gtk/HTMLStreamCloseFunc.xml index 8dd8a16d5..39c7d992f 100644 --- a/doc/en/Gtk/HTMLStreamCloseFunc.xml +++ b/doc/en/Gtk/HTMLStreamCloseFunc.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A delegate for use with . Meant to be used for closing the stream. + System.Delegate @@ -30,4 +30,4 @@ System.Void - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLStreamStatus.xml b/doc/en/Gtk/HTMLStreamStatus.xml index 223fae299..3a7ec2c28 100644 --- a/doc/en/Gtk/HTMLStreamStatus.xml +++ b/doc/en/Gtk/HTMLStreamStatus.xml @@ -10,8 +10,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + An enumeration of possible statuses for an HTML stream. + System.Enum @@ -37,7 +37,7 @@ - To be added + Okay; HTTP result 200 @@ -50,9 +50,10 @@ - To be added + Not okay. - + (TODO: This is for everything non-200? Look up in source.) + @@ -69,4 +70,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLStreamTypesFunc.xml b/doc/en/Gtk/HTMLStreamTypesFunc.xml index 1709eb9ce..f67ddcbcd 100644 --- a/doc/en/Gtk/HTMLStreamTypesFunc.xml +++ b/doc/en/Gtk/HTMLStreamTypesFunc.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A delegate for use with . + System.Delegate @@ -29,4 +29,4 @@ System.String - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLStreamWriteFunc.xml b/doc/en/Gtk/HTMLStreamWriteFunc.xml index 7e4fafe7a..6f8b65b9e 100644 --- a/doc/en/Gtk/HTMLStreamWriteFunc.xml +++ b/doc/en/Gtk/HTMLStreamWriteFunc.xml @@ -7,8 +7,8 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + A delegate for use with . Meant to be used for writing the stream. + System.Delegate @@ -31,4 +31,4 @@ System.Void - \ No newline at end of file +