Paradox Game Engine  v1.0.0 beta06
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Events Macros Pages
SiliconStudio.ActionStack.AggregateActionItem Class Reference

An ActionItem that represents a set of multiple action items. More...

Inheritance diagram for SiliconStudio.ActionStack.AggregateActionItem:
SiliconStudio.ActionStack.ActionItem SiliconStudio.ActionStack.IAggregateActionItem SiliconStudio.ActionStack.IActionItem SiliconStudio.ActionStack.IActionItem SiliconStudio.Presentation.Quantum.CombinedValueChangedActionItem

Public Member Functions

 AggregateActionItem (IEnumerable< IActionItem > actionItems)
 Initializes a new instance of the AggregateActionItem class with the given collection of action items. More...
 
 AggregateActionItem (string name, IEnumerable< IActionItem > actionItems)
 Initializes a new instance of the AggregateActionItem class with the given name and collection of action items. More...
 
bool ContainsAction (IActionItem actionItem)
 Gets whether the given action item is contained in this aggregate.
Parameters
actionItemThe action item to look for.
Returns
true if this aggregate contains the given action item, false otherwise.
More...
 
IEnumerable< IActionItemGetInnerActionItems ()
 Gets all action items contained in this aggregate that are not IAggregateActionItem themselves, recursively.
Returns
An enumeration of all action items contained in this aggregate that are not IAggregateActionItem themselves, recursively.
More...
 
- Public Member Functions inherited from SiliconStudio.ActionStack.ActionItem
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

override void FreezeMembers ()
 Invoked by Freeze before setting IsFrozen to true. This method will not be invoked if IsFrozen is already true. More...
 
override void UndoAction ()
 Invoked by Undo after setting IsDone to true. More...
 
override void RedoAction ()
 Invoked by Redo after setting IsDone to true. More...
 
- Protected Member Functions inherited from SiliconStudio.ActionStack.ActionItem
 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...
 

Properties

IEnumerable< IActionItemActionItems [get]
 
override bool IsSaved [get, set]
 
- Properties inherited from SiliconStudio.ActionStack.ActionItem
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...
 
- Properties inherited from SiliconStudio.ActionStack.IAggregateActionItem
IEnumerable< IActionItemActionItems [get]
 Gets the aggregated action items. More...
 

Detailed Description

An ActionItem that represents a set of multiple action items.

Definition at line 14 of file AggregateActionItem.cs.

Constructor & Destructor Documentation

SiliconStudio.ActionStack.AggregateActionItem.AggregateActionItem ( IEnumerable< IActionItem actionItems)

Initializes a new instance of the AggregateActionItem class with the given collection of action items.

Parameters
actionItemsThe action items to add to this aggregation.

Definition at line 22 of file AggregateActionItem.cs.

SiliconStudio.ActionStack.AggregateActionItem.AggregateActionItem ( string  name,
IEnumerable< IActionItem actionItems 
)

Initializes a new instance of the AggregateActionItem class with the given name and collection of action items.

Parameters
nameThe name of this action item.
actionItemsThe action items to add to this aggregation.

Definition at line 32 of file AggregateActionItem.cs.

Member Function Documentation

bool SiliconStudio.ActionStack.AggregateActionItem.ContainsAction ( IActionItem  actionItem)

Gets whether the given action item is contained in this aggregate.

Parameters
actionItemThe action item to look for.
Returns
true if this aggregate contains the given action item, false otherwise.

Implements SiliconStudio.ActionStack.IAggregateActionItem.

Definition at line 46 of file AggregateActionItem.cs.

override void SiliconStudio.ActionStack.AggregateActionItem.FreezeMembers ( )
protectedvirtual

Invoked by Freeze before setting IsFrozen to true. This method will not be invoked if IsFrozen is already true.

Implements SiliconStudio.ActionStack.ActionItem.

Definition at line 73 of file AggregateActionItem.cs.

IEnumerable<IActionItem> SiliconStudio.ActionStack.AggregateActionItem.GetInnerActionItems ( )

Gets all action items contained in this aggregate that are not IAggregateActionItem themselves, recursively.

Returns
An enumeration of all action items contained in this aggregate that are not IAggregateActionItem themselves, recursively.

Implements SiliconStudio.ActionStack.IAggregateActionItem.

Definition at line 52 of file AggregateActionItem.cs.

override void SiliconStudio.ActionStack.AggregateActionItem.RedoAction ( )
protectedvirtual

Invoked by Redo after setting IsDone to true.

Implements SiliconStudio.ActionStack.ActionItem.

Reimplemented in SiliconStudio.Presentation.Quantum.CombinedValueChangedActionItem.

Definition at line 87 of file AggregateActionItem.cs.

override void SiliconStudio.ActionStack.AggregateActionItem.UndoAction ( )
protectedvirtual

Invoked by Undo after setting IsDone to true.

Implements SiliconStudio.ActionStack.ActionItem.

Reimplemented in SiliconStudio.Presentation.Quantum.CombinedValueChangedActionItem.

Definition at line 80 of file AggregateActionItem.cs.

Property Documentation

IEnumerable<IActionItem> SiliconStudio.ActionStack.AggregateActionItem.ActionItems
get

Definition at line 40 of file AggregateActionItem.cs.

override bool SiliconStudio.ActionStack.AggregateActionItem.IsSaved
getset

Definition at line 43 of file AggregateActionItem.cs.


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