AlphaFramework API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Protected Member Functions | Protected Attributes | List of all members
AlphaFramework.Editor.UndoTab< T > Class Template Referenceabstract

A base class for all editor windows that have undo-functionality More...

Inheritance diagram for AlphaFramework.Editor.UndoTab< T >:
AlphaFramework.Editor.Tab AlphaFramework.Editor.UndoCloneTab< T > AlphaFramework.Editor.UndoCommandTab AlphaFramework.Editor.Gui.GuiEditor AlphaFramework.Editor.Gui.LanguageEditor AlphaFramework.Editor.World.TemplateEditor< T > AlphaFramework.Editor.Graphics.ParticleSystemEditor AlphaFramework.Editor.Gui.CutsceneEditor AlphaFramework.Editor.Graphics.CpuParticleSystemEditor AlphaFramework.Editor.Graphics.GpuParticleSystemEditor

Public Member Functions

override void Undo ()
 Hook to undo the last change
 
override void Redo ()
 Hook to redo the last undone change
 
- Public Member Functions inherited from AlphaFramework.Editor.Tab
void Open (IToastProvider toastProvider)
 Opens the tab. More...
 
new void Hide ()
 Hides this tab (so that another can be brought to the foreground) More...
 
bool RequestClose ()
 Requests the tab to close, displaying warnings about unsaved data, etc. allowing the user to cancel. More...
 
bool SaveFile ()
 Saves the content of this tab to a file - error-handling included! More...
 
void Delete ()
 Delete the currently selected object in this tab More...
 

Protected Member Functions

 UndoTab ()
 
override void OnSaveFile ()
 Called when the content of this tab is to be saved to a file.
Exceptions
ArgumentExceptionThe file path is invalid.
NotSupportedExceptionThe file path is invalid.
IOExceptionThere was a problem writing a file.
UnauthorizedAccessExceptionWrite access to a file was denied.

 
override void OnChange ()
 Mark the content of this tab as changed (needs to be saved)
 
abstract void OnUndo ()
 Hook to undo the last change More...
 
abstract void OnRedo ()
 Hook to redo the last undone change More...
 
- Protected Member Functions inherited from AlphaFramework.Editor.Tab
 Tab ()
 
void FocusDefaultControl ()
 Set the focus back to the default control on the tab More...
 
virtual void OnInitialize ()
 Called on startup to load the content for this tab. More...
 
virtual void OnDelete ()
 Hook to delete the currently selected object in this tab More...
 
virtual void OnUpdate ()
 Called on startup, content updates and tab switch to refresh any on-screen displays More...
 
virtual void OnClose ()
 Called when the tab needs to shutdown and close More...
 
void ForceClose ()
 Forces the tab to close, displaying warnings about unsaved data, etc. but not allowing the user to cancel. More...
 

Protected Attributes

readonly Button buttonUndo
 The undo button. More...
 
readonly Button buttonRedo
 The redo button. More...
 
readonly Stack< T > UndoBackups = new Stack<T>()
 Entries used by the undo-system to undo changes More...
 
readonly Stack< T > RedoBackups = new Stack<T>()
 Entries used by the undo-system to redo changes previously undone More...
 
- Protected Attributes inherited from AlphaFramework.Editor.Tab
bool _overwrite
 true if an existing file supposed to be overwritten when SaveFile is called. More...
 
string _fullPath
 The complete (rooted) path to load and/or save the file from/to More...
 
bool Changed
 True when unsaved changes to the content exist More...
 
IToastProvider ToastProvider
 Provides a surface for displaying toast messages to the user. More...
 

Additional Inherited Members

- Properties inherited from AlphaFramework.Editor.Tab
string NameUI [get, set]
 The user-friendly name of this editor More...
 
string FilePath [get, set]
 The path to the file in this editor More...
 
- Events inherited from AlphaFramework.Editor.Tab
EventHandler TabClosed
 Occurs after the tab was closed More...
 

Detailed Description

A base class for all editor windows that have undo-functionality

Template Parameters
TData type for storing undo checkpoint information (e.g. cloned snapshots or command logs)

Member Function Documentation

abstract void AlphaFramework.Editor.UndoTab< T >.OnRedo ( )
protectedpure virtual

Hook to redo the last undone change

Implemented in AlphaFramework.Editor.UndoCommandTab, and AlphaFramework.Editor.UndoCloneTab< T >.

abstract void AlphaFramework.Editor.UndoTab< T >.OnUndo ( )
protectedpure virtual

Hook to undo the last change

Implemented in AlphaFramework.Editor.UndoCommandTab, and AlphaFramework.Editor.UndoCloneTab< T >.

Member Data Documentation

readonly Button AlphaFramework.Editor.UndoTab< T >.buttonRedo
protected

The redo button.

readonly Button AlphaFramework.Editor.UndoTab< T >.buttonUndo
protected

The undo button.

readonly Stack<T> AlphaFramework.Editor.UndoTab< T >.RedoBackups = new Stack<T>()
protected

Entries used by the undo-system to redo changes previously undone

readonly Stack<T> AlphaFramework.Editor.UndoTab< T >.UndoBackups = new Stack<T>()
protected

Entries used by the undo-system to undo changes


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