gtk/auto/

toggle_button.rs

// 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 crate::{
    Actionable, Align, Bin, Buildable, Button, Container, PositionType, ReliefStyle, ResizeMode,
    Widget, ffi,
};
use glib::{
    object::ObjectType as _,
    prelude::*,
    signal::{SignalHandlerId, connect_raw},
    translate::*,
};
use std::boxed::Box as Box_;

glib::wrapper! {
    /// A [`ToggleButton`][crate::ToggleButton] is a [`Button`][crate::Button] which will remain “pressed-in” when
    /// clicked. Clicking again will cause the toggle button to return to its
    /// normal state.
    ///
    /// A toggle button is created by calling either [`new()`][Self::new()] or
    /// [`with_label()`][Self::with_label()]. If using the former, it is advisable to
    /// pack a widget, (such as a [`Label`][crate::Label] and/or a [`Image`][crate::Image]), into the toggle
    /// button’s container. (See [`Button`][crate::Button] for more information).
    ///
    /// The state of a [`ToggleButton`][crate::ToggleButton] can be set specifically using
    /// [`ToggleButtonExt::set_active()`][crate::prelude::ToggleButtonExt::set_active()], and retrieved using
    /// [`ToggleButtonExt::is_active()`][crate::prelude::ToggleButtonExt::is_active()].
    ///
    /// To simply switch the state of a toggle button, use [`ToggleButtonExt::toggled()`][crate::prelude::ToggleButtonExt::toggled()].
    ///
    /// # CSS nodes
    ///
    /// GtkToggleButton has a single CSS node with name button. To differentiate
    /// it from a plain [`Button`][crate::Button], it gets the .toggle style class.
    ///
    /// ## Creating two [`ToggleButton`][crate::ToggleButton] widgets.
    ///
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// static void output_state (GtkToggleButton *source, gpointer user_data) {
    ///   printf ("Active: %d\n", gtk_toggle_button_get_active (source));
    /// }
    ///
    /// void make_toggles (void) {
    ///   GtkWidget *window, *toggle1, *toggle2;
    ///   GtkWidget *box;
    ///   const char *text;
    ///
    ///   window = gtk_window_new (GTK_WINDOW_TOPLEVEL);
    ///   box = gtk_box_new (GTK_ORIENTATION_VERTICAL, 12);
    ///
    ///   text = "Hi, I’m a toggle button.";
    ///   toggle1 = gtk_toggle_button_new_with_label (text);
    ///
    ///   // Makes this toggle button invisible
    ///   gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle1),
    ///                               TRUE);
    ///
    ///   g_signal_connect (toggle1, "toggled",
    ///                     G_CALLBACK (output_state),
    ///                     NULL);
    ///   gtk_container_add (GTK_CONTAINER (box), toggle1);
    ///
    ///   text = "Hi, I’m a toggle button.";
    ///   toggle2 = gtk_toggle_button_new_with_label (text);
    ///   gtk_toggle_button_set_mode (GTK_TOGGLE_BUTTON (toggle2),
    ///                               FALSE);
    ///   g_signal_connect (toggle2, "toggled",
    ///                     G_CALLBACK (output_state),
    ///                     NULL);
    ///   gtk_container_add (GTK_CONTAINER (box), toggle2);
    ///
    ///   gtk_container_add (GTK_CONTAINER (window), box);
    ///   gtk_widget_show_all (window);
    /// }
    /// ```
    ///
    /// ## Properties
    ///
    ///
    /// #### `active`
    ///  Readable | Writable
    ///
    ///
    /// #### `draw-indicator`
    ///  Readable | Writable
    ///
    ///
    /// #### `inconsistent`
    ///  Readable | Writable
    /// <details><summary><h4>Button</h4></summary>
    ///
    ///
    /// #### `always-show-image`
    ///  If [`true`], the button will ignore the [`gtk-button-images`][struct@crate::Settings#gtk-button-images]
    /// setting and always show the image, if available.
    ///
    /// Use this property if the button would be useless or hard to use
    /// without the image.
    ///
    /// Readable | Writable | Construct
    ///
    ///
    /// #### `image`
    ///  The child widget to appear next to the button text.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `image-position`
    ///  The position of the image relative to the text inside the button.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `label`
    ///  Readable | Writable | Construct
    ///
    ///
    /// #### `relief`
    ///  Readable | Writable
    ///
    ///
    /// #### `use-stock`
    ///  Readable | Writable | Construct
    ///
    ///
    /// #### `use-underline`
    ///  Readable | Writable | Construct
    ///
    ///
    /// #### `xalign`
    ///  If the child of the button is a [`Misc`][crate::Misc] or `GtkAlignment`, this property
    /// can be used to control its horizontal alignment. 0.0 is left aligned,
    /// 1.0 is right aligned.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `yalign`
    ///  If the child of the button is a [`Misc`][crate::Misc] or `GtkAlignment`, this property
    /// can be used to control its vertical alignment. 0.0 is top aligned,
    /// 1.0 is bottom aligned.
    ///
    /// Readable | Writable
    /// </details>
    /// <details><summary><h4>Container</h4></summary>
    ///
    ///
    /// #### `border-width`
    ///  Readable | Writable
    ///
    ///
    /// #### `child`
    ///  Writable
    ///
    ///
    /// #### `resize-mode`
    ///  Readable | Writable
    /// </details>
    /// <details><summary><h4>Widget</h4></summary>
    ///
    ///
    /// #### `app-paintable`
    ///  Readable | Writable
    ///
    ///
    /// #### `can-default`
    ///  Readable | Writable
    ///
    ///
    /// #### `can-focus`
    ///  Readable | Writable
    ///
    ///
    /// #### `composite-child`
    ///  Readable
    ///
    ///
    /// #### `double-buffered`
    ///  Whether the widget is double buffered.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `events`
    ///  Readable | Writable
    ///
    ///
    /// #### `expand`
    ///  Whether to expand in both directions. Setting this sets both [`hexpand`][struct@crate::Widget#hexpand] and [`vexpand`][struct@crate::Widget#vexpand]
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `focus-on-click`
    ///  Whether the widget should grab focus when it is clicked with the mouse.
    ///
    /// This property is only relevant for widgets that can take focus.
    ///
    /// Before 3.20, several widgets (GtkButton, GtkFileChooserButton,
    /// GtkComboBox) implemented this property individually.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `halign`
    ///  How to distribute horizontal space if widget gets extra space, see [`Align`][crate::Align]
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `has-default`
    ///  Readable | Writable
    ///
    ///
    /// #### `has-focus`
    ///  Readable | Writable
    ///
    ///
    /// #### `has-tooltip`
    ///  Enables or disables the emission of [`query-tooltip`][struct@crate::Widget#query-tooltip] on `widget`.
    /// A value of [`true`] indicates that `widget` can have a tooltip, in this case
    /// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to determine
    /// whether it will provide a tooltip or not.
    ///
    /// Note that setting this property to [`true`] for the first time will change
    /// the event masks of the GdkWindows of this widget to include leave-notify
    /// and motion-notify events. This cannot and will not be undone when the
    /// property is set to [`false`] again.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `height-request`
    ///  Readable | Writable
    ///
    ///
    /// #### `hexpand`
    ///  Whether to expand horizontally. See [`WidgetExt::set_hexpand()`][crate::prelude::WidgetExt::set_hexpand()].
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `hexpand-set`
    ///  Whether to use the [`hexpand`][struct@crate::Widget#hexpand] property. See [`WidgetExt::is_hexpand_set()`][crate::prelude::WidgetExt::is_hexpand_set()].
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `is-focus`
    ///  Readable | Writable
    ///
    ///
    /// #### `margin`
    ///  Sets all four sides' margin at once. If read, returns max
    /// margin on any side.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `margin-bottom`
    ///  Margin on bottom side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `margin-end`
    ///  Margin on end of widget, horizontally. This property supports
    /// left-to-right and right-to-left text directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `margin-left`
    ///  Margin on left side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `margin-right`
    ///  Margin on right side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `margin-start`
    ///  Margin on start of widget, horizontally. This property supports
    /// left-to-right and right-to-left text directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `margin-top`
    ///  Margin on top side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `name`
    ///  Readable | Writable
    ///
    ///
    /// #### `no-show-all`
    ///  Readable | Writable
    ///
    ///
    /// #### `opacity`
    ///  The requested opacity of the widget. See [`WidgetExt::set_opacity()`][crate::prelude::WidgetExt::set_opacity()] for
    /// more details about window opacity.
    ///
    /// Before 3.8 this was only available in GtkWindow
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `parent`
    ///  Readable | Writable
    ///
    ///
    /// #### `receives-default`
    ///  Readable | Writable
    ///
    ///
    /// #### `scale-factor`
    ///  The scale factor of the widget. See [`WidgetExt::scale_factor()`][crate::prelude::WidgetExt::scale_factor()] for
    /// more details about widget scaling.
    ///
    /// Readable
    ///
    ///
    /// #### `sensitive`
    ///  Readable | Writable
    ///
    ///
    /// #### `style`
    ///  The style of the widget, which contains information about how it will look (colors, etc).
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `tooltip-markup`
    ///  Sets the text of tooltip to be the given string, which is marked up
    /// with the [Pango text markup language][PangoMarkupFormat].
    /// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `tooltip-text`
    ///  Sets the text of tooltip to be the given string.
    ///
    /// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `valign`
    ///  How to distribute vertical space if widget gets extra space, see [`Align`][crate::Align]
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `vexpand`
    ///  Whether to expand vertically. See [`WidgetExt::set_vexpand()`][crate::prelude::WidgetExt::set_vexpand()].
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `vexpand-set`
    ///  Whether to use the [`vexpand`][struct@crate::Widget#vexpand] property. See [`WidgetExt::is_vexpand_set()`][crate::prelude::WidgetExt::is_vexpand_set()].
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `visible`
    ///  Readable | Writable
    ///
    ///
    /// #### `width-request`
    ///  Readable | Writable
    ///
    ///
    /// #### `window`
    ///  The widget's window if it is realized, [`None`] otherwise.
    ///
    /// Readable
    /// </details>
    /// <details><summary><h4>Actionable</h4></summary>
    ///
    ///
    /// #### `action-name`
    ///  Readable | Writable
    ///
    ///
    /// #### `action-target`
    ///  Readable | Writable
    /// </details>
    /// <details><summary><h4>Activatable</h4></summary>
    ///
    ///
    /// #### `related-action`
    ///  The action that this activatable will activate and receive
    /// updates from for various states and possibly appearance.
    ///
    /// > `GtkActivatable` implementors need to handle the this property and
    /// > call `gtk_activatable_do_set_related_action()` when it changes.
    ///
    /// Readable | Writable
    ///
    ///
    /// #### `use-action-appearance`
    ///  Whether this activatable should reset its layout
    /// and appearance when setting the related action or when
    /// the action changes appearance.
    ///
    /// See the `GtkAction` documentation directly to find which properties
    /// should be ignored by the `GtkActivatable` when this property is [`false`].
    ///
    /// > `GtkActivatable` implementors need to handle this property
    /// > and call `gtk_activatable_sync_action_properties()` on the activatable
    /// > widget when it changes.
    ///
    /// Readable | Writable
    /// </details>
    ///
    /// ## Signals
    ///
    ///
    /// #### `toggled`
    ///  Should be connected if you wish to perform an action whenever the
    /// [`ToggleButton`][crate::ToggleButton]'s state is changed.
    ///
    ///
    /// <details><summary><h4>Button</h4></summary>
    ///
    ///
    /// #### `activate`
    ///  The ::activate signal on GtkButton is an action signal and
    /// emitting it causes the button to animate press then release.
    /// Applications should never connect to this signal, but use the
    /// [`clicked`][struct@crate::Button#clicked] signal.
    ///
    /// Action
    ///
    ///
    /// #### `clicked`
    ///  Emitted when the button has been activated (pressed and released).
    ///
    /// Action
    ///
    ///
    /// #### `enter`
    ///  Emitted when the pointer enters the button.
    ///
    ///
    ///
    ///
    /// #### `leave`
    ///  Emitted when the pointer leaves the button.
    ///
    ///
    ///
    ///
    /// #### `pressed`
    ///  Emitted when the button is pressed.
    ///
    ///
    ///
    ///
    /// #### `released`
    ///  Emitted when the button is released.
    ///
    ///
    /// </details>
    /// <details><summary><h4>Container</h4></summary>
    ///
    ///
    /// #### `add`
    ///
    ///
    ///
    /// #### `check-resize`
    ///
    ///
    ///
    /// #### `remove`
    ///
    ///
    ///
    /// #### `set-focus-child`
    ///
    /// </details>
    /// <details><summary><h4>Widget</h4></summary>
    ///
    ///
    /// #### `accel-closures-changed`
    ///
    ///
    ///
    /// #### `button-press-event`
    ///  The ::button-press-event signal will be emitted when a button
    /// (typically from a mouse) is pressed.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the
    /// widget needs to enable the [`gdk::EventMask::BUTTON_PRESS_MASK`][crate::gdk::EventMask::BUTTON_PRESS_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `button-release-event`
    ///  The ::button-release-event signal will be emitted when a button
    /// (typically from a mouse) is released.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the
    /// widget needs to enable the [`gdk::EventMask::BUTTON_RELEASE_MASK`][crate::gdk::EventMask::BUTTON_RELEASE_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `can-activate-accel`
    ///  Determines whether an accelerator that activates the signal
    /// identified by `signal_id` can currently be activated.
    /// This signal is present to allow applications and derived
    /// widgets to override the default [`Widget`][crate::Widget] handling
    /// for determining whether an accelerator can be activated.
    ///
    ///
    ///
    ///
    /// #### `child-notify`
    ///  The ::child-notify signal is emitted for each
    /// [child property][child-properties] that has
    /// changed on an object. The signal's detail holds the property name.
    ///
    /// Detailed
    ///
    ///
    /// #### `composited-changed`
    ///  The ::composited-changed signal is emitted when the composited
    /// status of `widgets` screen changes.
    /// See [`Screen::is_composited()`][crate::gdk::Screen::is_composited()].
    ///
    /// Action
    ///
    ///
    /// #### `configure-event`
    ///  The ::configure-event signal will be emitted when the size, position or
    /// stacking of the `widget`'s window has changed.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::STRUCTURE_MASK`][crate::gdk::EventMask::STRUCTURE_MASK] mask. GDK will enable this mask
    /// automatically for all new windows.
    ///
    ///
    ///
    ///
    /// #### `damage-event`
    ///  Emitted when a redirected window belonging to `widget` gets drawn into.
    /// The region/area members of the event shows what area of the redirected
    /// drawable was drawn into.
    ///
    ///
    ///
    ///
    /// #### `delete-event`
    ///  The ::delete-event signal is emitted if a user requests that
    /// a toplevel window is closed. The default handler for this signal
    /// destroys the window. Connecting [`WidgetExtManual::hide_on_delete()`][crate::prelude::WidgetExtManual::hide_on_delete()] to
    /// this signal will cause the window to be hidden instead, so that
    /// it can later be shown again without reconstructing it.
    ///
    ///
    ///
    ///
    /// #### `destroy`
    ///  Signals that all holders of a reference to the widget should release
    /// the reference that they hold. May result in finalization of the widget
    /// if all references are released.
    ///
    /// This signal is not suitable for saving widget state.
    ///
    ///
    ///
    ///
    /// #### `destroy-event`
    ///  The ::destroy-event signal is emitted when a [`gdk::Window`][crate::gdk::Window] is destroyed.
    /// You rarely get this signal, because most widgets disconnect themselves
    /// from their window before they destroy it, so no widget owns the
    /// window at destroy time.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::STRUCTURE_MASK`][crate::gdk::EventMask::STRUCTURE_MASK] mask. GDK will enable this mask
    /// automatically for all new windows.
    ///
    ///
    ///
    ///
    /// #### `direction-changed`
    ///  The ::direction-changed signal is emitted when the text direction
    /// of a widget changes.
    ///
    ///
    ///
    ///
    /// #### `drag-begin`
    ///  The ::drag-begin signal is emitted on the drag source when a drag is
    /// started. A typical reason to connect to this signal is to set up a
    /// custom drag icon with e.g. [`WidgetExt::drag_source_set_icon_pixbuf()`][crate::prelude::WidgetExt::drag_source_set_icon_pixbuf()].
    ///
    /// Note that some widgets set up a drag icon in the default handler of
    /// this signal, so you may have to use `g_signal_connect_after()` to
    /// override what the default handler did.
    ///
    ///
    ///
    ///
    /// #### `drag-data-delete`
    ///  The ::drag-data-delete signal is emitted on the drag source when a drag
    /// with the action [`gdk::DragAction::MOVE`][crate::gdk::DragAction::MOVE] is successfully completed. The signal
    /// handler is responsible for deleting the data that has been dropped. What
    /// "delete" means depends on the context of the drag operation.
    ///
    ///
    ///
    ///
    /// #### `drag-data-get`
    ///  The ::drag-data-get signal is emitted on the drag source when the drop
    /// site requests the data which is dragged. It is the responsibility of
    /// the signal handler to fill `data` with the data in the format which
    /// is indicated by `info`. See [`SelectionData::set()`][crate::SelectionData::set()] and
    /// [`SelectionData::set_text()`][crate::SelectionData::set_text()].
    ///
    ///
    ///
    ///
    /// #### `drag-data-received`
    ///  The ::drag-data-received signal is emitted on the drop site when the
    /// dragged data has been received. If the data was received in order to
    /// determine whether the drop will be accepted, the handler is expected
    /// to call `gdk_drag_status()` and not finish the drag.
    /// If the data was received in response to a [`drag-drop`][struct@crate::Widget#drag-drop] signal
    /// (and this is the last target to be received), the handler for this
    /// signal is expected to process the received data and then call
    /// `gtk_drag_finish()`, setting the `success` parameter depending on
    /// whether the data was processed successfully.
    ///
    /// Applications must create some means to determine why the signal was emitted
    /// and therefore whether to call `gdk_drag_status()` or `gtk_drag_finish()`.
    ///
    /// The handler may inspect the selected action with
    /// [`DragContext::selected_action()`][crate::gdk::DragContext::selected_action()] before calling
    /// `gtk_drag_finish()`, e.g. to implement [`gdk::DragAction::ASK`][crate::gdk::DragAction::ASK] as
    /// shown in the following example:
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// void
    /// drag_data_received (GtkWidget          *widget,
    ///                     GdkDragContext     *context,
    ///                     gint                x,
    ///                     gint                y,
    ///                     GtkSelectionData   *data,
    ///                     guint               info,
    ///                     guint               time)
    /// {
    ///   if ((data->length >= 0) && (data->format == 8))
    ///     {
    ///       GdkDragAction action;
    ///
    ///       // handle data here
    ///
    ///       action = gdk_drag_context_get_selected_action (context);
    ///       if (action == GDK_ACTION_ASK)
    ///         {
    ///           GtkWidget *dialog;
    ///           gint response;
    ///
    ///           dialog = gtk_message_dialog_new (NULL,
    ///                                            GTK_DIALOG_MODAL |
    ///                                            GTK_DIALOG_DESTROY_WITH_PARENT,
    ///                                            GTK_MESSAGE_INFO,
    ///                                            GTK_BUTTONS_YES_NO,
    ///                                            "Move the data ?\n");
    ///           response = gtk_dialog_run (GTK_DIALOG (dialog));
    ///           gtk_widget_destroy (dialog);
    ///
    ///           if (response == GTK_RESPONSE_YES)
    ///             action = GDK_ACTION_MOVE;
    ///           else
    ///             action = GDK_ACTION_COPY;
    ///          }
    ///
    ///       gtk_drag_finish (context, TRUE, action == GDK_ACTION_MOVE, time);
    ///     }
    ///   else
    ///     gtk_drag_finish (context, FALSE, FALSE, time);
    ///  }
    /// ```
    ///
    ///
    ///
    ///
    /// #### `drag-drop`
    ///  The ::drag-drop signal is emitted on the drop site when the user drops
    /// the data onto the widget. The signal handler must determine whether
    /// the cursor position is in a drop zone or not. If it is not in a drop
    /// zone, it returns [`false`] and no further processing is necessary.
    /// Otherwise, the handler returns [`true`]. In this case, the handler must
    /// ensure that `gtk_drag_finish()` is called to let the source know that
    /// the drop is done. The call to `gtk_drag_finish()` can be done either
    /// directly or in a [`drag-data-received`][struct@crate::Widget#drag-data-received] handler which gets
    /// triggered by calling [`WidgetExt::drag_get_data()`][crate::prelude::WidgetExt::drag_get_data()] to receive the data for one
    /// or more of the supported targets.
    ///
    ///
    ///
    ///
    /// #### `drag-end`
    ///  The ::drag-end signal is emitted on the drag source when a drag is
    /// finished. A typical reason to connect to this signal is to undo
    /// things done in [`drag-begin`][struct@crate::Widget#drag-begin].
    ///
    ///
    ///
    ///
    /// #### `drag-failed`
    ///  The ::drag-failed signal is emitted on the drag source when a drag has
    /// failed. The signal handler may hook custom code to handle a failed DnD
    /// operation based on the type of error, it returns [`true`] is the failure has
    /// been already handled (not showing the default "drag operation failed"
    /// animation), otherwise it returns [`false`].
    ///
    ///
    ///
    ///
    /// #### `drag-leave`
    ///  The ::drag-leave signal is emitted on the drop site when the cursor
    /// leaves the widget. A typical reason to connect to this signal is to
    /// undo things done in [`drag-motion`][struct@crate::Widget#drag-motion], e.g. undo highlighting
    /// with [`WidgetExt::drag_unhighlight()`][crate::prelude::WidgetExt::drag_unhighlight()].
    ///
    ///
    /// Likewise, the [`drag-leave`][struct@crate::Widget#drag-leave] signal is also emitted before the
    /// ::drag-drop signal, for instance to allow cleaning up of a preview item
    /// created in the [`drag-motion`][struct@crate::Widget#drag-motion] signal handler.
    ///
    ///
    ///
    ///
    /// #### `drag-motion`
    ///  The ::drag-motion signal is emitted on the drop site when the user
    /// moves the cursor over the widget during a drag. The signal handler
    /// must determine whether the cursor position is in a drop zone or not.
    /// If it is not in a drop zone, it returns [`false`] and no further processing
    /// is necessary. Otherwise, the handler returns [`true`]. In this case, the
    /// handler is responsible for providing the necessary information for
    /// displaying feedback to the user, by calling `gdk_drag_status()`.
    ///
    /// If the decision whether the drop will be accepted or rejected can't be
    /// made based solely on the cursor position and the type of the data, the
    /// handler may inspect the dragged data by calling [`WidgetExt::drag_get_data()`][crate::prelude::WidgetExt::drag_get_data()] and
    /// defer the `gdk_drag_status()` call to the [`drag-data-received`][struct@crate::Widget#drag-data-received]
    /// handler. Note that you must pass [`DestDefaults::DROP`][crate::DestDefaults::DROP],
    /// [`DestDefaults::MOTION`][crate::DestDefaults::MOTION] or [`DestDefaults::ALL`][crate::DestDefaults::ALL] to [`WidgetExtManual::drag_dest_set()`][crate::prelude::WidgetExtManual::drag_dest_set()]
    /// when using the drag-motion signal that way.
    ///
    /// Also note that there is no drag-enter signal. The drag receiver has to
    /// keep track of whether he has received any drag-motion signals since the
    /// last [`drag-leave`][struct@crate::Widget#drag-leave] and if not, treat the drag-motion signal as
    /// an "enter" signal. Upon an "enter", the handler will typically highlight
    /// the drop site with [`WidgetExt::drag_highlight()`][crate::prelude::WidgetExt::drag_highlight()].
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// static void
    /// drag_motion (GtkWidget      *widget,
    ///              GdkDragContext *context,
    ///              gint            x,
    ///              gint            y,
    ///              guint           time)
    /// {
    ///   GdkAtom target;
    ///
    ///   PrivateData *private_data = GET_PRIVATE_DATA (widget);
    ///
    ///   if (!private_data->drag_highlight)
    ///    {
    ///      private_data->drag_highlight = 1;
    ///      gtk_drag_highlight (widget);
    ///    }
    ///
    ///   target = gtk_drag_dest_find_target (widget, context, NULL);
    ///   if (target == GDK_NONE)
    ///     gdk_drag_status (context, 0, time);
    ///   else
    ///    {
    ///      private_data->pending_status
    ///         = gdk_drag_context_get_suggested_action (context);
    ///      gtk_drag_get_data (widget, context, target, time);
    ///    }
    ///
    ///   return TRUE;
    /// }
    ///
    /// static void
    /// drag_data_received (GtkWidget        *widget,
    ///                     GdkDragContext   *context,
    ///                     gint              x,
    ///                     gint              y,
    ///                     GtkSelectionData *selection_data,
    ///                     guint             info,
    ///                     guint             time)
    /// {
    ///   PrivateData *private_data = GET_PRIVATE_DATA (widget);
    ///
    ///   if (private_data->suggested_action)
    ///    {
    ///      private_data->suggested_action = 0;
    ///
    ///      // We are getting this data due to a request in drag_motion,
    ///      // rather than due to a request in drag_drop, so we are just
    ///      // supposed to call gdk_drag_status(), not actually paste in
    ///      // the data.
    ///
    ///      str = gtk_selection_data_get_text (selection_data);
    ///      if (!data_is_acceptable (str))
    ///        gdk_drag_status (context, 0, time);
    ///      else
    ///        gdk_drag_status (context,
    ///                         private_data->suggested_action,
    ///                         time);
    ///    }
    ///   else
    ///    {
    ///      // accept the drop
    ///    }
    /// }
    /// ```
    ///
    ///
    ///
    ///
    /// #### `draw`
    ///  This signal is emitted when a widget is supposed to render itself.
    /// The `widget`'s top left corner must be painted at the origin of
    /// the passed in context and be sized to the values returned by
    /// [`WidgetExt::allocated_width()`][crate::prelude::WidgetExt::allocated_width()] and
    /// [`WidgetExt::allocated_height()`][crate::prelude::WidgetExt::allocated_height()].
    ///
    /// Signal handlers connected to this signal can modify the cairo
    /// context passed as `cr` in any way they like and don't need to
    /// restore it. The signal emission takes care of calling `cairo_save()`
    /// before and `cairo_restore()` after invoking the handler.
    ///
    /// The signal handler will get a `cr` with a clip region already set to the
    /// widget's dirty region, i.e. to the area that needs repainting. Complicated
    /// widgets that want to avoid redrawing themselves completely can get the full
    /// extents of the clip region with `gdk_cairo_get_clip_rectangle()`, or they can
    /// get a finer-grained representation of the dirty region with
    /// `cairo_copy_clip_rectangle_list()`.
    ///
    ///
    ///
    ///
    /// #### `enter-notify-event`
    ///  The ::enter-notify-event will be emitted when the pointer enters
    /// the `widget`'s window.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::ENTER_NOTIFY_MASK`][crate::gdk::EventMask::ENTER_NOTIFY_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `event`
    ///  The GTK+ main loop will emit three signals for each GDK event delivered
    /// to a widget: one generic ::event signal, another, more specific,
    /// signal that matches the type of event delivered (e.g.
    /// [`key-press-event`][struct@crate::Widget#key-press-event]) and finally a generic
    /// [`event-after`][struct@crate::Widget#event-after] signal.
    ///
    ///
    ///
    ///
    /// #### `event-after`
    ///  After the emission of the [`event`][struct@crate::Widget#event] signal and (optionally)
    /// the second more specific signal, ::event-after will be emitted
    /// regardless of the previous two signals handlers return values.
    ///
    ///
    ///
    ///
    /// #### `focus`
    ///
    ///
    ///
    /// #### `focus-in-event`
    ///  The ::focus-in-event signal will be emitted when the keyboard focus
    /// enters the `widget`'s window.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::FOCUS_CHANGE_MASK`][crate::gdk::EventMask::FOCUS_CHANGE_MASK] mask.
    ///
    ///
    ///
    ///
    /// #### `focus-out-event`
    ///  The ::focus-out-event signal will be emitted when the keyboard focus
    /// leaves the `widget`'s window.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::FOCUS_CHANGE_MASK`][crate::gdk::EventMask::FOCUS_CHANGE_MASK] mask.
    ///
    ///
    ///
    ///
    /// #### `grab-broken-event`
    ///  Emitted when a pointer or keyboard grab on a window belonging
    /// to `widget` gets broken.
    ///
    /// On X11, this happens when the grab window becomes unviewable
    /// (i.e. it or one of its ancestors is unmapped), or if the same
    /// application grabs the pointer or keyboard again.
    ///
    ///
    ///
    ///
    /// #### `grab-focus`
    ///  Action
    ///
    ///
    /// #### `grab-notify`
    ///  The ::grab-notify signal is emitted when a widget becomes
    /// shadowed by a GTK+ grab (not a pointer or keyboard grab) on
    /// another widget, or when it becomes unshadowed due to a grab
    /// being removed.
    ///
    /// A widget is shadowed by a [`WidgetExt::grab_add()`][crate::prelude::WidgetExt::grab_add()] when the topmost
    /// grab widget in the grab stack of its window group is not
    /// its ancestor.
    ///
    ///
    ///
    ///
    /// #### `hide`
    ///  The ::hide signal is emitted when `widget` is hidden, for example with
    /// [`WidgetExt::hide()`][crate::prelude::WidgetExt::hide()].
    ///
    ///
    ///
    ///
    /// #### `hierarchy-changed`
    ///  The ::hierarchy-changed signal is emitted when the
    /// anchored state of a widget changes. A widget is
    /// “anchored” when its toplevel
    /// ancestor is a [`Window`][crate::Window]. This signal is emitted when
    /// a widget changes from un-anchored to anchored or vice-versa.
    ///
    ///
    ///
    ///
    /// #### `key-press-event`
    ///  The ::key-press-event signal is emitted when a key is pressed. The signal
    /// emission will reoccur at the key-repeat rate when the key is kept pressed.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::KEY_PRESS_MASK`][crate::gdk::EventMask::KEY_PRESS_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `key-release-event`
    ///  The ::key-release-event signal is emitted when a key is released.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::KEY_RELEASE_MASK`][crate::gdk::EventMask::KEY_RELEASE_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `keynav-failed`
    ///  Gets emitted if keyboard navigation fails.
    /// See [`WidgetExt::keynav_failed()`][crate::prelude::WidgetExt::keynav_failed()] for details.
    ///
    ///
    ///
    ///
    /// #### `leave-notify-event`
    ///  The ::leave-notify-event will be emitted when the pointer leaves
    /// the `widget`'s window.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::LEAVE_NOTIFY_MASK`][crate::gdk::EventMask::LEAVE_NOTIFY_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `map`
    ///  The ::map signal is emitted when `widget` is going to be mapped, that is
    /// when the widget is visible (which is controlled with
    /// [`WidgetExt::set_visible()`][crate::prelude::WidgetExt::set_visible()]) and all its parents up to the toplevel widget
    /// are also visible. Once the map has occurred, [`map-event`][struct@crate::Widget#map-event] will
    /// be emitted.
    ///
    /// The ::map signal can be used to determine whether a widget will be drawn,
    /// for instance it can resume an animation that was stopped during the
    /// emission of [`unmap`][struct@crate::Widget#unmap].
    ///
    ///
    ///
    ///
    /// #### `map-event`
    ///  The ::map-event signal will be emitted when the `widget`'s window is
    /// mapped. A window is mapped when it becomes visible on the screen.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::STRUCTURE_MASK`][crate::gdk::EventMask::STRUCTURE_MASK] mask. GDK will enable this mask
    /// automatically for all new windows.
    ///
    ///
    ///
    ///
    /// #### `mnemonic-activate`
    ///  The default handler for this signal activates `widget` if `group_cycling`
    /// is [`false`], or just makes `widget` grab focus if `group_cycling` is [`true`].
    ///
    ///
    ///
    ///
    /// #### `motion-notify-event`
    ///  The ::motion-notify-event signal is emitted when the pointer moves
    /// over the widget's [`gdk::Window`][crate::gdk::Window].
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget
    /// needs to enable the [`gdk::EventMask::POINTER_MOTION_MASK`][crate::gdk::EventMask::POINTER_MOTION_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `move-focus`
    ///  Action
    ///
    ///
    /// #### `parent-set`
    ///  The ::parent-set signal is emitted when a new parent
    /// has been set on a widget.
    ///
    ///
    ///
    ///
    /// #### `popup-menu`
    ///  This signal gets emitted whenever a widget should pop up a context
    /// menu. This usually happens through the standard key binding mechanism;
    /// by pressing a certain key while a widget is focused, the user can cause
    /// the widget to pop up a menu. For example, the [`Entry`][crate::Entry] widget creates
    /// a menu with clipboard commands. See the
    /// [Popup Menu Migration Checklist][checklist-popup-menu]
    /// for an example of how to use this signal.
    ///
    /// Action
    ///
    ///
    /// #### `property-notify-event`
    ///  The ::property-notify-event signal will be emitted when a property on
    /// the `widget`'s window has been changed or deleted.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::PROPERTY_CHANGE_MASK`][crate::gdk::EventMask::PROPERTY_CHANGE_MASK] mask.
    ///
    ///
    ///
    ///
    /// #### `proximity-in-event`
    ///  To receive this signal the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::PROXIMITY_IN_MASK`][crate::gdk::EventMask::PROXIMITY_IN_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `proximity-out-event`
    ///  To receive this signal the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::PROXIMITY_OUT_MASK`][crate::gdk::EventMask::PROXIMITY_OUT_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `query-tooltip`
    ///  Emitted when [`has-tooltip`][struct@crate::Widget#has-tooltip] is [`true`] and the hover timeout
    /// has expired with the cursor hovering "above" `widget`; or emitted when `widget` got
    /// focus in keyboard mode.
    ///
    /// Using the given coordinates, the signal handler should determine
    /// whether a tooltip should be shown for `widget`. If this is the case
    /// [`true`] should be returned, [`false`] otherwise. Note that if
    /// `keyboard_mode` is [`true`], the values of `x` and `y` are undefined and
    /// should not be used.
    ///
    /// The signal handler is free to manipulate `tooltip` with the therefore
    /// destined function calls.
    ///
    ///
    ///
    ///
    /// #### `realize`
    ///  The ::realize signal is emitted when `widget` is associated with a
    /// [`gdk::Window`][crate::gdk::Window], which means that [`WidgetExt::realize()`][crate::prelude::WidgetExt::realize()] has been called or the
    /// widget has been mapped (that is, it is going to be drawn).
    ///
    ///
    ///
    ///
    /// #### `screen-changed`
    ///  The ::screen-changed signal gets emitted when the
    /// screen of a widget has changed.
    ///
    ///
    ///
    ///
    /// #### `scroll-event`
    ///  The ::scroll-event signal is emitted when a button in the 4 to 7
    /// range is pressed. Wheel mice are usually configured to generate
    /// button press events for buttons 4 and 5 when the wheel is turned.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::SCROLL_MASK`][crate::gdk::EventMask::SCROLL_MASK] mask.
    ///
    /// This signal will be sent to the grab widget if there is one.
    ///
    ///
    ///
    ///
    /// #### `selection-clear-event`
    ///  The ::selection-clear-event signal will be emitted when the
    /// the `widget`'s window has lost ownership of a selection.
    ///
    ///
    ///
    ///
    /// #### `selection-get`
    ///
    ///
    ///
    /// #### `selection-notify-event`
    ///
    ///
    ///
    /// #### `selection-received`
    ///
    ///
    ///
    /// #### `selection-request-event`
    ///  The ::selection-request-event signal will be emitted when
    /// another client requests ownership of the selection owned by
    /// the `widget`'s window.
    ///
    ///
    ///
    ///
    /// #### `show`
    ///  The ::show signal is emitted when `widget` is shown, for example with
    /// [`WidgetExt::show()`][crate::prelude::WidgetExt::show()].
    ///
    ///
    ///
    ///
    /// #### `show-help`
    ///  Action
    ///
    ///
    /// #### `size-allocate`
    ///
    ///
    ///
    /// #### `state-changed`
    ///  The ::state-changed signal is emitted when the widget state changes.
    /// See `gtk_widget_get_state()`.
    ///
    ///
    ///
    ///
    /// #### `state-flags-changed`
    ///  The ::state-flags-changed signal is emitted when the widget state
    /// changes, see [`WidgetExt::state_flags()`][crate::prelude::WidgetExt::state_flags()].
    ///
    ///
    ///
    ///
    /// #### `style-set`
    ///  The ::style-set signal is emitted when a new style has been set
    /// on a widget. Note that style-modifying functions like
    /// `gtk_widget_modify_base()` also cause this signal to be emitted.
    ///
    /// Note that this signal is emitted for changes to the deprecated
    /// `GtkStyle`. To track changes to the [`StyleContext`][crate::StyleContext] associated
    /// with a widget, use the [`style-updated`][struct@crate::Widget#style-updated] signal.
    ///
    ///
    ///
    ///
    /// #### `style-updated`
    ///  The ::style-updated signal is a convenience signal that is emitted when the
    /// [`changed`][struct@crate::StyleContext#changed] signal is emitted on the `widget`'s associated
    /// [`StyleContext`][crate::StyleContext] as returned by [`WidgetExt::style_context()`][crate::prelude::WidgetExt::style_context()].
    ///
    /// Note that style-modifying functions like `gtk_widget_override_color()` also
    /// cause this signal to be emitted.
    ///
    ///
    ///
    ///
    /// #### `touch-event`
    ///
    ///
    ///
    /// #### `unmap`
    ///  The ::unmap signal is emitted when `widget` is going to be unmapped, which
    /// means that either it or any of its parents up to the toplevel widget have
    /// been set as hidden.
    ///
    /// As ::unmap indicates that a widget will not be shown any longer, it can be
    /// used to, for example, stop an animation on the widget.
    ///
    ///
    ///
    ///
    /// #### `unmap-event`
    ///  The ::unmap-event signal will be emitted when the `widget`'s window is
    /// unmapped. A window is unmapped when it becomes invisible on the screen.
    ///
    /// To receive this signal, the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::STRUCTURE_MASK`][crate::gdk::EventMask::STRUCTURE_MASK] mask. GDK will enable this mask
    /// automatically for all new windows.
    ///
    ///
    ///
    ///
    /// #### `unrealize`
    ///  The ::unrealize signal is emitted when the [`gdk::Window`][crate::gdk::Window] associated with
    /// `widget` is destroyed, which means that [`WidgetExt::unrealize()`][crate::prelude::WidgetExt::unrealize()] has been
    /// called or the widget has been unmapped (that is, it is going to be
    /// hidden).
    ///
    ///
    ///
    ///
    /// #### `visibility-notify-event`
    ///  The ::visibility-notify-event will be emitted when the `widget`'s
    /// window is obscured or unobscured.
    ///
    /// To receive this signal the [`gdk::Window`][crate::gdk::Window] associated to the widget needs
    /// to enable the [`gdk::EventMask::VISIBILITY_NOTIFY_MASK`][crate::gdk::EventMask::VISIBILITY_NOTIFY_MASK] mask.
    ///
    ///
    ///
    ///
    /// #### `window-state-event`
    ///  The ::window-state-event will be emitted when the state of the
    /// toplevel window associated to the `widget` changes.
    ///
    /// To receive this signal the [`gdk::Window`][crate::gdk::Window] associated to the widget
    /// needs to enable the [`gdk::EventMask::STRUCTURE_MASK`][crate::gdk::EventMask::STRUCTURE_MASK] mask. GDK will enable
    /// this mask automatically for all new windows.
    ///
    ///
    /// </details>
    ///
    /// # Implements
    ///
    /// [`ToggleButtonExt`][trait@crate::prelude::ToggleButtonExt], [`ButtonExt`][trait@crate::prelude::ButtonExt], [`BinExt`][trait@crate::prelude::BinExt], [`ContainerExt`][trait@crate::prelude::ContainerExt], [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`ActionableExt`][trait@crate::prelude::ActionableExt], [`ContainerExtManual`][trait@crate::prelude::ContainerExtManual], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`BuildableExtManual`][trait@crate::prelude::BuildableExtManual]
    #[doc(alias = "GtkToggleButton")]
    pub struct ToggleButton(Object<ffi::GtkToggleButton, ffi::GtkToggleButtonClass>) @extends Button, Bin, Container, Widget, @implements Buildable, Actionable;

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

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

    /// Creates a new toggle button. A widget should be packed into the button, as in [`Button::new()`][crate::Button::new()].
    ///
    /// # Returns
    ///
    /// a new toggle button.
    #[doc(alias = "gtk_toggle_button_new")]
    pub fn new() -> ToggleButton {
        assert_initialized_main_thread!();
        unsafe { Widget::from_glib_none(ffi::gtk_toggle_button_new()).unsafe_cast() }
    }

    /// Creates a new toggle button with a text label.
    /// ## `label`
    /// a string containing the message to be placed in the toggle button.
    ///
    /// # Returns
    ///
    /// a new toggle button.
    #[doc(alias = "gtk_toggle_button_new_with_label")]
    #[doc(alias = "new_with_label")]
    pub fn with_label(label: &str) -> ToggleButton {
        assert_initialized_main_thread!();
        unsafe {
            Widget::from_glib_none(ffi::gtk_toggle_button_new_with_label(
                label.to_glib_none().0,
            ))
            .unsafe_cast()
        }
    }

    /// Creates a new [`ToggleButton`][crate::ToggleButton] containing a label. The label
    /// will be created using [`Label::with_mnemonic()`][crate::Label::with_mnemonic()], so underscores
    /// in `label` indicate the mnemonic for the button.
    /// ## `label`
    /// the text of the button, with an underscore in front of the
    ///  mnemonic character
    ///
    /// # Returns
    ///
    /// a new [`ToggleButton`][crate::ToggleButton]
    #[doc(alias = "gtk_toggle_button_new_with_mnemonic")]
    #[doc(alias = "new_with_mnemonic")]
    pub fn with_mnemonic(label: &str) -> ToggleButton {
        assert_initialized_main_thread!();
        unsafe {
            Widget::from_glib_none(ffi::gtk_toggle_button_new_with_mnemonic(
                label.to_glib_none().0,
            ))
            .unsafe_cast()
        }
    }

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

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

// rustdoc-stripper-ignore-next
/// A [builder-pattern] type to construct [`ToggleButton`] 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 ToggleButtonBuilder {
    builder: glib::object::ObjectBuilder<'static, ToggleButton>,
}

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

    pub fn active(self, active: bool) -> Self {
        Self {
            builder: self.builder.property("active", active),
        }
    }

    pub fn draw_indicator(self, draw_indicator: bool) -> Self {
        Self {
            builder: self.builder.property("draw-indicator", draw_indicator),
        }
    }

    pub fn inconsistent(self, inconsistent: bool) -> Self {
        Self {
            builder: self.builder.property("inconsistent", inconsistent),
        }
    }

    /// If [`true`], the button will ignore the [`gtk-button-images`][struct@crate::Settings#gtk-button-images]
    /// setting and always show the image, if available.
    ///
    /// Use this property if the button would be useless or hard to use
    /// without the image.
    pub fn always_show_image(self, always_show_image: bool) -> Self {
        Self {
            builder: self
                .builder
                .property("always-show-image", always_show_image),
        }
    }

    /// The child widget to appear next to the button text.
    pub fn image(self, image: &impl IsA<Widget>) -> Self {
        Self {
            builder: self.builder.property("image", image.clone().upcast()),
        }
    }

    /// The position of the image relative to the text inside the button.
    pub fn image_position(self, image_position: PositionType) -> Self {
        Self {
            builder: self.builder.property("image-position", image_position),
        }
    }

    pub fn label(self, label: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("label", label.into()),
        }
    }

    pub fn relief(self, relief: ReliefStyle) -> Self {
        Self {
            builder: self.builder.property("relief", relief),
        }
    }

    pub fn use_underline(self, use_underline: bool) -> Self {
        Self {
            builder: self.builder.property("use-underline", use_underline),
        }
    }

    pub fn border_width(self, border_width: u32) -> Self {
        Self {
            builder: self.builder.property("border-width", border_width),
        }
    }

    pub fn child(self, child: &impl IsA<Widget>) -> Self {
        Self {
            builder: self.builder.property("child", child.clone().upcast()),
        }
    }

    pub fn resize_mode(self, resize_mode: ResizeMode) -> Self {
        Self {
            builder: self.builder.property("resize-mode", resize_mode),
        }
    }

    pub fn app_paintable(self, app_paintable: bool) -> Self {
        Self {
            builder: self.builder.property("app-paintable", app_paintable),
        }
    }

    pub fn can_default(self, can_default: bool) -> Self {
        Self {
            builder: self.builder.property("can-default", can_default),
        }
    }

    pub fn can_focus(self, can_focus: bool) -> Self {
        Self {
            builder: self.builder.property("can-focus", can_focus),
        }
    }

    pub fn events(self, events: gdk::EventMask) -> Self {
        Self {
            builder: self.builder.property("events", events),
        }
    }

    /// Whether to expand in both directions. Setting this sets both [`hexpand`][struct@crate::Widget#hexpand] and [`vexpand`][struct@crate::Widget#vexpand]
    pub fn expand(self, expand: bool) -> Self {
        Self {
            builder: self.builder.property("expand", expand),
        }
    }

    /// Whether the widget should grab focus when it is clicked with the mouse.
    ///
    /// This property is only relevant for widgets that can take focus.
    ///
    /// Before 3.20, several widgets (GtkButton, GtkFileChooserButton,
    /// GtkComboBox) implemented this property individually.
    pub fn focus_on_click(self, focus_on_click: bool) -> Self {
        Self {
            builder: self.builder.property("focus-on-click", focus_on_click),
        }
    }

    /// How to distribute horizontal space if widget gets extra space, see [`Align`][crate::Align]
    pub fn halign(self, halign: Align) -> Self {
        Self {
            builder: self.builder.property("halign", halign),
        }
    }

    pub fn has_default(self, has_default: bool) -> Self {
        Self {
            builder: self.builder.property("has-default", has_default),
        }
    }

    pub fn has_focus(self, has_focus: bool) -> Self {
        Self {
            builder: self.builder.property("has-focus", has_focus),
        }
    }

    /// Enables or disables the emission of [`query-tooltip`][struct@crate::Widget#query-tooltip] on `widget`.
    /// A value of [`true`] indicates that `widget` can have a tooltip, in this case
    /// the widget will be queried using [`query-tooltip`][struct@crate::Widget#query-tooltip] to determine
    /// whether it will provide a tooltip or not.
    ///
    /// Note that setting this property to [`true`] for the first time will change
    /// the event masks of the GdkWindows of this widget to include leave-notify
    /// and motion-notify events. This cannot and will not be undone when the
    /// property is set to [`false`] again.
    pub fn has_tooltip(self, has_tooltip: bool) -> Self {
        Self {
            builder: self.builder.property("has-tooltip", has_tooltip),
        }
    }

    pub fn height_request(self, height_request: i32) -> Self {
        Self {
            builder: self.builder.property("height-request", height_request),
        }
    }

    /// Whether to expand horizontally. See [`WidgetExt::set_hexpand()`][crate::prelude::WidgetExt::set_hexpand()].
    pub fn hexpand(self, hexpand: bool) -> Self {
        Self {
            builder: self.builder.property("hexpand", hexpand),
        }
    }

    /// Whether to use the [`hexpand`][struct@crate::Widget#hexpand] property. See [`WidgetExt::is_hexpand_set()`][crate::prelude::WidgetExt::is_hexpand_set()].
    pub fn hexpand_set(self, hexpand_set: bool) -> Self {
        Self {
            builder: self.builder.property("hexpand-set", hexpand_set),
        }
    }

    pub fn is_focus(self, is_focus: bool) -> Self {
        Self {
            builder: self.builder.property("is-focus", is_focus),
        }
    }

    /// Sets all four sides' margin at once. If read, returns max
    /// margin on any side.
    pub fn margin(self, margin: i32) -> Self {
        Self {
            builder: self.builder.property("margin", margin),
        }
    }

    /// Margin on bottom side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_bottom(self, margin_bottom: i32) -> Self {
        Self {
            builder: self.builder.property("margin-bottom", margin_bottom),
        }
    }

    /// Margin on end of widget, horizontally. This property supports
    /// left-to-right and right-to-left text directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_end(self, margin_end: i32) -> Self {
        Self {
            builder: self.builder.property("margin-end", margin_end),
        }
    }

    /// Margin on start of widget, horizontally. This property supports
    /// left-to-right and right-to-left text directions.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_start(self, margin_start: i32) -> Self {
        Self {
            builder: self.builder.property("margin-start", margin_start),
        }
    }

    /// Margin on top side of widget.
    ///
    /// This property adds margin outside of the widget's normal size
    /// request, the margin will be added in addition to the size from
    /// [`WidgetExt::set_size_request()`][crate::prelude::WidgetExt::set_size_request()] for example.
    pub fn margin_top(self, margin_top: i32) -> Self {
        Self {
            builder: self.builder.property("margin-top", margin_top),
        }
    }

    pub fn name(self, name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("name", name.into()),
        }
    }

    pub fn no_show_all(self, no_show_all: bool) -> Self {
        Self {
            builder: self.builder.property("no-show-all", no_show_all),
        }
    }

    /// The requested opacity of the widget. See [`WidgetExt::set_opacity()`][crate::prelude::WidgetExt::set_opacity()] for
    /// more details about window opacity.
    ///
    /// Before 3.8 this was only available in GtkWindow
    pub fn opacity(self, opacity: f64) -> Self {
        Self {
            builder: self.builder.property("opacity", opacity),
        }
    }

    pub fn parent(self, parent: &impl IsA<Container>) -> Self {
        Self {
            builder: self.builder.property("parent", parent.clone().upcast()),
        }
    }

    pub fn receives_default(self, receives_default: bool) -> Self {
        Self {
            builder: self.builder.property("receives-default", receives_default),
        }
    }

    pub fn sensitive(self, sensitive: bool) -> Self {
        Self {
            builder: self.builder.property("sensitive", sensitive),
        }
    }

    /// Sets the text of tooltip to be the given string, which is marked up
    /// with the [Pango text markup language][PangoMarkupFormat].
    /// Also see [`Tooltip::set_markup()`][crate::Tooltip::set_markup()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    pub fn tooltip_markup(self, tooltip_markup: impl Into<glib::GString>) -> Self {
        Self {
            builder: self
                .builder
                .property("tooltip-markup", tooltip_markup.into()),
        }
    }

    /// Sets the text of tooltip to be the given string.
    ///
    /// Also see [`Tooltip::set_text()`][crate::Tooltip::set_text()].
    ///
    /// This is a convenience property which will take care of getting the
    /// tooltip shown if the given string is not [`None`]: [`has-tooltip`][struct@crate::Widget#has-tooltip]
    /// will automatically be set to [`true`] and there will be taken care of
    /// [`query-tooltip`][struct@crate::Widget#query-tooltip] in the default signal handler.
    ///
    /// Note that if both [`tooltip-text`][struct@crate::Widget#tooltip-text] and [`tooltip-markup`][struct@crate::Widget#tooltip-markup]
    /// are set, the last one wins.
    pub fn tooltip_text(self, tooltip_text: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("tooltip-text", tooltip_text.into()),
        }
    }

    /// How to distribute vertical space if widget gets extra space, see [`Align`][crate::Align]
    pub fn valign(self, valign: Align) -> Self {
        Self {
            builder: self.builder.property("valign", valign),
        }
    }

    /// Whether to expand vertically. See [`WidgetExt::set_vexpand()`][crate::prelude::WidgetExt::set_vexpand()].
    pub fn vexpand(self, vexpand: bool) -> Self {
        Self {
            builder: self.builder.property("vexpand", vexpand),
        }
    }

    /// Whether to use the [`vexpand`][struct@crate::Widget#vexpand] property. See [`WidgetExt::is_vexpand_set()`][crate::prelude::WidgetExt::is_vexpand_set()].
    pub fn vexpand_set(self, vexpand_set: bool) -> Self {
        Self {
            builder: self.builder.property("vexpand-set", vexpand_set),
        }
    }

    pub fn visible(self, visible: bool) -> Self {
        Self {
            builder: self.builder.property("visible", visible),
        }
    }

    pub fn width_request(self, width_request: i32) -> Self {
        Self {
            builder: self.builder.property("width-request", width_request),
        }
    }

    pub fn action_name(self, action_name: impl Into<glib::GString>) -> Self {
        Self {
            builder: self.builder.property("action-name", action_name.into()),
        }
    }

    pub fn action_target(self, action_target: &glib::Variant) -> Self {
        Self {
            builder: self
                .builder
                .property("action-target", action_target.clone()),
        }
    }

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

/// Trait containing all [`struct@ToggleButton`] methods.
///
/// # Implementors
///
/// [`CheckButton`][struct@crate::CheckButton], [`MenuButton`][struct@crate::MenuButton], [`ToggleButton`][struct@crate::ToggleButton]
pub trait ToggleButtonExt: IsA<ToggleButton> + 'static {
    /// Queries a [`ToggleButton`][crate::ToggleButton] and returns its current state. Returns [`true`] if
    /// the toggle button is pressed in and [`false`] if it is raised.
    ///
    /// # Returns
    ///
    /// a `gboolean` value.
    #[doc(alias = "gtk_toggle_button_get_active")]
    #[doc(alias = "get_active")]
    #[doc(alias = "active")]
    fn is_active(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_toggle_button_get_active(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Gets the value set by [`set_inconsistent()`][Self::set_inconsistent()].
    ///
    /// # Returns
    ///
    /// [`true`] if the button is displayed as inconsistent, [`false`] otherwise
    #[doc(alias = "gtk_toggle_button_get_inconsistent")]
    #[doc(alias = "get_inconsistent")]
    #[doc(alias = "inconsistent")]
    fn is_inconsistent(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_toggle_button_get_inconsistent(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Retrieves whether the button is displayed as a separate indicator
    /// and label. See [`set_mode()`][Self::set_mode()].
    ///
    /// # Returns
    ///
    /// [`true`] if the togglebutton is drawn as a separate indicator
    ///  and label.
    #[doc(alias = "gtk_toggle_button_get_mode")]
    #[doc(alias = "get_mode")]
    fn is_mode(&self) -> bool {
        unsafe {
            from_glib(ffi::gtk_toggle_button_get_mode(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Sets the status of the toggle button. Set to [`true`] if you want the
    /// GtkToggleButton to be “pressed in”, and [`false`] to raise it.
    /// This action causes the [`toggled`][struct@crate::ToggleButton#toggled] signal and the
    /// [`clicked`][struct@crate::Button#clicked] signal to be emitted.
    /// ## `is_active`
    /// [`true`] or [`false`].
    #[doc(alias = "gtk_toggle_button_set_active")]
    #[doc(alias = "active")]
    fn set_active(&self, is_active: bool) {
        unsafe {
            ffi::gtk_toggle_button_set_active(
                self.as_ref().to_glib_none().0,
                is_active.into_glib(),
            );
        }
    }

    /// If the user has selected a range of elements (such as some text or
    /// spreadsheet cells) that are affected by a toggle button, and the
    /// current values in that range are inconsistent, you may want to
    /// display the toggle in an “in between” state. This function turns on
    /// “in between” display. Normally you would turn off the inconsistent
    /// state again if the user toggles the toggle button. This has to be
    /// done manually, [`set_inconsistent()`][Self::set_inconsistent()] only affects
    /// visual appearance, it doesn’t affect the semantics of the button.
    /// ## `setting`
    /// [`true`] if state is inconsistent
    #[doc(alias = "gtk_toggle_button_set_inconsistent")]
    #[doc(alias = "inconsistent")]
    fn set_inconsistent(&self, setting: bool) {
        unsafe {
            ffi::gtk_toggle_button_set_inconsistent(
                self.as_ref().to_glib_none().0,
                setting.into_glib(),
            );
        }
    }

    /// Sets whether the button is displayed as a separate indicator and label.
    /// You can call this function on a checkbutton or a radiobutton with
    /// `draw_indicator` = [`false`] to make the button look like a normal button.
    ///
    /// This can be used to create linked strip of buttons that work like
    /// a [`StackSwitcher`][crate::StackSwitcher].
    ///
    /// This function only affects instances of classes like [`CheckButton`][crate::CheckButton]
    /// and [`RadioButton`][crate::RadioButton] that derive from [`ToggleButton`][crate::ToggleButton],
    /// not instances of [`ToggleButton`][crate::ToggleButton] itself.
    /// ## `draw_indicator`
    /// if [`true`], draw the button as a separate indicator
    /// and label; if [`false`], draw the button like a normal button
    #[doc(alias = "gtk_toggle_button_set_mode")]
    fn set_mode(&self, draw_indicator: bool) {
        unsafe {
            ffi::gtk_toggle_button_set_mode(
                self.as_ref().to_glib_none().0,
                draw_indicator.into_glib(),
            );
        }
    }

    /// Emits the [`toggled`][struct@crate::ToggleButton#toggled] signal on the
    /// [`ToggleButton`][crate::ToggleButton]. There is no good reason for an
    /// application ever to call this function.
    #[doc(alias = "gtk_toggle_button_toggled")]
    fn toggled(&self) {
        unsafe {
            ffi::gtk_toggle_button_toggled(self.as_ref().to_glib_none().0);
        }
    }

    #[doc(alias = "draw-indicator")]
    fn draws_indicator(&self) -> bool {
        ObjectExt::property(self.as_ref(), "draw-indicator")
    }

    #[doc(alias = "draw-indicator")]
    fn set_draw_indicator(&self, draw_indicator: bool) {
        ObjectExt::set_property(self.as_ref(), "draw-indicator", draw_indicator)
    }

    /// Should be connected if you wish to perform an action whenever the
    /// [`ToggleButton`][crate::ToggleButton]'s state is changed.
    #[doc(alias = "toggled")]
    fn connect_toggled<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn toggled_trampoline<P: IsA<ToggleButton>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkToggleButton,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(ToggleButton::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"toggled".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    toggled_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "active")]
    fn connect_active_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_active_trampoline<P: IsA<ToggleButton>, F: Fn(&P) + 'static>(
            this: *mut ffi::GtkToggleButton,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(ToggleButton::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::active".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_active_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "draw-indicator")]
    fn connect_draw_indicator_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_draw_indicator_trampoline<
            P: IsA<ToggleButton>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkToggleButton,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(ToggleButton::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::draw-indicator".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_draw_indicator_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }

    #[doc(alias = "inconsistent")]
    fn connect_inconsistent_notify<F: Fn(&Self) + 'static>(&self, f: F) -> SignalHandlerId {
        unsafe extern "C" fn notify_inconsistent_trampoline<
            P: IsA<ToggleButton>,
            F: Fn(&P) + 'static,
        >(
            this: *mut ffi::GtkToggleButton,
            _param_spec: glib::ffi::gpointer,
            f: glib::ffi::gpointer,
        ) {
            unsafe {
                let f: &F = &*(f as *const F);
                f(ToggleButton::from_glib_borrow(this).unsafe_cast_ref())
            }
        }
        unsafe {
            let f: Box_<F> = Box_::new(f);
            connect_raw(
                self.as_ptr() as *mut _,
                c"notify::inconsistent".as_ptr(),
                Some(std::mem::transmute::<*const (), unsafe extern "C" fn()>(
                    notify_inconsistent_trampoline::<Self, F> as *const (),
                )),
                Box_::into_raw(f),
            )
        }
    }
}

impl<O: IsA<ToggleButton>> ToggleButtonExt for O {}