Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
Public Member Functions | Properties | List of all members
SiliconStudio.ActionStack.UndoToken Struct Reference

Represents a token that stores an unique identifier and an object. This token should be generated by a cancellable command and be passed as argument when the command must be undone. More...

Public Member Functions

 UndoToken (bool canUndo, object tokenValue=null)
 Initializes a new instance of the UndoToken structure with some parameters. More...
 

Properties

Guid Guid [get]
 Gets a unique identifier for the token. More...
 
bool CanUndo [get]
 Gets whether this token represents an action that can actually be undone. More...
 
object TokenValue [get]
 Gets a user-defined object hosted by the token that should store all information needed to undo a command. More...
 

Detailed Description

Represents a token that stores an unique identifier and an object. This token should be generated by a cancellable command and be passed as argument when the command must be undone.

This object is immutable.

Definition at line 12 of file UndoToken.cs.

Constructor & Destructor Documentation

SiliconStudio.ActionStack.UndoToken.UndoToken ( bool  canUndo,
object  tokenValue = null 
)

Initializes a new instance of the UndoToken structure with some parameters.

Parameters
canUndoIndicate if this token corresponds to an action that can be undone.
tokenValueThe object stored in this token which can be used to undo the associated action (such as previous value of a property).

Definition at line 23 of file UndoToken.cs.

Property Documentation

bool SiliconStudio.ActionStack.UndoToken.CanUndo
get

Gets whether this token represents an action that can actually be undone.

Definition at line 38 of file UndoToken.cs.

Guid SiliconStudio.ActionStack.UndoToken.Guid
get

Gets a unique identifier for the token.

Definition at line 33 of file UndoToken.cs.

object SiliconStudio.ActionStack.UndoToken.TokenValue
get

Gets a user-defined object hosted by the token that should store all information needed to undo a command.

Definition at line 43 of file UndoToken.cs.

Referenced by SiliconStudio.Quantum.Commands.RenameStringKeyCommand.Undo(), SiliconStudio.Presentation.Quantum.CombinedNodeCommandWrapper.Undo(), SiliconStudio.Quantum.Commands.AddNewItemCommand.Undo(), and SiliconStudio.Quantum.Commands.RemoveItemCommand.Undo().

The documentation for this struct was generated from the following file: