Struct UndoHistory

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

W Undo/redo stack view.

This widget shows a snapshot of the undo/redo stacks of the focused undo scope when the history widget is open. Note that the stack is not live, this widget is designed to work as a menu popup content.

Implementations

impl UndoHistory

pub fn widget_new() -> UndoHistory

Start building a new instance.

pub fn widget_type() -> WidgetType

Gets the widget type info.

impl UndoHistory

pub fn undo_entry_fn(&self, wgt_fn: impl IntoVar<WidgetFn<UndoEntryArgs>>)

P Widget function that converts UndoEntryArgs to widgets.

Try undo_button_style_fn for making only visual changes.

Sets the UNDO_ENTRY_FN_VAR.

impl UndoHistory

pub fn undo_stack_fn(&self, wgt_fn: impl IntoVar<WidgetFn<UndoStackArgs>>)

P Widget function that converts UndoStackArgs to widgets.

Sets the UNDO_STACK_FN_VAR.

impl UndoHistory

pub fn undo_panel_fn(&self, wgt_fn: impl IntoVar<WidgetFn<UndoPanelArgs>>)

P Widget function that converts UndoPanelArgs to widgets.

Sets the UNDO_PANEL_FN_VAR.

impl UndoHistory

pub fn group_by_undo_interval(&self, enabled: impl IntoVar<bool>)

P If undo entries are grouped by the UNDO.undo_interval.

Enabled by default.

Sets the GROUP_BY_UNDO_INTERVAL_VAR.

impl UndoHistory

pub fn op(&self, op: impl IntoValue<UndoOp>)

c Identifies what stack history is shown by the widget.

Methods from Deref<Target = WidgetBase>

pub fn widget_builder(&mut self) -> &mut WidgetBuilder

Returns a mutable reference to the widget builder.

pub fn widget_when(&mut self) -> Option<&mut WhenInfo>

Returns a mutable reference to the when block if called inside a when block.

pub fn widget_take(&mut self) -> WidgetBuilder

Takes the widget builder, finishing the widget macro build.

After this call trying to set a property using self will panic, the returned builder can still be manipulated directly.

pub fn widget_build(&mut self) -> impl UiNode

Build the widget.

After this call trying to set a property will panic.

pub fn widget_importance(&mut self) -> &mut Importance

Returns a mutable reference to the importance of the next property assigns, unsets or when blocks.

Note that during the widget_intrinsic call this is Importance::WIDGET and after it is Importance::INSTANCE.

pub fn start_when_block( &mut self, inputs: Box<[WhenInput]>, state: Box<dyn VarBoxed<bool>>, expr: &'static str, location: SourceLocation, )

Start building a when block, all properties set after this call are pushed in the when block.

pub fn end_when_block(&mut self)

End the current when block, all properties set after this call are pushed in the widget.

pub fn id(&self, id: impl IntoValue<WidgetId>)

c Unique ID of the widget instance.

Note that the id can convert from a &'static str unique name.

Trait Implementations

impl Deref for UndoHistory

type Target = WidgetBase

The resulting type after dereferencing.

fn deref(&self) -> &<UndoHistory as Deref>::Target

Dereferences the value.

impl DerefMut for UndoHistory

fn deref_mut(&mut self) -> &mut <UndoHistory as Deref>::Target

Mutably dereferences the value.