libshumate/auto/

viewport.rs

// This file was generated by gir (https://github.com/gtk-rs/gir)
// from
// from gir-files (https://github.com/gtk-rs/gir-files)
// DO NOT EDIT

use crate::{Location, MapSource, ffi};
#[cfg(feature = "v1_6")]
#[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
use glib::object::ObjectType as _;
use glib::{
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// The object holding the coordinate, zoom-level, and rotation state of the current view.
    ///
    /// As the object implements [`Location`][crate::Location], the latitude and longitude are
    /// accessible via the interface methods.
    ///
    /// ## Properties
    ///
    ///
    /// #### `max-zoom-level`
    ///  The highest allowed level of zoom of the content.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `min-zoom-level`
    ///  The lowest allowed level of zoom of the content.
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `reference-map-source`
    ///  The reference #ShumateMapSource being displayed
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `rotation`
    ///  The rotation of the map view, in radians clockwise from up being due north
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `zoom-level`
    ///  The level of zoom of the content.
    ///
    /// Readable | Writeable
    /// <details><summary><h4>Location</h4></summary>
    ///
    ///
    /// #### `latitude`
    ///  The latitude coordonate in degrees
    ///
    /// Readable | Writeable
    ///
    ///
    /// #### `longitude`
    ///  The longitude coordonate in degrees
    ///
    /// Readable | Writeable
    /// </details>
    ///
    /// ## Signals
    ///
    ///
    /// #### `changed`
    ///  Emitted when the viewport position (location, zoom, rotation, etc.) changes. Changes to multiple properties at once
    /// may be combined into a single signal emission.
    ///
    ///
    ///
    /// # Implements
    ///
    /// [`trait@glib::ObjectExt`], [`LocationExt`][trait@crate::prelude::LocationExt]
    #[doc(alias = "ShumateViewport")]
    pub struct Viewport(Object<ffi::ShumateViewport, ffi::ShumateViewportClass>) @implements Location;

    match fn {
        type_ => || ffi::shumate_viewport_get_type(),
    }
}

impl Viewport {
    /// Creates a new #ShumateViewport
    ///
    /// # Returns
    ///
    /// A new #ShumateViewport
    #[doc(alias = "shumate_viewport_new")]
    pub fn new() -> Viewport {
        assert_initialized_main_thread!();
        unsafe { from_glib_full(ffi::shumate_viewport_new()) }
    }

    // rustdoc-stripper-ignore-next
    /// Creates a new builder-pattern struct instance to construct [`Viewport`] objects.
    ///
    /// This method returns an instance of [`ViewportBuilder`](crate::builders::ViewportBuilder) which can be used to create [`Viewport`] objects.
    pub fn builder() -> ViewportBuilder {
        ViewportBuilder::new()
    }

    /// Get the maximal zoom level
    ///
    /// # Returns
    ///
    /// the maximal zoom level
    #[doc(alias = "shumate_viewport_get_max_zoom_level")]
    #[doc(alias = "get_max_zoom_level")]
    #[doc(alias = "max-zoom-level")]
    pub fn max_zoom_level(&self) -> u32 {
        unsafe { ffi::shumate_viewport_get_max_zoom_level(self.to_glib_none().0) }
    }

    /// Get the minimal zoom level
    ///
    /// # Returns
    ///
    /// the minimal zoom level
    #[doc(alias = "shumate_viewport_get_min_zoom_level")]
    #[doc(alias = "get_min_zoom_level")]
    #[doc(alias = "min-zoom-level")]
    pub fn min_zoom_level(&self) -> u32 {
        unsafe { ffi::shumate_viewport_get_min_zoom_level(self.to_glib_none().0) }
    }

    /// Get the reference map source
    ///
    /// # Returns
    ///
    /// the reference #ShumateMapSource or [`None`]
    /// when none has been set.
    #[doc(alias = "shumate_viewport_get_reference_map_source")]
    #[doc(alias = "get_reference_map_source")]
    #[doc(alias = "reference-map-source")]
    pub fn reference_map_source(&self) -> Option<MapSource> {
        unsafe {
            from_glib_none(ffi::shumate_viewport_get_reference_map_source(
                self.to_glib_none().0,
            ))
        }
    }

    /// Gets the current rotation
    ///
    /// # Returns
    ///
    /// the current rotation
    #[doc(alias = "shumate_viewport_get_rotation")]
    #[doc(alias = "get_rotation")]
    pub fn rotation(&self) -> f64 {
        unsafe { ffi::shumate_viewport_get_rotation(self.to_glib_none().0) }
    }

    /// Get the current zoom level
    ///
    /// # Returns
    ///
    /// the current zoom level
    #[doc(alias = "shumate_viewport_get_zoom_level")]
    #[doc(alias = "get_zoom_level")]
    #[doc(alias = "zoom-level")]
    pub fn zoom_level(&self) -> f64 {
        unsafe { ffi::shumate_viewport_get_zoom_level(self.to_glib_none().0) }
    }

    /// Gets the position on @widget that correspond to the given latitude and
    /// longitude.
    /// ## `widget`
    /// a #GtkWidget that uses @self as viewport
    /// ## `latitude`
    /// the latitude
    /// ## `longitude`
    /// the longitude
    ///
    /// # Returns
    ///
    ///
    /// ## `x`
    /// return value for the x coordinate
    ///
    /// ## `y`
    /// return value for the y coordinate
    #[doc(alias = "shumate_viewport_location_to_widget_coords")]
    pub fn location_to_widget_coords(
        &self,
        widget: &impl IsA<gtk::Widget>,
        latitude: f64,
        longitude: f64,
    ) -> (f64, f64) {
        unsafe {
            let mut x = std::mem::MaybeUninit::uninit();
            let mut y = std::mem::MaybeUninit::uninit();
            ffi::shumate_viewport_location_to_widget_coords(
                self.to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                latitude,
                longitude,
                x.as_mut_ptr(),
                y.as_mut_ptr(),
            );
            (x.assume_init(), y.assume_init())
        }
    }

    /// Set the maximal zoom level
    /// ## `max_zoom_level`
    /// the maximal zoom level
    #[doc(alias = "shumate_viewport_set_max_zoom_level")]
    #[doc(alias = "max-zoom-level")]
    pub fn set_max_zoom_level(&self, max_zoom_level: u32) {
        unsafe {
            ffi::shumate_viewport_set_max_zoom_level(self.to_glib_none().0, max_zoom_level);
        }
    }

    /// Set the minimal zoom level
    /// ## `min_zoom_level`
    /// the minimal zoom level
    #[doc(alias = "shumate_viewport_set_min_zoom_level")]
    #[doc(alias = "min-zoom-level")]
    pub fn set_min_zoom_level(&self, min_zoom_level: u32) {
        unsafe {
            ffi::shumate_viewport_set_min_zoom_level(self.to_glib_none().0, min_zoom_level);
        }
    }

    /// Set the reference map source
    /// ## `map_source`
    /// a #ShumateMapSource or [`None`] to set none.
    #[doc(alias = "shumate_viewport_set_reference_map_source")]
    #[doc(alias = "reference-map-source")]
    pub fn set_reference_map_source(&self, map_source: Option<&impl IsA<MapSource>>) {
        unsafe {
            ffi::shumate_viewport_set_reference_map_source(
                self.to_glib_none().0,
                map_source.map(|p| p.as_ref()).to_glib_none().0,
            );
        }
    }

    /// Sets the rotation
    /// ## `rotation`
    /// the rotation
    #[doc(alias = "shumate_viewport_set_rotation")]
    #[doc(alias = "rotation")]
    pub fn set_rotation(&self, rotation: f64) {
        unsafe {
            ffi::shumate_viewport_set_rotation(self.to_glib_none().0, rotation);
        }
    }

    /// Set the zoom level
    /// ## `zoom_level`
    /// the zoom level
    #[doc(alias = "shumate_viewport_set_zoom_level")]
    #[doc(alias = "zoom-level")]
    pub fn set_zoom_level(&self, zoom_level: f64) {
        unsafe {
            ffi::shumate_viewport_set_zoom_level(self.to_glib_none().0, zoom_level);
        }
    }

    /// Gets the latitude and longitude corresponding to a position on @widget.
    /// ## `widget`
    /// a #GtkWidget that uses @self as viewport
    /// ## `x`
    /// the x coordinate
    /// ## `y`
    /// the y coordinate
    ///
    /// # Returns
    ///
    ///
    /// ## `latitude`
    /// return location for the latitude
    ///
    /// ## `longitude`
    /// return location for the longitude
    #[doc(alias = "shumate_viewport_widget_coords_to_location")]
    pub fn widget_coords_to_location(
        &self,
        widget: &impl IsA<gtk::Widget>,
        x: f64,
        y: f64,
    ) -> (f64, f64) {
        unsafe {
            let mut latitude = std::mem::MaybeUninit::uninit();
            let mut longitude = std::mem::MaybeUninit::uninit();
            ffi::shumate_viewport_widget_coords_to_location(
                self.to_glib_none().0,
                widget.as_ref().to_glib_none().0,
                x,
                y,
                latitude.as_mut_ptr(),
                longitude.as_mut_ptr(),
            );
            (latitude.assume_init(), longitude.assume_init())
        }
    }

    /// Emitted when the viewport position (location, zoom, rotation, etc.) changes. Changes to multiple properties at once
    /// may be combined into a single signal emission.
    #[cfg(feature = "v1_6")]
    #[cfg_attr(docsrs, doc(cfg(feature = "v1_6")))]
    #[doc(alias = "changed")]
    pub fn connect_changed<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn changed_trampoline<F: Fn(&Viewport) + 'static>(
            this: *mut ffi::ShumateViewport,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"changed".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    changed_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "max-zoom-level")]
    pub fn connect_max_zoom_level_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_max_zoom_level_trampoline<F: Fn(&Viewport) + 'static>(
            this: *mut ffi::ShumateViewport,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::max-zoom-level".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_max_zoom_level_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "min-zoom-level")]
    pub fn connect_min_zoom_level_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_min_zoom_level_trampoline<F: Fn(&Viewport) + 'static>(
            this: *mut ffi::ShumateViewport,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::min-zoom-level".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_min_zoom_level_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "reference-map-source")]
    pub fn connect_reference_map_source_notify<F: Fn(&Self) + 'static>(
        &self,
        f: F,
    ) -> SignalHandlerId {
        unsafe extern "C" fn notify_reference_map_source_trampoline<F: Fn(&Viewport) + 'static>(
            this: *mut ffi::ShumateViewport,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::reference-map-source".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_reference_map_source_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "rotation")]
    pub fn connect_rotation_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_rotation_trampoline<F: Fn(&Viewport) + 'static>(
            this: *mut ffi::ShumateViewport,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::rotation".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_rotation_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "zoom-level")]
    pub fn connect_zoom_level_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_zoom_level_trampoline<F: Fn(&Viewport) + 'static>(
            this: *mut ffi::ShumateViewport,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(&from_glib_borrow(this))
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::zoom-level".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_zoom_level_trampoline::<F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl Default for Viewport {
    fn default() -> Self {
        Self::new()
    }
}

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`Viewport`] objects.
///
/// [builder-pattern]: https://doc.rust-lang.org/1.0.0/style/ownership/builders.html
#[must_use = "The builder must be built to be used"]
pub struct ViewportBuilder {
    builder: glib::object::ObjectBuilder<'static, Viewport>,
}

impl ViewportBuilder {
    fn new() -> Self {
        Self {
            builder: glib::object::Object::builder(),
        }
    }

    /// The highest allowed level of zoom of the content.
    pub fn max_zoom_level(self, max_zoom_level: u32) -> Self {
        Self {
            builder: self.builder.property("max-zoom-level", max_zoom_level),
        }
    }

    /// The lowest allowed level of zoom of the content.
    pub fn min_zoom_level(self, min_zoom_level: u32) -> Self {
        Self {
            builder: self.builder.property("min-zoom-level", min_zoom_level),
        }
    }

    /// The reference #ShumateMapSource being displayed
    pub fn reference_map_source(self, reference_map_source: &impl IsA<MapSource>) -> Self {
        Self {
            builder: self.builder.property(
                "reference-map-source",
                reference_map_source.clone().upcast(),
            ),
        }
    }

    /// The rotation of the map view, in radians clockwise from up being due north
    pub fn rotation(self, rotation: f64) -> Self {
        Self {
            builder: self.builder.property("rotation", rotation),
        }
    }

    /// The level of zoom of the content.
    pub fn zoom_level(self, zoom_level: f64) -> Self {
        Self {
            builder: self.builder.property("zoom-level", zoom_level),
        }
    }

    /// The latitude coordonate in degrees
    pub fn latitude(self, latitude: f64) -> Self {
        Self {
            builder: self.builder.property("latitude", latitude),
        }
    }

    /// The longitude coordonate in degrees
    pub fn longitude(self, longitude: f64) -> Self {
        Self {
            builder: self.builder.property("longitude", longitude),
        }
    }

    // rustdoc-stripper-ignore-next
    /// Build the [`Viewport`].
    #[must_use = "Building the object from the builder is usually expensive and is not expected to have side effects"]
    pub fn build(self) -> Viewport {
        assert_initialized_main_thread!();
        self.builder.build()
    }
}