Crear una aplicación de escritorio Linux con Ruby

Para definir nuestro diseño como plantilla, marque el Compuesto casilla de verificación en el widget de propiedad. Tenga en cuenta que el ID propiedad cambiada a Nombre de clase . Complete TodoApplicationWindow . Esta es la clase que crearemos en nuestro código para representar este widget.

Guarde el archivo con el nombre application_window.ui en una nueva carpeta llamada ui dentro de los recursos . Esto es lo que vemos si abrimos el archivo desde un editor:

<?xml version="1.0" encoding="UTF-8"?>

<!-- Generated with glade 3.18.3 -->

<interface>

  <requires lib="gtk+" version="3.12"/>

  <template class="TodoApplicationWindow" parent="GtkApplicationWindow">

    <property name="can_focus">False</property>

    <child>

      <placeholder/>

    </child>

  </template>

</interface>

Nuestro widget tiene una clase y un atributo principal. Siguiendo la convención de atributos de la clase principal, nuestra clase debe definirse dentro de un módulo llamado Todo . Antes de llegar allí, intentemos iniciar la aplicación ejecutando el script (./gtk-todo ).

¡Sí! ¡Empieza!

Crea la clase de ventana de la aplicación

Si revisamos el contenido del directorio raíz de la aplicación mientras la ejecutamos, podemos ver el gresource.bin archivo allí. Aunque la aplicación se inicia correctamente porque el contenedor de recursos está presente y se puede registrar, no lo usaremos todavía. Seguiremos iniciando un Gtk::ApplicationWindow ordinario en nuestro application.rb expediente. Ahora es el momento de crear nuestra clase de ventana de aplicación personalizada.

Cree un archivo llamado application_window.rb en la aplicación/ui/todo carpeta y agregue el siguiente contenido:

module Todo

  class ApplicationWindow < Gtk::ApplicationWindow

    # Register the class in the GLib world

    type_register



    class << self

      def init

        # Set the template from the resources binary

        set_template resource: '/com/iridakos/gtk-todo/ui/application_window.ui'

      end

    end



    def initialize(application)

      super application: application



      set_title 'GTK+ Simple ToDo'

    end

  end

end

Definimos el init como método singleton en la clase después de abrir la eigenclass para vincular la plantilla de este widget al archivo de recursos previamente registrado.

Antes de eso, llamamos al type_register método de clase, que registra y pone a disposición nuestra clase de widget personalizado para GLib mundo.

Finalmente, cada vez que creamos una instancia de esta ventana, establecemos su título en GTK+ Simple ToDo .

Ahora, volvamos a application.rb archivo y use lo que acabamos de implementar:

module ToDo

  class Application < Gtk::Application

    def initialize

      super 'com.iridakos.gtk-todo', Gio::ApplicationFlags::FLAGS_NONE



      signal_connect :activate do |application|

        window = Todo::ApplicationWindow.new(application)

        window.present

      end

    end

  end

end

Ejecute el script.

Definir el modelo

Para simplificar, guardaremos los elementos de ToDo en archivos en formato JSON en una carpeta oculta dedicada en el directorio de inicio de nuestro usuario. En una aplicación real, usaríamos una base de datos, pero eso está fuera del alcance de este tutorial.

Nuestro Todo::Item modelo tendrá las siguientes propiedades:

• identificación :la identificación del artículo
• título :El título
• notas :Cualquier nota
• prioridad :Su prioridad
• fecha_hora_de_creación :la fecha y la hora en que se creó el elemento
• nombre de archivo :el nombre del archivo en el que se guarda un elemento

Crearemos un archivo llamado item.rb bajo la aplicación/modelos directorio con los siguientes contenidos:

require 'securerandom'

require 'json'



module Todo

  class Item

    PROPERTIES = [:id, :title, :notes, :priority, :filename, :creation_datetime].freeze



    PRIORITIES = ['high', 'medium', 'normal', 'low'].freeze



    attr_accessor *PROPERTIES



    def initialize(options = {})

      if user_data_path = options[:user_data_path]

        # New item. When saved, it will be placed under the :user_data_path value

        @id = SecureRandom.uuid

        @creation_datetime = Time.now.to_s

        @filename = "#{user_data_path}/#{id}.json"

      elsif filename = options[:filename]

        # Load an existing item

        load_from_file filename

      else

        raise ArgumentError, 'Please specify the :user_data_path for new item or the :filename to load existing'

      end

    end



    # Loads an item from a file

    def load_from_file(filename)

      properties = JSON.parse(File.read(filename))



      # Assign the properties

      PROPERTIES.each do |property|

        self.send "#{property}=", properties[property.to_s]

      end

    rescue => e

      raise ArgumentError, "Failed to load existing item: #{e.message}"

    end



    # Resolves if an item is new

    def is_new?

      !File.exists? @filename

    end



    # Saves an item to its `filename` location

    def save!

      File.open(@filename, 'w') do |file|

        file.write self.to_json

      end

    end



    # Deletes an item

    def delete!

      raise 'Item is not saved!' if is_new?



      File.delete(@filename)

    end



    # Produces a json string for the item

    def to_json

      result = {}

      PROPERTIES.each do |prop|

        result[prop] = self.send prop

      end



      result.to_json

    end

  end

end

Aquí definimos métodos para:

• Inicializar un elemento:
  • Como "nuevo" definiendo :user_data_path en el que se guardará más tarde
  • Como "existente" definiendo :filename para ser cargado desde. El nombre del archivo debe ser un archivo JSON generado previamente por un elemento
• Cargar un elemento desde un archivo
• Resolver si un elemento es nuevo o no (es decir, guardado al menos una vez en :user_data_path o no)
• Guarde un elemento escribiendo su cadena JSON en un archivo
• Eliminar un elemento
• Producir la cadena JSON de un elemento como un hash de sus propiedades

Agregar un nuevo elemento

Crea el botón

Agreguemos un botón a nuestra ventana de aplicación para agregar un nuevo elemento. Abra resources/ui/application_window.ui archivo en Glade.

• Arrastre un Botón desde la sección Widget hasta la sección Diseño.
• En la sección Propiedades, establezca su ID valor para add_new_item_button .
• Cerca de la parte inferior del General en la sección Propiedades, hay un área de texto justo debajo de la Etiqueta con imagen opcional opción. Cambia su valor desde Botón para Añadir nuevo elemento .
• Guarde el archivo y ejecute el script.

No te preocupes; luego mejoraremos el diseño. Ahora, veamos cómo conectar funcionalidad a nuestro botón clic evento.

Primero, debemos actualizar nuestra clase de ventana de aplicación para que aprenda sobre su nuevo hijo, el botón con id add_new_item_button . Entonces podemos acceder al niño para alterar su comportamiento.

Cambia el init método de la siguiente manera:

def init

  # Set the template from the resources binary

  set_template resource: '/com/iridakos/gtk-todo/ui/application_window.ui'



  bind_template_child 'add_new_item_button'

end

Bastante simple, ¿verdad? El bind_template_child hace exactamente lo que dice, y de ahora en adelante cada instancia de nuestro Todo::ApplicationWindow la clase tendrá un add_new_item_button para acceder al botón relacionado. Entonces, modifiquemos el initialize método de la siguiente manera:

def initialize(application)

  super application: application



  set_title 'GTK+ Simple ToDo'



  add_new_item_button.signal_connect 'clicked' do |button, application|

    puts "OMG! I AM CLICKED"

  end

end

Como puede ver, accederemos al botón mediante el add_new_item_button método, y definimos lo que queremos que suceda cuando se haga clic en él. Reinicie la aplicación e intente hacer clic en el botón. En la consola, deberías ver el mensaje OMG! HAGO CLIC cuando haces clic en el botón.

Sin embargo, lo que queremos que suceda cuando hacemos clic en este botón es mostrar una nueva ventana para guardar un elemento ToDo. Has acertado:son las en punto de Glade.

Crea la ventana del nuevo elemento

• Cree un nuevo proyecto en Glade presionando el icono más a la izquierda en la barra superior o seleccionando Archivo> Nuevo desde el menú de la aplicación.
• Arrastre una Ventana desde la sección Widget hasta el área de Diseño.
• Compruebe su Compuesto propiedad y nombre la clase TodoNewItemWindow .

• Arrastre una Cuadrícula de la sección Widget y colóquelo en la ventana que agregamos anteriormente.
• Juego 5 filas y 2 columnas en la ventana que aparece.
• En el General pestaña de la sección Propiedades, establezca el espacio entre filas y columnas en 10 (píxeles).
• En el Común pestaña de la sección Propiedades, establezca Espaciado de widgets> Márgenes> Superior, Inferior, Izquierda, Derecha todo a 10 para que el contenido no se pegue a los bordes de la cuadrícula.

• Arrastre cuatro Etiqueta widgets de la sección Widget y coloque uno en cada fila de la cuadrícula.
• Cambiar su Etiqueta propiedades, de arriba a abajo, de la siguiente manera:
  • Identificación:
  • Título:
  • Notas:
  • Prioridad:
• En el General pestaña de la sección Propiedades, cambie la Alineación y relleno> Alineación> Horizontal propiedad de 0,50 a 1 para cada propiedad con el fin de alinear a la derecha el texto de la etiqueta.
• Este paso es opcional pero recomendado. No uniremos esas etiquetas en nuestra ventana ya que no necesitamos alterar su estado o comportamiento. En este contexto, no necesitamos establecer una identificación descriptiva para ellos como lo hicimos para el add_new_item_button botón en la ventana de la aplicación. PERO agregaremos más elementos a nuestro diseño, y la jerarquía de los widgets en Glade será difícil de leer si dicen label1 , etiqueta2 , etc. Establecer ID descriptivos (como id_label , título_etiqueta , notas_etiqueta , priority_label ) nos hará la vida más fácil. Incluso configuré la ID de la cuadrícula en main_grid porque no me gusta ver números o nombres de variables en los ID.

• Arrastre una Etiqueta desde la sección Widget hasta la segunda columna de la primera fila de la cuadrícula. El ID será generado automáticamente por nuestro modelo; no permitiremos la edición, por lo que una etiqueta para mostrarlo es más que suficiente.
• Establecer el ID propiedad a id_value_label .
• Establecer la Alineación y relleno> Alineación> Horizontal propiedad a 0 para que el texto se alinee a la izquierda.
• Enlazaremos este widget a nuestra clase Ventana para que podamos cambiar su texto cada vez que carguemos la ventana. Por lo tanto, no es necesario configurar una etiqueta a través de Glade, pero hace que el diseño se acerque más a cómo se verá cuando se represente con datos reales. Puede establecer una etiqueta para lo que más le convenga; Establecí el mío en id-of-the-todo-item-here .

• Arrastre una Entrada de texto desde la sección Widget a la segunda columna de la segunda fila de la cuadrícula.
• Establezca su propiedad ID en title_text_entry . Como habrás notado, prefiero obtener el tipo de widget en el ID para que el código de la clase sea más legible.
• En el Común pestaña de la sección Propiedades, marque Espaciado de widgets> Expandir> Horizontal casilla de verificación y encienda el interruptor junto a ella. De esta manera, el widget se expandirá horizontalmente cada vez que se cambie el tamaño de su padre (también conocido como la cuadrícula).

• Arrastre una Vista de texto desde la sección Widget hasta la segunda columna de la tercera fila de la cuadrícula.
• Establecer su ID a notas . No, solo te estoy probando. Establecer su ID propiedad a notes_text_view .
• En el Común pestaña de la sección Propiedades, marque Espaciado de widgets> Expandir> Horizontal, Vertical casillas de verificación y encienda los interruptores junto a ellas. De esta forma, el widget se expandirá horizontal y verticalmente cada vez que se cambie el tamaño de su padre (la cuadrícula).

• Arrastre un Cuadro combinado desde la sección Widget hasta la segunda columna de la cuarta fila de la cuadrícula.
• Establecer su ID a priority_combo_box .
• En el Común pestaña de la sección Propiedades, marque Espaciado de widgets> Expandir> Horizontal casilla de verificación y encienda el interruptor a su derecha. Esto permite que el widget se expanda horizontalmente cada vez que se cambia el tamaño de su padre (la cuadrícula).
• Este widget es un elemento desplegable. Completaremos sus valores que pueden ser seleccionados por el usuario cuando aparezca dentro de nuestra clase de ventana.

• Drag a Button Box from the Widget section to the second column of the last row of the grid.
• In the pop-up window, select 2 items.
• In the General tab of the Properties section, set the Box Attributes> Orientation property to Horizontal .
• In the General tab of the Properties section, set the Box Attributes> Spacing property to 10 .
• In the Common tab of the Properties section, set the Widget Spacing> Alignment> Horizontal to Center .
• Again, our code won't alter this widget, but you can give it a descriptive ID for readability. I named mine actions_box .

• Drag two Button widgets and place one in each box of the button box widget we added in the previous step.
• Set their ID properties to cancel_button and save_button , respectively.
• In the General tab of the Properties window, set their Button Content> Label with option image property to Cancel and Save , respectively.

The window is ready. Save the file under resources/ui/new_item_window.ui .

It's time to port it into our application.

Implement the new item window class

Before implementing the new class, we must update our GResource description file (resources/gresources.xml ) to obtain the new resource:

<?xml version="1.0" encoding="UTF-8"?>

<gresources>

  <gresource prefix="/com/iridakos/gtk-todo">

    <file preprocess="xml-stripblanks">ui/application_window.ui</file>

    <file preprocess="xml-stripblanks">ui/new_item_window.ui</file>

  </gresource>

</gresources>

Now we can create the new window class. Create a file under application/ui/todo named new_item_window.rb and set its contents as follows:

module Todo

  class NewItemWindow < Gtk::Window

    # Register the class in the GLib world

    type_register



    class << self

      def init

        # Set the template from the resources binary

        set_template resource: '/com/iridakos/gtk-todo/ui/new_item_window.ui'

      end

    end



    def initialize(application)

      super application: application

    end

  end

end

There's nothing special here. We just changed the template resource to point to the correct file of our resources.

We have to change the add_new_item_button code that executes on the clicked signal to show the new item window. We'll go ahead and change that code in application_window.rb to this:

add_new_item_button.signal_connect 'clicked' do |button|

  new_item_window = NewItemWindow.new(application)

  new_item_window.present

end

Let's see what we have done. Start the application and click on the Add new item botón. Tadaa!

But nothing happens when we press the buttons. Let's fix that.

First, we'll bind the UI widgets in the Todo::NewItemWindow class.

Change the init method to this:

def init

  # Set the template from the resources binary

  set_template resource: '/com/iridakos/gtk-todo/ui/new_item_window.ui'



  # Bind the window's widgets

  bind_template_child 'id_value_label'

  bind_template_child 'title_text_entry'

  bind_template_child 'notes_text_view'

  bind_template_child 'priority_combo_box'

  bind_template_child 'cancel_button'

  bind_template_child 'save_button'

end

This window will be shown when either creating or editing a ToDo item, so the new_item_window naming is not very valid. We'll refactor that later.

For now, we will update the window's initialize method to require one extra parameter for the Todo::Item to be created or edited. We can then set a more meaningful window title and change the child widgets to reflect the current item.

We'll change the initialize method to this:

def initialize(application, item)

  super application: application

  set_title "ToDo item #{item.id} - #{item.is_new? ? 'Create' : 'Edit' } Mode"



  id_value_label.text = item.id

  title_text_entry.text = item.title if item.title

  notes_text_view.buffer.text = item.notes if item.notes



  # Configure the combo box

  model = Gtk::ListStore.new(String)

  Todo::Item::PRIORITIES.each do |priority|

    iterator = model.append

    iterator[0] = priority

  end



  priority_combo_box.model = model

  renderer = Gtk::CellRendererText.new

  priority_combo_box.pack_start(renderer, true)

  priority_combo_box.set_attributes(renderer, "text" => 0)



  priority_combo_box.set_active(Todo::Item::PRIORITIES.index(item.priority)) if item.priority

end

Then we'll add the constant PRIORITIES in the application/models/item.rb file just below the PROPERTIES constant:

PRIORITIES = ['high', 'medium', 'normal', 'low'].freeze

What did we do here?

• We set the window's title to a string containing the current item's ID and the mode (depending on whether the item is being created or edited).
• We set the id_value_label text to display the current item's ID.
• We set the title_text_entry text to display the current item's title.
• We set the notes_text_view text to display the current item's notes.
• We created a model for the priority_combo_box whose entries are going to have only one String valor. At first sight, a Gtk::ListStore model might look a little confusing. Here's how it works.
  • Suppose we want to display in a combo box a list of country codes and their respective country names.
  • We would create a Gtk::ListStore defining that its entries would consist of two string values:one for the country code and one for the country name. Thus we would initialize the ListStore as: 
    

    model = Gtk::ListStore.new(String, String)

  • To fill the model with data, we would do something like the following (make sure you don't miss the comments in the snippet): 
    

    [['gr', 'Greece'], ['jp','Japan'], ['nl', 'Netherlands']].each do |country_pair|
    
      entry = model.append
    
      # Each entry has two string positions since that's how we initialized the Gtk::ListStore
    
      # Store the country code in position 0
    
      entry[0] = country_pair[0]
    
      # Store the country name in position 1
    
      entry[1] = country_pair[1]
    
    end

  • We also configured the combo box to render two text columns/cells (again, make sure you don't miss the comments in the snippet): 
    

    country_code_renderer = Gtk::CellRendererText.new
    
    # Add the first renderer
    
    combo.pack_start(country_code_renderer, true)
    
    # Use the value in index 0 of each model entry a.k.a. the country code
    
    combo.set_attributes(country_code_renderer, 'text' => 0)
    
    
    
    country_name_renderer = Gtk::CellRendererText.new
    
    # Add the second renderer
    
    combo.pack_start(country_name_renderer, true)
    
    # Use the value in index 1 of each model entry a.k.a. the country name
    
    combo.set_attributes(country_name_renderer, 'text' => 1)

  • I hope that made it a little clearer.
• We added a simple text renderer in the combo box and instructed it to display the only value of each model's entry (a.k.a., position 0 ). Imagine that our model is something like [['high'],['medium'],['normal'],['low']] and 0 is the first element of each sub-array. I will stop with the model-combo-text-renderer explanations now…

Configure the user data path

Remember that when initializing a new Todo::Item (not an existing one), we had to define a :user_data_path in which it would be saved. We are going to resolve this path when the application starts and make it accessible from all the widgets.

All we have to do is check if the .gtk-todo-tutorial path exists inside the user's home ~ directorio. If not, we will create it. Then we'll set this as an instance variable of the application. All widgets have access to the application instance. So, all widgets have access to this user path variable.

Change the application/application.rb file to this:

module ToDo

  class Application < Gtk::Application

    attr_reader :user_data_path



    def initialize

      super 'com.iridakos.gtk-todo', Gio::ApplicationFlags::FLAGS_NONE



      @user_data_path = File.expand_path('~/.gtk-todo-tutorial')

      unless File.directory?(@user_data_path)

        puts "First run. Creating user's application path: #{@user_data_path}"

        FileUtils.mkdir_p(@user_data_path)

      end



      signal_connect :activate do |application|

        window = Todo::ApplicationWindow.new(application)

        window.present

      end

    end

  end

end

One last thing we need to do before testing what we have done so far is to instantiate the Todo::NewItemWindow when the add_new_item_button is clicked complying with the changes we made. In other words, change the code in application_window.rb to this:

add_new_item_button.signal_connect 'clicked' do |button|

  new_item_window = NewItemWindow.new(application, Todo::Item.new(user_data_path: application.user_data_path))

  new_item_window.present

end

Start the application and click on the Add new item botón. Tadaa! (Note the - Create mode part in the title).

Cancel item creation/update

To close the Todo::NewItemWindow window when a user clicks the cancel_button , we only have to add this to the window's initialize method:

cancel_button.signal_connect 'clicked' do |button|

  close

end

close is an instance method of the Gtk::Window class that closes the window.

Save the item

Saving an item involves two steps:

• Update the item's properties based on the widgets' values.
• Call the save! method on the Todo::Item instance.

Again, our code will be placed in the initialize method of the Todo::NewItemWindow :

save_button.signal_connect 'clicked' do |button|

  item.title = title_text_entry.text

  item.notes = notes_text_view.buffer.text

  item.priority = priority_combo_box.active_iter.get_value(0) if priority_combo_box.active_iter

  item.save!

  close

end

Once again, the window closes after saving the item.

Let's try that out.

Now, by pressing Save and navigating to our ~/.gtk-todo-tutorial folder, we should see a file. Mine had the following contents:

{

        "id": "3d635839-66d0-4ce6-af31-e81b47b3e585",

        "title": "Optimize the priorities model creation",

        "notes": "It doesn't have to be initialized upon each window creation.",

        "priority": "high",

        "filename": "/home/iridakos/.gtk-todo-tutorial/3d635839-66d0-4ce6-af31-e81b47b3e585.json",

        "creation_datetime": "2018-01-25 18:09:51 +0200"

}

Don't forget to try out the Cancel button as well.

View ToDo items

The Todo::ApplicationWindow contains only one button. It's time to change that.

We want the window to have Add new item on the top and a list below with all of our ToDo items. We'll add a Gtk::ListBox to our design that can contain any number of rows.

Update the application window

• Open the resources/ui/application_window.ui file in Glade.
• Nothing happens if we drag a List Box widget from the Widget section directly on the window. Eso es normal. First, we have to split the window into two parts:one for the button and one for the list box. Bear with me.
• Right-click on the new_item_window in the Hierarchy section and select Add parent> Box .
• In the pop-up window, set 2 for the number of items.
• The orientation of the box is already vertical, so we are fine.

• Now, drag a List Box and place it on the free area of the previously added box.
• Set its ID property to todo_items_list_box .
• Set its Selection mode to None since we won't provide that functionality.

Design the ToDo item list box row

Each row of the list box we created in the previous step will be more complex than a row of text. Each will contain widgets that allow the user to expand an item's notes and to delete or edit the item.

• Create a new project in Glade, as we did for the new_item_window.ui . Save it under resources/ui/todo_item_list_box_row.ui .
• Unfortunately (at least in my version of Glade), there is no List Box Row widget in the Widget section. So, we'll add one as the top-level widget of our project in a kinda hackish way.
• Drag a List Box from the Widget section to the Design area.
• Inside the Hierarchy section, right-click on the List Box and select Add Row

• In the Hierarchy section, right-click on the newly added List Box Row nested under the List Box and select Remove parent . There it is! The List Box Row is the top-level widget of the project now.

• Check the widget's Composite property and set its name to TodoItemListBoxRow .
• Drag a Box from the Widget section to the Design area inside our List Box Row .
• Set 2 items in the pop-up window.
• Set its ID property to main_box .

• Drag another Box from the Widget section to the first row of the previously added box.
• Set 2 items in the pop-up window.
• Set its ID property to todo_item_top_box .
• Set its Orientation property to Horizontal .
• Set its Spacing (General tab) property to 10 .

• Drag a Label from the Widget section to the first column of the todo_item_top_box .
• Set its ID property to todo_item_title_label .
• Set its Alignment and Padding> Alignment> Horizontal property to 0.00 .
• In the Common tab of the Properties section, check the Widget Spacing> Expand> Horizontal checkbox and turn on the switch next to it so the label will expand to the available space.

• Drag a Button from the Widget section to the second column of the todo_item_top_box .
• Set its ID property to details_button .
• Check the Button Content> Label with optional image radio and type ... (three dots).

• Drag a Revealer widget from the Widget section to the second row of the main_box .
• Turn off the Reveal Child switch in the General tab.
• Set its ID property to todo_item_details_revealer .
• Set its Transition type property to Slide Down .

• Drag a Box from the Widget section to the reveal space.
• Set its items to 2 in the pop-up window.
• Set its ID property to details_box .
• In the Common tab, set its Widget Spacing> Margins> Top property to 10 .

• Drag a Button Box from the Widget section to the first row of the details_box .
• Set its ID property to todo_item_action_box .
• Set its Layout style property to expand .

• Drag Button widgets to the first and second columns of the todo_item_action_box .
• Set their ID properties to delete_button and edit_button , respectively.
• Set their Button Content> Label with optional image properties to Delete and Edit , respectively.

• Drag a Viewport widget from the Widget section to the second row of the details_box .
• Set its ID property to todo_action_notes_viewport .
• Drag a Text View widget from the Widget section to the todo_action_notes_viewport that we just added.
• Set its ID to todo_item_notes_text_view .
• Uncheck its Editable property in the General tab of the Properties section.

Create the ToDo item list-box row class

Now we will create the class reflecting the UI of the list-box row we just created.

First we have to update our GResource description file to include the newly created design. Change the resources/gresources.xml file as follows:

<?xml version="1.0" encoding="UTF-8"?>

<gresources>

  <gresource prefix="/com/iridakos/gtk-todo">

    <file preprocess="xml-stripblanks">ui/application_window.ui</file>

    <file preprocess="xml-stripblanks">ui/new_item_window.ui</file>

    <file preprocess="xml-stripblanks">ui/todo_item_list_box_row.ui</file>

  </gresource>

</gresources>

Create a file named item_list_box_row.rb inside the application/ui folder and add the following:

module Todo

  class ItemListBoxRow < Gtk::ListBoxRow

    type_register



    class << self

      def init

        set_template resource: '/com/iridakos/gtk-todo/ui/todo_item_list_box_row.ui'

      end

    end



    def initialize(item)

      super()

    end

  end

end

We will not bind any children at the moment.

When starting the application, we have to search for files in the :user_data_path , and we must create a Todo::Item instance for each file. For each instance, we must also add a new Todo::ItemListBoxRow to the Todo::ApplicationWindow 's todo_items_list_box list box. One thing at a time.

First, let's bind the todo_items_list_box in the Todo::ApplicationWindow clase. Change the init method as follows:

def init

  # Set the template from the resources binary

  set_template resource: '/com/iridakos/gtk-todo/ui/application_window.ui'



  bind_template_child 'add_new_item_button'

  bind_template_child 'todo_items_list_box'

end

Next, we'll add an instance method in the same class that will be responsible to load the ToDo list items in the related list box. Add this code in Todo::ApplicationWindow :

def load_todo_items

  todo_items_list_box.children.each { |child| todo_items_list_box.remove child }



  json_files = Dir[File.join(File.expand_path(application.user_data_path), '*.json')]

  items = json_files.map{ |filename| Todo::Item.new(filename: filename) }



  items.each do |item|

    todo_items_list_box.add Todo::ItemListBoxRow.new(item)

  end

end

Then we'll call this method at the end of the initialize method:

def initialize(application)

  super application: application



  set_title 'GTK+ Simple ToDo'



  add_new_item_button.signal_connect 'clicked' do |button|

    new_item_window = NewItemWindow.new(application, Todo::Item.new(user_data_path: application.user_data_path))

    new_item_window.present

  end



  load_todo_items

end

Nota: We must first empty the list box of its current children rows then refill it. This way, we will call this method after saving a Todo::Item via the signal_connect of the save_button of the Todo::NewItemWindow , and the parent application window will be reloaded! Here's the updated code (in application/ui/new_item_window.rb ):

save_button.signal_connect 'clicked' do |button|

  item.title = title_text_entry.text

  item.notes = notes_text_view.buffer.text

  item.priority = priority_combo_box.active_iter.get_value(0) if priority_combo_box.active_iter

  item.save!



  close



  # Locate the application window

  application_window = application.windows.find { |w| w.is_a? Todo::ApplicationWindow }

  application_window.load_todo_items

end

Previously, we used this code:

json_files = Dir[File.join(File.expand_path(application.user_data_path), '*.json')]

to find the names of all the files in the application-user data path with a JSON extension.

Let's see what we've created. Start the application and try adding a new ToDo item. After pressing the Save button, you should see the parent Todo::ApplicationWindow automatically updated with the new item!

What's left is to complete the functionality of the Todo::ItemListBoxRow .

First, we will bind the widgets. Change the init method of the Todo::ItemListBoxRow class as follows:

def init

  set_template resource: '/com/iridakos/gtk-todo/ui/todo_item_list_box_row.ui'



  bind_template_child 'details_button'

  bind_template_child 'todo_item_title_label'

  bind_template_child 'todo_item_details_revealer'

  bind_template_child 'todo_item_notes_text_view'

  bind_template_child 'delete_button'

  bind_template_child 'edit_button'

end

Then, we'll set up the widgets based on the item of each row.

def initialize(item)

  super()



  todo_item_title_label.text = item.title || ''



  todo_item_notes_text_view.buffer.text = item.notes



  details_button.signal_connect 'clicked' do

    todo_item_details_revealer.set_reveal_child !todo_item_details_revealer.reveal_child?

  end



  delete_button.signal_connect 'clicked' do

    item.delete!



    # Locate the application window

    application_window = application.windows.find { |w| w.is_a? Todo::ApplicationWindow }

    application_window.load_todo_items

  end



  edit_button.signal_connect 'clicked' do

    new_item_window = NewItemWindow.new(application, item)

    new_item_window.present

  end

end



def application

  parent = self.parent

  parent = parent.parent while !parent.is_a? Gtk::Window

  parent.application

end

• As you can see, when the details_button is clicked, we instruct the todo_item_details_revealer to swap the visibility of its contents.
• After deleting an item, we find the application's Todo::ApplicationWindow to call its load_todo_items , as we did after saving an item.
• When clicking to edit a button, we create a new instance of the Todo::NewItemWindow passing an item as the current item. Works like a charm!
• Finally, to reach the application parent of a list-box row, we defined a simple instance method application that navigates through the widget's parents until it reaches a window from which it can obtain the application object.

Save and run the application. There it is!

This has been a really long tutorial and, even though there are so many items that we haven't covered, I think we better end it here.

Long post, cat photo.

Useful links

• This tutorial's code
• A set of bindings for the GNOME-2.x libraries to use from Ruby
• Gtk3 tutorial for Ruby based on the official C version
• GTK+ 3 Reference Manual

This was originally published on Lazarus Lazaridis's blog, iridakos.com, and is republished with permission.