Struct widgetry::widgets::panel::Panel

pub struct Panel {
    top_level: Widget,
    cached_flexbox: Option<(Stretch, Vec<Node>, ScreenDims)>,
    horiz: HorizontalAlignment,
    vert: VerticalAlignment,
    dims: Dims,
    scrollable_x: bool,
    scrollable_y: bool,
    contents_dims: ScreenDims,
    container_dims: ScreenDims,
    clip_rect: Option<ScreenRectangle>,
}

Fields

top_level: Widget

cached_flexbox: Option<(Stretch, Vec<Node>, ScreenDims)>

horiz: HorizontalAlignment

vert: VerticalAlignment

dims: Dims

scrollable_x: bool

scrollable_y: bool

contents_dims: ScreenDims

container_dims: ScreenDims

clip_rect: Option<ScreenRectangle>

Implementations

impl Panel

pub fn new_builder(top_level: Widget) -> PanelBuilder

pub fn empty(ctx: &mut EventCtx<'_>) -> Panel

Returns an empty panel. event and draw will have no effect.

fn update_container_dims_for_canvas_dims(&mut self, canvas_dims: ScreenDims)

fn recompute_scrollbar_layout(&mut self, ctx: &EventCtx<'_>)

fn recompute_layout(&mut self, ctx: &EventCtx<'_>, recompute_bg: bool)

fn invalidate_flexbox(&mut self)

fn compute_flexbox(&self) -> (Stretch, Vec<Node>, ScreenDims)

fn recompute_layout_if_needed(&mut self, ctx: &EventCtx<'_>, recompute_bg: bool)

fn scroll_offset(&self) -> (f64, f64)

fn update_scroll_sliders(
    &mut self,
    ctx: &EventCtx<'_>,
    offset: (f64, f64)
) -> bool

fn set_scroll_offset(&mut self, ctx: &EventCtx<'_>, offset: (f64, f64))

pub fn event(&mut self, ctx: &mut EventCtx<'_>) -> Outcome

pub fn draw(&self, g: &mut GfxCtx<'_>)

pub fn get_all_click_actions(&self) -> HashSet<String>

pub fn restore(&mut self, ctx: &mut EventCtx<'_>, prev: &Panel)

pub fn restore_scroll(&mut self, ctx: &mut EventCtx<'_>, prev: &Panel)

pub fn scroll_to_member(&mut self, ctx: &EventCtx<'_>, name: String)

pub fn has_widget(&self, name: &str) -> bool

pub fn slider(&self, name: &str) -> &Slider

pub fn slider_mut(&mut self, name: &str) -> &mut Slider

pub fn take_menu_choice<T: 'static>(&mut self, name: &str) -> T

pub fn is_checked(&self, name: &str) -> bool

pub fn maybe_is_checked(&self, name: &str) -> Option<bool>

pub fn set_checked(&mut self, name: &str, on_off: bool)

pub fn text_box(&self, name: &str) -> String

pub fn spinner<T: 'static + SpinnerValue>(&self, name: &str) -> T

pub fn modify_spinner<T: 'static + SpinnerValue>(
    &mut self,
    ctx: &EventCtx<'_>,
    name: &str,
    delta: T
)

pub fn dropdown_value<T: 'static + PartialEq + Clone, I: AsRef<str>>(
    &self,
    name: I
) -> T

pub fn maybe_dropdown_value<T: 'static + PartialEq + Clone, I: AsRef<str>>(
    &self,
    name: I
) -> Option<T>

pub fn persistent_split_value<T: 'static + PartialEq + Clone>(
    &self,
    name: &str
) -> T

pub fn autocomplete_done<T: 'static + Clone>(
    &mut self,
    name: &str
) -> Option<Vec<T>>

Consumes the autocomplete widget. It’s fine if the panel survives past this event; the autocomplete just needs to be interacted with again to produce more values.

pub fn stash<T: 'static>(&self, name: &str) -> Rc<RefCell<T>>

Grab a stashed value, with the ability to pass it around and modify it.

pub fn clone_stashed<T: 'static + Clone>(&self, name: &str) -> T

Grab a stashed value and clone it.

pub fn is_button_enabled(&self, name: &str) -> bool

pub fn maybe_find_widget(&self, name: &str) -> Option<&Widget>

pub fn maybe_find<T: WidgetImpl>(&self, name: &str) -> Option<&T>

pub fn find<T: WidgetImpl>(&self, name: &str) -> &T

pub fn find_mut<T: WidgetImpl>(&mut self, name: &str) -> &mut T

pub(crate) fn swap_inner_content(
    &mut self,
    ctx: &EventCtx<'_>,
    container_name: &str,
    new_inner_content: &mut Widget
)

Swap the inner content of a container widget with new_inner_content.

pub fn rect_of(&self, name: &str) -> &ScreenRectangle

pub fn center_of(&self, name: &str) -> ScreenPt

pub fn center_of_panel(&self) -> ScreenPt

pub fn panel_dims(&self) -> ScreenDims

pub fn align(&mut self, horiz: HorizontalAlignment, vert: VerticalAlignment)

pub fn replace(&mut self, ctx: &mut EventCtx<'_>, id: &str, new: Widget)

All margins/padding/etc from the previous widget are retained. The ID is set on the new widget; no need to do that yourself.

pub fn take(&mut self, id: &str) -> Widget

Removes a widget from the panel. Does not recalculate layout!

pub fn clicked_outside(&self, ctx: &mut EventCtx<'_>) -> bool

pub fn currently_hovering(&self) -> Option<&String>