C# Class ARCed.Editor

Show file Open project: borisblizzard/arcreator

Private Properties

Property	Type	Description
BackupUtilityToolStripMenuItemClick	void
ButtonOpenGameDirectoryClick	void
CloseAllButThisToolStripMenuItemClick	void
CloseProject	void
CloseToolStripMenuItemClick	void
ConfirmProjectClose	bool
EditorFormClosing	void
FileMenuCloseProjectClick	void
FileMenuExitClick	void
FileMenuNewProjectClicked	void
FileMenuOpenProjectClick	void
FileMenuSaveProjectClick	void
FileMenuSaveTemplateClick	void
FloatToolStripMenuItemClick	void
GetContentFromPersistString	IDockContent
HelpMenuAboutClick	void
InitializeComponent	void
IsRunAsAdmin	bool
LoadProject	void
LoadSettings	void
MenuItemFileDropDownOpening	void
MenuStripEditDropDownOpening	void
MenuStripPluginsClicked	void
MenuStripToolsDropDownOpening	void
OpenRecentFileClick	void
RestoreWindowLocation	void
SaveProject	void
SaveToolStripMenuItemClick	void
StartSplash	void
StyleManagerToolStripMenuItemClick	void
ToolComboDatabaseItemClick	void
ToolMenuEditorOptionsClick	void
ToolMenuScriptManagerClick	void
ToolMenuSkinManagerClick	void
ToolScriptMenuAutoCompleteClick	void

Public Methods

Method	Description
AssociateFiles ( ) : void
AttachProcess ( string filename, bool hidden = false ) : void	Starts a process and attaches it to the editor. All child processes will be killed automatically when Editor exits
DatabaseNotify ( RefreshType type ) : void	Notifies all open database windows that objects of a given type need refreshed
Editor ( string filename = null ) : System	Constructs a new Editor, automatically opening a a project if filename is given
OpenScript ( Script script, bool show = false ) : ScriptEditorForm	Creates a script editor panel and puts it in the opened script list
OpenScript ( string file, bool show = false ) : ScriptEditorForm	Creates a script editor panel and puts it in the opened script list
Show ( DockContent window, DockState state = DockState.Unknown ) : void	Adds and activates a window to the main editor's dock panel
Show ( IPluginClient plugin, DockState state = DockState.Unknown ) : void

Protected Methods

Method	Description
Dispose ( bool disposing ) : void	Clean up any resources being used.

Private Methods

Method	Description
BackupUtilityToolStripMenuItemClick ( object sender, EventArgs e ) : void
ButtonOpenGameDirectoryClick ( object sender, EventArgs e ) : void
CloseAllButThisToolStripMenuItemClick ( object sender, EventArgs e ) : void
CloseProject ( ) : void	Closes the project and resets the Editor back to default
CloseToolStripMenuItemClick ( object sender, EventArgs e ) : void
ConfirmProjectClose ( ) : bool	Asks confirmation before continuing if there are unsaved changes to the project.
EditorFormClosing ( object sender, FormClosingEventArgs e ) : void
FileMenuCloseProjectClick ( object sender, EventArgs e ) : void	Menu: File -> Close Project
FileMenuExitClick ( object sender, EventArgs e ) : void	Menu: File -> Exit
FileMenuNewProjectClicked ( object sender, EventArgs e ) : void	Menu: File -> New Project...
FileMenuOpenProjectClick ( object sender, EventArgs e ) : void	Menu: File -> Open Project...
FileMenuSaveProjectClick ( object sender, EventArgs e ) : void	Menu: File -> Save Project
FileMenuSaveTemplateClick ( object sender, EventArgs e ) : void	Menu: File -> Save As Template...
FloatToolStripMenuItemClick ( object sender, EventArgs e ) : void
GetContentFromPersistString ( string persistString ) : IDockContent	Creates a window from a string representation of the original and returns it It is important that any plug-in have a parameterless constructor, else it will fail to load from a saved layout.
HelpMenuAboutClick ( object sender, EventArgs e ) : void
InitializeComponent ( ) : void	Required method for Designer support - do not modify the contents of this method with the code editor.
IsRunAsAdmin ( ) : bool
LoadProject ( string path ) : void	Loads the project file at the given path.
LoadSettings ( ) : void	Loads the settings of the editor or initializes new ones if not found.
MenuItemFileDropDownOpening ( object sender, EventArgs e ) : void	Invoked when "File" drop-down is opening on menu strip, enabling/disabling specific options as needed.
MenuStripEditDropDownOpening ( object sender, EventArgs e ) : void	Invoked when the "Tools" drop-down is opening on menu strip, enabling/disabling specific options as needed.
MenuStripPluginsClicked ( object sender, EventArgs e ) : void
MenuStripToolsDropDownOpening ( object sender, EventArgs e ) : void
OpenRecentFileClick ( object sender, EventArgs e ) : void
RestoreWindowLocation ( ) : void	Restores the window size, state, and location it was in from the last save
SaveProject ( ) : void
SaveToolStripMenuItemClick ( object sender, EventArgs e ) : void
StartSplash ( string filename ) : void
StyleManagerToolStripMenuItemClick ( object sender, EventArgs e ) : void
ToolComboDatabaseItemClick ( object sender, EventArgs e ) : void	TEST PURPOSES ONLY
ToolMenuEditorOptionsClick ( object sender, EventArgs e ) : void
ToolMenuScriptManagerClick ( object sender, EventArgs e ) : void
ToolMenuSkinManagerClick ( object sender, EventArgs e ) : void
ToolScriptMenuAutoCompleteClick ( object sender, EventArgs e ) : void

Method Details

AssociateFiles() public static method

public static AssociateFiles ( ) : void
return	void

AttachProcess() public static method

Starts a process and attaches it to the editor.

All child processes will be killed automatically when Editor exits

public static AttachProcess ( string filename, bool hidden = false ) : void
filename	string	The path to the process
hidden	bool	Flag to start hidden or not
return	void

DatabaseNotify() public static method

Notifies all open database windows that objects of a given type need refreshed

public static DatabaseNotify ( RefreshType type ) : void
type	RefreshType	Flag for type of object to refresh
return	void

Dispose() protected method

Clean up any resources being used.

protected Dispose ( bool disposing ) : void
disposing	bool	true if managed resources should be disposed; otherwise, false.
return	void

Editor() public method

Constructs a new Editor, automatically opening a a project if filename is given

public Editor ( string filename = null ) : System
filename	string
return	System

OpenScript() public static method

Creates a script editor panel and puts it in the opened script list

public static OpenScript ( Script script, bool show = false ) : ScriptEditorForm
script	Script	The script to open
show	bool	Flag to display the script window
return	ScriptEditorForm

OpenScript() public static method

Creates a script editor panel and puts it in the opened script list

public static OpenScript ( string file, bool show = false ) : ScriptEditorForm
file	string	The path of the script
show	bool	Flag to display the script window
return	ScriptEditorForm

Show() public static method

Adds and activates a window to the main editor's dock panel

public static Show ( DockContent window, DockState state = DockState.Unknown ) : void
window	DockContent	The dockable window
state	DockState	The initial state of the window
return	void

Show() public static method

public static Show ( IPluginClient plugin, DockState state = DockState.Unknown ) : void
plugin	IPluginClient
state	DockState
return	void