Base class for action items. More...

Inheritance diagram for SiliconStudio.ActionStack.ActionItem:

Public Member Functions
void	Freeze ()
	Freezes this ActionItem. A frozen action item can't be undone anymore and should have freed the resources stored for undo actions More...

void	Undo ()
	Undo the action. More...

void	Redo ()
	Redo the action. More...

Protected Member Functions
	ActionItem (string name)
	Initializes a new instance of the ActionItem class with the given name. More...

	ActionItem ()
	Initializes a new instance of the ActionItem class. More...

abstract void	FreezeMembers ()
	Invoked by Freeze before setting IsFrozen to true. More...

abstract void	UndoAction ()
	Invoked by Undo after setting IsDone to true. More...

abstract void	RedoAction ()
	Invoked by Redo after setting IsDone to true. More...

Properties
Guid	Identifier `[get]`

string	Name `[get, set]`

virtual bool	IsSaved `[get, set]`

virtual bool	IsDone `[get, set]`

bool	IsFrozen `[get, set]`

Properties inherited from SiliconStudio.ActionStack.IActionItem
string	Name `[get, set]`
	Gets or sets the name of the current action. More...

Guid	Identifier `[get]`
	Gets an unique identifier of the action, per instance. More...

bool	IsSaved `[get, set]`
	Gets or sets whether this action as already been saved when evaluating the dirtiness of an object. More...

bool	IsDone `[get]`
	Gets whether this action is currently done. Modified when invoking Undo or Redo. More...

bool	IsFrozen `[get]`
	Gets whether this action has been frozen with the Freeze method. More...

Detailed Description

Base class for action items.

An ActionItem represents an action that can be undone or redone. Action items are usually stacked in an IActionStack.

Definition at line 13 of file ActionItem.cs.

Constructor & Destructor Documentation

SiliconStudio.ActionStack.ActionItem.ActionItem ( string name )

protected

Initializes a new instance of the ActionItem class with the given name.

Parameters

name	The name of this action item.

Definition at line 23 of file ActionItem.cs.

SiliconStudio.ActionStack.ActionItem.ActionItem ( )

protected

Initializes a new instance of the ActionItem class.

Definition at line 31 of file ActionItem.cs.

Member Function Documentation

void SiliconStudio.ActionStack.ActionItem.Freeze ( )

Freezes this ActionItem. A frozen action item can't be undone anymore and should have freed the resources stored for undo actions

Implements SiliconStudio.ActionStack.IActionItem.

Definition at line 51 of file ActionItem.cs.

abstract void SiliconStudio.ActionStack.ActionItem.FreezeMembers ( )

protectedpure virtual

Invoked by Freeze before setting IsFrozen to true.

This method will not be invoked if IsFrozen is already true.

Implemented in SiliconStudio.ActionStack.AggregateActionItem, SiliconStudio.ActionStack.CollectionChangedActionItem, SiliconStudio.Presentation.ViewModel.ActionStack.CollectionChangedViewModelActionItem, SiliconStudio.Presentation.Quantum.ValueChangedActionItem, SiliconStudio.ActionStack.PropertyChangedActionItem, SiliconStudio.Presentation.Commands.CommandActionItem, and SiliconStudio.Presentation.ViewModel.ActionStack.PropertyChangedViewModelActionItem.

void SiliconStudio.ActionStack.ActionItem.Redo ( )

Redo the action.

Implements SiliconStudio.ActionStack.IActionItem.

Definition at line 72 of file ActionItem.cs.

abstract void SiliconStudio.ActionStack.ActionItem.RedoAction ( )

protectedpure virtual

Invoked by Redo after setting IsDone to true.

Implemented in SiliconStudio.ActionStack.CollectionChangedActionItem, SiliconStudio.ActionStack.AggregateActionItem, SiliconStudio.Presentation.Quantum.ValueChangedActionItem, SiliconStudio.Presentation.ViewModel.ActionStack.CollectionChangedViewModelActionItem, SiliconStudio.ActionStack.PropertyChangedActionItem, SiliconStudio.Presentation.Commands.CommandActionItem, SiliconStudio.Presentation.ViewModel.ActionStack.PropertyChangedViewModelActionItem, and SiliconStudio.Presentation.Quantum.CombinedValueChangedActionItem.

void SiliconStudio.ActionStack.ActionItem.Undo ( )

Undo the action.

Implements SiliconStudio.ActionStack.IActionItem.

Definition at line 61 of file ActionItem.cs.

abstract void SiliconStudio.ActionStack.ActionItem.UndoAction ( )

protectedpure virtual

Invoked by Undo after setting IsDone to true.

Implemented in SiliconStudio.ActionStack.AggregateActionItem, SiliconStudio.ActionStack.CollectionChangedActionItem, SiliconStudio.Presentation.Quantum.ValueChangedActionItem, SiliconStudio.Presentation.ViewModel.ActionStack.CollectionChangedViewModelActionItem, SiliconStudio.ActionStack.PropertyChangedActionItem, SiliconStudio.Presentation.Commands.CommandActionItem, SiliconStudio.Presentation.ViewModel.ActionStack.PropertyChangedViewModelActionItem, and SiliconStudio.Presentation.Quantum.CombinedValueChangedActionItem.

Property Documentation

Guid SiliconStudio.ActionStack.ActionItem.Identifier

get

Definition at line 36 of file ActionItem.cs.

virtual bool SiliconStudio.ActionStack.ActionItem.IsDone

getset

Definition at line 45 of file ActionItem.cs.

bool SiliconStudio.ActionStack.ActionItem.IsFrozen

getset

Definition at line 48 of file ActionItem.cs.

virtual bool SiliconStudio.ActionStack.ActionItem.IsSaved

getset

Definition at line 42 of file ActionItem.cs.

string SiliconStudio.ActionStack.ActionItem.Name

getset

Definition at line 39 of file ActionItem.cs.

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

D:/Projects/Bitbucket Hosting/DoxygenFilesAndSources/Paradox v1.0.0 beta06/sources/common/presentation/SiliconStudio.ActionStack/ActionItem.cs

Public Member Functions

Protected Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Property Documentation