// 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 gdk;
use glib::object::Cast;
use glib::object::IsA;
use glib::signal::connect_raw;
use glib::signal::SignalHandlerId;
use glib::translate::*;
use glib::StaticType;
use glib::ToValue;
use glib_sys;
use gtk_sys;
use std::boxed::Box as Box_;
use std::fmt;
use std::mem::transmute;
use xlib;
use Align;
use Buildable;
use Container;
use ResizeMode;
use Widget;

glib_wrapper! {
    /// Together with `Plug`, `Socket` provides the ability to embed
    /// widgets from one process into another process in a fashion that
    /// is transparent to the user. One process creates a `Socket` widget
    /// and passes that widget’s window ID to the other process, which then
    /// creates a `Plug` with that window ID. Any widgets contained in the
    /// `Plug` then will appear inside the first application’s window.
    ///
    /// The socket’s window ID is obtained by using `GtkSocketExt::get_id`.
    /// Before using this function, the socket must have been realized,
    /// and for hence, have been added to its parent.
    ///
    /// ## Obtaining the window ID of a socket.
    ///
    ///
    /// ```C
    /// GtkWidget *socket = gtk_socket_new ();
    /// gtk_widget_show (socket);
    /// gtk_container_add (GTK_CONTAINER (parent), socket);
    ///
    /// // The following call is only necessary if one of
    /// // the ancestors of the socket is not yet visible.
    /// gtk_widget_realize (socket);
    /// g_print ("The ID of the sockets window is %#x\n",
    ///          gtk_socket_get_id (socket));
    /// ```
    ///
    /// Note that if you pass the window ID of the socket to another
    /// process that will create a plug in the socket, you must make
    /// sure that the socket widget is not destroyed until that plug
    /// is created. Violating this rule will cause unpredictable
    /// consequences, the most likely consequence being that the plug
    /// will appear as a separate toplevel window. You can check if
    /// the plug has been created by using `GtkSocketExt::get_plug_window`.
    /// If it returns a non-`None` value, then the plug has been
    /// successfully created inside of the socket.
    ///
    /// When GTK+ is notified that the embedded window has been destroyed,
    /// then it will destroy the socket as well. You should always,
    /// therefore, be prepared for your sockets to be destroyed at any
    /// time when the main event loop is running. To prevent this from
    /// happening, you can connect to the `Socket::plug-removed` signal.
    ///
    /// The communication between a `Socket` and a `Plug` follows the
    /// [XEmbed Protocol](http://www.freedesktop.org/Standards/xembed-spec).
    /// This protocol has also been implemented in other toolkits, e.g. Qt,
    /// allowing the same level of integration when embedding a Qt widget
    /// in GTK or vice versa.
    ///
    /// The `Plug` and `Socket` widgets are only available when GTK+
    /// is compiled for the X11 platform and `GDK_WINDOWING_X11` is defined.
    /// They can only be used on a ``GdkX11Display``. To use `Plug` and
    /// `Socket`, you need to include the `gtk/gtkx.h` header.
    ///
    /// # Implements
    ///
    /// [`GtkSocketExt`](trait.GtkSocketExt.html), [`ContainerExt`](trait.ContainerExt.html), [`WidgetExt`](trait.WidgetExt.html), [`glib::object::ObjectExt`](../glib/object/trait.ObjectExt.html), [`BuildableExt`](trait.BuildableExt.html), [`WidgetExtManual`](prelude/trait.WidgetExtManual.html), [`BuildableExtManual`](prelude/trait.BuildableExtManual.html)
    pub struct Socket(Object<gtk_sys::GtkSocket, gtk_sys::GtkSocketClass, SocketClass>) @extends Container, Widget, @implements Buildable;

    match fn {
        get_type => || gtk_sys::gtk_socket_get_type(),
    }
}

impl Socket {
    /// Create a new empty `Socket`.
    ///
    /// # Returns
    ///
    /// the new `Socket`.
    pub fn new() -> Socket {
        assert_initialized_main_thread!();
        unsafe { Widget::from_glib_none(gtk_sys::gtk_socket_new()).unsafe_cast() }
    }
}

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

#[derive(Clone, Default)]
pub struct SocketBuilder {
    border_width: Option<u32>,
    child: Option<Widget>,
    resize_mode: Option<ResizeMode>,
    app_paintable: Option<bool>,
    can_default: Option<bool>,
    can_focus: Option<bool>,
    events: Option<gdk::EventMask>,
    expand: Option<bool>,
    #[cfg(any(feature = "v3_20", feature = "dox"))]
    focus_on_click: Option<bool>,
    halign: Option<Align>,
    has_default: Option<bool>,
    has_focus: Option<bool>,
    has_tooltip: Option<bool>,
    height_request: Option<i32>,
    hexpand: Option<bool>,
    hexpand_set: Option<bool>,
    is_focus: Option<bool>,
    margin: Option<i32>,
    margin_bottom: Option<i32>,
    margin_end: Option<i32>,
    margin_start: Option<i32>,
    margin_top: Option<i32>,
    name: Option<String>,
    no_show_all: Option<bool>,
    opacity: Option<f64>,
    parent: Option<Container>,
    receives_default: Option<bool>,
    sensitive: Option<bool>,
    tooltip_markup: Option<String>,
    tooltip_text: Option<String>,
    valign: Option<Align>,
    vexpand: Option<bool>,
    vexpand_set: Option<bool>,
    visible: Option<bool>,
    width_request: Option<i32>,
}

impl SocketBuilder {
    pub fn new() -> Self {
        Self::default()
    }

    pub fn build(self) -> Socket {
        let mut properties: Vec<(&str, &dyn ToValue)> = vec![];
        if let Some(ref border_width) = self.border_width {
            properties.push(("border-width", border_width));
        }
        if let Some(ref child) = self.child {
            properties.push(("child", child));
        }
        if let Some(ref resize_mode) = self.resize_mode {
            properties.push(("resize-mode", resize_mode));
        }
        if let Some(ref app_paintable) = self.app_paintable {
            properties.push(("app-paintable", app_paintable));
        }
        if let Some(ref can_default) = self.can_default {
            properties.push(("can-default", can_default));
        }
        if let Some(ref can_focus) = self.can_focus {
            properties.push(("can-focus", can_focus));
        }
        if let Some(ref events) = self.events {
            properties.push(("events", events));
        }
        if let Some(ref expand) = self.expand {
            properties.push(("expand", expand));
        }
        #[cfg(any(feature = "v3_20", feature = "dox"))]
        {
            if let Some(ref focus_on_click) = self.focus_on_click {
                properties.push(("focus-on-click", focus_on_click));
            }
        }
        if let Some(ref halign) = self.halign {
            properties.push(("halign", halign));
        }
        if let Some(ref has_default) = self.has_default {
            properties.push(("has-default", has_default));
        }
        if let Some(ref has_focus) = self.has_focus {
            properties.push(("has-focus", has_focus));
        }
        if let Some(ref has_tooltip) = self.has_tooltip {
            properties.push(("has-tooltip", has_tooltip));
        }
        if let Some(ref height_request) = self.height_request {
            properties.push(("height-request", height_request));
        }
        if let Some(ref hexpand) = self.hexpand {
            properties.push(("hexpand", hexpand));
        }
        if let Some(ref hexpand_set) = self.hexpand_set {
            properties.push(("hexpand-set", hexpand_set));
        }
        if let Some(ref is_focus) = self.is_focus {
            properties.push(("is-focus", is_focus));
        }
        if let Some(ref margin) = self.margin {
            properties.push(("margin", margin));
        }
        if let Some(ref margin_bottom) = self.margin_bottom {
            properties.push(("margin-bottom", margin_bottom));
        }
        if let Some(ref margin_end) = self.margin_end {
            properties.push(("margin-end", margin_end));
        }
        if let Some(ref margin_start) = self.margin_start {
            properties.push(("margin-start", margin_start));
        }
        if let Some(ref margin_top) = self.margin_top {
            properties.push(("margin-top", margin_top));
        }
        if let Some(ref name) = self.name {
            properties.push(("name", name));
        }
        if let Some(ref no_show_all) = self.no_show_all {
            properties.push(("no-show-all", no_show_all));
        }
        if let Some(ref opacity) = self.opacity {
            properties.push(("opacity", opacity));
        }
        if let Some(ref parent) = self.parent {
            properties.push(("parent", parent));
        }
        if let Some(ref receives_default) = self.receives_default {
            properties.push(("receives-default", receives_default));
        }
        if let Some(ref sensitive) = self.sensitive {
            properties.push(("sensitive", sensitive));
        }
        if let Some(ref tooltip_markup) = self.tooltip_markup {
            properties.push(("tooltip-markup", tooltip_markup));
        }
        if let Some(ref tooltip_text) = self.tooltip_text {
            properties.push(("tooltip-text", tooltip_text));
        }
        if let Some(ref valign) = self.valign {
            properties.push(("valign", valign));
        }
        if let Some(ref vexpand) = self.vexpand {
            properties.push(("vexpand", vexpand));
        }
        if let Some(ref vexpand_set) = self.vexpand_set {
            properties.push(("vexpand-set", vexpand_set));
        }
        if let Some(ref visible) = self.visible {
            properties.push(("visible", visible));
        }
        if let Some(ref width_request) = self.width_request {
            properties.push(("width-request", width_request));
        }
        let ret = glib::Object::new(Socket::static_type(), &properties)
            .expect("object new")
            .downcast::<Socket>()
            .expect("downcast");
        ret
    }

    pub fn border_width(mut self, border_width: u32) -> Self {
        self.border_width = Some(border_width);
        self
    }

    pub fn child<P: IsA<Widget>>(mut self, child: &P) -> Self {
        self.child = Some(child.clone().upcast());
        self
    }

    pub fn resize_mode(mut self, resize_mode: ResizeMode) -> Self {
        self.resize_mode = Some(resize_mode);
        self
    }

    pub fn app_paintable(mut self, app_paintable: bool) -> Self {
        self.app_paintable = Some(app_paintable);
        self
    }

    pub fn can_default(mut self, can_default: bool) -> Self {
        self.can_default = Some(can_default);
        self
    }

    pub fn can_focus(mut self, can_focus: bool) -> Self {
        self.can_focus = Some(can_focus);
        self
    }

    pub fn events(mut self, events: gdk::EventMask) -> Self {
        self.events = Some(events);
        self
    }

    pub fn expand(mut self, expand: bool) -> Self {
        self.expand = Some(expand);
        self
    }

    #[cfg(any(feature = "v3_20", feature = "dox"))]
    pub fn focus_on_click(mut self, focus_on_click: bool) -> Self {
        self.focus_on_click = Some(focus_on_click);
        self
    }

    pub fn halign(mut self, halign: Align) -> Self {
        self.halign = Some(halign);
        self
    }

    pub fn has_default(mut self, has_default: bool) -> Self {
        self.has_default = Some(has_default);
        self
    }

    pub fn has_focus(mut self, has_focus: bool) -> Self {
        self.has_focus = Some(has_focus);
        self
    }

    pub fn has_tooltip(mut self, has_tooltip: bool) -> Self {
        self.has_tooltip = Some(has_tooltip);
        self
    }

    pub fn height_request(mut self, height_request: i32) -> Self {
        self.height_request = Some(height_request);
        self
    }

    pub fn hexpand(mut self, hexpand: bool) -> Self {
        self.hexpand = Some(hexpand);
        self
    }

    pub fn hexpand_set(mut self, hexpand_set: bool) -> Self {
        self.hexpand_set = Some(hexpand_set);
        self
    }

    pub fn is_focus(mut self, is_focus: bool) -> Self {
        self.is_focus = Some(is_focus);
        self
    }

    pub fn margin(mut self, margin: i32) -> Self {
        self.margin = Some(margin);
        self
    }

    pub fn margin_bottom(mut self, margin_bottom: i32) -> Self {
        self.margin_bottom = Some(margin_bottom);
        self
    }

    pub fn margin_end(mut self, margin_end: i32) -> Self {
        self.margin_end = Some(margin_end);
        self
    }

    pub fn margin_start(mut self, margin_start: i32) -> Self {
        self.margin_start = Some(margin_start);
        self
    }

    pub fn margin_top(mut self, margin_top: i32) -> Self {
        self.margin_top = Some(margin_top);
        self
    }

    pub fn name(mut self, name: &str) -> Self {
        self.name = Some(name.to_string());
        self
    }

    pub fn no_show_all(mut self, no_show_all: bool) -> Self {
        self.no_show_all = Some(no_show_all);
        self
    }

    pub fn opacity(mut self, opacity: f64) -> Self {
        self.opacity = Some(opacity);
        self
    }

    pub fn parent<P: IsA<Container>>(mut self, parent: &P) -> Self {
        self.parent = Some(parent.clone().upcast());
        self
    }

    pub fn receives_default(mut self, receives_default: bool) -> Self {
        self.receives_default = Some(receives_default);
        self
    }

    pub fn sensitive(mut self, sensitive: bool) -> Self {
        self.sensitive = Some(sensitive);
        self
    }

    pub fn tooltip_markup(mut self, tooltip_markup: &str) -> Self {
        self.tooltip_markup = Some(tooltip_markup.to_string());
        self
    }

    pub fn tooltip_text(mut self, tooltip_text: &str) -> Self {
        self.tooltip_text = Some(tooltip_text.to_string());
        self
    }

    pub fn valign(mut self, valign: Align) -> Self {
        self.valign = Some(valign);
        self
    }

    pub fn vexpand(mut self, vexpand: bool) -> Self {
        self.vexpand = Some(vexpand);
        self
    }

    pub fn vexpand_set(mut self, vexpand_set: bool) -> Self {
        self.vexpand_set = Some(vexpand_set);
        self
    }

    pub fn visible(mut self, visible: bool) -> Self {
        self.visible = Some(visible);
        self
    }

    pub fn width_request(mut self, width_request: i32) -> Self {
        self.width_request = Some(width_request);
        self
    }
}

pub const NONE_SOCKET: Option<&Socket> = None;

/// Trait containing all `Socket` methods.
///
/// # Implementors
///
/// [`Socket`](struct.Socket.html)
pub trait GtkSocketExt: 'static {
    /// Adds an XEMBED client, such as a `Plug`, to the `Socket`. The
    /// client may be in the same process or in a different process.
    ///
    /// To embed a `Plug` in a `Socket`, you can either create the
    /// `Plug` with `gtk_plug_new (0)`, call
    /// `PlugExt::get_id` to get the window ID of the plug, and then pass that to the
    /// `GtkSocketExt::add_id`, or you can call `GtkSocketExt::get_id` to get the
    /// window ID for the socket, and call `Plug::new` passing in that
    /// ID.
    ///
    /// The `Socket` must have already be added into a toplevel window
    ///  before you can make this call.
    /// ## `window`
    /// the Window of a client participating in the XEMBED protocol.
    fn add_id(&self, window: xlib::Window);

    /// Gets the window ID of a `Socket` widget, which can then
    /// be used to create a client embedded inside the socket, for
    /// instance with `Plug::new`.
    ///
    /// The `Socket` must have already be added into a toplevel window
    /// before you can make this call.
    ///
    /// # Returns
    ///
    /// the window ID for the socket
    fn get_id(&self) -> xlib::Window;

    /// Retrieves the window of the plug. Use this to check if the plug has
    /// been created inside of the socket.
    ///
    /// # Returns
    ///
    /// the window of the plug if
    /// available, or `None`
    fn get_plug_window(&self) -> Option<gdk::Window>;

    /// This signal is emitted when a client is successfully
    /// added to the socket.
    fn connect_plug_added<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId;

    /// This signal is emitted when a client is removed from the socket.
    /// The default action is to destroy the `Socket` widget, so if you
    /// want to reuse it you must add a signal handler that returns `true`.
    ///
    /// # Returns
    ///
    /// `true` to stop other handlers from being invoked.
    fn connect_plug_removed<F: Fn(&Self) -> bool + 'static>(&self, f: F) -> SignalHandlerId;
}

impl<O: IsA<Socket>> GtkSocketExt for O {
    fn add_id(&self, window: xlib::Window) {
        unsafe {
            gtk_sys::gtk_socket_add_id(self.as_ref().to_glib_none().0, window);
        }
    }

    fn get_id(&self) -> xlib::Window {
        unsafe { gtk_sys::gtk_socket_get_id(self.as_ref().to_glib_none().0) }
    }

    fn get_plug_window(&self) -> Option<gdk::Window> {
        unsafe {
            from_glib_none(gtk_sys::gtk_socket_get_plug_window(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    fn connect_plug_added<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn plug_added_trampoline<P, F: Fn(&P) + 'static>(
            this: *mut gtk_sys::GtkSocket,
            f: glib_sys::gpointer,
        ) where
            P: IsA<Socket>,
        {
            let f: &F = &*(f as *const F);
            f(&Socket::from_glib_borrow(this).unsafe_cast_ref())
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"plug-added\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    plug_added_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    fn connect_plug_removed<F: Fn(&Self) -> bool + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn plug_removed_trampoline<P, F: Fn(&P) -> bool + 'static>(
            this: *mut gtk_sys::GtkSocket,
            f: glib_sys::gpointer,
        ) -> glib_sys::gboolean
        where
            P: IsA<Socket>,
        {
            let f: &F = &*(f as *const F);
            f(&Socket::from_glib_borrow(this).unsafe_cast_ref()).to_glib()
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                b"plug-removed\0".as_ptr() as *const _,
                Some(transmute::<_, unsafe extern "C" fn()>(
                    plug_removed_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl fmt::Display for Socket {
    fn fmt(&self, f: &mut fmt::Formatter) -> fmt::Result {
        write!(f, "Socket")
    }
}