Struct Overlay

pub struct Overlay(/* private fields */);

Implementations

impl Overlay

pub fn new<M>(widget: M) -> Overlay

where M: WidgetBuilder + 'static + Clone,

Create overlay from Clone able widget.

Example

use ribir::prelude::*;
let w = fn_widget! {
let overlay = Overlay::new(
   fn_widget! {
     @Text {
       h_align: HAlign::Center,
       v_align: VAlign::Center,
       text: "Hello"
     }
   }
 );
 @FilledButton{
   on_tap: move |e| overlay.show(e.window()),
   @{ Label::new("Click to show overlay") }
 }
};
App::run(w);

pub fn new_with_handle<O, M>(builder: M) -> Overlay

where M: Fn(OverlayCloseHandle) -> O + 'static, O: WidgetBuilder + 'static,

Create overlay from a builder with a close_handle

Example

popup a widget of a button which will close when clicked.

use ribir::prelude::*;
let w = fn_widget! {
  let overlay = Overlay::new_with_handle(
    move |ctrl: OverlayCloseHandle| {
      let ctrl = ctrl.clone();
      fn_widget! {
        @FilledButton {
          h_align: HAlign::Center,
          v_align: VAlign::Center,
          on_tap: move |_| ctrl.close(),
          @{ Label::new("Click to close") }
        }
      }
    }
  );
  @FilledButton {
    on_tap: move |e| overlay.show(e.window()),
    @{ Label::new("Click to show overlay") }
  }
};

App::run(w).with_size(Size::new(200., 200.));

pub fn with_style(&self, style: OverlayStyle)

Overlay will show with the given style, if the overlay have not been set with style, the default style will be get from the theme.

pub fn show(&self, wnd: Rc<Window>)

the Overlay widget will be show at the top level of all widget. if the overlay is showing, nothing will happen.

pub fn show_map<O, F>(&self, f: F, wnd: Rc<Window>)

where F: Fn(Box<dyn for<'a, 'b> FnOnce(&'a BuildCtx<'b>) -> Widget>, OverlayCloseHandle) -> O + 'static, O: WidgetBuilder + 'static,

User can make transform before the widget show at the top level of all widget. if the overlay is showing, nothing will happen.

Example

Overlay widget which auto align horizontal position to the src button even when window’s size changed

use ribir::prelude::*;
let w = fn_widget! {
  let overlay = Overlay::new(
    fn_widget! { @Text { text: "overlay" } }
  );
  let button = @FilledButton{};
  let wid = button.lazy_host_id();
  @$button {
    h_align: HAlign::Center,
    v_align: VAlign::Center,
    on_tap: move |e| {
      let wid = wid.clone();
      overlay.show_map(
        move |w, _| {
          let wid = wid.clone();
          fn_widget! {
            let mut w = @$w {};
            w.left_align_to(&wid, 0., ctx!());
            w
          }
        },
        e.window()
      );
    },
    @{ Label::new("Click to show overlay") }
  }
};
App::run(w);

pub fn show_at(&self, pos: Point2D<f32, LogicUnit>, wnd: Rc<Window>)

Show the widget at the give position. if the overlay is showing, nothing will happen.

pub fn is_show(&self) -> bool

return whether the overlay is show.

pub fn close(&self)

remove the showing overlay.

Trait Implementations

impl Clone for Overlay

fn clone(&self) -> Overlay

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.