gtk: Use glib enums instead of bools where it makes sense

Author: bilelmoussaoui

examples/femtovg_area/femtovg_area/imp.rs

@@ -80,7 +80,7 @@ impl GLAreaImpl for FemtoVGArea {
             self.obj().scale_factor() as f32,
         );
     }
-    fn render(&self, _context: &gtk::gdk::GLContext) -> bool {
+    fn render(&self, _context: &gtk::gdk::GLContext) -> glib::Propagation {
         use femtovg::{Color, Paint, Path};
 
         self.ensure_canvas();
@@ -126,7 +126,7 @@ impl GLAreaImpl for FemtoVGArea {
         canvas.stroke_path(&mut path, &paint);
         canvas.flush();
 
-        true
+        glib::Propagation::Stop
     }
 }
 impl FemtoVGArea {

examples/glium_gl_area/glium_gl_area/imp.rs

@@ -171,9 +171,9 @@ impl WidgetImpl for GliumGLArea {
 }
 
 impl GLAreaImpl for GliumGLArea {
-    fn render(&self, _context: &gtk::gdk::GLContext) -> bool {
+    fn render(&self, _context: &gtk::gdk::GLContext) -> glib::Propagation {
         self.renderer.borrow().as_ref().unwrap().draw();
 
-        true
+        glib::Propagation::Stop
     }
 }

gdk4/src/surface.rs

@@ -28,6 +28,7 @@ pub trait SurfaceExtManual: sealed::Sealed + IsA<Surface> + 'static {
         }
     }
 
+    // Returns true if the coordinates were successfully translated
     #[doc(alias = "gdk_surface_translate_coordinates")]
     fn translate_coordinates(&self, to: &Surface, mut x: f64, mut y: f64) -> bool {
         unsafe {

gsk4/src/path.rs

@@ -5,14 +5,14 @@ use glib::translate::*;
 
 impl Path {
     #[doc(alias = "gsk_path_foreach")]
-    pub fn foreach<P: FnMut(&PathOperation, &graphene::Point, usize, f32) -> bool>(
+    pub fn foreach<P: FnMut(&PathOperation, &graphene::Point, usize, f32) -> glib::ControlFlow>(
         &self,
         flags: PathForeachFlags,
         func: P,
-    ) -> bool {
+    ) -> glib::ControlFlow {
         let func_data: P = func;
         unsafe extern "C" fn func_func<
-            P: FnMut(&PathOperation, &graphene::Point, usize, f32) -> bool,
+            P: FnMut(&PathOperation, &graphene::Point, usize, f32) -> glib::ControlFlow,
         >(
             op: ffi::GskPathOperation,
             pts: *const graphene::ffi::graphene_point_t,

gtk4/src/drop_target.rs

@@ -45,6 +45,7 @@ impl DropTarget {
         }
     }
 
+    // Returns true if the drop was accepted
     pub fn connect_drop<F: Fn(&DropTarget, &glib::Value, f64, f64) -> bool + 'static>(
         &self,
         f: F,

gtk4/src/shortcuts_section.rs

@@ -8,11 +8,22 @@ use glib::{
 use std::mem::transmute;
 
 impl ShortcutsSection {
+    // todo: figure out what the bool return value here corresponds to
     pub fn connect_change_current_page<F: Fn(&ShortcutsSection, i32) -> bool + 'static>(
         &self,
         f: F,
     ) -> SignalHandlerId {
         unsafe {
+            unsafe extern "C" fn change_current_page_trampoline<
+                F: Fn(&ShortcutsSection, i32) -> bool + 'static,
+            >(
+                this: *mut ffi::GtkShortcutsSection,
+                object: libc::c_int,
+                f: glib::ffi::gpointer,
+            ) -> glib::ffi::gboolean {
+                let f: &F = &*(f as *const F);
+                f(&from_glib_borrow(this), object).into_glib()
+            }
             let f = Box::new(f);
             connect_raw(
                 self.as_ptr() as *mut _,
@@ -27,14 +38,3 @@ impl ShortcutsSection {
         self.emit_by_name("change-current-page", &[&object])
     }
 }
-
-unsafe extern "C" fn change_current_page_trampoline<
-    F: Fn(&ShortcutsSection, i32) -> bool + 'static,
->(
-    this: *mut ffi::GtkShortcutsSection,
-    object: libc::c_int,
-    f: glib::ffi::gpointer,
-) -> glib::ffi::gboolean {
-    let f: &F = &*(f as *const F);
-    f(&from_glib_borrow(this), object).into_glib()
-}

gtk4/src/subclass/accessible_range.rs

@@ -18,6 +18,7 @@ mod sealed {
 }
 
 pub trait AccessibleRangeImplExt: sealed::Sealed + ObjectSubclass {
+    // Returns true if the operation was performed, false otherwise
     fn parent_set_current_value(&self, accessible_range: &Self::Type, value: f64) -> bool {
         unsafe {
             let type_data = Self::type_data();

gtk4/src/subclass/cell_area.rs

@@ -17,16 +17,15 @@ pub struct CellCallback {
 }
 
 impl CellCallback {
-    pub fn call<R: IsA<CellRenderer>>(&self, cell_renderer: &R) -> bool {
+    pub fn call<R: IsA<CellRenderer>>(&self, cell_renderer: &R) -> glib::ControlFlow {
         unsafe {
             if let Some(callback) = self.callback {
                 from_glib(callback(
                     cell_renderer.as_ref().to_glib_none().0,
                     self.user_data,
                 ))
             } else {
-                // true to stop iterating over cells
-                true
+                glib::ControlFlow::Break
             }
         }
     }
@@ -44,7 +43,7 @@ impl CellCallbackAllocate {
         cell_renderer: &R,
         cell_area: &gdk::Rectangle,
         cell_background: &gdk::Rectangle,
-    ) -> bool {
+    ) -> glib::ControlFlow {
         unsafe {
             if let Some(callback) = self.callback {
                 from_glib(callback(
@@ -54,8 +53,7 @@ impl CellCallbackAllocate {
                     self.user_data,
                 ))
             } else {
-                // true to stop iterating over cells
-                true
+                glib::ControlFlow::Break
             }
         }
     }
@@ -227,6 +225,7 @@ mod sealed {
 #[cfg_attr(feature = "v4_10", deprecated = "Since 4.10")]
 #[allow(deprecated)]
 pub trait CellAreaImplExt: sealed::Sealed + ObjectSubclass {
+    // Returns true if the area was successfully activated
     fn parent_activate<P: IsA<CellAreaContext>, W: IsA<Widget>>(
         &self,
         context: &P,
@@ -317,6 +316,7 @@ pub trait CellAreaImplExt: sealed::Sealed + ObjectSubclass {
         }
     }
 
+    // returns true only if the event is handled
     fn parent_event<W: IsA<Widget>, P: IsA<CellAreaContext>>(
         &self,
         context: &P,
@@ -338,7 +338,6 @@ pub trait CellAreaImplExt: sealed::Sealed + ObjectSubclass {
                     flags.into_glib(),
                 ))
             } else {
-                // returns true only if the event is handled
                 false
             }
         }
@@ -396,6 +395,7 @@ pub trait CellAreaImplExt: sealed::Sealed + ObjectSubclass {
         }
     }
 
+    // Whether the cell is activatable
     fn parent_is_activatable(&self) -> bool {
         unsafe {
             let data = Self::type_data();
@@ -408,6 +408,7 @@ pub trait CellAreaImplExt: sealed::Sealed + ObjectSubclass {
         }
     }
 
+    // TRUE if focus remains inside area as a result of this call.
     fn parent_focus(&self, direction_type: DirectionType) -> bool {
         unsafe {
             let data = Self::type_data();

gtk4/src/subclass/cell_renderer.rs

@@ -257,6 +257,7 @@ pub trait CellRendererImplExt: sealed::Sealed + ObjectSubclass {
         }
     }
 
+    // Returns true if the event was consumed/handled
     fn parent_activate<P: IsA<Widget>>(
         &self,
         event: Option<&gdk::Event>,

gtk4/src/subclass/font_chooser.rs

@@ -17,6 +17,7 @@ pub struct FilterCallback {
 }
 
 impl FilterCallback {
+    // true if the font should be displayed
     pub fn call(&self, font_family: &FontFamily, font_face: &FontFace) -> bool {
         unsafe {
             if let Some(filter_func) = self.filter_func {