Docs Polish and GObject Interface

Project.toml

@@ -1,7 +1,7 @@
 name = "Mousetrap"
 uuid = "5deeb4b9-6e04-4da7-8b7f-c77fb1eae65e"
 authors = ["C.Cords <[email protected]>"]
-version = "0.3.1"
+version = "0.3.2"
 
 [deps]
 BinaryBuilder = "12aac903-9f7c-5d81-afc2-d9565ea332ae"
@@ -18,7 +18,7 @@ libcxxwrap_julia_jll = "3eaa8342-bff7-56a5-9981-c04077f7cee7"
 mousetrap_jll = "0e90efc8-2bbd-550f-bf3c-306a2edaaeef"
 
 [compat]
-CxxWrap = "0.14.0"
+CxxWrap = "0.14, 0.15"
 mousetrap_jll = "0.3.0"
 GTK4_jll = "4.10"
 Glib_jll = "2.76"

README.md

@@ -101,27 +101,12 @@ add_render_task!(render_area, RenderTask(rectangle))
 
 ---
 
-### Displaying a GLMakie Plot in a Mousetrap Window
-
-```julia
-using GLMakie, MousetrapMakie
-canvas = GLMakieArea()
-window = Mousetrap.Window()
-set_child!(window, canvas) # can be used like any other widget
-
-screen = create_glmakie_screen(canvas)
-display(screen, scatter(rand(123)))
-```
-![](docs/src/assets/makie_scatter.png)
-
-(**Note**: This feature is still experimental. See [here](https://github.com/Clemapfel/MousetrapMakie.jl) for more information)
-
----
-
 ## Supported Platforms
 
 Since `v0.3.0`, Mousetrap is fully portable. All features are available for all 64-bit versions of Linux, FreeBSD, macOS, and Windows.
 
+> **WARNING**: macOS systems with a newer architecture, such as the M1/M2 macs, seem to be causing an issue when using the `RenderArea` widget, forcing it to be disabled. Only this single widget is affected, see the [manual section on native rendering](http://clemens-cords.com/mousetrap/01_manual/09_native_rendering/) for more information.
+
 > **Note**: Linux systems running Wayland may require additional configuration before the `RenderArea` widget becomes available. See [here](http://clemens-cords.com/mousetrap/01_manual/09_native_rendering/) for more information.
 
 > **Note**: Ubuntu systems using proprietary NVIDIA drivers may encounter a crash on initialization, a fix is available [here](https://github.com/Clemapfel/Mousetrap.jl/issues/25#issuecomment-1731349366).

docs/src/01_manual/01_installation.md

@@ -1,3 +1,17 @@
+```@meta
+DocTestSetup = quote
+  using Mousetrap
+  function Window(app::Application)
+      out = Mousetrap.Window(app)
+      set_tick_callback!(out, out) do clock, self
+          close!(self)
+          return TICK_CALLBACK_RESULT_DISCONTINUE
+      end
+      return out
+  end
+end
+```
+
 # Chapter 1: Installation & Workflow
 
 In this chapter, we will learn:
@@ -9,10 +23,8 @@ In this chapter, we will learn:
 
 ## Installation
 
-
 To install Mousetrap, in the REPL, press the `]` key, then
 
-
 ```julia
 import Pkg;
 begin
@@ -41,13 +53,16 @@ Installation may take a long time. Once installation is succesfull, `Mousetrap t
 
 To create our first Mousetrap app, we create a Julia file `main.jl`, with the following contents:
 
-```julia
+```jldoctest; output = false
 using Mousetrap
 main() do app::Application
     window = Window(app)
     set_child!(window, Label("Hello World!"))
     present!(window)
 end
+
+# output
+0
 ```
 
 To start our app, we navigate to the location of `main.jl` in our console, then execute:

docs/src/01_manual/02_signals.md

@@ -1,3 +1,17 @@
+```@meta
+DocTestSetup = quote
+  using Mousetrap
+  function Window(app::Application)
+      out = Mousetrap.Window(app)
+      set_tick_callback!(out, out) do clock, self
+          close!(self)
+          return TICK_CALLBACK_RESULT_DISCONTINUE
+      end
+      return out
+  end
+end
+```
+
 # Chapter 2: Signals
 
 In this chapter, we will learn:
@@ -63,7 +77,7 @@ end
 
     For example, to execute the example snippet above, we would create the following `main.jl` file:
 
-    ```julia
+    ```jldoctest; output = false
     using Mousetrap
     main() do app::Application
         window = Window(app)
@@ -78,6 +92,8 @@ end
         set_child!(window, button) # add the button to the window
         present!(window)
     end
+    # output
+    0
     ```
 
     Then execute it from the console by calling `julia main.jl`
@@ -494,7 +510,7 @@ By blocking signals, we get the correct behavior of both buttons being triggered
 
 To verify this is indeed the resulting behavior, we can use the following `main.jl`:
 
-```julia
+```jldoctest; output = false
 using Mousetrap
 main() do app::Application
     window = Window(app)
@@ -521,6 +537,8 @@ main() do app::Application
     set_child!(window, hbox(button_01, button_02))
     present!(window)
 end
+# output
+0
 ```
 
 ![](../assets/double_button_signal_blocking.png)

docs/src/01_manual/03_actions.md

@@ -1,3 +1,17 @@
+```@meta
+DocTestSetup = quote
+  using Mousetrap
+  function Window(app::Application)
+      out = Mousetrap.Window(app)
+      set_tick_callback!(out, out) do clock, self
+          close!(self)
+          return TICK_CALLBACK_RESULT_DISCONTINUE
+      end
+      return out
+  end
+end
+```
+
 # Chapter 3: Actions
 
 In this chapter, we will learn:
@@ -222,10 +236,9 @@ We need one more thing before we can trigger our action: an object that can rece
 
 A complete `main.jl` file showing how to trigger an action using a shortcut is given here:
 
-```julia
+```jldoctest; output = false
 using Mousetrap
 main() do app::Application
-
     # create a window
     window = Window(app)
 
@@ -243,6 +256,8 @@ main() do app::Application
     # show the window to the user
     present!(window)
 end
+# output
+0
 ```
 
 Pressing "Control + M", we get: