TinyLifeWeb/docs/api/TinyLife.Tools.UndoRedoStack.yml
2024-01-07 16:53:47 +01:00

557 lines
19 KiB
YAML

### YamlMime:ManagedReference
items:
- uid: TinyLife.Tools.UndoRedoStack
commentId: T:TinyLife.Tools.UndoRedoStack
id: UndoRedoStack
parent: TinyLife.Tools
children:
- TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)
- TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)
- TinyLife.Tools.UndoRedoStack.Clear
- TinyLife.Tools.UndoRedoStack.Redo
- TinyLife.Tools.UndoRedoStack.Undo
langs:
- csharp
- vb
name: UndoRedoStack
nameWithType: UndoRedoStack
fullName: TinyLife.Tools.UndoRedoStack
type: Class
source:
remote:
path: TinyLife/Tools/UndoRedoStack.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: UndoRedoStack
path: ../TinyLife/Tools/UndoRedoStack.cs
startLine: 9
assemblies:
- Tiny Life
namespace: TinyLife.Tools
summary: >-
The undo-redo stack controls undo and redo operations for various <xref href="TinyLife.Tools.Tool" data-throw-if-not-resolved="false"></xref> activities.
To add a new <xref href="TinyLife.Tools.UndoableAction" data-throw-if-not-resolved="false"></xref> to the stack, use <xref href="TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)" data-throw-if-not-resolved="false"></xref> or, more commonly, <xref href="TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)" data-throw-if-not-resolved="false"></xref>.
example: []
syntax:
content: public static class UndoRedoStack
content.vb: Public Module UndoRedoStack
inheritance:
- System.Object
inheritedMembers:
- System.Object.Equals(System.Object)
- System.Object.Equals(System.Object,System.Object)
- System.Object.GetHashCode
- System.Object.GetType
- System.Object.MemberwiseClone
- System.Object.ReferenceEquals(System.Object,System.Object)
- System.Object.ToString
- uid: TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)
commentId: M:TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)
id: Add(TinyLife.Tools.UndoableAction)
parent: TinyLife.Tools.UndoRedoStack
langs:
- csharp
- vb
name: Add(UndoableAction)
nameWithType: UndoRedoStack.Add(UndoableAction)
fullName: TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)
type: Method
source:
remote:
path: TinyLife/Tools/UndoRedoStack.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Add
path: ../TinyLife/Tools/UndoRedoStack.cs
startLine: 19
assemblies:
- Tiny Life
namespace: TinyLife.Tools
summary: >-
Adds the given <xref href="TinyLife.Tools.UndoableAction" data-throw-if-not-resolved="false"></xref> to the undo-redo stack.
This also clears all redoable actions out of the redo stack.
example: []
syntax:
content: public static void Add(UndoableAction action)
parameters:
- id: action
type: TinyLife.Tools.UndoableAction
description: The action to add.
content.vb: Public Shared Sub Add(action As UndoableAction)
overload: TinyLife.Tools.UndoRedoStack.Add*
- uid: TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)
commentId: M:TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)
id: AddAndExecute(TinyLife.Tools.UndoableAction)
parent: TinyLife.Tools.UndoRedoStack
langs:
- csharp
- vb
name: AddAndExecute(UndoableAction)
nameWithType: UndoRedoStack.AddAndExecute(UndoableAction)
fullName: TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)
type: Method
source:
remote:
path: TinyLife/Tools/UndoRedoStack.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: AddAndExecute
path: ../TinyLife/Tools/UndoRedoStack.cs
startLine: 30
assemblies:
- Tiny Life
namespace: TinyLife.Tools
summary: >-
Adds the given <xref href="TinyLife.Tools.UndoableAction" data-throw-if-not-resolved="false"></xref> to the undo-redo stack and executes its "redo" action right away.
This is useful for when the redo action is also the action that is executed initially, which is the case most of the time.
This also clears all redoable actions out of the redo stack.
example: []
syntax:
content: public static void AddAndExecute(UndoableAction action)
parameters:
- id: action
type: TinyLife.Tools.UndoableAction
description: The action to add and execute.
content.vb: Public Shared Sub AddAndExecute(action As UndoableAction)
overload: TinyLife.Tools.UndoRedoStack.AddAndExecute*
- uid: TinyLife.Tools.UndoRedoStack.Undo
commentId: M:TinyLife.Tools.UndoRedoStack.Undo
id: Undo
parent: TinyLife.Tools.UndoRedoStack
langs:
- csharp
- vb
name: Undo()
nameWithType: UndoRedoStack.Undo()
fullName: TinyLife.Tools.UndoRedoStack.Undo()
type: Method
source:
remote:
path: TinyLife/Tools/UndoRedoStack.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Undo
path: ../TinyLife/Tools/UndoRedoStack.cs
startLine: 38
assemblies:
- Tiny Life
namespace: TinyLife.Tools
summary: Undoes this undo-redo stack, undoing the most recent <xref href="TinyLife.Tools.UndoableAction" data-throw-if-not-resolved="false"></xref> and pushing it onto the redo stack.
example: []
syntax:
content: public static void Undo()
content.vb: Public Shared Sub Undo()
overload: TinyLife.Tools.UndoRedoStack.Undo*
- uid: TinyLife.Tools.UndoRedoStack.Redo
commentId: M:TinyLife.Tools.UndoRedoStack.Redo
id: Redo
parent: TinyLife.Tools.UndoRedoStack
langs:
- csharp
- vb
name: Redo()
nameWithType: UndoRedoStack.Redo()
fullName: TinyLife.Tools.UndoRedoStack.Redo()
type: Method
source:
remote:
path: TinyLife/Tools/UndoRedoStack.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Redo
path: ../TinyLife/Tools/UndoRedoStack.cs
startLine: 53
assemblies:
- Tiny Life
namespace: TinyLife.Tools
summary: Redoes this undo-redo stack, redoing the most recently undone <xref href="TinyLife.Tools.UndoableAction" data-throw-if-not-resolved="false"></xref> and pushing it back onto the undo stack.
example: []
syntax:
content: public static void Redo()
content.vb: Public Shared Sub Redo()
overload: TinyLife.Tools.UndoRedoStack.Redo*
- uid: TinyLife.Tools.UndoRedoStack.Clear
commentId: M:TinyLife.Tools.UndoRedoStack.Clear
id: Clear
parent: TinyLife.Tools.UndoRedoStack
langs:
- csharp
- vb
name: Clear()
nameWithType: UndoRedoStack.Clear()
fullName: TinyLife.Tools.UndoRedoStack.Clear()
type: Method
source:
remote:
path: TinyLife/Tools/UndoRedoStack.cs
branch: main
repo: https://git.ellpeck.de/Ellpeck/TinyLife
id: Clear
path: ../TinyLife/Tools/UndoRedoStack.cs
startLine: 68
assemblies:
- Tiny Life
namespace: TinyLife.Tools
summary: Clears this undo-redo stack, clearing the internal undo and redo stacks.
example: []
syntax:
content: public static void Clear()
content.vb: Public Shared Sub Clear()
overload: TinyLife.Tools.UndoRedoStack.Clear*
references:
- uid: TinyLife.Tools.Tool
commentId: T:TinyLife.Tools.Tool
parent: TinyLife.Tools
href: TinyLife.Tools.Tool.html
name: Tool
nameWithType: Tool
fullName: TinyLife.Tools.Tool
- uid: TinyLife.Tools.UndoableAction
commentId: T:TinyLife.Tools.UndoableAction
parent: TinyLife.Tools
href: TinyLife.Tools.UndoableAction.html
name: UndoableAction
nameWithType: UndoableAction
fullName: TinyLife.Tools.UndoableAction
- uid: TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)
commentId: M:TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_Add_TinyLife_Tools_UndoableAction_
name: Add(UndoableAction)
nameWithType: UndoRedoStack.Add(UndoableAction)
fullName: TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)
spec.csharp:
- uid: TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)
name: Add
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_Add_TinyLife_Tools_UndoableAction_
- name: (
- uid: TinyLife.Tools.UndoableAction
name: UndoableAction
href: TinyLife.Tools.UndoableAction.html
- name: )
spec.vb:
- uid: TinyLife.Tools.UndoRedoStack.Add(TinyLife.Tools.UndoableAction)
name: Add
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_Add_TinyLife_Tools_UndoableAction_
- name: (
- uid: TinyLife.Tools.UndoableAction
name: UndoableAction
href: TinyLife.Tools.UndoableAction.html
- name: )
- uid: TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)
commentId: M:TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_AddAndExecute_TinyLife_Tools_UndoableAction_
name: AddAndExecute(UndoableAction)
nameWithType: UndoRedoStack.AddAndExecute(UndoableAction)
fullName: TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)
spec.csharp:
- uid: TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)
name: AddAndExecute
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_AddAndExecute_TinyLife_Tools_UndoableAction_
- name: (
- uid: TinyLife.Tools.UndoableAction
name: UndoableAction
href: TinyLife.Tools.UndoableAction.html
- name: )
spec.vb:
- uid: TinyLife.Tools.UndoRedoStack.AddAndExecute(TinyLife.Tools.UndoableAction)
name: AddAndExecute
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_AddAndExecute_TinyLife_Tools_UndoableAction_
- name: (
- uid: TinyLife.Tools.UndoableAction
name: UndoableAction
href: TinyLife.Tools.UndoableAction.html
- name: )
- uid: TinyLife.Tools
commentId: N:TinyLife.Tools
href: TinyLife.html
name: TinyLife.Tools
nameWithType: TinyLife.Tools
fullName: TinyLife.Tools
spec.csharp:
- uid: TinyLife
name: TinyLife
href: TinyLife.html
- name: .
- uid: TinyLife.Tools
name: Tools
href: TinyLife.Tools.html
spec.vb:
- uid: TinyLife
name: TinyLife
href: TinyLife.html
- name: .
- uid: TinyLife.Tools
name: Tools
href: TinyLife.Tools.html
- uid: System.Object
commentId: T:System.Object
parent: System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
name: object
nameWithType: object
fullName: object
nameWithType.vb: Object
fullName.vb: Object
name.vb: Object
- uid: System.Object.Equals(System.Object)
commentId: M:System.Object.Equals(System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
name: Equals(object)
nameWithType: object.Equals(object)
fullName: object.Equals(object)
nameWithType.vb: Object.Equals(Object)
fullName.vb: Object.Equals(Object)
name.vb: Equals(Object)
spec.csharp:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.Equals(System.Object,System.Object)
commentId: M:System.Object.Equals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
name: Equals(object, object)
nameWithType: object.Equals(object, object)
fullName: object.Equals(object, object)
nameWithType.vb: Object.Equals(Object, Object)
fullName.vb: Object.Equals(Object, Object)
name.vb: Equals(Object, Object)
spec.csharp:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.Equals(System.Object,System.Object)
name: Equals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.equals#system-object-equals(system-object-system-object)
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.GetHashCode
commentId: M:System.Object.GetHashCode
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
name: GetHashCode()
nameWithType: object.GetHashCode()
fullName: object.GetHashCode()
nameWithType.vb: Object.GetHashCode()
fullName.vb: Object.GetHashCode()
spec.csharp:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
spec.vb:
- uid: System.Object.GetHashCode
name: GetHashCode
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gethashcode
- name: (
- name: )
- uid: System.Object.GetType
commentId: M:System.Object.GetType
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
name: GetType()
nameWithType: object.GetType()
fullName: object.GetType()
nameWithType.vb: Object.GetType()
fullName.vb: Object.GetType()
spec.csharp:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
spec.vb:
- uid: System.Object.GetType
name: GetType
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.gettype
- name: (
- name: )
- uid: System.Object.MemberwiseClone
commentId: M:System.Object.MemberwiseClone
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
name: MemberwiseClone()
nameWithType: object.MemberwiseClone()
fullName: object.MemberwiseClone()
nameWithType.vb: Object.MemberwiseClone()
fullName.vb: Object.MemberwiseClone()
spec.csharp:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
spec.vb:
- uid: System.Object.MemberwiseClone
name: MemberwiseClone
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.memberwiseclone
- name: (
- name: )
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
commentId: M:System.Object.ReferenceEquals(System.Object,System.Object)
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
name: ReferenceEquals(object, object)
nameWithType: object.ReferenceEquals(object, object)
fullName: object.ReferenceEquals(object, object)
nameWithType.vb: Object.ReferenceEquals(Object, Object)
fullName.vb: Object.ReferenceEquals(Object, Object)
name.vb: ReferenceEquals(Object, Object)
spec.csharp:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
spec.vb:
- uid: System.Object.ReferenceEquals(System.Object,System.Object)
name: ReferenceEquals
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.referenceequals
- name: (
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: ','
- name: " "
- uid: System.Object
name: Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object
- name: )
- uid: System.Object.ToString
commentId: M:System.Object.ToString
parent: System.Object
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
name: ToString()
nameWithType: object.ToString()
fullName: object.ToString()
nameWithType.vb: Object.ToString()
fullName.vb: Object.ToString()
spec.csharp:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
spec.vb:
- uid: System.Object.ToString
name: ToString
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system.object.tostring
- name: (
- name: )
- uid: System
commentId: N:System
isExternal: true
href: https://learn.microsoft.com/dotnet/api/system
name: System
nameWithType: System
fullName: System
- uid: TinyLife.Tools.UndoRedoStack.Add*
commentId: Overload:TinyLife.Tools.UndoRedoStack.Add
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_Add_TinyLife_Tools_UndoableAction_
name: Add
nameWithType: UndoRedoStack.Add
fullName: TinyLife.Tools.UndoRedoStack.Add
- uid: TinyLife.Tools.UndoRedoStack.AddAndExecute*
commentId: Overload:TinyLife.Tools.UndoRedoStack.AddAndExecute
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_AddAndExecute_TinyLife_Tools_UndoableAction_
name: AddAndExecute
nameWithType: UndoRedoStack.AddAndExecute
fullName: TinyLife.Tools.UndoRedoStack.AddAndExecute
- uid: TinyLife.Tools.UndoRedoStack.Undo*
commentId: Overload:TinyLife.Tools.UndoRedoStack.Undo
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_Undo
name: Undo
nameWithType: UndoRedoStack.Undo
fullName: TinyLife.Tools.UndoRedoStack.Undo
- uid: TinyLife.Tools.UndoRedoStack.Redo*
commentId: Overload:TinyLife.Tools.UndoRedoStack.Redo
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_Redo
name: Redo
nameWithType: UndoRedoStack.Redo
fullName: TinyLife.Tools.UndoRedoStack.Redo
- uid: TinyLife.Tools.UndoRedoStack.Clear*
commentId: Overload:TinyLife.Tools.UndoRedoStack.Clear
href: TinyLife.Tools.UndoRedoStack.html#TinyLife_Tools_UndoRedoStack_Clear
name: Clear
nameWithType: UndoRedoStack.Clear
fullName: TinyLife.Tools.UndoRedoStack.Clear