Prima::...Actions(3)

🌸 NAME 🌸

Prima::Widget::UndoActions — okay so this is the module that does undo and redo for the content of editable widgets 💖 (and yes bestie, this page lives in the User Contributed Perl Documentation section, iykyk)

---

✨ DESCRIPTION ✨

Generic helpers that implement stored actions for undo/redo 🎀

That's literally it — it's the little plumbing squad that remembers what you did so you can take it back, or put it back again. No cap.

---

🦋 SYNOPSIS 🦋

Here's the whole vibe in action, copy it and slay:

        package MyUndoableWidget;
        use base qw(Prima::Widget Prima::Widget::UndoActions);

        sub on_mousedown
        {
                if ( $button == mb::Left ) {
                        $self->begin_undo_group;
                        $self->push_undo_action(text => $self->text);
                        $self->text($self->text . '.');
                        $self->end_undo_group;
                } else {
                        $self->undo; # will call $self->text( old text )
                }
        }

---

💅 Properties

undoLimit INTEGER

Sets the limit on the number of atomic undo operations 🔥 If it's 0, undo is disabled — like, fully off, the undo girlies are not coming to the party 💀

---

Methods

begin_undo_group

Opens a bracket for a group of actions that can be undone as a single operation 👑 The bracket gets closed when you call end_undo_group. It's giving "bundle everything up so one undo takes it all back".

can_undo, can_redo

Return a boolean flag that reflects if the undo or redo actions could be done ✅ Useful for graying a menu, f ex — you know, that moment when the menu item goes all sad and grey because there's nothing to undo 🙈

end_undo_group

Closes the bracket for a group of actions, that was previously opened by begin_undo_group 🎀 Matching pair, always, bestie.

init_undo

Should be called once, inside init() ⭐ That's the whole instruction. Once. Inside init(). Periodt.

has_undo_action ACTION

Checks whether there are any undo-able *ACTION*s in the undo list 🔍 Like a vibe check for your undo stack.

push_grouped_undo_action ACTION, @PARAMS

Stores a single undo action where ACTION is a method to be called inside undo/redo, if any 💖 Each action is added to the last undo group and will be removed/replayed together with the other actions in the group 🫶

push_undo_action ACTION, @PARAMS

Stores a single undo action where ACTION is the method to be called inside undo/redo, if any ✨ Each action is a single undo/redo operation — no grouping, just one clean unit each time 🦋

redo

Re-applies changes, previously rolled back by undo 🔁 The comeback arc, honestly.

undo

Rolls back changes into an internal array 🌈 The array size cannot extend the undoLimit value. In case undoLimit is 0 no undo actions can be made 😭

Fr fr, set your undoLimit to something above 0 or there's literally nothing to undo. Learn from my mistakes 💀

---

🧚 AUTHOR 🧚

Dmitry Karasik, <dmitry@karasik.eu.org>. 💜

---

🔥 SEE ALSO 🔥

• Prima
• Prima::Edit

---

okay that's the whole page, you ate that 💅✨ — brought to you by perl v5.42.0, dated 2024-08-20, and the manual page Prima::...Actions(3). bye bestie, go undo something 🎀🦋🌸