diff --git a/doc/ChangeLog b/doc/ChangeLog index 9b020f4c9..8f0bd1ce9 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,11 @@ +2004-08-13 Shane Landrum + + * en/Gtk/HTML.xml + * en/Gtk/HTMLCommandType.xml + * en/Gtk/HTMLFontStyle.xml + * en/Gtk/HTMLParagraphAlignment.xml + * en/Gtk/HTMLSaveReceiverFn.xml: documented HTML widget classes. + 2004-08-08 Hector E. Gomez Morales * en/Gtk/AccelGroup.xml diff --git a/doc/en/Gtk/HTML.xml b/doc/en/Gtk/HTML.xml index d3089d398..a5bad6ee1 100644 --- a/doc/en/Gtk/HTML.xml +++ b/doc/en/Gtk/HTML.xml @@ -205,11 +205,11 @@ namespace HtmlTest - To be added - an object of type + Sends HTML out from the widget. + a , a content type. an object of type - an object of type - To be added + a , true if the export happened successfully, false if otherwise. + @@ -246,9 +246,9 @@ namespace HtmlTest - To be added - an object of type - To be added + Changes the font style by flipping toggle bits: from bold to regular or vice-versa. For a full list of toggle bits, see . + a + @@ -259,8 +259,8 @@ namespace HtmlTest - To be added - To be added + Selects a paragraph. + @@ -271,8 +271,8 @@ namespace HtmlTest - To be added - To be added + Resets the magnification of the text to 100% (normal). + @@ -287,11 +287,11 @@ namespace HtmlTest - To be added + Writes bytes of content from to . an object of type an object of type an object of type - To be added + @@ -344,8 +344,8 @@ namespace HtmlTest - To be added - To be added + This method is designed to be called after the style, indentation, or other font attributes of an editable HTML widget have changed. + When this is called, it will trigger the emission of signals for paragraphs whose indentation or style has changed. @@ -414,8 +414,8 @@ class X { - To be added - To be added + Sets up internal references to all images. + FIXME: verify this. @@ -445,8 +445,8 @@ class X { - To be added - To be added + Set up an empty widget. + @@ -533,9 +533,9 @@ class X { - To be added + Adds HTML to the end of the HTML currently being rendered by the widget. an object of type - To be added + @@ -546,8 +546,8 @@ class X { - To be added - To be added + Selects the line the cursor is currently on. + @@ -558,8 +558,8 @@ class X { - To be added - To be added + Removes an indent level. + @@ -591,7 +591,7 @@ class X { an object of type an object of type an object of type - To be added + @@ -604,9 +604,9 @@ class X { - To be added - an object of type - To be added + Enables or disables debugging features. + an object of type , true for enabled, false for disabled + @@ -617,9 +617,9 @@ class X { - To be added - an object of type - To be added + Makes the edit cursor visible. + a , true if the operation was a success. + @@ -651,7 +651,7 @@ class X { To be added an object of type - To be added + @@ -676,9 +676,9 @@ class X { - To be added + Inserts HTML into the existing HTML of the widget. an object of type - To be added + @@ -695,7 +695,7 @@ class X { To be added an object of type an object of type - To be added + @@ -710,7 +710,7 @@ class X { To be added an object of type - To be added + @@ -725,7 +725,7 @@ class X { To be added an object of type - To be added + @@ -755,9 +755,9 @@ class X { - To be added - an object of type - To be added + Preloads the image at the URL + a , an image URL. + @@ -779,7 +779,7 @@ class X { an object of type an object of type an object of type - To be added + @@ -791,7 +791,7 @@ class X { To be added - To be added + @@ -804,10 +804,10 @@ class X { - To be added - an object of type - an object of type - To be added + Invokes a delegate function to save the HTML. + a + an object of type , whether the operation succeeded. + @@ -882,9 +882,9 @@ class X { - To be added - an object of type - To be added + Set whether selection is allowed in this widget. + an object of type , true if selection is allowed. + @@ -908,7 +908,7 @@ class X { To be added - To be added + @@ -933,10 +933,10 @@ class X { - To be added - an object of type - an object of type - To be added + Execute a command on the widget. + an object of type , one of the values named in . + an object of type for whether the command succeeded. + @@ -1010,9 +1010,9 @@ class X { System.UInt32 - To be added + The indentation level of a paragraph. an object of type - To be added + @@ -1024,10 +1024,10 @@ class X { - To be added + The base URL of this document. an object of type an object of type - To be added + @@ -1039,10 +1039,10 @@ class X { - To be added + The title of this HTML document. an object of type an object of type - To be added + @@ -1054,10 +1054,10 @@ class X { - To be added + The default content type. an object of type an object of type - To be added + @@ -1069,10 +1069,10 @@ class X { - To be added + The style of a paragraph. an object of type an object of type - To be added + @@ -1087,7 +1087,7 @@ class X { To be added an object of type an object of type - To be added + @@ -1099,10 +1099,10 @@ class X { - To be added + The current widget magnification level. an object of type an object of type - To be added + @@ -1114,10 +1114,10 @@ class X { - To be added + The alignment of text (right, left, center) an object of type an object of type - To be added + @@ -1129,10 +1129,10 @@ class X { - To be added + Whether to allow framesets in this widget. an object of type an object of type - To be added + @@ -1143,8 +1143,8 @@ class X { - To be added - To be added + Fired when the font style under the cursor is changed. + @@ -1171,8 +1171,8 @@ class X { - To be added - To be added + Fired when the base URL of the document is changed. + @@ -1183,8 +1183,8 @@ class X { - To be added - To be added + Fired when the size of text is changed. + @@ -1195,8 +1195,8 @@ class X { - To be added - To be added + Fired when the text style of this paragraph is changed. + @@ -1207,8 +1207,8 @@ class X { - To be added - To be added + Fired after a webpage is finished loading. + @@ -1234,8 +1234,8 @@ class X { - To be added - To be added + Fired when a command is issued to the widget. + @@ -1323,8 +1323,8 @@ class X { - To be added - To be added + Fired after an IFRAME is created. + @@ -1335,8 +1335,8 @@ class X { - To be added - To be added + Fired when the widget is scrolled. + @@ -1347,8 +1347,8 @@ class X { - To be added - To be added + Fired when the indent level of the current paragraph is changed. + @@ -1359,8 +1359,8 @@ class X { - To be added - To be added + Fired when the alignment of the current paragraph is changed. + @@ -1371,8 +1371,8 @@ class X { - To be added - To be added + Fired when the text color to insert is changed. + @@ -1435,8 +1435,8 @@ class X { - To be added - To be added + Fired when a form submit button is clicked. + @@ -1447,8 +1447,8 @@ class X { - To be added - To be added + Fired when an HTTP redirect is received. + @@ -1513,8 +1513,8 @@ class X { - To be added - To be added + Fired when the base URL target is changed. + @@ -1527,9 +1527,9 @@ class X { - To be added - To be added: an object of type 'string' - To be added + Load a string into the HTML viewing widget. + The string to load. + @@ -1540,10 +1540,10 @@ class X { - To be added - an object of type + A constructor. + an object of type (FIXME: check this) an object of type - To be added + @@ -1555,10 +1555,10 @@ class X { - To be added - an object of type - an object of type - To be added + The base URL of the document. + A containing the URL + A containing the URL. + @@ -1573,7 +1573,7 @@ class X { To be added an object of type an object of type - To be added + @@ -1585,10 +1585,10 @@ class X { - To be added + Whether magic links (auto-recognizing URLs and making them clickable) is activated. a a - To be added + @@ -1600,10 +1600,10 @@ class X { - To be added + Whether magic smileys (automatically recognizing smileys and turning them into small graphics) is activated. a a - To be added + @@ -1618,7 +1618,7 @@ class X { To be added a a - To be added + @@ -1633,7 +1633,7 @@ class X { To be added a a - To be added + @@ -1656,7 +1656,7 @@ class X { a a a - To be added + @@ -1671,7 +1671,7 @@ class X { To be added a - To be added + @@ -1686,7 +1686,7 @@ class X { To be added a - To be added + @@ -1701,12 +1701,12 @@ class X { - To be added + Gets the number of pages this HTML would print to given a context with the given header and footer heights. a a a a - To be added + @@ -1718,7 +1718,7 @@ class X { To be added - To be added + @@ -1729,9 +1729,9 @@ class X { - To be added + Whether the widget has an Undo option or not. a - To be added + @@ -2063,7 +2063,7 @@ class X { To be added a - To be added + diff --git a/doc/en/Gtk/HTMLCommandType.xml b/doc/en/Gtk/HTMLCommandType.xml index ee962f45e..68805166d 100644 --- a/doc/en/Gtk/HTMLCommandType.xml +++ b/doc/en/Gtk/HTMLCommandType.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 commands that knows how to respond to. + System.Enum @@ -37,7 +37,7 @@ - To be added + Undo the last command @@ -50,7 +50,7 @@ - To be added + Redo the last un-done command. @@ -63,7 +63,7 @@ - To be added + Copy the current selection. @@ -76,7 +76,7 @@ - To be added + Copy the current selection and make further selection impossible. @@ -89,7 +89,7 @@ - To be added + Cut the current selection. @@ -102,7 +102,7 @@ - To be added + Paste the current clipboard contents. @@ -115,7 +115,7 @@ - To be added + Cut the current line to the clipboard. @@ -128,7 +128,7 @@ - To be added + Insert a new paragraph at the cursor location. @@ -141,7 +141,7 @@ - To be added + Insert a tab character. @@ -154,7 +154,7 @@ - To be added + Insert a rule line. @@ -167,7 +167,7 @@ - To be added + Insert parameters for a rule line. @@ -180,7 +180,7 @@ - To be added + Insert parameters for an image. @@ -193,7 +193,7 @@ - To be added + Add a new tab or increase the current indent level. @@ -206,7 +206,7 @@ - To be added + Insert a new tab or go to the next table in a cell. @@ -219,7 +219,7 @@ - To be added + Create a new link. @@ -232,7 +232,7 @@ - To be added + Remove an existing link. @@ -245,7 +245,7 @@ - To be added + Delete text. @@ -258,7 +258,7 @@ - To be added + Delete the character before the cursor. @@ -271,7 +271,7 @@ - To be added + Delete the character before the cursor or remove an indent level. @@ -284,7 +284,7 @@ - To be added + Go into selection mode. @@ -297,7 +297,7 @@ - To be added + Disable selections. @@ -310,7 +310,7 @@ - To be added + Make text bold. @@ -323,7 +323,7 @@ - To be added + Make text non-bold. @@ -336,7 +336,7 @@ - To be added + Toggle the bold style for a character or region. @@ -349,7 +349,7 @@ - To be added + Make text italic. @@ -362,7 +362,7 @@ - To be added + Make text non-italic. @@ -375,7 +375,7 @@ - To be added + Toggle the italic attribute for a character or block of text. @@ -388,7 +388,7 @@ - To be added + Make text underlined. @@ -401,7 +401,7 @@ - To be added + Make text non-underlined. @@ -414,7 +414,7 @@ - To be added + Toggle the underline attribute on a character or block of text. @@ -427,7 +427,7 @@ - To be added + Strike out text. @@ -440,7 +440,7 @@ - To be added + Remove strikeouts from text. @@ -453,7 +453,7 @@ - To be added + Toggle the strikeout attribute on a character or block of text. @@ -466,7 +466,7 @@ - To be added + Sets text to the smallest size. @@ -479,7 +479,7 @@ - To be added + Sets text to the second-smallest size. @@ -492,7 +492,7 @@ - To be added + Sets text to normal size. @@ -505,7 +505,7 @@ - To be added + Sets text to a medium-large size. @@ -518,7 +518,7 @@ - To be added + Sets text to a large size. @@ -531,7 +531,7 @@ - To be added + Sets text to a very large size. @@ -544,7 +544,7 @@ - To be added + Sets text to the largest possible size. @@ -557,7 +557,7 @@ - To be added + Makes text one size larger. @@ -570,7 +570,7 @@ - To be added + Makes text one size smaller. @@ -583,7 +583,7 @@ - To be added + Left-aligns text. @@ -596,7 +596,7 @@ - To be added + Center-aligns text. @@ -609,7 +609,7 @@ - To be added + Right-aligns text. @@ -622,7 +622,7 @@ - To be added + Clears indent values on text. @@ -635,7 +635,7 @@ - To be added + Indents text one level. @@ -648,7 +648,7 @@ - To be added + Indents text one level or moves it to the next cell in a table. @@ -661,7 +661,7 @@ - To be added + De-indents text. @@ -674,7 +674,7 @@ - To be added + Goes to the previous cell in a table. @@ -687,7 +687,7 @@ - To be added + Indents an entire paragraph. @@ -700,7 +700,7 @@ - To be added + Adds a new linebreak and re-flows text appropriately. @@ -713,7 +713,7 @@ - To be added + Adds a new space and re-flows text appropriately. @@ -726,7 +726,7 @@ - To be added + Sets the style of this paragraph to normal. @@ -739,7 +739,7 @@ - To be added + Sets this paragraph to be an HTML H1 element. @@ -752,7 +752,7 @@ - To be added + Sets this paragraph to be an HTML H2 element. @@ -765,7 +765,7 @@ - To be added + Sets this paragraph to be an HTML H3 element. @@ -778,7 +778,7 @@ - To be added + Sets this paragraph to be an HTML H4 element. @@ -791,7 +791,7 @@ - To be added + Sets this paragraph to be an HTML H5 element. @@ -804,7 +804,7 @@ - To be added + Sets this paragraph to be an HTML H6 element. @@ -817,7 +817,7 @@ - To be added + Sets this paragraph to be an HTML <address> element. @@ -830,7 +830,7 @@ - To be added + Sets this paragraph to be preformatted (i.e. fixed-width with carriage returns being significant). @@ -843,7 +843,7 @@ - To be added + Sets this paragraph to be an HTML <LI> item. @@ -856,7 +856,7 @@ - To be added + Sets this paragraph to be part of a sequentially-Roman-numeral-numbered list. @@ -869,7 +869,7 @@ - To be added + Sets this paragraph to be part of a sequentially-numbered list. @@ -882,7 +882,7 @@ - To be added + Sets this paragraph to be part of a sequentially-alphabetically-numbered list ("a. Item one; b. Item two; c. Item three.") @@ -895,7 +895,7 @@ - To be added + Extends the current selection up. @@ -908,7 +908,7 @@ - To be added + Extends the current selection down. @@ -921,7 +921,7 @@ - To be added + Extends the current selection to the left. @@ -934,7 +934,7 @@ - To be added + Extends the current selection to the right. @@ -947,7 +947,7 @@ - To be added + Extends the current selection by one page upwards. @@ -960,7 +960,7 @@ - To be added + Extends the current selection by one page downwards. @@ -973,7 +973,7 @@ - To be added + Extends the current selection to the beginning of the line. @@ -986,7 +986,7 @@ - To be added + Extends the current selection to the end of the line. @@ -999,7 +999,7 @@ - To be added + Extend the selection to the beginning of the document. @@ -1012,7 +1012,7 @@ - To be added + Extend the selection to the end of the document. @@ -1025,7 +1025,7 @@ - To be added + Extend the selection to include the previous word. @@ -1038,7 +1038,7 @@ - To be added + Extend the selection to include the next word. @@ -1051,7 +1051,7 @@ - To be added + Capitalize the current word. @@ -1064,7 +1064,7 @@ - To be added + Turns this word into all-upper-case. @@ -1077,7 +1077,7 @@ - To be added + Turns this word into all-lower-case. @@ -1090,7 +1090,7 @@ - To be added + Suggest a spelling for the current (misspelled) word. @@ -1103,7 +1103,7 @@ - To be added + Add this word to the user's personal spellchecker dictionary. @@ -1116,7 +1116,7 @@ - To be added + Add this word to the spellchecker dictionary for this session, so that it doesn't show up as misspelled. @@ -1129,7 +1129,7 @@ - To be added + Search the widget for a given term. @@ -1142,7 +1142,7 @@ - To be added + Incremental search forward. @@ -1155,7 +1155,7 @@ - To be added + Incremental search backward. @@ -1168,7 +1168,7 @@ - To be added + Search the text using a regular expression. @@ -1220,7 +1220,7 @@ - To be added + Pop up the properties dialog. @@ -1233,7 +1233,7 @@ - To be added + Move the cursor forward. @@ -1246,7 +1246,7 @@ - To be added + Move the cursor backward. @@ -1259,7 +1259,7 @@ - To be added + Insert a table with empty text, one row, and one column. @@ -1272,7 +1272,7 @@ - To be added + Insert a table column after the current one. @@ -1285,7 +1285,7 @@ - To be added + Insert a table column before the current one. @@ -1298,7 +1298,7 @@ - To be added + Insert a table row after the current one. @@ -1311,7 +1311,7 @@ - To be added + Insert a table row before the current one. @@ -1324,7 +1324,7 @@ - To be added + Delete a table column. @@ -1337,7 +1337,7 @@ - To be added + Delete a row from the current table. @@ -1350,7 +1350,7 @@ - To be added + Widen/increase the COLSPAN attribute for a table cell. @@ -1363,7 +1363,7 @@ - To be added + Narrow/decrease the COLSPAN attribute for a table cell. @@ -1376,7 +1376,7 @@ - To be added + Increase the ROWSPAN attribute for a table cell. @@ -1389,7 +1389,7 @@ - To be added + Decrease the ROWSPAN attribute for a table cell. @@ -1402,7 +1402,7 @@ - To be added + Join this table cell with one to its left. @@ -1415,7 +1415,7 @@ - To be added + Join this table cell with one to its right. @@ -1428,7 +1428,7 @@ - To be added + Join this table cell with one above it. @@ -1441,7 +1441,7 @@ - To be added + Join this table cell with one below it. @@ -1454,7 +1454,7 @@ - To be added + Make the borders of this table wider. @@ -1467,7 +1467,7 @@ - To be added + Make the borders of this table narrower. @@ -1480,7 +1480,7 @@ - To be added + Make the borders of this table zero. @@ -1493,7 +1493,7 @@ - To be added + Set the default color of text. @@ -1506,7 +1506,7 @@ - To be added + Select the current word. @@ -1519,7 +1519,7 @@ - To be added + Select the current line. @@ -1532,7 +1532,7 @@ - To be added + Select the current paragraph. @@ -1558,7 +1558,7 @@ - To be added + Select all of this document. @@ -1571,7 +1571,7 @@ - To be added + Save the cursor's current position to the cursor position stack. @@ -1584,7 +1584,7 @@ - To be added + Restores a cursor position that was saved to the cursor position stack. @@ -1597,7 +1597,7 @@ - To be added + Move the cursor to the beginning of the document. @@ -1610,7 +1610,7 @@ - To be added + Move the cursor to the end of the document. @@ -1649,7 +1649,7 @@ - To be added + Magnify the text. @@ -1662,7 +1662,7 @@ - To be added + Make the text display size smaller. @@ -1675,7 +1675,7 @@ - To be added + Reset the zoom level to normal size text. @@ -1688,7 +1688,7 @@ - To be added + Increase the spacing between table cells. @@ -1701,7 +1701,7 @@ - To be added + Decrease the spacing between table cells. @@ -1714,7 +1714,7 @@ - To be added + Make the spacing between table cells zero. @@ -1727,7 +1727,7 @@ - To be added + Increase the padding between table cells. @@ -1740,7 +1740,7 @@ - To be added + Decrease the padding between table cells. @@ -1753,7 +1753,7 @@ - To be added + Set the padding between table cells to zero. @@ -1766,7 +1766,7 @@ - To be added + Delete an entire table. @@ -1779,7 +1779,7 @@ - To be added + Delete a row from a table. @@ -1792,7 +1792,7 @@ - To be added + Delete a column from a table. @@ -1805,7 +1805,7 @@ - To be added + Clear the contents of a table cell. @@ -1857,7 +1857,7 @@ - To be added + Apply a certain color to a text selection. @@ -1922,7 +1922,7 @@ - To be added + Go to the beginning of the document. @@ -1935,7 +1935,7 @@ - To be added + Go to the end of the document. @@ -1948,7 +1948,7 @@ - To be added + Increase the COLSPAN value of a table cell. @@ -1961,7 +1961,7 @@ - To be added + Increase the ROWSPAN value of a table cell. @@ -1974,7 +1974,7 @@ - To be added + Decrease the COLSPAN attribute of a cell. @@ -1987,7 +1987,7 @@ - To be added + Decrease the ROWSPAN attribute of a cell. @@ -2006,4 +2006,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLFontStyle.xml b/doc/en/Gtk/HTMLFontStyle.xml index 7bee7dd20..c462e6124 100644 --- a/doc/en/Gtk/HTMLFontStyle.xml +++ b/doc/en/Gtk/HTMLFontStyle.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 font styles within a widget. + System.Enum @@ -37,7 +37,7 @@ - To be added + The default style. @@ -50,7 +50,7 @@ - To be added + The smallest text size. @@ -63,7 +63,7 @@ - To be added + A small text size. @@ -75,8 +75,8 @@ Gtk.HTMLFontStyle - - To be added + + A medium-small text size. @@ -89,7 +89,7 @@ - To be added + A medium text size. @@ -102,7 +102,7 @@ - To be added + A medium-large text size. @@ -115,7 +115,7 @@ - To be added + A large text size. @@ -128,7 +128,7 @@ - To be added + The largest text size. @@ -141,8 +141,8 @@ - To be added - + A mask for changing font sizes. + FIXME: explain this. @@ -154,7 +154,7 @@ - To be added + An italic style. @@ -167,7 +167,7 @@ - To be added + An italic style. @@ -180,7 +180,7 @@ - To be added + An underlined style. @@ -193,7 +193,7 @@ - To be added + A strikeout style. @@ -206,7 +206,7 @@ - To be added + A fixed-width style. @@ -219,7 +219,7 @@ - To be added + A subscript style. @@ -232,7 +232,7 @@ - To be added + A superscript style. @@ -251,4 +251,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLParagraphAlignment.xml b/doc/en/Gtk/HTMLParagraphAlignment.xml index fddc82ae8..37c8c7747 100644 --- a/doc/en/Gtk/HTMLParagraphAlignment.xml +++ b/doc/en/Gtk/HTMLParagraphAlignment.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 representing the possible alignment of paragraphs. + System.Enum @@ -37,7 +37,7 @@ - To be added + Aligned with a straight left margin. @@ -50,7 +50,7 @@ - To be added + Aligned with a straight right margin. @@ -63,7 +63,7 @@ - To be added + Aligned so that every line is centered. @@ -82,4 +82,4 @@ - \ No newline at end of file + diff --git a/doc/en/Gtk/HTMLSaveReceiverFn.xml b/doc/en/Gtk/HTMLSaveReceiverFn.xml index 40172228d..bcedc3b89 100644 --- a/doc/en/Gtk/HTMLSaveReceiverFn.xml +++ b/doc/en/Gtk/HTMLSaveReceiverFn.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 to receive HTML content from . In most cases, a delegate of this form probably saves HTML to a file, prints it, or similar. + System.Delegate @@ -30,4 +30,4 @@ System.Boolean - \ No newline at end of file +