diff --git a/doc/ChangeLog b/doc/ChangeLog index bc588173c..476dbfe35 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,10 @@ +2003-07-13 Duncan Mak + + * en/Gtk/TextTag.xml: + * en/Gtk/TextTagTable.xml: + * en/Gtk/TextMark.xml: + * en/Gtk/TextChildAnchor.xml: documented. + 2003-07-12 Duncan Mak * en/Gtk/TextBuffer.xml: all documented except for events. diff --git a/doc/en/Gtk/TextBuffer.xml b/doc/en/Gtk/TextBuffer.xml index c97ec9a98..32d3de3a5 100644 --- a/doc/en/Gtk/TextBuffer.xml +++ b/doc/en/Gtk/TextBuffer.xml @@ -102,7 +102,9 @@ - Emits the "remove_tag" signal. + Fires the events + and removes all occurrences of from + the given range the to remove the beginning of the range diff --git a/doc/en/Gtk/TextChildAnchor.xml b/doc/en/Gtk/TextChildAnchor.xml index 404510961..8913f0c6a 100644 --- a/doc/en/Gtk/TextChildAnchor.xml +++ b/doc/en/Gtk/TextChildAnchor.xml @@ -57,9 +57,16 @@ - To be added + Creates a new TextChildAnchor To be added: an object of type 'Gtk.TextChildAnchor' - To be added + + + To create a new , you + can also use the factory method + from the class. + + @@ -81,9 +88,9 @@ GLib.List - To be added - To be added: an object of type 'GLib.List' - To be added + Gets a list of all widgets anchored at this child anchor. + a list of widgets anchored + @@ -93,9 +100,11 @@ System.Boolean - To be added - To be added: an object of type 'bool' - To be added + Determines whether the child anchor has been deleted from the buffer. + + if the child anchor has been deleted from its buffer + + diff --git a/doc/en/Gtk/TextMark.xml b/doc/en/Gtk/TextMark.xml index d90a6422f..3827c3e4a 100644 --- a/doc/en/Gtk/TextMark.xml +++ b/doc/en/Gtk/TextMark.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,34 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + A GtkTextMark is like a bookmark in a text buffer; it preserves a position in the text. + + + + A GtkTextMark is like a bookmark in a text buffer; it + preserves a position in the text. You can convert the mark to + an iterator using . Unlike + iterators, marks remain valid across buffer mutations, because + their behavior is defined when text is inserted or + deleted. When text containing a mark is deleted, the mark + remains in the position originally occupied by the deleted + text. When text is inserted at a mark, a mark with left + gravity will be moved to the beginning of the newly-inserted + text, and a mark with right gravity will be moved to the + end. + + + Marks optionally have names; these can be convenient to avoid + passing the object around. + + + Marks are typically created using the + function. + + + GLib.Object @@ -81,9 +107,12 @@ System.String - To be added - To be added: an object of type 'string' - To be added + The name of the mark + + Returns the name of the mark and if + it's an anonymous mark + + @@ -93,9 +122,16 @@ System.Boolean - To be added - To be added: an object of type 'bool' - To be added + Whether of not the mark has been removed + Returns if the mark has been removed from its buffer. + + + Returns if the mark has been + removed from its buffer with . Marks + can't be used once they are deleted. + + @@ -105,9 +141,17 @@ System.Boolean - To be added - To be added: an object of type 'bool' - To be added + Whether or not the mark has left gravity + + if the mark has left gravity, + otherwise. + + + "left" and "right" here refer to logical direction (left is + the toward the start of the buffer); in some languages such + as Hebrew the logically-leftmost text is not actually on the + left when displayed. + @@ -120,10 +164,18 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + The visibility of the mark + The visibility of the mark + if the mark is visible (i.e. a cursor is displayed for it) + + + The insertion point is normally visible, i.e. you can see + it as a vertical bar. Also, the text widget uses a visible + mark to indicate where a drop will occur when + dragging-and-dropping text. Most other marks are not + visible. Marks are not visible by default. + + @@ -133,9 +185,13 @@ Gtk.TextBuffer - To be added - To be added: an object of type 'Gtk.TextBuffer' - To be added + + Gets the buffer where this mark is located + + The buffer where this mark is applied + + is returned if the mark has been deleted. + diff --git a/doc/en/Gtk/TextTag.xml b/doc/en/Gtk/TextTag.xml index 72c418490..b180d8337 100644 --- a/doc/en/Gtk/TextTag.xml +++ b/doc/en/Gtk/TextTag.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -326,10 +326,12 @@ - To be added - To be added: an object of type 'Gdk.Pixmap' - To be added: an object of type 'Gdk.Pixmap' - To be added + Bitmap to use as a mask when drawing the text background. + + The bitmap of type + + The background bitmap + @@ -342,10 +344,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Width of the left margin in pixels. + The width of the left margin in pixels + The width of the margin + @@ -358,10 +360,10 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + Font size in points. + Font size in points. + The font size + @@ -374,7 +376,7 @@ - To be added + This property should be fixed To be added: an object of type 'int' To be added: an object of type 'int' To be added @@ -390,10 +392,10 @@ - To be added - To be added: an object of type 'Gtk.TextDirection' - To be added: an object of type 'Gtk.TextDirection' - To be added + Text direction, e.g. right-to-left or left-to-right. + The direction of the text + The text direction + @@ -406,10 +408,12 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Pixels of blank space above paragraphs. + + The number of pixels of blank space above the paragraphs. + + The blank space above the paragraphs in pixels + @@ -422,10 +426,10 @@ - To be added - To be added: an object of type 'Gtk.WrapMode' - To be added: an object of type 'Gtk.WrapMode' - To be added + Whether to wrap lines never, at word boundaries, or at character boundaries. + The of this tag + a + @@ -435,9 +439,12 @@ System.String - To be added - To be added: an object of type 'string' - To be added + The name of this tag + + The name of this name, or if it's an + anonymous tag + + @@ -450,10 +457,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Amount to indent the paragraph, in pixels + The amount to indent in pixels + The indent of the paragraph + @@ -466,10 +473,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + Foreground color + the foreground color as a string + the foreground color + @@ -482,10 +489,14 @@ - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + + Background color as a (possibly unallocated) . + + + The background color as a . + + The background color + @@ -498,10 +509,14 @@ - To be added - To be added: an object of type 'Gdk.Color' - To be added: an object of type 'Gdk.Color' - To be added + + Foreground color as a (possibly unallocated) . + + + The foreground color as a . + + The foreground color + @@ -514,10 +529,10 @@ - To be added - To be added: an object of type 'Pango.TabArray' - To be added: an object of type 'Pango.TabArray' - To be added + Custom tabs for this text. + a + the custom tabs for this text + @@ -530,10 +545,10 @@ - To be added - To be added: an object of type 'Pango.Underline' - To be added: an object of type 'Pango.Underline' - To be added + Style of underline for this text. + the underline style + The underline style for this text + @@ -546,10 +561,18 @@ - To be added - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + Font size as a scale factor relative to the default font size + + Font size as a scale factor relative to the default font size. + + The font size as a scale factor + + + This properly adapts to theme changes etc. so is + recommended. Pango predefines some scales such as . + + @@ -562,10 +585,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The language this text is in, as an ISO code. + The ISO code of the language + The ISO code of the language of this text + @@ -578,10 +601,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Font size + Font size + The font size in Pango units + @@ -594,10 +617,12 @@ - To be added - To be added: an object of type 'Pango.Style' - To be added: an object of type 'Pango.Style' - To be added + Font style + + The font style in as a + + the font style of this text + @@ -610,10 +635,12 @@ - To be added - To be added: an object of type 'Pango.Variant' - To be added: an object of type 'Pango.Variant' - To be added + Font variant + + The font variant as a + + The font variant of this text + @@ -626,10 +653,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + Background color + The name of the background color + + @@ -658,10 +685,13 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the background color fills the entire line height or only the height of the tagged characters. + + if the background + color fills the entire line height + + Whether the background color fills the entire line height or only the height of the tagged characters. + diff --git a/doc/en/Gtk/TextTagTable.xml b/doc/en/Gtk/TextTagTable.xml index 14beeaab7..95965e507 100644 --- a/doc/en/Gtk/TextTagTable.xml +++ b/doc/en/Gtk/TextTagTable.xml @@ -7,8 +7,15 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + A tag table defines a set of tags + + + A tag table defines a set of tags that can be used + together. Each buffer has one tag table associated with it; only + tags from that tag table can be used with the buffer. A single + tag table can be shared between multiple buffers, however. + GLib.Object @@ -33,9 +40,9 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added + Remove a tag from the table. + the tag to be removed + @@ -48,9 +55,18 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added + Add a tag to the table. The tag is assigned the highest priority in the table. + the tag to be added + + + Add a tag to the table. The tag is assigned the highest + priority in the table. + + + must not be in a tag table already, + and may not have the same name as an already-added tag. + + @@ -63,10 +79,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.TextTag' - To be added + Finds a by its name + the name of a tag + The tag, or if none by that name is in the table. + @@ -142,9 +158,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The size of the table + The number of the tags in this table + @@ -153,8 +169,8 @@ - To be added - To be added + Emitted when a tag is removed from the table + @@ -163,8 +179,8 @@ - To be added - To be added + Emitted when a tag in the table is changed + @@ -173,8 +189,8 @@ - To be added - To be added + Emitted when a tag is added to the table +