<page xmlns="http://projectmallard.org/1.0/" xmlns:its="http://www.w3.org/2005/11/its" xmlns:xi="http://www.w3.org/2001/XInclude" type="guide" style="task" id="textview.py" xml:lang="es">

  <info>

    <title type="text">TextView (Python)</title>

    <link type="guide" xref="beginner.py#multiline"/>

    <link type="seealso" xref="strings.py"/>

    <link type="seealso" xref="scrolledwindow.py"/>

    <link type="next" xref="dialog.py"/>

    <revision version="0.2" date="2012-06-19" status="draft"/>

    <credit type="author copyright">

      <name>Sebastian Pölsterl</name>

      <email its:translate="no">sebp@k-d-w.org</email>

      <years>2011</years>

    </credit>

    <credit type="author copyright editor">

      <name>Marta Maria Casetti</name>

      <email its:translate="no">mmcasetti@gmail.com</email>

      <years>2012</years>

    </credit>

    <desc>Un widget que muestra un GtkTextBuffer</desc>

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">

      <mal:name>Daniel Mustieles</mal:name>

      <mal:email>daniel.mustieles@gmail.com</mal:email>

      <mal:years>2011 - 2017</mal:years>

    </mal:credit>

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">

      <mal:name>Nicolás Satragno</mal:name>

      <mal:email>nsatragno@gmail.com</mal:email>

      <mal:years>2012 - 2013</mal:years>

    </mal:credit>

    <mal:credit xmlns:mal="http://projectmallard.org/1.0/" type="translator copyright">

      <mal:name>Jorge González</mal:name>

      <mal:email>jorgegonz@svn.gnome.org</mal:email>

      <mal:years>2011</mal:years>

    </mal:credit>

  </info>

  <title>TextView</title>

  <note style="sidebar">
Esto es un ejemplo de Gtk.TextView.

  
Si se pulsa «Intro» se obtiene una línea nueva.

  
Pero también se puede obtener una línea nueva si se escribe una frase larga (el texto se ajustará a los saltos de línea entre palabras.

  
Si es escribe una palabra laaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaaarga

  
(esto es una palabra larga)

  
, aparecerá una barra de desplazamiento horizontal.
</note>

  <media type="image" mime="image/png" src="media/textview.png"/>

  <links type="section"/>

  <section id="code">

  <title>Código usado para generar este ejemplo</title>

  from gi.repository import Gtk

import sys

class MyWindow(Gtk.ApplicationWindow):

    def __init__(self, app):

        Gtk.Window.__init__(self, title="TextView Example", application=app)

        self.set_default_size(300, 450)

        # a scrollbar for the child widget (that is going to be the textview)

        scrolled_window = Gtk.ScrolledWindow()

        scrolled_window.set_border_width(5)

        # we scroll only if needed

        scrolled_window.set_policy(

            Gtk.PolicyType.AUTOMATIC, Gtk.PolicyType.AUTOMATIC)

        # a text buffer (stores text)

        buffer1 = Gtk.TextBuffer()

        # a textview (displays the buffer)

        textview = Gtk.TextView(buffer=buffer1)

        # wrap the text, if needed, breaking lines in between words

        textview.set_wrap_mode(Gtk.WrapMode.WORD)

        # textview is scrolled

        scrolled_window.add(textview)

        self.add(scrolled_window)

class MyApplication(Gtk.Application):

    def __init__(self):

        Gtk.Application.__init__(self)

    def do_activate(self):

        win = MyWindow(self)

        win.show_all()

    def do_startup(self):

        Gtk.Application.do_startup(self)

app = MyApplication()

exit_status = app.run(sys.argv)

sys.exit(exit_status)

  </section>

  <section id="methods">

  <title>Métodos útiles para un widget «TextView»</title>

  
Un Gtk.TextView muestra el texto almacenado en un Gtk.TextBuffer. Sin embargo, la mayor parte de la manipulación de texto se hace con iteradores, representados por un Gtk.TextIter: una posición entre dos caracteres en el búfer de texto. Los iteradores no son válidos indefinidamente; cada vez que se modifica el búfer de alguna manera que se altere su contenido, todos los iteradores relevantes dejan de ser válidos. Es por esto que no se pueden usar iteradores para mantener posiciones entre modificaciones del búfer. Para mantener una posición, se usa una Gtk.TextMark, que puede hacerse visible con visible(True). Un búfer de texto contiene dos marcas empotradas: una marca «insert» (la posición del cursor) y la marca «selection_bound».

  
Métodos para un widget «TextView»:

  <list>

    <item>
El widget «TextView» es editable de manera predeterminada. Si prefiere que no lo sea, use set_editable(False). Si el búfer no tiene texto editable, puede ser una buena idea usar set_cursor_visible(False) también.
</item>

    <item>
La alineación del texto se establece con set_justification(Gtk.Justification.JUSTIFICACIÓN) donde JUSTIFICACIÓN puede ser LEFT, RIGHT, CENTER, FILL.
</item>

    <item>
El ajuste de línea del texto se establece con set_wrap_mode(Gtk.WrapMode.WRAP) donde WRAP es uno de NONE (el área de texto se hace más ancha), CHAR (rompe líneas en cualquier lugar en que el cursor pueda aparecer), WORD (rompe líneas entre palabras), WORD_CHAR (rompe líneas entre palabras, pero si no es suficiente, entre caracteres).
</item>

  </list>

  
Métodos para un widget «TextBuffer»:

  <list>

    <item>
get_insert() devuelve la Gtk.TextMark que representa al cursor, que es el punto de inserción.
</item>

    <item>
get_selection_bound() devuelve la Gtk.TextMark que representa los límites de la selección.
</item>

    <item>
set_text("texto", longitud) donde longitud es un entero positivo o -1, establece el contenido del búfer como los primeros longitud caracteres del "texto". Si se omite longitud o es -1, se inserta todo el texto. El contenido del búfer, si existe, se destruye.
</item>

    <item>
insert(iter, "texto", longitud), donde iter es un iterador de texto y longitud es un entero positivo o -1, inserta en el búfer en iter los primeros longitud caracteres del texto. Si se omite longitud o es -1, se inserta todo el texto.
</item>

    <item>
insert_at_cursor("texto", longitud) hace los mismo que insert(iter, "texto", longitud), tomando el cursor actual como iter.
</item>

    <item>
create_mark("nombre_de_la_marca", iter, gravedad_izquierda) donde iter es un Gtk.TextIter y gravedad_izquierda es un booleano, crea una Gtk.TextMark en la posición de iter. Si "nombre_de_la_marca" es None, la marca es anónima; de lo contrario, la marca puede obtenerse por su nombre usando get_mark(). Si una marca tiene gravedad izquierda, y el texto se inserta en la posición actual de la marca, esta se moverá a la izquierda del texto recién insertado. Si gravedad_izquierda se omite, su valor predeterminado es False.
</item>

    <item>
Para especificar que algún texto en el búfer debe tener un formato específico, defina una etiqueta que contenga esa información de formato, y luego aplíquela a la región de texto usando create_tag("nombre de la etiqueta", propiedad) y apply_tag(etiqueta, iter_inicial, iter_final) como en, por ejemplo:

tag = textbuffer.create_tag("orange_bg", background="orange")

textbuffer.apply_tag(tag, start_iter, end_iter)

     
A continuación se muestran algunos de los estilos comunes aplicados al texto:

      <list>

        <item>
Color de fondo (propiedad «background»)
</item>

        <item>
Color de primer plano (propiedad «foreground»)
</item>

        <item>
Subrayado (propiedad «underline»)
</item>

        <item>
Negrita (propiedad «weight»)
</item>

        <item>
Cursiva (propiedad «style»)
</item>

        <item>
Tachado (propiedad «strikethrough»)
</item>

        <item>
Justificación (propiedad «justification»)
</item>

        <item>
Tamaño (propiedades «size» y «size-points»)
</item>

        <item>
Ajuste de texto (propiedad «wrap-mode»)
</item>

      </list>

    
También puede eliminar etiquetas particulares más tarde usando remove_tag() o eliminar todas las etiquetas en una región dada llamando a remove_all_tags().
</item>

  </list>

  
Métodos para un widget «TextIter»

  <list>

    <item>
forward_search(cadena, banderas, límite) busca cadena hacia delante. La búsqueda no continuará después del límite Gtk.TextIter. Las banderas pueden ser cualquier combinación de las siguientes, concatenándolas con el operador OR a nivel de bits |: 0 (la coincidencia debe ser exacta); Gtk.TextSearchFlags.VISIBLE_ONLY (la coincidencia puede tener texto invisible intercalado en «aguja»); Gtk.TextSearchFlags.TEXT_ONLY (la coincidencia puede tener «pixbufs» o widgets hijos mezclados dentro del rango coincidente); Gtk.TextSearchFlags.CASE_INSENSITIVE (el texto coincidirá sin importar su capitalización). El método devuelve una tupla que contiene un Gtk.TextIter apuntando al inicio y al primer carácter después de la coincidencia; si no se encuentra, se devuelve None.
</item>

    <item>
backward_search(cadena, banderas, límite) hace lo mismo que forward_search(), pero hacia atrás.
</item>

  </list>

  </section>

  <section id="references">

  <title>Referencias de la API</title>

  
En este ejemplo se usa lo siguiente:

  <list>

    <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkTextView.html">GtkTextView</link>
</item>

    <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkTextBuffer.html">GtkTextBuffer</link>
</item>

    <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkTextTag.html">GtkTextTag</link>
</item>

    <item>
<link href="http://developer.gnome.org/gtk3/unstable/GtkScrolledWindow.html">GtkScrolledWindow</link>
</item>

    <item>
<link href="http://developer.gnome.org/gtk3/unstable/gtk3-Standard-Enumerations.html">Enumeraciones estándar</link>
</item>

  </list>

  </section>

</page>