subclass PaginatorWidget

src/application.rs

@@ -68,7 +68,7 @@ mod imp {
                 "next-page",
                 clone!(@weak application => move |_, _| {
                     let window = application.window();
-                    if window.paginator.borrow_mut().try_next().is_none() {
+                    if window.paginator.try_next().is_none() {
                         window.widget.close();
                     }
                 }),
@@ -79,7 +79,7 @@ mod imp {
                 "previous-page",
                 clone!(@weak application => move |_, _| {
                     let window = application.window();
-                    if window.paginator.borrow_mut().try_previous().is_none() {
+                    if window.paginator.try_previous().is_none() {
                         window.reset_tour();
                     }
                 }),

src/widgets/paginator.rs

 use gettextrs::gettext;
-use gtk::glib::{self, clone};
 use gtk::prelude::*;
+use gtk::{
+    glib::{self, clone},
+    subclass::prelude::*,
+};
 use std::cell::RefCell;
-use std::rc::Rc;
-
-#[derive(Debug)]
-pub struct PaginatorWidget {
-    pub widget: gtk::Box,
-    carousel: adw::Carousel,
-    carousel_dots: adw::CarouselIndicatorDots,
-    headerbar: gtk::HeaderBar,
-    pages: RefCell<Vec<gtk::Widget>>,
-    current_page: RefCell<u32>,
-    next_overlay: gtk::Overlay,
-    next_btn: gtk::Button,
-    start_btn: gtk::Button,
-    finish_btn: gtk::Button,
-    close_btn: gtk::Button,
-    previous_btn: gtk::Button,
-}
 
-impl PaginatorWidget {
-    pub fn new() -> Rc<Self> {
-        let widget = gtk::Box::new(gtk::Orientation::Vertical, 0);
+mod imp {
+    use std::cell::Cell;
+
+    use super::*;
+
+    #[derive(Debug)]
+    pub struct PaginatorWidget {
+        pub(super) carousel: adw::Carousel,
+        pub(super) carousel_dots: adw::CarouselIndicatorDots,
+        pub(super) headerbar: gtk::HeaderBar,
+        pub(super) pages: RefCell<Vec<gtk::Widget>>,
+        pub(super) current_page: Cell<u32>,
+        pub(super) next_overlay: gtk::Overlay,
+        pub(super) next_btn: gtk::Button,
+        pub(super) start_btn: gtk::Button,
+        pub(super) finish_btn: gtk::Button,
+        pub(super) close_btn: gtk::Button,
+        pub(super) previous_btn: gtk::Button,
+    }
 
-        let paginator = Rc::new(Self {
-            widget,
+    impl Default for PaginatorWidget {
+        fn default() -> Self {
+            Self {
                 carousel: adw::Carousel::new(),
                 carousel_dots: adw::CarouselIndicatorDots::new(),
                 headerbar: gtk::HeaderBar::builder().show_title_buttons(false).build(),
@@ -36,81 +39,26 @@ impl PaginatorWidget {
                 close_btn: gtk::Button::with_label(&gettext("_Close")),
                 previous_btn: gtk::Button::with_label(&gettext("_Previous")),
                 pages: RefCell::new(Vec::new()),
-            current_page: RefCell::new(0),
-        });
-        paginator.init(paginator.clone());
-        paginator
-    }
-
-    pub fn try_next(&self) -> Option<()> {
-        let p = *self.current_page.borrow() + 1;
-        if p == self.carousel.n_pages() {
-            return None;
-        }
-        self.set_page(p);
-        Some(())
-    }
-
-    pub fn try_previous(&self) -> Option<()> {
-        let p = *self.current_page.borrow();
-        if p == 0 {
-            return None;
+                current_page: Cell::new(0),
             }
-        self.set_page(p - 1);
-        Some(())
         }
-
-    pub fn add_page(&self, page: gtk::Widget) {
-        let page_nr = self.pages.borrow().len();
-        self.carousel.insert(&page, page_nr as i32);
-        self.pages.borrow_mut().push(page);
-
-        self.update_position();
     }
 
-    fn update_position(&self) {
-        let position = self.carousel.position();
-        let page_nr = position.round() as u32;
-
-        let n_pages = self.carousel.n_pages() as f64;
-        let forelast_page = n_pages - 2.0;
-        let last_page = n_pages - 1.0;
-
-        let (opacity_finish, opacity_previous, opacity_start, opacity_next, opacity_close) =
-            if (0.0..1.0).contains(&position) {
-                if position == 0.0 {
-                    (0.0, position, 1.0, position, 1.0)
-                } else {
-                    (0.0, position, 1.0, position, 1f64 - position)
+    #[glib::object_subclass]
+    impl ObjectSubclass for PaginatorWidget {
+        const NAME: &'static str = "PaginatorWidget";
+        type ParentType = gtk::Box;
+        type Type = super::PaginatorWidget;
     }
-            } else if (0.0 <= position) && (position <= forelast_page) {
-                (0.0, 1.0, 1f64 - position, 1.0, 0.0)
-            } else if (forelast_page < position) && (position <= last_page) {
-                (position - forelast_page, 1.0, 0.0, 1.0, 0.0)
-            } else {
-                panic!("Position of the carousel is outside the allowed range");
-            };
-
-        self.start_btn.set_opacity(opacity_start);
-        self.start_btn.set_visible(opacity_start > 0_f64);
-
-        self.next_btn.set_opacity(opacity_next);
-        self.next_btn.set_visible(opacity_next > 0_f64);
-        self.next_overlay.set_can_target(opacity_next > 0_f64);
-
-        self.finish_btn.set_opacity(opacity_finish);
-        self.finish_btn.set_visible(opacity_finish > 0_f64);
 
-        self.previous_btn.set_opacity(opacity_previous);
-        self.previous_btn.set_visible(opacity_previous > 0_f64);
-
-        self.close_btn.set_opacity(opacity_close);
-        self.start_btn.set_visible(opacity_close > 0_f64);
-
-        self.current_page.replace(page_nr);
-    }
+    impl ObjectImpl for PaginatorWidget {
+        fn constructed(&self, obj: &Self::Type) {
+            let layout_manager = obj
+                .layout_manager()
+                .map(|l| l.downcast::<gtk::BoxLayout>().unwrap())
+                .unwrap();
+            layout_manager.set_orientation(gtk::Orientation::Vertical);
 
-    fn init(&self, p: Rc<Self>) {
             self.carousel_dots.set_carousel(Some(&self.carousel));
             self.carousel.set_hexpand(true);
             self.carousel.set_vexpand(true);
@@ -118,8 +66,8 @@ impl PaginatorWidget {
                 .set_scroll_params(&adw::SpringParams::new(1.0, 0.5, 300.0));
 
             self.carousel
-            .connect_position_notify(clone!(@weak p => move |_| {
-                p.update_position();
+                .connect_position_notify(clone!(@weak obj => move |_| {
+                    obj.update_position();
                 }));
             self.start_btn.add_css_class("suggested-action");
             self.start_btn.set_use_underline(true);
@@ -162,15 +110,105 @@ impl PaginatorWidget {
             self.headerbar.pack_start(&previous_overlay);
             self.headerbar.pack_end(&start_overlay);
 
-        self.widget.append(&self.headerbar);
-        self.widget.append(&self.carousel);
+            obj.append(&self.headerbar);
+            obj.append(&self.carousel);
+
+            self.parent_constructed(obj);
+        }
+    }
+    impl WidgetImpl for PaginatorWidget {}
+    impl BoxImpl for PaginatorWidget {}
+}
+
+glib::wrapper! {
+    pub struct PaginatorWidget(ObjectSubclass<imp::PaginatorWidget>)
+        @extends gtk::Widget, gtk::Box;
+
+}
+
+impl PaginatorWidget {
+    pub fn new() -> Self {
+        glib::Object::new(&[]).unwrap()
+    }
+
+    pub fn try_next(&self) -> Option<()> {
+        let imp = self.imp();
+        let p = imp.current_page.get() + 1;
+        if p == imp.carousel.n_pages() {
+            return None;
+        }
+        self.set_page(p);
+        Some(())
+    }
+
+    pub fn try_previous(&self) -> Option<()> {
+        let p = self.imp().current_page.get();
+        if p == 0 {
+            return None;
+        }
+        self.set_page(p - 1);
+        Some(())
+    }
+
+    pub fn add_page(&self, page: gtk::Widget) {
+        let imp = self.imp();
+        let page_nr = imp.pages.borrow().len();
+        imp.carousel.insert(&page, page_nr as i32);
+        imp.pages.borrow_mut().push(page);
+
+        self.update_position();
+    }
+
+    fn update_position(&self) {
+        let imp = self.imp();
+
+        let position = imp.carousel.position();
+        let page_nr = position.round() as u32;
+
+        let n_pages = imp.carousel.n_pages() as f64;
+        let forelast_page = n_pages - 2.0;
+        let last_page = n_pages - 1.0;
+
+        let (opacity_finish, opacity_previous, opacity_start, opacity_next, opacity_close) =
+            if (0.0..1.0).contains(&position) {
+                if position == 0.0 {
+                    (0.0, position, 1.0, position, 1.0)
+                } else {
+                    (0.0, position, 1.0, position, 1f64 - position)
+                }
+            } else if (0.0 <= position) && (position <= forelast_page) {
+                (0.0, 1.0, 1f64 - position, 1.0, 0.0)
+            } else if (forelast_page < position) && (position <= last_page) {
+                (position - forelast_page, 1.0, 0.0, 1.0, 0.0)
+            } else {
+                panic!("Position of the carousel is outside the allowed range");
+            };
+
+        imp.start_btn.set_opacity(opacity_start);
+        imp.start_btn.set_visible(opacity_start > 0_f64);
+
+        imp.next_btn.set_opacity(opacity_next);
+        imp.next_btn.set_visible(opacity_next > 0_f64);
+        imp.next_overlay.set_can_target(opacity_next > 0_f64);
+
+        imp.finish_btn.set_opacity(opacity_finish);
+        imp.finish_btn.set_visible(opacity_finish > 0_f64);
+
+        imp.previous_btn.set_opacity(opacity_previous);
+        imp.previous_btn.set_visible(opacity_previous > 0_f64);
+
+        imp.close_btn.set_opacity(opacity_close);
+        imp.start_btn.set_visible(opacity_close > 0_f64);
+
+        imp.current_page.set(page_nr);
     }
 
     pub fn set_page(&self, page_nr: u32) {
-        if page_nr < self.carousel.n_pages() {
-            let pages = &self.pages.borrow();
+        let imp = self.imp();
+        if page_nr < imp.carousel.n_pages() {
+            let pages = &imp.pages.borrow();
             let page = pages.get(page_nr as usize).unwrap();
-            self.carousel.scroll_to(page, true);
+            imp.carousel.scroll_to(page, true);
         }
     }
 }

src/widgets/window.rs

 use adw::prelude::*;
 use gettextrs::gettext;
-use std::cell::RefCell;
-use std::rc::Rc;
 
 use super::pages::{ImagePageWidget, WelcomePageWidget};
 use super::paginator::PaginatorWidget;
@@ -11,14 +9,14 @@ use crate::Application;
 #[derive(Debug)]
 pub struct Window {
     pub widget: adw::ApplicationWindow,
-    pub paginator: RefCell<Rc<PaginatorWidget>>,
+    pub paginator: PaginatorWidget,
 }
 
 impl Window {
     pub fn new(app: &Application) -> Self {
         let widget = adw::ApplicationWindow::new(app);
 
-        let paginator = RefCell::new(PaginatorWidget::new());
+        let paginator = PaginatorWidget::new();
 
         let mut window_widget = Window { widget, paginator };
 
@@ -27,11 +25,11 @@ impl Window {
     }
 
     pub fn start_tour(&self) {
-        self.paginator.borrow_mut().set_page(1);
+        self.paginator.set_page(1);
     }
 
     pub fn reset_tour(&self) {
-        self.paginator.borrow_mut().set_page(0);
+        self.paginator.set_page(0);
     }
 
     fn init(&mut self) {
@@ -43,9 +41,8 @@ impl Window {
             self.widget.add_css_class("devel");
         }
         self.paginator
-            .borrow_mut()
             .add_page(WelcomePageWidget::new().widget.upcast::<gtk::Widget>());
-        self.paginator.borrow_mut().add_page(
+        self.paginator.add_page(
             ImagePageWidget::new(
                 "/org/gnome/Tour/overview.svg",
                 gettext("Get an Overview"),
@@ -55,7 +52,7 @@ impl Window {
             .upcast::<gtk::Widget>(),
         );
 
-        self.paginator.borrow_mut().add_page(
+        self.paginator.add_page(
             ImagePageWidget::new(
                 "/org/gnome/Tour/search.svg",
                 gettext("Just Type to Search"),
@@ -65,7 +62,7 @@ impl Window {
             .upcast::<gtk::Widget>(),
         );
 
-        self.paginator.borrow_mut().add_page(
+        self.paginator.add_page(
             ImagePageWidget::new(
                 "/org/gnome/Tour/workspaces.svg",
                 gettext("Keep on Top with Workspaces"),
@@ -75,7 +72,7 @@ impl Window {
             .upcast::<gtk::Widget>(),
         );
 
-        self.paginator.borrow_mut().add_page(
+        self.paginator.add_page(
             ImagePageWidget::new(
                 "/org/gnome/Tour/blank.svg",
                 gettext("Up/Down for the Overview"),
@@ -85,7 +82,7 @@ impl Window {
             .upcast::<gtk::Widget>(),
         );
 
-        self.paginator.borrow_mut().add_page(
+        self.paginator.add_page(
             ImagePageWidget::new(
                 "/org/gnome/Tour/blank.svg",
                 gettext("Left/Right for Workspaces"),
@@ -102,10 +99,8 @@ impl Window {
         );
         last_page.widget.add_css_class("last-page");
         self.paginator
-            .borrow_mut()
             .add_page(last_page.widget.upcast::<gtk::Widget>());
 
-        self.widget
-            .set_content(Some(&self.paginator.borrow().widget));
+        self.widget.set_content(Some(&self.paginator));
     }
 }