gtk/auto/

drawing_area.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::{Align, Buildable, Container, Widget};
use glib::{prelude::*, translate::*};
use std::fmt;

glib::wrapper! {
    /// The [`DrawingArea`][crate::DrawingArea] widget is used for creating custom user interface
    /// elements. It’s essentially a blank widget; you can draw on it. After
    /// creating a drawing area, the application may want to connect to:
    ///
    /// - Mouse and button press signals to respond to input from
    ///  the user. (Use [`WidgetExtManual::add_events()`][crate::prelude::WidgetExtManual::add_events()] to enable events
    ///  you wish to receive.)
    ///
    /// - The [`realize`][struct@crate::Widget#realize] signal to take any necessary actions
    ///  when the widget is instantiated on a particular display.
    ///  (Create GDK resources in response to this signal.)
    ///
    /// - The [`size-allocate`][struct@crate::Widget#size-allocate] signal to take any necessary
    ///  actions when the widget changes size.
    ///
    /// - The [`draw`][struct@crate::Widget#draw] signal to handle redrawing the
    ///  contents of the widget.
    ///
    /// The following code portion demonstrates using a drawing
    /// area to display a circle in the normal widget foreground
    /// color.
    ///
    /// Note that GDK automatically clears the exposed area before sending
    /// the expose event, and that drawing is implicitly clipped to the exposed
    /// area. If you want to have a theme-provided background, you need
    /// to call [`render_background()`][crate::render_background()] in your ::draw method.
    ///
    /// ## Simple GtkDrawingArea usage
    ///
    ///
    ///
    /// **⚠️ The following code is in C ⚠️**
    ///
    /// ```C
    /// gboolean
    /// draw_callback (GtkWidget *widget, cairo_t *cr, gpointer data)
    /// {
    ///   guint width, height;
    ///   GdkRGBA color;
    ///   GtkStyleContext *context;
    ///
    ///   context = gtk_widget_get_style_context (widget);
    ///
    ///   width = gtk_widget_get_allocated_width (widget);
    ///   height = gtk_widget_get_allocated_height (widget);
    ///
    ///   gtk_render_background (context, cr, 0, 0, width, height);
    ///
    ///   cairo_arc (cr,
    ///              width / 2.0, height / 2.0,
    ///              MIN (width, height) / 2.0,
    ///              0, 2 * G_PI);
    ///
    ///   gtk_style_context_get_color (context,
    ///                                gtk_style_context_get_state (context),
    ///                                &color);
    ///   gdk_cairo_set_source_rgba (cr, &color);
    ///
    ///   cairo_fill (cr);
    ///
    ///  return FALSE;
    /// }
    /// [...]
    ///   GtkWidget *drawing_area = gtk_drawing_area_new ();
    ///   gtk_widget_set_size_request (drawing_area, 100, 100);
    ///   g_signal_connect (G_OBJECT (drawing_area), "draw",
    ///                     G_CALLBACK (draw_callback), NULL);
    /// ```
    ///
    /// Draw signals are normally delivered when a drawing area first comes
    /// onscreen, or when it’s covered by another window and then uncovered.
    /// You can also force an expose event by adding to the “damage region”
    /// of the drawing area’s window; [`WidgetExt::queue_draw_area()`][crate::prelude::WidgetExt::queue_draw_area()] and
    /// [`Window::invalidate_rect()`][crate::gdk::Window::invalidate_rect()] are equally good ways to do this.
    /// You’ll then get a draw signal for the invalid region.
    ///
    /// The available routines for drawing are documented on the
    /// [GDK Drawing Primitives][gdk3-Cairo-Interaction] page
    /// and the cairo documentation.
    ///
    /// To receive mouse events on a drawing area, you will need to enable
    /// them with [`WidgetExtManual::add_events()`][crate::prelude::WidgetExtManual::add_events()]. To receive keyboard events, you
    /// will need to set the “can-focus” property on the drawing area, and you
    /// should probably draw some user-visible indication that the drawing
    /// area is focused. Use [`WidgetExt::has_focus()`][crate::prelude::WidgetExt::has_focus()] in your expose event
    /// handler to decide whether to draw the focus indicator. See
    /// [`render_focus()`][crate::render_focus()] for one way to draw focus.
    ///
    /// # Implements
    ///
    /// [`WidgetExt`][trait@crate::prelude::WidgetExt], [`trait@glib::ObjectExt`], [`BuildableExt`][trait@crate::prelude::BuildableExt], [`WidgetExtManual`][trait@crate::prelude::WidgetExtManual], [`BuildableExtManual`][trait@crate::prelude::BuildableExtManual]
    #[doc(alias = "GtkDrawingArea")]
    pub struct DrawingArea(Object<ffi::GtkDrawingArea, ffi::GtkDrawingAreaClass>) @extends Widget, @implements Buildable;

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

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

    /// Creates a new drawing area.
    ///
    /// # Returns
    ///
    /// a new [`DrawingArea`][crate::DrawingArea]
    #[doc(alias = "gtk_drawing_area_new")]
    pub fn new() -> DrawingArea {
        assert_initialized_main_thread!();
        unsafe { Widget::from_glib_none(ffi::gtk_drawing_area_new()).unsafe_cast() }
    }

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

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

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

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

    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),
        }
    }

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

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