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

use glib::{prelude::*, translate::*};
use std::fmt;

glib::wrapper! {
    /// The [`SettingsBackend`][crate::SettingsBackend] interface defines a generic interface for
    /// non-strictly-typed data that is stored in a hierarchy. To implement
    /// an alternative storage backend for [`Settings`][crate::Settings], you need to implement
    /// the [`SettingsBackend`][crate::SettingsBackend] interface and then make it implement the
    /// extension point [`SETTINGS_BACKEND_EXTENSION_POINT_NAME`][crate::SETTINGS_BACKEND_EXTENSION_POINT_NAME].
    ///
    /// The interface defines methods for reading and writing values, a
    /// method for determining if writing of certain values will fail
    /// (lockdown) and a change notification mechanism.
    ///
    /// The semantics of the interface are very precisely defined and
    /// implementations must carefully adhere to the expectations of
    /// callers that are documented on each of the interface methods.
    ///
    /// Some of the [`SettingsBackend`][crate::SettingsBackend] functions accept or return a `GTree`.
    /// These trees always have strings as keys and [`glib::Variant`][struct@crate::glib::Variant] as values.
    /// `g_settings_backend_create_tree()` is a convenience function to create
    /// suitable trees.
    ///
    /// The [`SettingsBackend`][crate::SettingsBackend] API is exported to allow third-party
    /// implementations, but does not carry the same stability guarantees
    /// as the public GIO API. For this reason, you have to define the
    /// C preprocessor symbol `G_SETTINGS_ENABLE_BACKEND` before including
    /// `gio/gsettingsbackend.h`.
    ///
    /// This is an Abstract Base Class, you cannot instantiate it.
    ///
    /// # Implements
    ///
    /// [`SettingsBackendExt`][trait@crate::prelude::SettingsBackendExt], [`trait@glib::ObjectExt`]
    #[doc(alias = "GSettingsBackend")]
    pub struct SettingsBackend(Object<ffi::GSettingsBackend, ffi::GSettingsBackendClass>);

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

impl SettingsBackend {
    pub const NONE: Option<&'static SettingsBackend> = None;

    //#[doc(alias = "g_settings_backend_flatten_tree")]
    //pub fn flatten_tree(tree: /*Ignored*/&glib::Tree) -> (glib::GString, Vec<glib::GString>, Vec<glib::Variant>) {
    //    unsafe { TODO: call ffi:g_settings_backend_flatten_tree() }
    //}

    /// Returns the default [`SettingsBackend`][crate::SettingsBackend]. It is possible to override
    /// the default by setting the `GSETTINGS_BACKEND` environment variable
    /// to the name of a settings backend.
    ///
    /// The user gets a reference to the backend.
    ///
    /// # Returns
    ///
    /// the default [`SettingsBackend`][crate::SettingsBackend],
    ///  which will be a dummy (memory) settings backend if no other settings
    ///  backend is available.
    #[doc(alias = "g_settings_backend_get_default")]
    #[doc(alias = "get_default")]
    #[allow(clippy::should_implement_trait)]
    pub fn default() -> SettingsBackend {
        unsafe { from_glib_full(ffi::g_settings_backend_get_default()) }
    }
}

mod sealed {
    pub trait Sealed {}
    impl<T: super::IsA<super::SettingsBackend>> Sealed for T {}
}

/// Trait containing all [`struct@SettingsBackend`] methods.
///
/// # Implementors
///
/// [`SettingsBackend`][struct@crate::SettingsBackend]
pub trait SettingsBackendExt: IsA<SettingsBackend> + sealed::Sealed + 'static {
    //#[doc(alias = "g_settings_backend_changed")]
    //fn changed(&self, key: &str, origin_tag: /*Unimplemented*/Option<Basic: Pointer>) {
    //    unsafe { TODO: call ffi:g_settings_backend_changed() }
    //}

    //#[doc(alias = "g_settings_backend_changed_tree")]
    //fn changed_tree(&self, tree: /*Ignored*/&glib::Tree, origin_tag: /*Unimplemented*/Option<Basic: Pointer>) {
    //    unsafe { TODO: call ffi:g_settings_backend_changed_tree() }
    //}

    //#[doc(alias = "g_settings_backend_keys_changed")]
    //fn keys_changed(&self, path: &str, items: &[&str], origin_tag: /*Unimplemented*/Option<Basic: Pointer>) {
    //    unsafe { TODO: call ffi:g_settings_backend_keys_changed() }
    //}

    //#[doc(alias = "g_settings_backend_path_changed")]
    //fn path_changed(&self, path: &str, origin_tag: /*Unimplemented*/Option<Basic: Pointer>) {
    //    unsafe { TODO: call ffi:g_settings_backend_path_changed() }
    //}

    /// Signals that the writability of all keys below a given path may have
    /// changed.
    ///
    /// Since GSettings performs no locking operations for itself, this call
    /// will always be made in response to external events.
    /// ## `path`
    /// the name of the path
    #[doc(alias = "g_settings_backend_path_writable_changed")]
    fn path_writable_changed(&self, path: &str) {
        unsafe {
            ffi::g_settings_backend_path_writable_changed(
                self.as_ref().to_glib_none().0,
                path.to_glib_none().0,
            );
        }
    }

    /// Signals that the writability of a single key has possibly changed.
    ///
    /// Since GSettings performs no locking operations for itself, this call
    /// will always be made in response to external events.
    /// ## `key`
    /// the name of the key
    #[doc(alias = "g_settings_backend_writable_changed")]
    fn writable_changed(&self, key: &str) {
        unsafe {
            ffi::g_settings_backend_writable_changed(
                self.as_ref().to_glib_none().0,
                key.to_glib_none().0,
            );
        }
    }
}

impl<O: IsA<SettingsBackend>> SettingsBackendExt for O {}

impl fmt::Display for SettingsBackend {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        f.write_str("SettingsBackend")
    }
}