Base interface to for an action stack. More...

Inheritance diagram for SiliconStudio.ActionStack.IActionStack:

Public Member Functions
void	Add (IActionItem item)
	Adds an action item to the stack. Discards any action item that is currently undone. More...

void	AddRange (IEnumerable< IActionItem > items)
	Adds multiple action items on the stack. Discards any action item that is currently undone. More...

void	Clear ()
	Clears the action stack. More...

SavePoint	CreateSavePoint (bool markActionsAsSaved)
	Creates a save point at the current index of the action stack. More...

bool	Undo ()
	Undoes the last action item that is currently done. More...

bool	Redo ()
	Redoes the first action item that is currently undone. More...

Properties
IEnumerable< IActionItem >	ActionItems `[get]`
	Gets the action items currently stored in the action stack, including undone items that have not been disbranched. More...

Events
EventHandler < ActionItemsEventArgs < IActionItem > >	ActionItemsAdded
	Raised whenever action items are added to the stack. More...

EventHandler	ActionItemsCleared
	Raised whenever the action stack is cleared. More...

EventHandler < DiscardedActionItemsEventArgs < IActionItem > >	ActionItemsDiscarded
	Raised whenever action items are discarded from the stack. More...

EventHandler < ActionItemsEventArgs < IActionItem > >	Undone
	Raised when an action item is undone. More...

EventHandler < ActionItemsEventArgs < IActionItem > >	Redone
	Raised when an action item is redone. More...

Detailed Description

Base interface to for an action stack.

Definition at line 11 of file IActionStack.cs.

Member Function Documentation

void SiliconStudio.ActionStack.IActionStack.Add ( IActionItem item )

Adds an action item to the stack. Discards any action item that is currently undone.

Parameters

item	The action item to add to the stack.

Implemented in SiliconStudio.ActionStack.TransactionalActionStack, SiliconStudio.ActionStack.NullTransactionalActionStack, SiliconStudio.ActionStack.ActionStack, and SiliconStudio.Presentation.ViewModel.ActionStack.ViewModelTransactionalActionStack.

void SiliconStudio.ActionStack.IActionStack.AddRange ( IEnumerable< IActionItem > items )

Adds multiple action items on the stack. Discards any action item that is currently undone.

Parameters

items The action items to add on the stack.

Implemented in SiliconStudio.ActionStack.ActionStack, and SiliconStudio.ActionStack.NullTransactionalActionStack.

void SiliconStudio.ActionStack.IActionStack.Clear ( )

Clears the action stack.

Implemented in SiliconStudio.ActionStack.ActionStack, and SiliconStudio.ActionStack.NullTransactionalActionStack.

SavePoint SiliconStudio.ActionStack.IActionStack.CreateSavePoint ( bool markActionsAsSaved )

Creates a save point at the current index of the action stack.

Parameters

markActionsAsSaved Indicate whether to set the IActionItem.IsSaved of all preceding action items to true.

Returns: A SavePoint object corresponding to the created save point.

Implemented in SiliconStudio.ActionStack.ActionStack, SiliconStudio.ActionStack.NullTransactionalActionStack, and SiliconStudio.Presentation.ViewModel.ActionStack.ViewModelTransactionalActionStack.

bool SiliconStudio.ActionStack.IActionStack.Redo ( )

Redoes the first action item that is currently undone.

Returns: True if an action could be redone, False otherwise.

Implemented in SiliconStudio.ActionStack.ActionStack, and SiliconStudio.ActionStack.NullTransactionalActionStack.

bool SiliconStudio.ActionStack.IActionStack.Undo ( )

Undoes the last action item that is currently done.

Returns: True if an action could be undone, False otherwise.

Implemented in SiliconStudio.ActionStack.ActionStack, and SiliconStudio.ActionStack.NullTransactionalActionStack.

Property Documentation

IEnumerable<IActionItem> SiliconStudio.ActionStack.IActionStack.ActionItems

get

Gets the action items currently stored in the action stack, including undone items that have not been disbranched.

Definition at line 16 of file IActionStack.cs.

Event Documentation

EventHandler<ActionItemsEventArgs<IActionItem> > SiliconStudio.ActionStack.IActionStack.ActionItemsAdded

Raised whenever action items are added to the stack.

Definition at line 21 of file IActionStack.cs.

EventHandler SiliconStudio.ActionStack.IActionStack.ActionItemsCleared

Raised whenever the action stack is cleared.

Definition at line 26 of file IActionStack.cs.

EventHandler<DiscardedActionItemsEventArgs<IActionItem> > SiliconStudio.ActionStack.IActionStack.ActionItemsDiscarded

Raised whenever action items are discarded from the stack.

Definition at line 31 of file IActionStack.cs.

EventHandler<ActionItemsEventArgs<IActionItem> > SiliconStudio.ActionStack.IActionStack.Redone

Raised when an action item is redone.

Definition at line 41 of file IActionStack.cs.

EventHandler<ActionItemsEventArgs<IActionItem> > SiliconStudio.ActionStack.IActionStack.Undone

Raised when an action item is undone.

Definition at line 36 of file IActionStack.cs.

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

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

Public Member Functions

Properties

Events

Detailed Description

Member Function Documentation

Property Documentation

Event Documentation