# Image Viewer (JavaScript)

Algo más que una sencilla aplicación «Hola mundo»; escribir un visor de imágenes en GTK. Incluye una introducción al lenguaje JavaScript.
Jonh Wendell
jwendell@gnome.org
Johannes Schmid
jhs@gnome.org

# 1. Visor de imágenes

      En este tutorial se va a escribir una aplicación GTK+ muy sencilla que carga un archivo e imagen y lo muestra. Aprenderá a:

        Escribir una interfaz GTK+ de usuario básica usando JavaScript
        Trabajar con eventos conectando señales a manejadores de señales
        La disposición de las interfaces de usuario usando contenedores
        Cargar y mostrar archivos de imagen

      Necesitará lo siguiente para poder seguir este tutorial:

        Una copia instalada del EID Anjuta
        Una copia instalada del intérprete gjs
        Conocimiento básico de cualquier lenguaje de programación orientado a objetos

# Crear un proyecto en Anjuta

Antes de empezar a programar, deberá configurar un proyecto nuevo en Anjuta. Esto creará todos los archivos que necesite para construir y ejecutar el código más adelante. También es útil para mantener todo ordenado.

Inicie Anjuta y pulse Archivo Nuevo Proyecto para abrir el asistente de proyectos.

Elija Javascript genérico de la pestaña JS, pulse Adelante y rellene los detalles en las siguientes páginas. Use visor-imágenes como nombre de proyecto y de carpeta.

Pulse Aplicar y se creará el proyecto. Abra src/main.js desde las pestañas Proyecto o Archivo. Contiene un ejemplo de código muy básico:

# JavaScript básico: hola mundo

Antes de empezar a escribir el visor de imágenes, averigüe algo más sobre cómo se usa JavaScript en GNOME. Por supuesto que su primer contacto con un lenguaje de programación debe ser el programa «Hola mundo», que se puede encontrar en el archivo main.js:

print ("¡Hola mundo!");

Esto debería resultarle natural si está familiarizado con la mayoría del resto de lenguajes de programación. La función `print` se llama con el argumento `"¡Hola mundo!"`, que se mostrará en la pantalla. Tenga en cuenta que cada línea de código termina en «;».

# Clases en JavaScript

Esta es la manera estándar de definir una clase en JavaScript:

function MyClass () { this._init (); }

MyClass.prototype = {

_init: function () { this.propertyA = "This is an object's field"; this.propertyB = 10; },

aMethod: function (arg1, arg2) { print ("inside aMethod: " + arg1 + " " + arg2); },

dumpProperties: function () { print (this.propertyA); print (this.propertyB); }

}

Esto define una clase llamada `MyClass`. Vea cada una de las partes de la definición de la clase:

`function MyClass` es el constructor de la clase; su nombre debe coincidir con el de la clase. Puede acceder a cualquier miembro de la clase usando el objeto `this`; aquí, el constructor llama al método `_init` de la clase.

El bloque `MyClass.prototype` es donde define la estructura de la clase. Cada clase se compone de métodos (funciones) y campos (variables); en este ejemplo, hay tres métodos y dos campos.

El primer método definido se llama `_init`, y se especifica que es una función sin argumentos:

_init: function ()

Se escribe la función entre corchetes. Aquí se definen dos campos, `propertyA` y `propertyB`. La primera se establece como una cadena, y la segunda se establece como un entero (10). La función no retorna ningún valor.

El siguiente método se llama `aMethod` y tiene dos argumentos que imprime cuando se invoca. El último método es `dumpProperties`, que imprime los campos `propertyA` y `propertyB`.

Tenga en cuenta cómo se ordena la definición de la clase (prototipo); cada definición de función se separa con una coma.

Ahora que «MyClass» se ha definido, se puede jugar con ella:

var o = new MyClass (); o.aMethod ("Hello", "world"); o.propertyA = "Just changed its value!"; o.dumpProperties ();

Este código crear una instancia nueva de la clase llamada `o`, ejecuta `aMethod`, cambia `propertyA` a una cadena diferente y entonces llama a `dumpProperties` (que muestra los campos).

Guarde el código en el archivo main.js y ejecútelo usando Ejecutar Ejecutar desde el menú o usando la barra de herramientas.

# Una primera aplicación en GTK

Vea como queda una aplicación GTK+ muy básica en JavaScript:

const Gtk = imports.gi.Gtk;

Gtk.init (null, null);

var w = new Gtk.Window ({title: "Image Viewer Demo"}); w.show ();

Gtk.main ();

Eche un vistazo a lo que está pasando:

La primera línea importa el espacio de nombres de GTK+ (es decir, incluye la biblioteca GTK+). Las bibliotecas las proporciona «GObject Introspection (gi)», que implementa asociaciones de lenguajes para la mayoría de las bilbiotecas de GNOME.

`Gtk.init` inicializa la biblioteca GTK; esta sentencia es obligatoria para todos los programas GTK.

La siguiente línea crea la ventana principal creando un objeto `Gtk.Window`. Puede pasar varias propiedades al constructor de la ventana usando la sintaxis `{property: value, property: value, ...}`. En este caso, se está estableciendo el título de la ventana.

La siguiente línea muestra explícitamente la ventana. En GTK+, cada widget está oculto de manera predeterminada.

Finalmente, `Gtk.main` ejecuta el bucle principal; en otras palabras, ejecuta el programa. El bucle principal escucha los eventos (señales) de la interfaz del usuario y llama a un manejador de la señal que hará algo útil. En breve aprenderá más cosas sobre las señales.

Guarde el código en main.js y ejecútelo. Notará que la aplicación no termina cuando cierra la ventana. Esto es porque todavía no se ha configurado un manejador de señal para gestionar la señal `destroy` (cerrar) de la ventana. Esto se hará en breve, pero por el momento puede pulsar Ctrl C en la ventana de la terminal para salir del programa.

# Añadir clases

La manera correcta de programar en GTK+ es usando clases. Reescriba el código que acaba de escribir usando clases:

const Gtk = imports.gi.Gtk;

function ImageViewer () { this._init (); }

ImageViewer.prototype = { _init: function () { this.window = new Gtk.Window ({title: "Image Viewer Demo"}); this.window.show (); } }

Gtk.init (0, null); var iv = new ImageViewer (); Gtk.main ();

Tenga en cuenta que el programa es el mismo; simplemente se ha movido el código de creación de la ventana a la clase `ImageViewer`. El constructor de la clase llama al método `_init`, que crea y muestra la ventana. Se crea entonces una instancia de la clase antes de ejecutar el bucle principal (`Gtk.main`).

El código es modular y se puede dividir el varios archivos fácilmente. Esto hace que sea más limpio y fácil de leer.

# Señales

Las señales son un concepto clave en la programación en GTK. Cuando pasa algo en un objeto, emite una señal; por ejemplo, cuando se pulsa un botón, emite la señal `clicked`. Si quiere que su programa haga algo cuando ocurre ese evento, debe conectar una función (un «manejador de la señal») a esa señal. Aquí hay un ejemplo:

function button_clicked () { print ("you clicked me!"); } var b = new Gtk.Button ({label:"Click me"}); b.connect ("clicked", button_clicked);

Las dos últimas líneas crean un `Gtk.Button` llamado `b` y conectan su señal `clicked` con la función `button_clicked` que se ha definido anteriormente. Cada vez que se pulsa un botón, se ejecuta el código de la función `button_clicked`. Esto sólo imprime un mensaje aquí.

La sintaxis para conectar cualquier señal a una función es:

object.connect (<signal_name>, <function_to_be_called>);

Puede encontrar definiciones de señales para cualquier objeto en la referencia de clases de GTK+.

Puede simplificar el código usando una definición de función en línea:

`b.connect ("clicked", function () { print ("you clicked me!"); });`

# Cerrar la ventana

Cuando cierra una ventana de GTK, realmente no se cierra, se oculta. Esto le permite mantener la ventana (lo que es útil si quiere preguntar al usuario si realmente quiere cerrar la ventana, por ejemplo).

En este caso, simplemente se quiere cerrar la ventana. La manera más sencilla de hacerlo es conectar la señal `hide` del objeto GtkWindow a una función que cierra la aplicación. Vuelva al archivo image-viewer.js y añada el siguiente código al método `_init`, en la línea anterior a `this.window.show`:

this.window.connect ("hide", Gtk.main_quit);

Esto conecta la señal `hide` de la ventana con la función `main_quit` de GTK, que termina la ejecución del bucle principal de GTK. Una vez que el bucle principal termina, la función `Gtk.main` retorna. El programa puede continuar ejecutando cualquier código que haya después de la línea `Gtk.main ();`, pero como no hay ningún código después de ese punto, el programa simplemente termina.

# Contenedores: diseñar la interfaz de usuario

Los widgets (controles, como botones y etiquetas) se pueden organizar en la ventana usando contenedores. Puede organizar el diseño mezclando diferentes tipos de contenedores, como cajas y rejillas.

Una `Gtk.Window` es en sí misma un tipo de contenedor, pero sólo puede poner un widget directamente en ella. Se quieren poner dos widgets, una imagen y un botón, por lo que se necesita poner un contenedor «de mayor capacidad» dentro de la ventana para que contenga otros widgets. Hay varios tipos de contenedores disponibles, pero aquí se usará una `Gtk.Box`. Una `Gtk.Box` puede contener varios widgets, organizados horizontal o verticalmente. Se pueden hacer diseños más complejos poniendo varias cajas dentro de otras, y así sucesivamente.

Hay un diseñador de interfaces gráficas llamado Glade integrado en Anjuta que hace que el diseño de IU sea realmente fácil. Sin embargo, para este ejemplo, se va a codificar todo manualmente.

Añada la caja y los widgets a la ventana. Inserte el siguiente código en el método `_init`, justo debajo de la línea `this.window.show`:

var main_box = new Gtk.Box ({orientation: Gtk.Orientation.VERTICAL, spacing: 0}); this.window.add (main_box);

La primera línea crea una `Gtk.Box` llamada `main_box` y establece dos de sus propiedades: la `orientation` se establece a «vertical» (por lo que los widgets se ordenan en columna), y el `spacing` entre los widgets, que se establece a 0 píxeles. La siguiente línea añade la `Gtk.Box` recién creada a la ventana.

De momento, la ventana sólo contiene una `Gtk.Box` vacía, y si ejecuta el programa ahora no verá ningún cambio (la `Gtk.Box` es un contenedor transparente, por lo que no puede que está ahí).

# Empaquetado: añadir widgets al contenedor

Para añadir algunos widgets a la `Gtk.Box`, inserte el siguiente código justo debajo de la línea `this.window.add (main_box)`:

this.image = new Gtk.Image (); main_box.pack_start (this.image, true, true, 0);

La primera línea crea una `Gtk.Image` nueva llamada `image`, que se usará para mostrar un archivo de imagen. Entonces, se añade el widget de imagen (packed) al contenedor `main_box` usando el método `pack_start` de `Gtk.Box`.

`pack_start` toma 4 argumentos: el widget que añadir a la `Gtk.Box` (`child`); indica si la `Gtk.Box` debe crecer a lo largo cuando se añade el widget nuevo (`expand`); indica si el widget nuevo debe tomar todo el espacio adicional creado si la `Gtk.Box` se hace más grande (`fill`); y cuánto espacio debe haber, en píxeles, entre el widget y los demás widgets dentro de la `Gtk.Box` (`padding`).

Los contenedores (y los widgets) de GTK+ se expanden dinámicamente, si les deja, para rellenar el espacio disponible. No posicione widgets indicando unas coordenadas x-y precisas en la ventana; en lugar de eso, se posicionan relativos a otro. Esto hace que el manejo de la redimensión de las ventanas sea más fácil, y que los widgets tengan un tamaño sensible automática en la mayoría de las situaciones.

También tenga en cuenta cómo se organizan los widgets de manera jerárquica. Una vez empaquetados en la `Gtk.Box`, la `Gtk.Image` se considera un hijo de la `Gtk.Box`. Esto le permite tratar a todos los hijos de un widget como un grupo; por ejemplo, puede ocultar la `Gtk.Box`, lo que haría que también se ocultaran todos sus hijos a la vez.

Ahora inserte estas dos líneas, justo debajo de las dos que acaba de añadir.

var open_button = new Gtk.Button ({label: "Open a picture..."}); main_box.pack_start (open_button, false, false, 0);

Estas líneas son similares a las dos primeras, pero esta vez crean un `Gtk.Button` y lo añaden a la `main_box`. Tenga en cuenta que aquí se está estableciendo el argumento `expand` (el segundo) a `false`, mientras que para la `Gtk.Image` se estableció a `true`. Esto hará que la imagen tome todo el espacio disponible y que el botón tome sólo el espacio que necesite. Cuando se maximiza la ventana, el tamaño del botón será el mismo, pero el tamaño de la imagen aumentará junto con el resto de la ventana.

Finalmente, se debe cambiar la línea `this.window.show ();` para leer:

this.window.show_all ();

Esto mostrará el hijo de la ventana de GTK, y todos sus hijos, y los hijos de sus hijos, etcétera. (Recuerde que los widgets de GTK están ocultos de manera predeterminada.)

# Cargar la imagen: conectar con la señal `clicked` del botón

Cuando el usuario pulse en el botón Abrir, debe aparecer un diálogo en el que el usuario pueda elegir una imagen. una vez elegida, la imagen se debe cargar y mostrar en el widget de imagen.

El primer paso es conectar la señal `clicked` del botón a una función manejadora de la señal, llamada `_openClicked`. Ponga este código inmediatamente después de la línea `var open_button = new Gtk.Button` en la que se creó el botón:

open_button.connect ("clicked", Lang.bind (this, this._openClicked));

Aquí se está usando el JavaScript auxiliar Lang. Permite conectar un método de clase a la señal, en vez de una función normal (sin clase) que se haya usado anteriormente para señal `hide` de la ventana. No se preocupe por esto ahora, es sólo un detalle técnico. Para que funcione, debe poner también la siguiente línea en la parte superior del archivo:

const Lang = imports.lang;

# Cargar la imagen: escribir la llamada de retorno de la señal

Ahora se puede crear el método `_openClicked()`. Inserte el siguiente código en el bloque de código de `ImageViewer.prototype`, después del método `_init` (y no olvide la coma):

_openClicked: function () { var chooser = new Gtk.FileChooserDialog ({title: "Select an image", action: Gtk.FileChooserAction.OPEN, transient_for: this.window, modal: true}); chooser.add_button (Gtk.STOCK_CANCEL, 0); chooser.add_button (Gtk.STOCK_OPEN, 1); chooser.set_default_response (1);

var filter = new Gtk.FileFilter (); filter.add_pixbuf_formats (); chooser.filter = filter;

if (chooser.run () == 1) this.image.file = chooser.get_filename ();

chooser.destroy (); }

Esto es un poco más complicado que todo lo que se ha intentado hasta ahora, así que se puede desglosar:

La línea que comienza por `var chooser` crear un diálogo Abrir, que el usuario puede utilizar para elegir archivos. Se establecen cuatro propiedades: el título del diálogo, la acción (tipo) del diálogo (es un diálogo «open», pero se podría haber usado `SAVE` si la intención hubiese sido guardar un archivo; `transient_for`, que establece la ventana padre del diálogo; y `modal`, que si se establecer a `true` evita que el usuario pueda pulsar en otra área de la aplicación hasta que no se cierre el diálogo.

Las dos siguientes líneas añaden los botones Cancelar y Abrir al diálogo. el segundo argumento del método `add_button` es el valor (entero) que se devuelve cuando se pulsa el botón: 0 para Cancelar y 1 para Abrir.

Note que se está usando nombres de botones del almacén de GTK, en lugar de escribir manualmente «Cancelar» o «Abrir». La ventaja de usar nombres del almacén es que las etiquetas de los botones ya estarán traducidas en el idioma del usuario.

`set_default_response` determina qué botón se activará si el usuario hace una doble pulsación o presiona Intro. En este caso, se usa el botón Abrir como predeterminado (que tiene el valor «1»).

Las tres líneas siguientes restringen el diálogo Abrir para que sólo muestre archivos que se puedan abrir con `Gtk.Image`. Primero se crea un objeto de filtro; luego se añaden los tipos de archivos soportados por el `Gdk.Pixbuf` (que incluye la mayoría de los formatos de imagen como PNG y JPEG) al filtro. Por último, se establece que este filtro sea el filtro del diálogo Abrir.

`chooser.run` muestra el diálogo Abrir. El diálogo esperará a que el usuario elija una imagen; cuando lo haga, `chooser.run` devolverá el valor 1 (devolvería 0 si el usuario pulsara Cancelar). La sentencia `if` comprueba esto.

Asumiendo que el usuario pulsó Abrir, la siguiente línea establece la propiedad `file` de la `Gtk.Image` al nombre del archivo de imagen seleccionada por el usuario. La `Gtk.Image` cargará y mostrará la imagen elegida.

En la última línea de este método se destruye el diálogo Abrir porque ya no se necesita.

# Ejecutar la aplicación

Todo el código que necesita debe estar en su lugar, así que trate de ejecutar el código. Esto debería ser todo; un visor de imágenes completamente funcional (y un completo tour sobre JavaScript y GTK+) en poco tiempo.

# Implementación de referencia

Si tiene problemas con este tutorial, compare su código con este código de referencia.

# Siguientes pasos

Aquí hay algunas ideas sobre cómo puede extender esta sencilla demostración:

Haga que el usuario selecciona una carpeta en vez de un archivo, y proporcione controles para moverse por todas las imágenes de una carpeta.

Aplicar filtros aleatorios y efectos a la imagen cuando se carga y permitir al usuario guardar la imagen modificada.

GEGL proporciona la capacidad de manipular imágenes de manera potente.

Permitir al usuario cargar imágenes desde recursos de red compartidos, escáneres y otras fuentes más complicadas.

Puede usar GIO para gestionar transferencias de archivos de red y similares, y GNOME Scan para gestionar el escaneado.