gtk4 4.1.2 → 4.1.4

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 031bdff3af35f8c9ca1993b8857fe51b9c6e658d327a3fb263d8df8e0fd476ee
-  data.tar.gz: ac2485eb8b4f99c3c714fcaa4ab18eccffd347980705a32e028c4503fa136585
+  metadata.gz: 3046d15df9010c560d2b714291c5ec3b27dd119600ea487407e59e4b92306ac4
+  data.tar.gz: 6442d209ea930b5637f3d228b671fac88ff45925a66db2439e13e5d32a2f731f
 SHA512:
-  metadata.gz: 687e5abb4016942dbfb0228d6371ddb0a64263b90192575c21cb14470fb8066402d5323b1086ca74dbdec18e4df92d3206689020b6864f53d571b46b4b40d302
-  data.tar.gz: f7b56275f7613f8f9a979d7b96ddfe16ef1c75b562c37516fd1da6da3840e236059d06426d0ee8008e3f8ba7b8a92d9c8f66890e00687d51e2ecbe0a47ea6938
+  metadata.gz: aaab417c8f0106174987778df08f8218aa2f87fc85fdbdde231d0cfa2686c923e26a64d20cff271556377cb054d215c7c7d40560f9cd80f4d11e306cbdea03e0
+  data.tar.gz: 70f22d049e6f21cd0f43d5cdb09e20b57547aba3ef098b32c98a9fbe3bafbe4bf9c6fe09a7d2489d63376c669aaf3f10cfa63143e5a1cdfc0f9b127392829b5f

data/sample/examples/application1/exampleapp.rb

@@ -18,7 +18,7 @@
 #
 # Example from:
 # * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application1/exampleapp.c
-# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application1/exampleappwin.c#
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application1/exampleappwin.c
 # License: LGPL2.1-or-later
 
 require "gtk4"
@@ -36,7 +36,7 @@ class ExampleApp < Gtk::Application
       window = ExampleAppWindow.new(application)
       window.present
     end
-    signal_connect "open" do |application, files, hin|
+    signal_connect "open" do |application, files, hint|
       window = application.windows[0] || ExampleAppWindow.new(application)
       files.each do |file|
         window.open(file)

data/sample/examples/application2/README.md

@@ -0,0 +1,10 @@
+# Step 2: Populating the window
+
+The original files are located in the following directory.
+
+- https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application2
+
+They are written in C language and use GResource because it is the best way in C language.
+But when it comes to Ruby language, GResource is not the best way especially when the resource only includes ui files.
+So, the program here uses a string instead of a resource.
+If you want to know how to program with GResource in Ruby language, see gtk3/sample/tutorial/exampleapp2 directory.

data/sample/examples/application2/exampleapp.rb

@@ -0,0 +1,80 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# Example from:
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application2/exampleapp.c
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application2/exampleappwin.c
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application2/window.ui
+# License: LGPL2.1-or-later
+
+require "gtk4"
+
+class ExampleAppWindow < Gtk::ApplicationWindow
+  type_register
+  class << self
+    def init
+      template = <<~TEMPLATE
+      <?xml version="1.0" encoding="UTF-8"?>
+      <interface>
+        <template class="ExampleAppWindow" parent="GtkApplicationWindow">
+          <property name="title" translatable="yes">Example Application</property>
+          <property name="default-width">600</property>
+          <property name="default-height">400</property>
+          <child>
+            <object class="GtkBox" id="content_box">
+              <property name="orientation">vertical</property>
+              <child>
+                <object class="GtkStack" id="stack"/>
+              </child>
+            </object>
+          </child>
+        </template>
+      </interface>
+      TEMPLATE
+      set_template(data: template)
+    end
+  end
+
+  def initialize(application)
+    super(application: application)
+  end
+
+  def open(file)
+  end
+end
+
+class ExampleApp < Gtk::Application
+  def initialize
+    super("org.gtk.exampleapp", :handles_open)
+
+    signal_connect "activate" do |application|
+      window = ExampleAppWindow.new(application)
+      window.present
+    end
+    signal_connect "open" do |application, files, hint|
+      window = application.windows[0] || ExampleAppWindow.new(application)
+      files.each do |file|
+        window.open(file)
+      end
+      window.present
+    end
+  end
+end
+
+app = ExampleApp.new
+app.run

data/sample/examples/application3/README.md

@@ -0,0 +1 @@
+# Step 3: Opening files, add a stack switcher

data/sample/examples/application3/exampleapp.rb

@@ -0,0 +1,108 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# Example from:
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application3/exampleapp.c
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application3/exampleappwin.c
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application3/window.ui
+# License: LGPL2.1-or-later
+
+require "gtk4"
+
+class ExampleAppWindow < Gtk::ApplicationWindow
+  type_register
+  class << self
+    def init
+      template = <<~TEMPLATE
+      <?xml version="1.0" encoding="UTF-8"?>
+      <interface>
+        <template class="ExampleAppWindow" parent="GtkApplicationWindow">
+          <property name="title" translatable="yes">Example Application</property>
+          <property name="default-width">600</property>
+          <property name="default-height">400</property>
+          <child type="titlebar">
+            <object class="GtkHeaderBar" id="header">
+              <child type="title">
+                <object class="GtkStackSwitcher" id="tabs">
+                  <property name="stack">stack</property>
+                </object>
+              </child>
+            </object>
+          </child>
+          <child>
+            <object class="GtkBox" id="content_box">
+              <property name="orientation">vertical</property>
+              <child>
+                <object class="GtkStack" id="stack"/>
+              </child>
+            </object>
+          </child>
+        </template>
+      </interface>
+      TEMPLATE
+      set_template(data: template)
+      bind_template_child("stack")
+    end
+  end
+
+  def initialize(application)
+    super(application: application)
+  end
+
+  def open(file)
+    basename = file.basename
+    scrolled = Gtk::ScrolledWindow.new
+    scrolled.hexpand = true
+    scrolled.vexpand = true
+    view = Gtk::TextView.new
+    view.editable = false
+    view.cursor_visible = false
+    scrolled.child = view
+    stack.add_titled(scrolled, basename, basename)
+    buffer = view.buffer
+    file.read do |stream|
+      buffer.text = stream.read.force_encoding(Encoding::UTF_8)
+    end
+  end
+end
+
+class ExampleApp < Gtk::Application
+  def initialize
+    super("org.gtk.exampleapp", :handles_open)
+
+    signal_connect "activate" do |application|
+      window = ExampleAppWindow.new(application)
+      window.present
+    end
+    signal_connect "open" do |application, files, hint|
+      window = application.windows[0] || ExampleAppWindow.new(application)
+      files.each do |file|
+        window.open(file)
+      end
+      window.present
+    end
+  end
+end
+
+app = ExampleApp.new
+
+# Gtk::Application#run needs C style argv ([prog, arg1, arg2, ...,argn]).
+# The ARGV ruby variable only contains the arguments ([arg1, arg2, ...,argb])
+# and not the program name. We have to add it explicitly.
+
+app.run([$PROGRAM_NAME] + ARGV)

data/sample/examples/application4/README.md

@@ -0,0 +1,13 @@
+# Step 4: Add a menu
+
+The original files are located in the following directory.
+
+- https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application4
+
+They are written in the C language and use `g_action_map_add_action entries`.
+It is a convenience function for creating multiple GSimpleAction instances and adding them to a GActionMap.
+If you write a program in C, it is the best way.
+
+However, the program in this directory doesn't use `add_action_entries` method.
+Instead, it uses `each` method of an array of action names.
+The way above is flexible and simple.

data/sample/examples/application4/exampleapp.rb

@@ -0,0 +1,158 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# Example from:
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application4/exampleapp.c
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application4/exampleappwin.c
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application4/window.ui
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application4/gears-menu.ui
+# License: LGPL2.1-or-later
+
+require "gtk4"
+
+class ExampleAppWindow < Gtk::ApplicationWindow
+  type_register
+  class << self
+    def init
+      template = <<~TEMPLATE
+      <?xml version="1.0" encoding="UTF-8"?>
+      <interface>
+        <template class="ExampleAppWindow" parent="GtkApplicationWindow">
+          <property name="title" translatable="yes">Example Application</property>
+          <property name="default-width">600</property>
+          <property name="default-height">400</property>
+          <child type="titlebar">
+            <object class="GtkHeaderBar" id="header">
+              <child type="title">
+                <object class="GtkStackSwitcher" id="tabs">
+                  <property name="stack">stack</property>
+                </object>
+              </child>
+              <child type="end">
+                <object class="GtkMenuButton" id="gears">
+                  <property name="direction">none</property>
+                </object>
+              </child>
+            </object>
+          </child>
+          <child>
+            <object class="GtkBox" id="content_box">
+              <property name="orientation">vertical</property>
+              <child>
+                <object class="GtkStack" id="stack"/>
+              </child>
+            </object>
+          </child>
+        </template>
+      </interface>
+      TEMPLATE
+      set_template(data: template)
+      bind_template_child("stack")
+      bind_template_child("gears")
+    end
+  end
+
+  def initialize(application)
+    menu_ui = <<~MENU
+    <?xml version="1.0" encoding="UTF-8"?>
+    <interface>
+      <menu id="menu">
+        <section>
+          <item>
+            <attribute name="label" translatable="yes">_Preferences</attribute>
+            <attribute name="action">app.preferences</attribute>
+          </item>
+        </section>
+        <section>
+          <item>
+            <attribute name="label" translatable="yes">_Quit</attribute>
+            <attribute name="action">app.quit</attribute>
+          </item>
+        </section>
+      </menu>
+    </interface>
+    MENU
+    super(application: application)
+    builder = Gtk::Builder.new(string: menu_ui)
+    gears.menu_model = builder["menu"]
+  end
+
+  def open(file)
+    basename = file.basename
+    scrolled = Gtk::ScrolledWindow.new
+    scrolled.hexpand = true
+    scrolled.vexpand = true
+    view = Gtk::TextView.new
+    view.editable = false
+    view.cursor_visible = false
+    scrolled.child = view
+    stack.add_titled(scrolled, basename, basename)
+    buffer = view.buffer
+    file.read do |stream|
+      buffer.text = stream.read.force_encoding(Encoding::UTF_8)
+    end
+  end
+end
+
+class ExampleApp < Gtk::Application
+  def initialize
+    super("org.gtk.exampleapp", :handles_open)
+
+    signal_connect "startup" do |application|
+      [
+        "preferences",
+        "quit"
+      ].each do |action_name|
+        action = Gio::SimpleAction.new(action_name)
+        action.signal_connect("activate") do |_action, _parameter|
+          __send__("#{action_name}_activated")
+        end
+        application.add_action(action)
+      end
+      application.set_accels_for_action("app.quit", ["<Control>Q"])
+    end
+    signal_connect "activate" do |application|
+      window = ExampleAppWindow.new(application)
+      window.present
+    end
+    signal_connect "open" do |application, files, hint|
+      window = application.windows[0] || ExampleAppWindow.new(application)
+      files.each do |file|
+        window.open(file)
+      end
+      window.present
+    end
+  end
+
+  private
+
+  def preferences_activated
+  end
+
+  def quit_activated
+    quit
+  end
+end
+
+app = ExampleApp.new
+
+# Gtk::Application#run needs C style argv ([prog, arg1, arg2, ...,argn]).
+# The ARGV ruby variable only contains the arguments ([arg1, arg2, ...,argb])
+# and not the program name. We have to add it explicitly.
+
+app.run([$PROGRAM_NAME] + ARGV)

data/sample/examples/application5/README.md

@@ -0,0 +1,30 @@
+# Step 5: Add a GSettings object
+
+The original files are located in the following directory.
+
+- https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application5
+
+The original schema file is [here](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application5/org.gtk.exampleapp.gschema.xml) and the license is LGPL 2.1 or later.
+
+This program uses GSettings object of the GIO library.
+You need to compile the schema file (`org.gtk.exampleapp.gschema.xml`) in advance.
+The instruction is written in the `Rakefile`, so you just run `rake` to compile it.
+
+```console
+$ cd gtk4/sample/examples/application5
+$ rake
+```
+
+The Ruby script `exampleapp.rb` works with `gschemas.compiled`.
+
+```console
+$ ruby exampleapp.rb README.md Rakefile
+```
+
+You will see the contents of the two files `README.md` and `Rakefile` in the window.
+
+If you want to remove `gschemas.compiled`, do like this:
+
+```console
+$ rake clean
+```

data/sample/examples/application5/Rakefile

@@ -0,0 +1,27 @@
+# Copyright (C) 2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+
+require "rake/clean"
+
+task :default => "gschemas.compiled"
+
+file "gschemas.compiled" => "org.gtk.exampleapp.gschema.xml" do
+  sh("glib-compile-schemas", ".")
+end
+
+CLEAN << "gschemas.compiled"
+
+task :clean

data/sample/examples/application5/exampleapp.rb

@@ -0,0 +1,171 @@
+#!/usr/bin/env ruby
+#
+# Copyright (C) 2023  Ruby-GNOME Project Team
+#
+# This library is free software; you can redistribute it and/or
+# modify it under the terms of the GNU Lesser General Public
+# License as published by the Free Software Foundation; either
+# version 2.1 of the License, or (at your option) any later version.
+#
+# This library is distributed in the hope that it will be useful,
+# but WITHOUT ANY WARRANTY; without even the implied warranty of
+# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+# Lesser General Public License for more details.
+#
+# You should have received a copy of the GNU Lesser General Public
+# License along with this library; if not, write to the Free Software
+# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+#
+# Example from:
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application5/exampleapp.c
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application5/exampleappwin.c
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application5/window.ui
+# * https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application5/gears-menu.ui
+# License: LGPL2.1-or-later
+
+# GSETTINGS_SCHEMA_DIR must be set before requiring "gtk4" gem because it is used in the GIO initialization.
+
+if File.exist?(File.join(__dir__, "gschemas.compiled"))
+  ENV["GSETTINGS_SCHEMA_DIR"] = __dir__
+else
+  raise %{gschemas.compiled doesn't exist. Run "rake" to generate it.}
+end
+
+require "gtk4"
+
+class ExampleAppWindow < Gtk::ApplicationWindow
+  type_register
+  class << self
+    def init
+      template = <<~TEMPLATE
+      <?xml version="1.0" encoding="UTF-8"?>
+      <interface>
+        <template class="ExampleAppWindow" parent="GtkApplicationWindow">
+          <property name="title" translatable="yes">Example Application</property>
+          <property name="default-width">600</property>
+          <property name="default-height">400</property>
+          <child type="titlebar">
+            <object class="GtkHeaderBar" id="header">
+              <child type="title">
+                <object class="GtkStackSwitcher" id="tabs">
+                  <property name="stack">stack</property>
+                </object>
+              </child>
+              <child type="end">
+                <object class="GtkMenuButton" id="gears">
+                  <property name="direction">none</property>
+                </object>
+              </child>
+            </object>
+          </child>
+          <child>
+            <object class="GtkBox" id="content_box">
+              <property name="orientation">vertical</property>
+              <child>
+                <object class="GtkStack" id="stack"/>
+              </child>
+            </object>
+          </child>
+        </template>
+      </interface>
+      TEMPLATE
+      set_template(data: template)
+      bind_template_child("stack")
+      bind_template_child("gears")
+    end
+  end
+
+  def initialize(application)
+    menu_ui = <<~MENU
+    <?xml version="1.0" encoding="UTF-8"?>
+    <interface>
+      <menu id="menu">
+        <section>
+          <item>
+            <attribute name="label" translatable="yes">_Preferences</attribute>
+            <attribute name="action">app.preferences</attribute>
+          </item>
+        </section>
+        <section>
+          <item>
+            <attribute name="label" translatable="yes">_Quit</attribute>
+            <attribute name="action">app.quit</attribute>
+          </item>
+        </section>
+      </menu>
+    </interface>
+    MENU
+    super(application: application)
+    builder = Gtk::Builder.new(string: menu_ui)
+    gears.menu_model = builder["menu"]
+    @settings = Gio::Settings.new("org.gtk.exampleapp")
+    @settings.bind("transition", stack, "transition-type", :default)
+  end
+
+  def open(file)
+    basename = file.basename
+    scrolled = Gtk::ScrolledWindow.new
+    scrolled.hexpand = true
+    scrolled.vexpand = true
+    view = Gtk::TextView.new
+    view.editable = false
+    view.cursor_visible = false
+    scrolled.child = view
+    stack.add_titled(scrolled, basename, basename)
+    buffer = view.buffer
+    file.read do |stream|
+      buffer.text = stream.read.force_encoding(Encoding::UTF_8)
+    end
+    tag = buffer.create_tag
+    @settings.bind("font", tag, "font", :default)
+    buffer.apply_tag(tag, buffer.start_iter, buffer.end_iter)
+  end
+end
+
+class ExampleApp < Gtk::Application
+  def initialize
+    super("org.gtk.exampleapp", :handles_open)
+
+    signal_connect "startup" do |application|
+      [
+        "preferences",
+        "quit"
+      ].each do |action_name|
+        action = Gio::SimpleAction.new(action_name)
+        action.signal_connect("activate") do |_action, _parameter|
+          __send__("#{action_name}_activated")
+        end
+        application.add_action(action)
+      end
+      application.set_accels_for_action("app.quit", ["<Control>Q"])
+    end
+    signal_connect "activate" do |application|
+      window = ExampleAppWindow.new(application)
+      window.present
+    end
+    signal_connect "open" do |application, files, hint|
+      window = application.windows[0] || ExampleAppWindow.new(application)
+      files.each do |file|
+        window.open(file)
+      end
+      window.present
+    end
+  end
+
+  private
+
+  def preferences_activated
+  end
+
+  def quit_activated
+    quit
+  end
+end
+
+app = ExampleApp.new
+
+# Gtk::Application#run needs C style argv ([prog, arg1, arg2, ...,argn]).
+# The ARGV ruby variable only contains the arguments ([arg1, arg2, ...,argb])
+# and not the program name. We have to add it explicitly.
+
+app.run([$PROGRAM_NAME] + ARGV)

data/sample/examples/application5/org.gtk.exampleapp.gschema.xml

@@ -0,0 +1,20 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<schemalist>
+  <schema path="/org/gtk/exampleapp/" id="org.gtk.exampleapp">
+    <key name="font" type="s">
+      <default>'Monospace 12'</default>
+      <summary>Font</summary>
+      <description>The font to be used for content.</description>
+    </key>
+    <key name="transition" type="s">
+      <choices>
+        <choice value='none'/>
+        <choice value='crossfade'/>
+        <choice value='slide-left-right'/>
+      </choices>
+      <default>'none'</default>
+      <summary>Transition</summary>
+      <description>The transition to use when switching tabs.</description>
+    </key>
+  </schema>
+</schemalist>

data/sample/examples/application6/README.md

@@ -0,0 +1,15 @@
+# Step 6: Add a preference dialog
+
+The original files are located in the following directory.
+
+- https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application6
+
+The original schema file is [here](https://gitlab.gnome.org/GNOME/gtk/-/blob/main/examples/application6/org.gtk.exampleapp.gschema.xml) and the license is LGPL 2.1 or later.
+
+Run `rake` before trying `exampleapp.rb`.
+
+```console
+$ cd gtk4/sample/examples/application6
+$ rake
+$ ruby exampleapp.rb README.md Rakefile
+```