// This file was generated by gir (https://github.com/gtk-rs/gir)
// from gir-files (https://github.com/gtk-rs/gir-files)
// from gst-gir-files (https://gitlab.freedesktop.org/gstreamer/gir-files-rs.git)
// DO NOT EDIT
#![allow(deprecated)]

use crate::{
    Extractable, MetaContainer, Operation, TextHAlign, TextVAlign, TimelineElement, TrackElement,
};
use glib::{prelude::*, translate::*};

glib::wrapper! {
    ///
    ///
    /// # Implements
    ///
    /// [`TextOverlayExt`][trait@crate::prelude::TextOverlayExt], [`OperationExt`][trait@crate::prelude::OperationExt], [`TrackElementExt`][trait@crate::prelude::TrackElementExt], [`TimelineElementExt`][trait@crate::prelude::TimelineElementExt], [`trait@glib::ObjectExt`], [`ExtractableExt`][trait@crate::prelude::ExtractableExt], [`MetaContainerExt`][trait@crate::prelude::MetaContainerExt], [`TimelineElementExtManual`][trait@crate::prelude::TimelineElementExtManual]
    #[doc(alias = "GESTextOverlay")]
    pub struct TextOverlay(Object<ffi::GESTextOverlay, ffi::GESTextOverlayClass>) @extends Operation, TrackElement, TimelineElement, @implements Extractable, MetaContainer;

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

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

    /// Creates a new [`TextOverlay`][crate::TextOverlay].
    ///
    /// # Deprecated since 1.18
    ///
    /// This should never be called by applications as this will
    /// be created by clips.
    ///
    /// # Returns
    ///
    /// The newly created [`TextOverlay`][crate::TextOverlay] or
    /// [`None`] if something went wrong.
    #[cfg_attr(feature = "v1_18", deprecated = "Since 1.18")]
    #[allow(deprecated)]
    #[doc(alias = "ges_text_overlay_new")]
    pub fn new() -> Option<TextOverlay> {
        assert_initialized_main_thread!();
        unsafe { from_glib_none(ffi::ges_text_overlay_new()) }
    }
}

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

/// Trait containing all [`struct@TextOverlay`] methods.
///
/// # Implementors
///
/// [`TextOverlay`][struct@crate::TextOverlay]
pub trait TextOverlayExt: IsA<TextOverlay> + sealed::Sealed + 'static {
    /// Get the color used by `source`.
    ///
    /// # Returns
    ///
    /// The color used by `source`.
    #[doc(alias = "ges_text_overlay_get_color")]
    #[doc(alias = "get_color")]
    fn color(&self) -> u32 {
        unsafe { ffi::ges_text_overlay_get_color(self.as_ref().to_glib_none().0) }
    }

    /// Get the pango font description currently set on `source`.
    ///
    /// # Returns
    ///
    /// The pango font description currently set on `source`.
    #[doc(alias = "ges_text_overlay_get_font_desc")]
    #[doc(alias = "get_font_desc")]
    fn font_desc(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::ges_text_overlay_get_font_desc(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Get the horizontal aligment used by `source`.
    ///
    /// # Returns
    ///
    /// The horizontal aligment used by `source`.
    #[doc(alias = "ges_text_overlay_get_halignment")]
    #[doc(alias = "get_halignment")]
    fn halignment(&self) -> TextHAlign {
        unsafe {
            from_glib(ffi::ges_text_overlay_get_halignment(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Get the text currently set on `source`.
    ///
    /// # Returns
    ///
    /// The text currently set on `source`.
    #[doc(alias = "ges_text_overlay_get_text")]
    #[doc(alias = "get_text")]
    fn text(&self) -> Option<glib::GString> {
        unsafe {
            from_glib_none(ffi::ges_text_overlay_get_text(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Get the vertical aligment used by `source`.
    ///
    /// # Returns
    ///
    /// The vertical aligment used by `source`.
    #[doc(alias = "ges_text_overlay_get_valignment")]
    #[doc(alias = "get_valignment")]
    fn valignment(&self) -> TextVAlign {
        unsafe {
            from_glib(ffi::ges_text_overlay_get_valignment(
                self.as_ref().to_glib_none().0,
            ))
        }
    }

    /// Get the horizontal position used by `source`.
    ///
    /// # Returns
    ///
    /// The horizontal position used by `source`.
    #[doc(alias = "ges_text_overlay_get_xpos")]
    #[doc(alias = "get_xpos")]
    fn xpos(&self) -> f64 {
        unsafe { ffi::ges_text_overlay_get_xpos(self.as_ref().to_glib_none().0) }
    }

    /// Get the vertical position used by `source`.
    ///
    /// # Returns
    ///
    /// The vertical position used by `source`.
    #[doc(alias = "ges_text_overlay_get_ypos")]
    #[doc(alias = "get_ypos")]
    fn ypos(&self) -> f64 {
        unsafe { ffi::ges_text_overlay_get_ypos(self.as_ref().to_glib_none().0) }
    }

    /// Sets the color of the text.
    /// ## `color`
    /// The color `self` is being set to
    #[doc(alias = "ges_text_overlay_set_color")]
    fn set_color(&self, color: u32) {
        unsafe {
            ffi::ges_text_overlay_set_color(self.as_ref().to_glib_none().0, color);
        }
    }

    /// Sets the pango font description of the text this track element
    /// will render.
    /// ## `font_desc`
    /// the pango font description
    #[doc(alias = "ges_text_overlay_set_font_desc")]
    fn set_font_desc(&self, font_desc: Option<&str>) {
        unsafe {
            ffi::ges_text_overlay_set_font_desc(
                self.as_ref().to_glib_none().0,
                font_desc.to_glib_none().0,
            );
        }
    }

    /// Sets the horizontal aligment of the text.
    /// ## `halign`
    /// The [`TextHAlign`][crate::TextHAlign] defining the horizontal alignment
    /// of the text render by `self`.
    #[doc(alias = "ges_text_overlay_set_halignment")]
    fn set_halignment(&self, halign: TextHAlign) {
        unsafe {
            ffi::ges_text_overlay_set_halignment(
                self.as_ref().to_glib_none().0,
                halign.into_glib(),
            );
        }
    }

    /// Sets the text this track element will render.
    /// ## `text`
    /// the text to render. an internal copy of this text will be
    /// made.
    #[doc(alias = "ges_text_overlay_set_text")]
    fn set_text(&self, text: Option<&str>) {
        unsafe {
            ffi::ges_text_overlay_set_text(self.as_ref().to_glib_none().0, text.to_glib_none().0);
        }
    }

    /// Sets the vertical aligment of the text.
    /// ## `valign`
    /// The [`TextVAlign`][crate::TextVAlign] defining the vertical alignment
    /// of the text render by `self`.
    #[doc(alias = "ges_text_overlay_set_valignment")]
    fn set_valignment(&self, valign: TextVAlign) {
        unsafe {
            ffi::ges_text_overlay_set_valignment(
                self.as_ref().to_glib_none().0,
                valign.into_glib(),
            );
        }
    }

    /// Sets the horizontal position of the text.
    /// ## `position`
    /// The horizontal position `self` is being set to
    #[doc(alias = "ges_text_overlay_set_xpos")]
    fn set_xpos(&self, position: f64) {
        unsafe {
            ffi::ges_text_overlay_set_xpos(self.as_ref().to_glib_none().0, position);
        }
    }

    /// Sets the vertical position of the text.
    /// ## `position`
    /// The vertical position `self` is being set to
    #[doc(alias = "ges_text_overlay_set_ypos")]
    fn set_ypos(&self, position: f64) {
        unsafe {
            ffi::ges_text_overlay_set_ypos(self.as_ref().to_glib_none().0, position);
        }
    }
}

impl<O: IsA<TextOverlay>> TextOverlayExt for O {}