From aa65123a95cf4f2da9f6090f5b5d527c8bdf18a6 Mon Sep 17 00:00:00 2001 From: Duncan Mak Date: Sat, 12 Jul 2003 09:20:37 +0000 Subject: [PATCH] 2003-07-12 Duncan Mak * en/Gtk/TextBuffer.xml: all documented except for events. 2003-07-07 Duncan Mak * en/Gtk/TearoffMenuItem.xml: documented. svn path=/trunk/gtk-sharp/; revision=16135 --- doc/ChangeLog | 9 + doc/en/Gtk/HScrollbar.xml | 2 +- doc/en/Gtk/TearoffMenuItem.xml | 33 +- doc/en/Gtk/TextBuffer.xml | 851 +++++++++++++++++++++++++-------- 4 files changed, 686 insertions(+), 209 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 8f35e180c..71cf742c9 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,12 @@ +<<<<<<< ChangeLog +2003-07-12 Duncan Mak + + * en/Gtk/TextBuffer.xml: all documented except for events. + +2003-07-07 Duncan Mak + + * en/Gtk/TearoffMenuItem.xml: documented. + 2003-07-08 John Luke * en/Gtk/Fixed.xml: diff --git a/doc/en/Gtk/HScrollbar.xml b/doc/en/Gtk/HScrollbar.xml index 29b48045e..7254919b9 100644 --- a/doc/en/Gtk/HScrollbar.xml +++ b/doc/en/Gtk/HScrollbar.xml @@ -71,7 +71,7 @@ Creates a new horizontal scrollbar. The to use, or to create a new adjustment. The new - To be added + diff --git a/doc/en/Gtk/TearoffMenuItem.xml b/doc/en/Gtk/TearoffMenuItem.xml index 50d3f07da..c122197bf 100644 --- a/doc/en/Gtk/TearoffMenuItem.xml +++ b/doc/en/Gtk/TearoffMenuItem.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,29 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + a menu item used to tear off and reattach its menu. + + + a is a special which is used to tear off and + reattach its menu. + + + When its menu is shown normally, the is drawn as a dotted line + indicating that the menu can be torn off. Activating it causes + its menu to be torn off and displayed in its own window as a + tearoff menu. + + + + When its menu is shown as a tearoff menu, the is drawn as a dotted line which + has a left pointing arrow graphic indicating that the tearoff + menu can be reattached. Activating it will erase the tearoff + menu window. + + Gtk.MenuItem @@ -63,9 +84,9 @@ - To be added - To be added: an object of type 'Gtk.TearoffMenuItem' - To be added + Creates a new + a new . + diff --git a/doc/en/Gtk/TextBuffer.xml b/doc/en/Gtk/TextBuffer.xml index bb0f33599..c97ec9a98 100644 --- a/doc/en/Gtk/TextBuffer.xml +++ b/doc/en/Gtk/TextBuffer.xml @@ -1,5 +1,5 @@ - + gtk-sharp 0.0.0.0 @@ -7,8 +7,11 @@ Gtk# is thread aware, but not thread safe; See the Gtk# Thread Programming for details. - To be added - To be added + + This is a store for formatted text for display in a . + + GLib.Object @@ -31,8 +34,14 @@ - To be added - To be added + Clears the contents in the current buffer + + + This is a convenience call to . + + @@ -45,9 +54,14 @@ - To be added - To be added: an object of type 'string' - To be added + Deletes the mark named ; the mark must exist. + the name of a mark in buffer + + + See for more details. + + @@ -61,10 +75,18 @@ - To be added - To be added: an object of type 'Gtk.TextIter&' - To be added: an object of type 'Gtk.TextIter&' - To be added + + Retrieves the first and last iterators in the buffer, i.e. the entire buffer. + + + A object to store the location + of the beginning of the buffer. + + + A object to store the location + of the end of the buffer. + + @@ -79,11 +101,20 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added + + Emits the "remove_tag" signal. + + the to remove + the beginning of the range + the end of the range + + + Fires the + event. The default handler for the signal removes all + occurrences of tag from the given range. and . + + @@ -97,10 +128,21 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added + + Removes all tags in the range between and . + + The beginning of the range + The end of the range + + + Removes all tags in the range between start and end. Be + careful with this function; it could remove tags added in + code unrelated to the code you're currently writing. That + is, calling this method is probably a bad idea if you have + two or more unrelated code sections that add tags. + + @@ -113,10 +155,16 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.TextMark' - To be added + + Returns the mark named name in buffer buffer, or if no such mark exists in the buffer. + + the name of a mark + + Returns the mark named name in buffer buffer, or if no such mark exists in the buffer. + + @@ -142,10 +190,29 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextChildAnchor' - To be added + Inserts a child widget anchor into the text buffer. + location to insert the anchor + a . + + + Inserts a child widget anchor into the text buffer at . The anchor will be counted as one + character in character counts, and when obtaining the + buffer contents as a string, will be represented by the + Unicode "object replacement character" 0xFFFC. Note that + the "slice" variants for obtaining portions of the buffer + as a string include this character for pixbufs, but the + "text" variants do not. e.g. see and ). Consider as a + more convenient alternative to this function. The buffer + will add a reference to the anchor, so you can unref it + after insertion. + + @@ -159,11 +226,24 @@ - To be added - To be added: an object of type 'Gtk.TextIter&' - To be added: an object of type 'Gtk.TextIter&' - To be added: an object of type 'bool' - To be added + Returns if some text is selected + the location of the beginning of the selection + the location of the end of the selection + Returns if the selection has nonzero length + + + Returns if some text is selected; + and sets the bounds of the selection in and (if + the selection has length 0, then start and end are filled + in with the same value). and will be in + ascending order. If and are , then they are + not filled in, but the return value still indicates + whether text is selected. + + @@ -190,11 +270,24 @@ - To be added - To be added: an object of type 'Gtk.Clipboard' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added + + Pastes the contents of a clipboard at the insertion point, + or at . + + the to paste from + + the location to insert pasted text, or for at the cursor + + + whether the buffer is editable by default + + + Pastes the contents of a clipboard at the insertion point, + or at . (Note: pasting + is asynchronous, that is, we'll ask for the paste data and + return, and at some point later after the main loop runs, + the paste data will be inserted.) + @@ -208,10 +301,15 @@ - To be added - To be added: an object of type 'Gtk.TextMark' - To be added: an object of type 'Gtk.TextIter' - To be added + Moves mark to the new location . + a . + the new location for mark in buffer + + + Moves mark to the new location where. Fires the event as notification of the move. + + @@ -226,12 +324,34 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added: an object of type 'string' - To be added + + Returns the text from to . + + the start of a range + the end of the range + whether to include invisible text + + a string containing the text from + to + + + + Returns the text in the range from to . Excludes undisplayed text + (text marked with tags that set the invisibility + attribute) if is + . The returned string includes a + 0xFFFC character whenever the buffer contains embedded + images, so byte and character indexes into the returned + string do correspond to byte and character indexes into + the buffer. Contrast with . Note that 0xFFFC can occur in normal text as well, so + it is not a reliable indicator that a pixbuf or widget is + in the buffer. + + @@ -244,10 +364,26 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextChildAnchor' - To be added + + This is a convenience function which simply creates a child + anchor with and inserts it into + the buffer with . + + the location in the buffer + the created child anchor + + + This is a convenience function which simply creates a child + anchor with and inserts it into + the buffer with . The new anchor is owned by the buffer; no reference + count is returned to the caller of . + + @@ -262,11 +398,16 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added + Fires the events on buffer. + a + the beginning of the range to be tagged + the end of the range to be tagged + + + The default handler for the signal applies tag to the + given range. start and end do not have to be in order. + + @@ -281,11 +422,34 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added + + Copies text, tags, and pixbufs between + and and inserts the copy at . + + a position in buffer + + a position in the source + + + a position in the source + + + + Copies text, tags, and pixbufs between and (the + order does not matter) and inserts the + copy at . Used instead of simply getting/inserting + text because it preserves images and tags. If and + are in a different buffer from buffer, the two buffers + must share the same tag table. + + + This method is implemented with the and events. + + @@ -300,11 +464,16 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added + + Calls on the buffer's tag table to get a , then calls + + + the name of the tag + the beginning of the buffer to be untagged + the end of the buffer to be untagged + @@ -318,11 +487,21 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Deletes the currently-selected text + whether the deletion is caused by user interaction + whether the buffer is editable by default + + whether there was a non-empty selection to delete + + + + Deletes the range between the "insert" and + "selection_bound" marks, that is, the currently-selected + text. If is , the editability of the selection will + be considered (users can't delete uneditable text). + + @@ -337,12 +516,22 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Deletes all editable text in the given range. + the beginning of range to delete + the end of the range to delete + whether the buffer is editable by default + whether some text was actually deleted + + + Deletes all editable text in the given range. Calls for each editable sub-range of + and . and + are revalidated to point to the + location of the last deleted range, or left untouched if + no text was deleted. + + @@ -371,10 +560,26 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added + + Deletes text between and . + + a position in the buffer + a position in the buffer + + + Deletes text between and . The order of the two is not actually + relevant, as they will be r reordered. This function + actually fires off the event, and the default + handler of that signal deletes the text. Because the + buffer is modified, all outstanding iterators become + invalid after calling this function; however, the start + and end will be re-initialized to point to the location + where text was deleted. + + @@ -387,9 +592,21 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added + Moves the "insert" and "selection_bound" marks simultaneously. + where to put the cursor + + + This function moves the "insert" and "selection_bound" + marks simultaneously. If you move them to the same place + in two steps with , + you will temporarily select a region in between their old + and new locations, which can be pretty inefficient since + the temporarily-selected region will force stuff to be + recalculated. This function moves them as a unit, which + can be optimized. + + @@ -417,9 +634,23 @@ - To be added - To be added: an object of type 'Gtk.TextMark' - To be added + Deletes mark, so that it's no longer located anywhere in the buffer. + + a in the buffer to be deleted. + + + + Deletes mark, so that it's no longer located anywhere in + the buffer. There is no way to undelete a + mark. will return + after + this function has been called on a mark; + indicates that a mark no + longer belongs to a buffer. The event will + be fired as notification after the mark is deleted. + + @@ -434,12 +665,32 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added: an object of type 'Gtk.TextMark' - To be added + Creates a mark at position . + name for mark, or . + location to place mark + whether the mark has left gravity + a new object + + + Creates a mark at position where. If is , + the mark is anonymous; otherwise, the mark can be + retrieved by name using . If a + mark has left gravity, and text is inserted at the mark's + current location, the mark will be moved to the left of + the newly-inserted text. If the mark has right gravity + (ie. = ), the mark will end up on the right + of newly-inserted text. The standard left-to-right cursor + is a mark with right gravity (when you type, the cursor + stays on the right side of the text you're typing). + + + Fires the event as + notification of the mark's initial placement. + + @@ -468,10 +719,18 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.TextIter' - To be added + + Moves the mark named (which must + exist) to location . + + the name of the mark + the new location for mark + + + see + for more details. + + @@ -487,13 +746,41 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + + Same as , but does nothing if the insertion point isn't editable. + + a position in buffer + + a position in the source + + + a position in the source + + + whether the text is editable at if no tags enclosing + iter affect editability + + + if an insertion was possible at + + + + Same as , but does nothing if the insertion point isn't + editable. + + + The parameter + indicates whether the text is editable at if no tags + enclosing iter affect editability. Typically the result of + is appropriate here. + + @@ -508,12 +795,29 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added: an object of type 'string' - To be added + Returns the text from a specified range + the beginning of the specified range + the end of the specified range + whether to include invisible text + a string containing the text from the specified range + + + Returns the text in the range specified by and . Excludes + undisplayed text (text marked with tags that set the + invisibility attribute) if is . Does not include characters + representing embedded images, so byte and character + indexes into the returned string do not correspond to byte + and character indexes into the buffer. + + + Contrast this with . + + @@ -528,11 +832,19 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gtk.TextIter' - To be added + + Fires the event on buffer. The default handler + for the signal applies tag to the given range. + + the name of the tag + the location of the beginning of the range + the location of the end of the range + + + The order for and is not important. + + @@ -546,10 +858,27 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'Gdk.Pixbuf' - To be added + + Inserts an image into the text buffer at . + + The location to insert the image + The image to be inserted + + + Inserts an image into the text buffer at . The image will be counted as one character in character counts, and + when obtaining the buffer contents as a string, will be + represented by the Unicode "object replacement character" + 0xFFFC. Note that the "slice" variants for obtaining + portions of the buffer as a string include this character + for pixbufs, but the "text" variants do not. e.g. see + and . + + @@ -605,10 +934,10 @@ - To be added - To be added: an object of type 'Gtk.TextTagTable' - To be added: an object of type 'Gtk.TextBuffer' - To be added + Creates a new text buffer. + a tag table, or to create a new one + a newly created TextBuffer + @@ -644,10 +973,10 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'string' - To be added + The complete contents of the buffer + a string to be the contents of the buffer + The contents of the current buffer' + @@ -657,9 +986,13 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + Obtains the number of lines in the buffer. + The number of lines in the buffer + + + The results of this method is cache, so this is very fast. + + @@ -669,9 +1002,9 @@ Gtk.TextIter - To be added - To be added: an object of type 'Gtk.TextIter' - To be added + The end of the buffer + The location of the end of the buffer + @@ -684,10 +1017,26 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether or not the buffer has been modified + + if the buffer has + been modified, otherwise. + + + if the buffer has + been modified, otherwise. + + + + Whenever the buffer is saved to disk, set this property to + . When the buffer is modified, it + will automatically toggled to . + + + Whenever this property is changed, the event is fired. + + @@ -697,9 +1046,9 @@ Gtk.TextTagTable - To be added - To be added: an object of type 'Gtk.TextTagTable' - To be added + The tag table of the current buffer + The current of the buffer + @@ -709,9 +1058,27 @@ Gtk.TextMark - To be added - To be added: an object of type 'Gtk.TextMark' - To be added + Returns the mark that represents the selection bound. + a + + + Returns the mark that represents the selection + bound. Equivalent to calling to + get the mark named "selection_bound", but very slightly + more efficient, and involves less typing. + + + The currently-selected text in buffer is the region + between the "selection_bound" and "insert" marks. If + "selection_bound" and "insert" are in the same place, then + there is no current selection. is another convenient function for handling the + selection, if you just want to know whether there's a + selection and what its bounds are. + + @@ -721,9 +1088,15 @@ Gtk.TextMark - To be added - To be added: an object of type 'Gtk.TextMark' - To be added + Returns the mark that represents the cursor (insertion point). + The mark of the insert point. + + + This is equivelant to calling for the + mark named "insert". + + @@ -733,9 +1106,11 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + The number of characters in the buffer + The number of characters in the buffer + + The result of this method is cached, so it is very fast. + @@ -745,9 +1120,14 @@ Gtk.TextIter - To be added - To be added: an object of type 'Gtk.TextIter' - To be added + The location of the beginning of the buffer + The location of the beginning of the buffer + + + This is the equivelant to calling to get the iter at character offset 0. + + @@ -880,10 +1260,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'Gtk.TextIter' - To be added + Returns the location at a particular character offset + The requested character offset + The location at + @@ -896,9 +1276,14 @@ - To be added - To be added: an object of type 'string' - To be added + Insert text into the current cursor position + The text to be inserted + + + The event is + fired when a call to this method is made. + + @@ -912,10 +1297,13 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'string' - To be added + Insert text at a specific point + + The location for to be + inserted + + The text to be inserted + @@ -929,11 +1317,15 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Insert text at cursor position if the location is editable + The text to be inserted + The default editability of the buffer + Whether or not was inserted + + See for more details. + @@ -948,12 +1340,32 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'string' - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + + Insert text if the cursor is at an editable point in + the buffer + + a location in the buffer + the text to be inserted + the default editability of buffer + whether text was actually inserted + + + Similar to , but the insertion will not occur if is at a non-editable location in the + buffer. Usually you want to prevent insertions at + ineditable locations if the insertion results from a user + action (is interactive). + + + indicates the editability of text that + doesn't have a tag affecting editability applied to + it. Typically the result of + is appropriate here. + + @@ -966,9 +1378,14 @@ - To be added - To be added: an object of type 'string' - To be added + Set the contents of the buffer + The new contents of the buffer + + + This is equivelant to using the setter of the + property. + + @@ -998,10 +1415,18 @@ - To be added - To be added: an object of type 'Gtk.TextIter&' - To be added: an object of type 'int' - To be added + Gets the location at a specific character offset + The location of + + The number of characters from the beginning of the buffer + + + + if is -1, or greater than + the number of characters in the buffer, will be initialized to the end iterator. + + @@ -1017,10 +1442,24 @@ To be added - To be added: an object of type 'Gtk.TextIter&' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + + The location as specified by + and + + + A line number for the current buffer, counting from 0. + + + the byte index from start of line + + + + must be the start of a + UTF-8 character, and must not be beyond the end of the + line. Note bytes, not characters; UTF-8 may encode one + character as multiple bytes. + + @@ -1034,10 +1473,12 @@ - To be added - To be added: an object of type 'Gtk.TextIter&' - To be added: an object of type 'Gtk.TextChildAnchor' - To be added + Gets the location of the specific anchor + the location at + + a at the current buffer. + + @@ -1051,10 +1492,10 @@ - To be added - To be added: an object of type 'Gtk.TextIter&' - To be added: an object of type 'Gtk.TextMark' - To be added + Gets the location of the specified mark + The location of . + The specified mark + @@ -1068,10 +1509,13 @@ - To be added - To be added: an object of type 'Gtk.TextIter&' - To be added: an object of type 'int' - To be added + Gets the location of a particular line + + The location at the beginning fo the line as specified by + + + The specified line number + @@ -1086,11 +1530,14 @@ - To be added - To be added: an object of type 'Gtk.TextIter&' + Gets the location of a specific point + + The location at the location specified by and . + To be added: an object of type 'int' To be added: an object of type 'int' - To be added +