book: Document remove_done_tasks

gtk-rs · Oct 30, 2023 · a42af08 · a42af08
1 parent b825e35
commit a42af08
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 0 deletions.
diff --git a/book/listings/todo/2/window/mod.rs b/book/listings/todo/2/window/mod.rs
@@ -225,6 +225,7 @@ impl Window {
     }
     // ANCHOR_END: setup_actions
 
+    // ANCHOR: remove_done_tasks
     fn remove_done_tasks(&self) {
         let tasks = self.tasks();
         let mut position = 0;
@@ -241,4 +242,5 @@ impl Window {
             }
         }
     }
+    // ANCHOR_END: remove_done_tasks
 }
diff --git a/book/src/todo_2.md b/book/src/todo_2.md
@@ -126,6 +126,15 @@ Filename: <a class=file-link href="https://github.com/gtk-rs/gtk4-rs/blob/master
 {{#rustdoc_include ../listings/todo/2/window/imp.rs:object_subclass}}
 ```
 
+This is the implementation of `remove_done_tasks`.
+We iterate through the `gio::ListStore` and remove all completed task objects.
+
+Filename: <a class=file-link href="https://github.com/gtk-rs/gtk4-rs/blob/master/book/listings/todo/2/window/mod.rs">listings/todo/2/window/mod.rs</a>
+
+```rust
+{{#rustdoc_include ../listings/todo/2/window/mod.rs:remove_done_tasks}}
+```
+
 After activating the action "win.filter", the corresponding setting will be changed.
 So we need a method which translates this setting into a filter that the [`gtk::FilterListModel`](https://gtk-rs.org/gtk4-rs/stable/latest/docs/gtk4/struct.FilterListModel.html) understands.
 The possible states are "All", "Open" and "Done".