svn: /gtk/php-gtk-doc/trunk/manual/en/reference/gtk/ gtktextbuffer.xml gtktextview.xml

classic Classic list List threaded Threaded
1 message Options
Reply | Threaded
Open this post in threaded view
|

svn: /gtk/php-gtk-doc/trunk/manual/en/reference/gtk/ gtktextbuffer.xml gtktextview.xml

markskilbeck
markskilbeck                             Fri, 22 Oct 2010 09:53:29 +0000

Revision: http://svn.php.net/viewvc?view=revision&revision=304608

Log:
Adding extra info - thanks Ben.

Changed paths:
    U   gtk/php-gtk-doc/trunk/manual/en/reference/gtk/gtktextbuffer.xml
    U   gtk/php-gtk-doc/trunk/manual/en/reference/gtk/gtktextview.xml

Modified: gtk/php-gtk-doc/trunk/manual/en/reference/gtk/gtktextbuffer.xml
===================================================================
--- gtk/php-gtk-doc/trunk/manual/en/reference/gtk/gtktextbuffer.xml 2010-10-22 09:24:41 UTC (rev 304607)
+++ gtk/php-gtk-doc/trunk/manual/en/reference/gtk/gtktextbuffer.xml 2010-10-22 09:53:29 UTC (rev 304608)
@@ -748,7 +748,7 @@
      <funcdef>string <function>get_text</function></funcdef>
      <paramdef><classname>GtkTextIter</classname> <parameter>start</parameter></paramdef>
      <paramdef><classname>GtkTextIter</classname> <parameter>end</parameter></paramdef>
-     <paramdef>boolean <parameter>include_hidden_chars</parameter></paramdef>
+     <paramdef>boolean <parameter><optional>include_hidden_chars</optional></parameter></paramdef>
     </funcprototype>
    </funcsynopsis>
    <shortdesc>
@@ -756,7 +756,7 @@
    </shortdesc>
    <desc>
     <para>
-    Returns the text in the specified range [<parameter>start</parameter>,
+    Returns the text in the specified range (<parameter>start</parameter>,
     <parameter>end</parameter>). This method does not return characters
     representing embedded images, so byte and character indexes
     into the returned string do not correspond to byte and character
@@ -764,6 +764,7 @@
     invisibility attribute are excluded if <parameter>include_hidden_chars</parameter>
     is FALSE.
     </para>
+ <para>Note: If you want to get the full text stored in the <classname>GtkTextBuffer</classname>, use the <function class="GtkTextBuffer">get_start_iter</function> and <function class="GtkTextBuffer">get_end_iter</function> respectively.</para>
     <para>
      &seealso;
      <function class="GtkTextBuffer">set_text</function>

Modified: gtk/php-gtk-doc/trunk/manual/en/reference/gtk/gtktextview.xml
===================================================================
--- gtk/php-gtk-doc/trunk/manual/en/reference/gtk/gtktextview.xml 2010-10-22 09:24:41 UTC (rev 304607)
+++ gtk/php-gtk-doc/trunk/manual/en/reference/gtk/gtktextview.xml 2010-10-22 09:53:29 UTC (rev 304608)
@@ -8,7 +8,7 @@
    A widget for displaying and editing a large block of text.
   </shortdesc>
   <desc>
-
+    <para>GtkTextViews store text in a buffer. If you want to get the text contents of the <classname>GtkTextView</classname>, you need to use the <function class="GtkTextView">get_buffer</function> function (which returns a <classname>GtkTextBuffer</classname> object) and from that object you have created, get the text contents using the <function class="GtkTextBuffer">get_text</function> function.</para>
   </desc>
  </classmeta>



--
PHP-GTK Documentation Mailing List (http://gtk.php.net/)
To unsubscribe, visit: http://www.php.net/unsub.php