Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.Quantum.Commands.UncancellableCommand Class Referenceabstract
Inheritance diagram for SiliconStudio.Quantum.Commands.UncancellableCommand:
SiliconStudio.Quantum.Commands.INodeCommand

Public Member Functions

abstract bool CanAttach (ITypeDescriptor typeDescriptor, MemberDescriptorBase memberDescriptor)
 Indicates whether this command can be attached to an object or a member with the given descriptors.
Parameters
typeDescriptorThe ITypeDescriptor of the object or the member to attach.
memberDescriptorThe MemberDescriptorBase of the member to attach. This parameter is null when testing on an object that is not a member of another object.
Returns
More...
 
object Invoke (object currentValue, ITypeDescriptor descriptor, object parameter, out UndoToken undoToken)
 Invokes the node command. More...
 
object Undo (object currentValue, ITypeDescriptor descriptor, UndoToken undoToken)
 Undoes an invoke of the node command. More...
 

Protected Member Functions

abstract void InvokeUncancellable (object currentValue, ITypeDescriptor descriptor, object parameter)
 

Properties

abstract string Name [get]
 
abstract CombineMode CombineMode [get]
 
- Properties inherited from SiliconStudio.Quantum.Commands.INodeCommand
string Name [get]
 Gets the name of the command. More...
 
CombineMode CombineMode [get]
 Gets how to combine this command in a combined view model. More...
 

Detailed Description

Definition at line 10 of file UncancellableCommand.cs.

Member Function Documentation

abstract bool SiliconStudio.Quantum.Commands.UncancellableCommand.CanAttach ( ITypeDescriptor  typeDescriptor,
MemberDescriptorBase  memberDescriptor 
)
pure virtual

Indicates whether this command can be attached to an object or a member with the given descriptors.

Parameters
typeDescriptorThe ITypeDescriptor of the object or the member to attach.
memberDescriptorThe MemberDescriptorBase of the member to attach. This parameter is null when testing on an object that is not a member of another object.
Returns

Implements SiliconStudio.Quantum.Commands.INodeCommand.

object SiliconStudio.Quantum.Commands.UncancellableCommand.Invoke ( object  currentValue,
ITypeDescriptor  descriptor,
object  parameter,
out UndoToken  undoToken 
)

Invokes the node command.

Parameters
currentValueThe current value of the associated object or member.
descriptorThe type descriptor of the associated object or member.
parameterThe parameter of the command.
undoTokenThe UndoToken that will be passed to the Undo method when undoing the execution of this command.
Returns
The new value to assign to the associated object or member.

Implements SiliconStudio.Quantum.Commands.INodeCommand.

Definition at line 21 of file UncancellableCommand.cs.

abstract void SiliconStudio.Quantum.Commands.UncancellableCommand.InvokeUncancellable ( object  currentValue,
ITypeDescriptor  descriptor,
object  parameter 
)
protectedpure virtual
object SiliconStudio.Quantum.Commands.UncancellableCommand.Undo ( object  currentValue,
ITypeDescriptor  descriptor,
UndoToken  undoToken 
)

Undoes an invoke of the node command.

Parameters
currentValueThe current value of the associated object or member.
descriptorThe type descriptor of the associated object or member.
undoTokenThe UndoToken that was generated when invoking this command.
Returns
The new value to assign to the associated object or member.

Implements SiliconStudio.Quantum.Commands.INodeCommand.

Definition at line 28 of file UncancellableCommand.cs.

Property Documentation

abstract CombineMode SiliconStudio.Quantum.Commands.UncancellableCommand.CombineMode
get

Definition at line 16 of file UncancellableCommand.cs.

abstract string SiliconStudio.Quantum.Commands.UncancellableCommand.Name
get

Definition at line 13 of file UncancellableCommand.cs.


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