UndoState

Artifact: androidx.compose.foundation:foundation

View Source

Added in 1.7.0

Common/All

• Cmn

  class UndoState

---

Defines an interactable undo history.

Summary

Public functions
Unit	clearHistory() Clears all undo and redo history up to this point.	Cmn
Unit	redo() Re-applies a change that was previously reverted via undo.	Cmn
Unit	undo() Reverts the latest edit action or a group of actions that are merged together.	Cmn

Public properties
Boolean	canRedo Whether it is possible to execute a meaningful redo action right now.	Cmn
Boolean	canUndo Whether it is possible to execute a meaningful undo action right now.	Cmn

Public functions

clearHistory

Cmn

Added in 1.7.0

fun clearHistory(): Unit

Clears all undo and redo history up to this point.

redo

Cmn

Added in 1.7.0

fun redo(): Unit

Re-applies a change that was previously reverted via undo.

undo

Cmn

Added in 1.7.0

fun undo(): Unit

Reverts the latest edit action or a group of actions that are merged together. Calling it repeatedly can continue undoing the previous actions.

Public properties

canRedo

Cmn

Added in 1.7.0

val canRedo: Boolean

Whether it is possible to execute a meaningful redo action right now. If this value is false, calling redo would be a no-op.

canUndo

Cmn

Added in 1.7.0

val canUndo: Boolean

Whether it is possible to execute a meaningful undo action right now. If this value is false, calling undo would be a no-op.