From f579d4098e05356dd606fa62421038a695841bb5 Mon Sep 17 00:00:00 2001 From: John Luke Date: Thu, 22 Jul 2004 00:03:35 +0000 Subject: [PATCH] doc'ed TextIter and the rest of TextView svn path=/trunk/gtk-sharp/; revision=31352 --- doc/ChangeLog | 5 + doc/en/Gtk/TextChildAnchor.xml | 6 +- doc/en/Gtk/TextIter.xml | 520 ++++++++++++++++++--------------- doc/en/Gtk/TextView.xml | 36 +-- 4 files changed, 309 insertions(+), 258 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index aff4fb521..dda5b01a3 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,3 +1,8 @@ +2004-07-21 John Luke + + * en/Gtk/TextView.xml: + * en/Gtk/TextIter.xml: documented the rest + 2004-07-16 John Luke * en/Pango/*: doc'ed some more pango stuff diff --git a/doc/en/Gtk/TextChildAnchor.xml b/doc/en/Gtk/TextChildAnchor.xml index ad0224771..26c3000bc 100644 --- a/doc/en/Gtk/TextChildAnchor.xml +++ b/doc/en/Gtk/TextChildAnchor.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 spot in the buffer where child widgets can be "anchored" (inserted inline, as if they were characters). + The anchor can have multiple widgets anchored, to allow for multiple views. GLib.Object @@ -61,7 +61,7 @@ Creates a new TextChildAnchor - To be added: an object of type 'Gtk.TextChildAnchor' + a new To create a new , you diff --git a/doc/en/Gtk/TextIter.xml b/doc/en/Gtk/TextIter.xml index ed46994c2..e4942b301 100644 --- a/doc/en/Gtk/TextIter.xml +++ b/doc/en/Gtk/TextIter.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 + Text buffer iterator + System.ValueType @@ -27,8 +27,8 @@ - To be added - To be added + Returns an empty + @@ -41,10 +41,10 @@ - To be added - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.TextIter' - To be added + Internal method + a + a new + This is an internal method and should not be used by user code. @@ -57,10 +57,10 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added: an object of type 'bool' - To be added + Moves backward to the next toggle (on or off) of the tag, or to the next toggle of any tag if tag is . + a or + whether we found a tag toggle before iter + If no matching tag toggles are found, returns , otherwise . Does not return toggles located at iter, only toggles before iter. Sets iter to the location of the toggle, or the start of the buffer if no toggle is found. @@ -71,9 +71,9 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added + Creates a dynamically-allocated copy of an iterator. + a + @@ -84,9 +84,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Moves backward to the previous word start. + + if iter moved and is not the end iterator + (If iter is currently on a word start, moves backward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). @@ -97,9 +98,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Moves forward to the next sentence end. + + if iter moved and is not the end iterator + If iter is at the end of a sentence, moves to the next end of sentence. Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). @@ -112,9 +114,9 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added + Swaps the value of first and second if second comes before first in the buffer. + another + That is, ensures that first and second are in sequence. Most text buffer functions that take a range call this automatically on your behalf, so there's no real reason to call it yourself in those cases. There are some exceptions, such as , that expect a pre-sorted range. @@ -127,10 +129,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Moves back cursor positions. + number of positions to move + + if we moved and the new position is dereferenceable + @@ -143,7 +146,7 @@ Moves the iterator backward one line true if the operation succeeded. - To be added + Returns if iter could be moved; i.e. if iter was at character offset 0, this function returns . Therefore if iter was already on line 0, but not at the start of the line, iter is snapped to the start of the line and the function returns . (Note that this implies that in a loop calling this function, the line number may not change on every iteration, if your first iteration is on line 0.) @@ -156,10 +159,10 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'string' - To be added + Like , but invisible text is not included. + iterator at end of range + slice of text from the buffer + Invisible text is usually invisible because a with the "invisible" attribute turned on has been applied to it. @@ -172,10 +175,10 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'string' - To be added + Returns the text in the given range. + iterator at end of a range + slice of text from the buffer + A "slice" is an array of characters encoded in UTF-8 format, including the Unicode "unknown" character 0xFFFC for iterable non-character elements in the buffer, such as images. Because images are encoded in the slice, byte and character offsets in the returned array will correspond to byte offsets in the text buffer. 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. @@ -186,9 +189,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Moves forward to the next word end. + + if iter moved and is not the end iterator + (If iter is currently on a word end, moves forward to the next one after that.) Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). @@ -203,12 +207,12 @@ - To be added - To be added: an object of type 'Gtk.TextCharPredicate' - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added + Advances iter, calling pred on each character. + a function to be called on each character + user data for pred + search limit, or for none + whether a match was found + If pred returns , returns and stops scanning. If pred never returns , iter is set to limit if limit is non-, otherwise to the end iterator. @@ -219,9 +223,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Determines whether iter ends a natural-language word. + + if iter is at the end of a word + Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). @@ -234,10 +239,18 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Returns whether the character at iter is within an editable region of text. + + if text is editable by default + whether iter is inside an editable range + + +Non-editable text is "locked" and cannot be changed by the user via . This function is simply a convenience wrapper around . If no tags applied to this text effect editability, will be returned. + + +You do not want to use this function to decide whether text can be inserted at iter, because for insertion you do not want to know whether the char at iter is inside an editable range, you want to know whether a new character inserted at iter would be inside an editable range. Use to handle this case. + + @@ -248,9 +261,9 @@ - To be added + Moves iter forward by one character offset. To be added: an object of type 'bool' - To be added + Note that images embedded in the buffer occupy 1 character slot, so this may actually move onto an image instead of a character, if you have images in your buffer. If iter is the end iterator or one character before it, iter will now point at the end iterator, and return for convenience when writing loops. @@ -266,7 +279,7 @@ Moves the iterator back a number of lines. number of lines to move backwards. true if the operation succeeded. - To be added + Moves count lines backward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then is returned. If count is 0, the function does nothing and returns . If count is negative, moves forward by 0 - count lines. @@ -279,7 +292,7 @@ Returns true if the iterator is at the end of a line. true if the iterator is at the end of a line. - To be added + Returns if iter points to the start of the paragraph delimiter characters for a line (delimiters will be either a newline, a carriage return, a carriage return followed by a newline, or a Unicode paragraph separator character). Note that an iterator pointing to the \n of a \r\n pair will not be counted as the end of a line, the line ends before the \r. The end iterator is considered to be at the end of a line, even though there are no paragraph delimiter chars there. @@ -290,8 +303,8 @@ - To be added - To be added + Disposes of resources held by the iter. + @@ -304,10 +317,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Calls up to times, or until it returns . + number of sentences to move + + if iter moved and is not the end iterator + If is negative, moves forward instead of backward. @@ -318,8 +332,8 @@ - To be added - To be added + Moves iter forward to the "end iterator," which points one past the last valid character in the buffer. + @@ -334,12 +348,12 @@ - To be added - To be added: an object of type 'Gtk.TextCharPredicate' - To be added: an object of type 'IntPtr' - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added + Same as , but goes backward from iter. + function to be called on each character + user data for pred + search limit, or for none + whether a match was found + @@ -352,10 +366,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Moves up cursor positions. + number of positions to move + + if we moved and the new position is dereferenceable + See for details. @@ -368,10 +383,11 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added + Tests whether two iterators are equal, using the fastest possible mechanism. + another + + if the iterators point to the same place in the buffer + This function is very fast; you can expect it to perform better than e.g. getting the character offset for each iterator and comparing the offsets yourself. Also, it's a bit faster than . @@ -384,10 +400,10 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added: an object of type 'bool' - To be added + whether tag is either toggled on or off at iter + a or + whether tag is toggled on or off at iter + @@ -398,9 +414,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Determines whether iter begins a sentence. + + if iter is at the start of a sentence. + Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). @@ -413,10 +430,10 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added: an object of type 'bool' - To be added + Moves forward to the next toggle (on or off) of the tag, or to the next toggle of any tag if tag is . + a or + whether we found a tag toggle after iter + If no matching tag toggles are found, returns , otherwise . Does not return toggles located at iter, only toggles after iter. Sets iter to the location of the toggle, or to the end of the buffer if no toggle is found. @@ -427,9 +444,9 @@ - To be added - To be added: an object of type 'bool' - To be added + Returns if iter begins a paragraph. + whether iter begins a line + @@ -440,9 +457,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Like , but moves backward. + + if we moved + @@ -455,10 +473,18 @@ - To be added - To be added: an object of type 'Gtk.TextAttributes' - To be added: an object of type 'bool' - To be added + Computes the effect of any tags applied to this spot in the text. + a s + + if values was modified + + +The values parameter should be initialized to the default settings you wish to use if no tags are in effect. You would typically obtain the defaults from . + + + will modify values, applying the effects of any tags present at iter. If any tags affected values, the function returns . + + @@ -471,10 +497,10 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'string' - To be added + Returns text in the given range. + iterator at end of a range + the string from the buffer + If the range contains non-text elements such as images, the character and byte offsets in the returned string will not correspond to character and byte offsets in the buffer. If you want offsets to correspond, see . @@ -485,9 +511,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Moves iter forward by a single cursor position. + + if we moved and the new position is dereferenceable + Cursor positions are (unsurprisingly) positions where the cursor can appear. Perhaps surprisingly, there may not be a cursor position between all characters. The most common example for European languages would be a carriage return/newline sequence. For some Unicode characters, the equivalent of say the letter "a" with an accent mark will be represented as two characters, first the letter then a "combining mark" that causes the accent to be rendered; so the cursor cannot go between those two characters. @@ -500,10 +527,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Moves count lines forward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). + number of lines to move forward + whether iter moved and is dereferenceable + The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then is returned. If count is 0, the function does nothing and returns . If count is negative, moves backward by 0 - count lines. @@ -514,9 +541,9 @@ - To be added + Moves iter to the start of the next line. To be added: an object of type 'bool' - To be added + Returns if there was a next line to move to, and if iter was simply moved to the end of the buffer and is now not dereferenceable, or if iter was already at the end of the buffer. @@ -532,7 +559,7 @@ Moves the iterator back a number of characters. number of characters to move backwards. true if the operation succeeded - To be added + Moves count characters backward, if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). The return value indicates whether the iterator moved onto a dereferenceable position; if the iterator didn't move, or moved onto the end iterator, then is returned. If count is 0, the function does nothing and returns . @@ -545,10 +572,10 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added: an object of type 'bool' - To be added + Returns if iter is within a range tagged with tag. + a + whether iter is tagged with tag + @@ -559,9 +586,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Moves backward to the previous sentence start; if iter is already at the start of a sentence, moves backward to the next one. + + if iter moved and is not the end iterator + Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). @@ -572,9 +600,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Determines whether iter begins a natural-language word. + + if iter is at the start of a word + Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). @@ -587,10 +616,10 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added: an object of type 'bool' - To be added + Returns if tag is toggled on at exactly this point. + a or + whether iter is the start of a range tagged with tag + If tag is , returns if any tag is toggled on at this point. Note that the returns if iter is the start of the tagged range; tells you whether an iterator is within a tagged range. @@ -603,10 +632,10 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'string' - To be added + Like , but invisible text is not included. + iterator at end of range + string containing visible text in the range + Invisible text is usually invisible because a with the "invisible" attribute turned on has been applied to it. @@ -617,9 +646,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Moves the iterator to point to the paragraph delimiter characters, which will be either a newline, a carriage return, a carriage return/newline in sequence, or the Unicode paragraph separator character. + + if we moved and the new location is not the end iterator + If the iterator is already at the paragraph delimiter characters, moves to the paragraph delimiter characters for the next line. If iter is on the last line in the buffer, which does not end in paragraph delimiters, moves to the end iterator (end of the last line), and returns . @@ -630,9 +660,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Determines whether iter ends a sentence. + + if iter is at the end of a sentence. + Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). @@ -645,10 +676,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Calls times (or until it returns ). + number of sentences to move + + if iter moved and is not the end iterator + If is negative, moves backward instead of forward. @@ -659,9 +691,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Determines whether iter is inside a sentence (as opposed to in between two sentences, e.g. after a period and before the first letter of the next sentence). + + if iter is inside a sentence. + Sentence boundaries are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango text boundary algorithms). @@ -674,10 +707,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Calls up to times. + number of times to move + + if iter moved and is not the end iterator + @@ -690,7 +724,7 @@ Moves the iterator back one character true if the operation succeeded - To be added + Returns if movement was possible; if iter was the first in the buffer (character offset 0), this returns for convenience when writing loops. @@ -703,10 +737,10 @@ - To be added - To be added: an object of type 'Gtk.TextTag' - To be added: an object of type 'bool' - To be added + Returns if tag is toggled off at exactly this point. + a or + whether iter is the end of a range tagged with tag + If tag is , returns if any tag is toggled off at this point. Note that the returns if iter is the end of the tagged range; tells you whether an iterator is within a tagged range. @@ -719,10 +753,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Moves count characters if possible (if count would move past the start or end of the buffer, moves to the start or end of the buffer). + number of characters to move, may be negative + whether iter moved and is dereferenceable + The return value indicates whether the new position of iter is different from its original position, and dereferenceable (the last iterator in the buffer is not dereferenceable). If count is 0, the function does nothing and returns . @@ -735,10 +769,11 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Considering the default editability of the buffer, and tags that affect editability, determines whether text inserted at iter would be editable. + + if text is editable by default + whether text inserted at iter would be editable + If text inserted at iter would be editable then the user should be allowed to insert text at iter. uses this function to decide whether insertions are allowed at a given position. @@ -751,10 +786,10 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'int' - To be added + A qsort()-style function that returns negative if lhs is less than rhs, positive if lhs is greater than rhs, and 0 if they are equal. + another + -1 if lhs is less than rhs, 1 if lhs is greater, 0 if they are equal + Ordering is in character offset order, i.e. the first character in the buffer is less than the second character in the buffer. @@ -765,9 +800,10 @@ - To be added - To be added: an object of type 'bool' - To be added + Determines whether iter is inside a natural-language word (as opposed to say inside some whitespace). + + if iter is inside a word + Word breaks are determined by Pango and should be correct for nearly any language (if not, the correct fix would be to the Pango word break algorithms). @@ -781,11 +817,13 @@ - 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 + Checks whether iter falls in the range (start, end). + start of range + end of range + + if iter is in the range + + and must be in ascending order. @@ -798,10 +836,11 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'bool' - To be added + Calls up to times. + number of times to move + + if iter moved and is not the end iterator + @@ -813,10 +852,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Returns the number of bytes from the start of the line to the given iter, not counting bytes that are invisible due to tags with the "invisible" flag toggled on. + a + byte index of iter with respect to the start of the line + @@ -826,9 +865,9 @@ Gtk.TextChildAnchor - To be added - To be added: an object of type 'Gtk.TextChildAnchor' - To be added + If the location at iter contains a child anchor, the anchor is returned. Otherwise, is returned. + the anchor at iter + @@ -839,7 +878,7 @@ Number of characters in the TextIter's line. - Returns the number of characters in the TextIter's current line. + Returns the number of characters in the TextIter's current line, including the paragraph delimiters. None. @@ -855,7 +894,7 @@ Line number the iterator is currently on. Moves the iterator to this line number. The line number the iterator is currently on. - To be added + Lines in a are numbered beginning with 0 for the first line in the buffer. @@ -865,9 +904,9 @@ System.Int32 - To be added - To be added: an object of type 'int' - To be added + Returns the number of bytes in the line containing iter, including the paragraph delimiters. + number of bytes in the line + @@ -904,9 +943,9 @@ Gdk.Pixbuf - To be added - To be added: an object of type 'Gdk.Pixbuf' - To be added + return the pixbuf at this iter, if it is one. + the pixbuf at iter + If the element at iter is a , the Pixbuf is returned. Otherwise, is returned. @@ -916,9 +955,9 @@ Pango.Language - To be added - To be added: an object of type 'Pango.Language' - To be added + A convenience wrapper around , which returns the language in effect at iter. + language in effect at iter + If no tags affecting language apply to iter, the return value is identical to that of . @@ -930,10 +969,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Returns the byte index of the iterator, counting from the start of a newline-terminated line. + a + distance from start of line, in bytes + Remember that encodes text in UTF-8, and that characters can require a variable number of bytes to represent. @@ -945,10 +984,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Returns the character offset of the iterator, counting from the start of a newline-terminated line. + a + offset from start of line + The first character on the line has offset 0. @@ -960,10 +999,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + Returns the offset in characters from the start of the line to the given iter, not counting characters that are invisible due to tags with the "invisible" flag toggled on. + a + offset in visible characters from the start of the line + @@ -975,7 +1014,7 @@ Obtains the buffer the iter is in containing buffer - To be added + @@ -992,14 +1031,14 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.TextSearchFlags' - 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 + Same as , but moves backward. + search string + bitmask of flags affecting the search + return location for start of match, or + return location for end of match, or + location of last possible match_start, or for start of buffer + whether a match was found + @@ -1016,14 +1055,21 @@ - To be added - To be added: an object of type 'string' - To be added: an object of type 'Gtk.TextSearchFlags' - 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 + Searches forward for . + a search string + flags affecting how the search is done + return location for start of match, or + return location for end of match, or + bound for the search, or for the end of the buffer + whether a match was found + + +Any match is returned by setting to the first character of the match and to the first character after the match. The search will not continue past limit. Note that a search is a linear or O(n) operation, so you may wish to use limit to avoid locking up your UI on large buffers. + + +If the GTK_TEXT_SEARCH_VISIBLE_ONLY flag is present, the match may have invisible text interspersed in str. i.e. str will be a possibly-noncontiguous subsequence of the matched range. similarly, if you specify GTK_TEXT_SEARCH_TEXT_ONLY, the match may have pixbufs or child widgets mixed inside the matched range. If these flags are not given, the match must be exact; the special 0xFFFC character in str will match embedded pixbufs or child widgets. + + @@ -1036,7 +1082,7 @@ Returns true if the iterator is at the end of the parent true if the iterator is equal to Buffer.EndIter - To be added + The most efficient way to check whether an iterator is the end iterator. @@ -1047,9 +1093,9 @@ - To be added - a - To be added + Returns if iter is the first iterator in the buffer, that is if iter has a character offset of 0. + whether iter is the first in the buffer + @@ -1062,7 +1108,7 @@ returns true if the iter is at the caret a - returns true if this iterator equals the iterator returned by Buffer.GetIterAtMark (Buffer.InsertMark) + returns true if this iterator equals the iterator returned by @@ -1086,9 +1132,9 @@ - To be added + Returns an array of at this location. a - To be added + Because marks are not iterable (they do not take up any "space" in the buffer, they are just marks in between iterable locations), multiple marks can exist in the same place. The returned list is not in any meaningful order. @@ -1099,9 +1145,9 @@ - To be added + Returns an array of tags that apply to iter, in ascending order of priority (highest-priority tags are last). a - To be added + @@ -1114,10 +1160,10 @@ - To be added + Returns an array of that are toggled on or off at this point. a - a - To be added + tags toggled at this point + (If toggled_on is , the list contains tags that are toggled on.) If a tag is toggled on at iter, then some non-empty range of characters following iter has that tag applied to it. If a tag is toggled off, then some non-empty range following iter does not have the tag applied to it. diff --git a/doc/en/Gtk/TextView.xml b/doc/en/Gtk/TextView.xml index c991d32f0..a24ace2f4 100644 --- a/doc/en/Gtk/TextView.xml +++ b/doc/en/Gtk/TextView.xml @@ -1056,10 +1056,10 @@ class TextViewSample This method should be fixed - 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 + a + a y coordinate + return location for top coordinate of the line + Gets the at the start of the line containing the coordinate . is in buffer coordinates, convert from window coordinates with . If non-, will be filled with the coordinate of the top edge of the line. @@ -1074,11 +1074,11 @@ class TextViewSample - To be added - a - a - a - To be added + Updates the position of a child + child widget already added to the text view + new X position in window coordinates + new Y position in window coordinates + @@ -1094,12 +1094,12 @@ class TextViewSample - To be added + Adds a child at fixed coordinates in one of the text widget's windows. a a a a - To be added + The window must have non-zero size (see ). Note that the child coordinates are given relative to the in question, and that these coordinates have no sane relationship to scrolling. When placing a child in GTK_TEXT_WINDOW_WIDGET, scrolling is irrelevant, the child floats above all scrollable areas. But when placing a child in one of the scrollable windows (border windows or text window), you will need to compute the child's correct position in buffer coordinates any time scrolling occurs or buffer changes occur, and then call to update the child's position. Unfortunately there is no good way to detect that scrolling has occurred, using the current API; a possible hack would be to update all child positions when the scroll adjustments change or the text buffer changes. See bug 64518 on bugzilla.gnome.org for status of fixing this issue. @@ -1315,11 +1315,11 @@ class TextViewSample - To be added - a - a + Retrieves the iterator at buffer coordinates and . + x position, in buffer coordinates + y position, in buffer coordinates a - To be added + Buffer coordinates are coordinates for the entire buffer, not just the currently-displayed portion. If you have coordinates from an event, you have to convert those to buffer coordinates with . @@ -1332,10 +1332,10 @@ class TextViewSample - To be added + Gets a rectangle which roughly contains the character at iter. a - a - To be added + a , which is the bounds of the character at + The rectangle position is in buffer coordinates; use to convert these coordinates to coordinates for one of the windows in the text view.