From b0da34e07f0172f86981469370e7ac9a6c5c3d33 Mon Sep 17 00:00:00 2001 From: Duncan Mak Date: Tue, 15 Jul 2003 00:20:31 +0000 Subject: [PATCH] all documented except for events. svn path=/trunk/gtk-sharp/; revision=16242 --- doc/ChangeLog | 2 + doc/en/Gtk/TextView.xml | 587 +++++++++++++++++++++++++++++----------- 2 files changed, 433 insertions(+), 156 deletions(-) diff --git a/doc/ChangeLog b/doc/ChangeLog index 318b9b18f..551e657f9 100644 --- a/doc/ChangeLog +++ b/doc/ChangeLog @@ -1,5 +1,7 @@ 2003-07-14 Duncan Mak + * en/Gtk/TextView.xml: all documented except for events. + * en/Gtk/TextTag.xml: added the missing properties. 2003-07-13 Duncan Mak diff --git a/doc/en/Gtk/TextView.xml b/doc/en/Gtk/TextView.xml index ef53592ff..fdf5601bd 100644 --- a/doc/en/Gtk/TextView.xml +++ b/doc/en/Gtk/TextView.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 + Widget that displays a + + + + + Gtk.TextView view; + Gtk.TextBuffer buffer; + + view = new Gtk.TextView (); + buffer = view.Buffer; + + buffer.Text = "Hello, this is some text"; + + + Now you might put the view in a container and display it on + the screen; when the user edits the text, events on the + buffer will be emitted, such as , , + and so on. + + + Gtk.Container @@ -40,7 +61,7 @@ - To be added + This API needs to be fixed To be added: an object of type 'Gtk.TextIter' To be added: an object of type 'Gdk.Rectangle' To be added @@ -60,13 +81,24 @@ - To be added - To be added: an object of type 'Gtk.TextWindowType' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int&' - To be added: an object of type 'int&' - To be added + + Converts specified buffer coordinates to coordinates + for window + + + a , + except for + + x coordinate of the buffer + y coordinate of the buffer + return location for the window's x coordinate + return location for the window's y coordinate + + + Note that you can't convert coordinates for a nonexisting + window (see . + + @@ -79,10 +111,10 @@ - To be added - To be added: an object of type 'Gtk.TextWindowType' - To be added: an object of type 'int' - To be added + Gets the width of the specified border window. + a window to return size from + the width of the window + @@ -95,10 +127,23 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added + Moves the given iter backward by one display (wrapped) line + the given + if was moved and is not on the end iterator + + + Moves the given iter backward by one display (wrapped) + line. A display line is different from a + paragraph. Paragraphs are separated by newlines or other + paragraph separator characters. Display lines are created + by line-wrapping a paragraph. If wrapping is turned off, + display lines and paragraphs will be the same. Display + lines are divided differently for each view, since they + depend on the view's width; paragraphs are the same in all + views, since they depend on the contents of the . + + @@ -111,10 +156,22 @@ - To be added - To be added: an object of type 'Gtk.TextWindowType' - To be added: an object of type 'Gdk.Window' - To be added + Retrieves the corresponding to an area of the text view + window to get + + a , or + + + + Retrieves the corresponding to + an area of the text view; possible windows include the + overall widget window, child windows on the left, right, + top, bottom, and the window that displays the text + buffer. Windows are and + nonexistent if their width or height is 0, and are + nonexistent before the widget has been realized. + + @@ -128,10 +185,24 @@ - To be added - To be added: an object of type 'Gtk.TextWindowType' - To be added: an object of type 'int' - To be added + + Sets the width of + or , or the height of + or . + + the window to affect + the width or height of the window + + + Automatically destroys the corresponding window if the + size is set to 0, and creates the window if the size is + set to non-zero. This function can only be used for the + "border windows," it doesn't work with , , or . + + @@ -142,9 +213,9 @@ - To be added - To be added: an object of type 'bool' - To be added + Moves the cursor to the currently visible region of the buffer, it it isn't there already. + if the cursor had to be moved + @@ -157,10 +228,23 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added + Moves forward to the next display line end + a + if was moved and is not on the end iterator + + + Moves the given iter forward to the next display line + end. A display line is different from a + paragraph. Paragraphs are separated by newlines or other + paragraph separator characters. Display lines are created + by line-wrapping a paragraph. If wrapping is turned off, + display lines and paragraphs will be the same. Display + lines are divided differently for each view, since they + depend on the view's width; paragraphs are the same in all + views, since they depend on the contents of the + . + + @@ -173,9 +257,13 @@ - To be added - To be added: an object of type 'Gdk.Rectangle' - To be added + Fills with the currently-visible region of the buffer, in buffer coordinates. + the rectangle to fill + + You can convert to window coordinates with . + @@ -189,10 +277,13 @@ - To be added - To be added: an object of type 'Gtk.Widget' - To be added: an object of type 'Gtk.TextChildAnchor' - To be added + Adds a child widget in the text buffer, at the given anchor + any + + a in the current + + @@ -205,10 +296,22 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added + Moves the given backward to the next display line start + the given + if was moved and is not on the end iterator + + + A display line is different from a paragraph. Paragraphs + are separated by newlines or other paragraph separator + characters. Display lines are created by line-wrapping a + paragraph. If wrapping is turned off, display lines and + paragraphs will be the same. Display lines are divided + differently for each view, since they depend on the view's + width; paragraphs are the same in all views, since they + depend on the contents of the . + + @@ -221,10 +324,22 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added + Moves the given forward by one display (wrapped) line + the given + if was moved and is not on the end iterator + + + A display line is different from a paragraph. Paragraphs + are separated by newlines or other paragraph separator + characters. Display lines are created by line-wrapping a + paragraph. If wrapping is turned off, display lines and + paragraphs will be the same. Display lines are divided + differently for each view, since they depend on the view's + width; paragraphs are the same in all views, since they + depend on the contents of the . + + @@ -239,11 +354,20 @@ - 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 + + Gets the y coordinate of the top of the line + containing , and the height of the line + + the given + return location for the y coordinate + return location for the height + + Gets the y coordinate of the top of the line containing + iter, and the height of the line. The coordinate is a buffer + coordinate; convert to window coordinates with . + @@ -260,13 +384,36 @@ - To be added - To be added: an object of type 'Gtk.TextMark' - To be added: an object of type 'double' - To be added: an object of type 'bool' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added + + Scrolls the view so that is on the + screen in the position indicated by and + + a given + + margin of screen size, the valid range is 0.0 to 0.5 + + + whether to use alignment arguments (if , just get the mark onscreen) + + + horizontal alignment of mark within visible area + + + vertical alignment of mark within visible area + + + + An alignment of 0.0 indicates left or top, 1.0 indicates + right or bottom, 0.5 means center. If is , + the text scrolls the minimal distance to get the mark + onscreen, possibly not scrolling at all. The effective + screen for purposes of this function is reduced by a + margin of size . + + @@ -279,10 +426,17 @@ - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'bool' - To be added + Determines whether iter is at the start of a display line + the given + if begins a wrapped line + + + Determines whether iter is at the start of a display + line. See for an + explanation of display lines vs. paragraphs. + + @@ -295,10 +449,10 @@ - To be added - To be added: an object of type 'Gdk.Window' - To be added: an object of type 'Gtk.TextWindowType' - To be added + Used for finding out which window an event corresponds to + a window type + the window type + @@ -312,11 +466,27 @@ - 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 'bool' - To be added + Move the iterator a given number of characters visually, treating it as the strong cursor position + the given + the number of characters to move (negative moves left, positive moves right) + if iter moved and is not on the end iterator + + + Move the iterator a given number of characters visually, + treating it as the strong cursor position. If count is + positive, then the new strong cursor position will be + count positions to the right of the old cursor + position. If count is negative then the new strong cursor + position will be count positions to the left of the old + cursor position. + + + In the presence of bidirection text, the correspondence + between logical and visual order will depend on the + direction of the current run, and there may be jumps when + the cursor is moved off of the end of a run. + + @@ -329,10 +499,10 @@ - To be added - To be added: an object of type 'Gtk.TextMark' - To be added: an object of type 'bool' - To be added + Moves within the buffer so that it's located within the currently-visible text area + a + if the mark moved (wasn't already onscreen) + @@ -348,15 +518,47 @@ - - To be added - To be added: an object of type 'Gtk.TextIter' - To be added: an object of type 'double' - To be added: an object of type 'bool' - To be added: an object of type 'double' - To be added: an object of type 'double' - To be added: an object of type 'bool' - To be added + p + + Scrolls the text view so that is on + the screen in the position indicated by and + + the given + + margin of screen size, the valid range is 0.0 to 0.5 + + + whether to use alignment arguments (if , just get the mark onscreen) + + horizontal alignment of mark within visible area + vertical alignment of mark within visible area + if scrolling occurred + + + Scrolls the text view so that is on the screen in the + position indicated by and . An alignment of + 0.0 indicates left or top, 1.0 indicates right or bottom, + 0.5 means center. If is , the text scrolls + the minimal distance to get the mark onscreen, possibly + not scrolling at all. The effective screen for purposes of + this function is reduced by a margin of size + within_margin. + + + NOTE: This function uses the currently-computed height of + the lines in the text buffer. Note that line heights are + computed in an idle handler; so this function may not have + the desired effect if it's called before the height + computations. To avoid oddness, consider using which saves a point to be scrolled to after line + validation. + + @@ -369,9 +571,15 @@ - To be added - To be added: an object of type 'Gtk.TextMark' - To be added + + Scrolls the text view the minimum distance such that is contained within the visible area of + the widget + + + a mark in the current + + @@ -388,13 +596,21 @@ - To be added - To be added: an object of type 'Gtk.TextWindowType' - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added: an object of type 'int&' - To be added: an object of type 'int&' - To be added + Converts coordinates on the window to buffer coordinates + + a except + + x coordinate of the window + y coordinate of the window + return location for the buffer's x coordinate + return location for the buffer's y coordinate + + + Note that you can't convert coordinates for a nonexisting + window (see . + + @@ -431,9 +647,16 @@ - To be added - To be added: an object of type 'Gtk.TextView' - To be added + Creates a new TextView + the newly-created TextView + + + If you don't set the before using + the text view, an empty default buffer will be created for + you. If you want to specify your own buffer, use + . + + @@ -444,10 +667,16 @@ - To be added - To be added: an object of type 'Gtk.TextBuffer' - To be added: an object of type 'Gtk.TextView' - To be added + Creates a new TextView displaying a specified buffer. + the buffer to be displayed + a newly-created TextView + + + Creates a new widget + displaying the buffer. One + buffer can be shared among many widgets. + + @@ -469,9 +698,22 @@ Gtk.TextAttributes - To be added + The default text attributes To be added: an object of type 'Gtk.TextAttributes' - To be added + + + Obtains a copy of the default text attributes. These are + the attributes used for text unless a tag overrides + them. You'd typically pass the default attributes in to + in order to get the attributes in effect at a given + text position. + + + The return valuea is a copy owned by the caller of this + function, and should be freed. + + @@ -484,10 +726,12 @@ - To be added - To be added: an object of type 'Gtk.TextBuffer' - To be added: an object of type 'Gtk.TextBuffer' - To be added + + The displayed by the text view + + the new buffer to be displayed + the current buffer that is displayed + @@ -500,10 +744,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 insertion point is displayed + + to display the insertion + point + + whether the insertion point is visible + @@ -516,10 +763,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The default left margin + the left margin in pixels + the left margin + @@ -532,10 +779,10 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The default right margin + the right margin in pixels + the right margin + @@ -548,10 +795,15 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The default number of blank pixels above paragraphs + the number of pixels above paragraphs + the number of pixels above paragraphs + + + Tags in the may + override the defaults. + + @@ -564,10 +816,15 @@ - To be added - To be added: an object of type 'Gtk.Justification' - To be added: an object of type 'Gtk.Justification' - To be added + The default justification + The for the text + The default justification of paragraphs + + + Tags in the may + override the defaults. + + @@ -580,10 +837,14 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The default indentation for paragraphs + the indentation in pixels + the number of pixels of indentation + + + Tags in the may override the default. + + @@ -596,10 +857,14 @@ - To be added - To be added: an object of type 'bool' - To be added: an object of type 'bool' - To be added + Whether the text can be modified by the user + + if the text is editable by the user + + + whether or not the text can be edited by the user + + @@ -612,10 +877,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. + a + the of the text view + @@ -628,10 +893,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 + custom tabes for this text + @@ -644,10 +909,15 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The default number of pixels of blank space to put below paragraphs + the number of pixels of blank space below paragraphs + the blank space below paragraphs in pixels + + + Tags in the may + override this default. + + @@ -660,10 +930,15 @@ - To be added - To be added: an object of type 'int' - To be added: an object of type 'int' - To be added + The default number of pixels of blank space to leave between display/wrapped lines within a paragraph + default number of pixels between wrapped lines + default number of pixels of blank space between wrapped lines + + + Tags in the may + override this default. + + @@ -814,7 +1089,7 @@ - To be added + 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&' @@ -833,7 +1108,7 @@ - To be added + 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'