C# Class AGS.Editor.GUIController

Inheritance: IGUIController

Show file Open project: adventuregamestudio/ags Class Usage Examples

Private Properties

Property	Type	Description
AutoComplete_BackgroundCacheUpdateStatusChanged	void
AutoNumberSpeechLinesProcess	object
CheckInOrAddFiles	void
ConstructRoomTemplateFileList	string[]
CreateNewGame	bool
CreateVoiceActingScriptProcess	object
EnsureLastImportDirectoryIsSet	void
GUIController	System
GetMenuCommandID	string
IGUIController	Sprite
ProcessCommandLineArgumentsAndReturnWhetherToShowWelcomeScreen	bool
PropertyTabInteractions_UpdateEventName	string
RegisterContextMenuCommands	void
RegisterMenuCommand	string
SaveEditorWindowSizeToRegistry	void
ScriptFunctionUIEditor_CreateScriptFunction	void
ScriptFunctionUIEditor_OpenScriptEditor	void
SetEditorWindowSizeFromRegistry	void
ShowCustomResolutionChooserFromPropertyGrid	System.Drawing.Size
ShowNewGameWizard	bool
ShowPropertiesEditorFromPropertyGrid	void
ShowRoomMessageEditorFromPropertyGrid	void
ShowSpriteChooserFromPropertyGrid	int
ShowViewChooserFromPropertyGrid	int
SystemEvents_DisplaySettingsChanging	void
WriteLineIfItHasVoiceFile	void
WriteLinesForCharacter	void
_mainForm_OnActiveDocumentChanged	void
_mainForm_OnEditorShutdown	bool
_mainForm_OnMainWindowActivated	void
timer_Tick	void

Public Methods

Method	Description
AddMenu ( IEditorComponent plugin, string id, string title ) : void
AddMenu ( IEditorComponent plugin, string id, string title, string insertAfterMenu ) : void
AddMenuItems ( IEditorComponent plugin, MenuCommands commands ) : void
AddOrShowPane ( AGS.Types.ContentDocument pane ) : void
AdjustSizeFrom96DpiToSystemDpi ( int sizeAt96Dpi ) : int
CanFindComponentFromMenuItemID ( string menuItemID ) : bool
ClearOutputPanel ( ) : void
CreateMenuCommand ( IEditorComponent component, string commandID, string commandName ) : AGS.Types.MenuCommand
CreateScriptEditor ( Point position, Size size ) : IScriptEditorControl
CustomPropertiesEditor ( AGS.Types.CustomProperties properties, CustomPropertyAppliesTo showPropertiesOfType ) : void
DocumentTitlesChanged ( ) : void
ExitApplication ( ) : void
GameNameUpdated ( ) : void
GetPropertyGridObject ( ) : object
GetScriptEditorControl ( string scriptFileName, bool showEditor ) : IScriptEditorControl
GetSystemDPI ( ) : int
HideCallStack ( ) : void
HideFindSymbolResults ( ) : void
HideOutputPanel ( ) : void
IGUIController ( Graphics g, int spriteNumber, int x, int y, int width, int height, bool centreHorizontally ) : void
IGUIController ( string text ) : void
IGUIController ( string fileName, int lineNumber ) : void
Initialize ( AGSEditor agsEditor ) : void
Invoke ( Delegate method ) : void
LaunchHelpForKeyword ( string keyword ) : void
MoveMouseCursorToPropertyGrid ( ) : void
QueryWhetherToSaveGameBeforeContinuing ( string message ) : bool
RePopulateTreeView ( IEditorComponent component ) : void
RePopulateTreeView ( IEditorComponent component, string selectedNode ) : void
RefreshPropertyGrid ( ) : void
RegisterIcon ( string key, Icon icon ) : void
RemoveMenuItems ( MenuCommands commands ) : void
RemovePaneIfExists ( AGS.Types.ContentDocument pane ) : void
SelectEventsTabInPropertyGrid ( ) : bool
SelectPropertyByName ( string propertyName ) : void
SetMenuItemEnabled ( IEditorComponent plugin, string id, bool enabled ) : void
SetPropertyGridObject ( object objectToSetPropertiesOn ) : void
SetPropertyGridObjectList ( object>.Dictionary propertyObjects ) : void
SetPropertyGridObjects ( object objectsToSetPropertiesOn ) : void
SetTitleBarPrefix ( string prefix ) : void
ShowAutoNumberSpeechWizard ( ) : void
ShowCallStack ( AGS.Editor.DebugCallStack callStack ) : void
ShowCheckOutDialog ( List fileNames ) : bool
ShowCheckOutDialog ( string fileName ) : bool
ShowCreateRoomTemplateWizard ( AGS.Types.UnloadedRoom room ) : void
ShowCreateTemplateWizard ( ) : void
ShowCreateVoiceActingScriptWizard ( ) : void
ShowCuppit ( string helpText, string helpTextID ) : void
ShowCuppit ( string helpText, string helpTextID, bool modal ) : void
ShowFindSymbolResults ( List results ) : void
ShowMessage ( string message, MessageBoxIcon icon ) : void
ShowMessage ( string message, MessageBoxIconType icon ) : void
ShowOpenFileDialog ( string title, string fileFilter ) : string
ShowOpenFileDialog ( string title, string fileFilter, bool useFileImportPath ) : string
ShowOpenFileDialogMultipleFiles ( string title, string fileFilter ) : string[]
ShowOutputPanel ( CompileMessages errors ) : void
ShowPendingCheckinsDialog ( ) : void
ShowPreferencesEditor ( ) : void
ShowQuestion ( string message ) : DialogResult
ShowQuestion ( string message, MessageBoxIcon icon ) : DialogResult
ShowSaveFileDialog ( string title, string fileFilter ) : string
ShowSelectFolderOrDefaultDialog ( string title, string defaultPath ) : string
ShowSelectFolderOrDefaultDialog ( string title, string defaultPath, bool allowNewFolder ) : string
ShowSelectFolderOrNoneDialog ( string title, string initialPath ) : string
ShowSelectFolderOrNoneDialog ( string title, string initialPath, bool allowNewFolder ) : string
ShowWelcomeScreen ( ) : bool
StartGUI ( string commandLineArguments ) : void
UpdateStatusBarText ( string text ) : void
VerifyTemplatesDirectoryExists ( ) : bool
ZoomToFile ( string fileName ) : void
ZoomToFile ( string fileName, ZoomToFileZoomType zoomType, int zoomToPosition ) : void
ZoomToFile ( string fileName, ZoomToFileZoomType zoomType, int zoomPosition, bool isDebugExecutionPoint ) : void
ZoomToFile ( string fileName, ZoomToFileZoomType zoomType, int zoomPosition, bool isDebugExecutionPoint, bool selectWholeLine, string errorMessage, bool activateEditor ) : void
ZoomToFile ( string fileName, int lineNumber ) : void
ZoomToFile ( string fileName, int lineNumber, bool isDebugExecutionPoint, string errorMessage ) : void
ZoomToFile ( string fileName, string function ) : void
_mainForm_OnMenuClick ( string menuItemID ) : void
_mainForm_OnPropertyChanged ( string propertyName, object oldValue ) : void
_mainForm_OnPropertyObjectChanged ( object newPropertyObject ) : void

Private Methods

Method	Description
AutoComplete_BackgroundCacheUpdateStatusChanged ( BackgroundAutoCompleteStatus status, Exception errorDetails ) : void
AutoNumberSpeechLinesProcess ( object parameter ) : object
CheckInOrAddFiles ( string selectedFiles, string checkinComments ) : void
ConstructRoomTemplateFileList ( AGS.Types.UnloadedRoom room ) : string[]
CreateNewGame ( string newGameDirectory, string newGameName, AGS.Types.GameTemplate createFromTemplate ) : bool
CreateVoiceActingScriptProcess ( object parameter ) : object
EnsureLastImportDirectoryIsSet ( bool useFileImportPath ) : void
GUIController ( ) : System
GetMenuCommandID ( string id, IEditorComponent component ) : string
IGUIController ( int initiallySelectedSprite ) : Sprite
ProcessCommandLineArgumentsAndReturnWhetherToShowWelcomeScreen ( ) : bool
PropertyTabInteractions_UpdateEventName ( string eventName ) : string
RegisterContextMenuCommands ( IList commands, IEditorComponent plugin ) : void
RegisterMenuCommand ( string id, IEditorComponent component ) : string
SaveEditorWindowSizeToRegistry ( ) : void
ScriptFunctionUIEditor_CreateScriptFunction ( bool isGlobalScript, string functionName, string parameters ) : void
ScriptFunctionUIEditor_OpenScriptEditor ( bool isGlobalScript, string functionName ) : void
SetEditorWindowSizeFromRegistry ( ) : void
ShowCustomResolutionChooserFromPropertyGrid ( Size currentSize ) : Size
ShowNewGameWizard ( ) : bool
ShowPropertiesEditorFromPropertyGrid ( AGS.Types.CustomProperties props, object objectThatHasProperties ) : void
ShowRoomMessageEditorFromPropertyGrid ( List messages ) : void
ShowSpriteChooserFromPropertyGrid ( int currentSprite ) : int
ShowViewChooserFromPropertyGrid ( int currentView ) : int
SystemEvents_DisplaySettingsChanging ( object sender, EventArgs e ) : void
WriteLineIfItHasVoiceFile ( string prefix, string line, StreamWriter sw ) : void
WriteLinesForCharacter ( int charID, StreamWriter sw, string>.Dictionary lines ) : void
_mainForm_OnActiveDocumentChanged ( ) : void
_mainForm_OnEditorShutdown ( ) : bool
_mainForm_OnMainWindowActivated ( object sender, EventArgs e ) : void
timer_Tick ( object sender, EventArgs e ) : void

Method Details

AddMenu() public method

public AddMenu ( IEditorComponent plugin, string id, string title ) : void
plugin	IEditorComponent
id	string
title	string
return	void

AddMenu() public method

public AddMenu ( IEditorComponent plugin, string id, string title, string insertAfterMenu ) : void
plugin	IEditorComponent
id	string
title	string
insertAfterMenu	string
return	void

AddMenuItems() public method

public AddMenuItems ( IEditorComponent plugin, MenuCommands commands ) : void
plugin	IEditorComponent
commands	MenuCommands
return	void

AddOrShowPane() public method

public AddOrShowPane ( AGS.Types.ContentDocument pane ) : void
pane	AGS.Types.ContentDocument
return	void

AdjustSizeFrom96DpiToSystemDpi() public method

public AdjustSizeFrom96DpiToSystemDpi ( int sizeAt96Dpi ) : int
sizeAt96Dpi	int
return	int

CanFindComponentFromMenuItemID() public method

public CanFindComponentFromMenuItemID ( string menuItemID ) : bool
menuItemID	string
return	bool

ClearOutputPanel() public method

public ClearOutputPanel ( ) : void
return	void

CreateMenuCommand() public method

public CreateMenuCommand ( IEditorComponent component, string commandID, string commandName ) : AGS.Types.MenuCommand
component	IEditorComponent
commandID	string
commandName	string
return	AGS.Types.MenuCommand

CreateScriptEditor() public method

public CreateScriptEditor ( Point position, Size size ) : IScriptEditorControl
position	Point
size	System.Drawing.Size
return	IScriptEditorControl

CustomPropertiesEditor() public method

public CustomPropertiesEditor ( AGS.Types.CustomProperties properties, CustomPropertyAppliesTo showPropertiesOfType ) : void
properties	AGS.Types.CustomProperties
showPropertiesOfType	CustomPropertyAppliesTo
return	void

DocumentTitlesChanged() public method

public DocumentTitlesChanged ( ) : void
return	void

ExitApplication() public method

public ExitApplication ( ) : void
return	void

GameNameUpdated() public method

public GameNameUpdated ( ) : void
return	void

GetPropertyGridObject() public method

public GetPropertyGridObject ( ) : object
return	object

GetScriptEditorControl() public method

public GetScriptEditorControl ( string scriptFileName, bool showEditor ) : IScriptEditorControl
scriptFileName	string
showEditor	bool
return	IScriptEditorControl

GetSystemDPI() public method

public GetSystemDPI ( ) : int
return	int

HideCallStack() public method

public HideCallStack ( ) : void
return	void

HideFindSymbolResults() public method

public HideFindSymbolResults ( ) : void
return	void

HideOutputPanel() public method

public HideOutputPanel ( ) : void
return	void

IGUIController() public method

public IGUIController ( Graphics g, int spriteNumber, int x, int y, int width, int height, bool centreHorizontally ) : void
g	System.Drawing.Graphics
spriteNumber	int
x	int
y	int
width	int
height	int
centreHorizontally	bool
return	void

IGUIController() public method

public IGUIController ( string text ) : void
text	string
return	void

IGUIController() public method

public IGUIController ( string fileName, int lineNumber ) : void
fileName	string
lineNumber	int
return	void

Initialize() public method

public Initialize ( AGSEditor agsEditor ) : void
agsEditor	AGSEditor
return	void

Invoke() public method

public Invoke ( Delegate method ) : void
method	System.Delegate
return	void

LaunchHelpForKeyword() public method

public LaunchHelpForKeyword ( string keyword ) : void
keyword	string
return	void

MoveMouseCursorToPropertyGrid() public method

public MoveMouseCursorToPropertyGrid ( ) : void
return	void

QueryWhetherToSaveGameBeforeContinuing() public method

public QueryWhetherToSaveGameBeforeContinuing ( string message ) : bool
message	string
return	bool

RePopulateTreeView() public method

public RePopulateTreeView ( IEditorComponent component ) : void
component	IEditorComponent
return	void

RePopulateTreeView() public method

public RePopulateTreeView ( IEditorComponent component, string selectedNode ) : void
component	IEditorComponent
selectedNode	string
return	void

RefreshPropertyGrid() public method

public RefreshPropertyGrid ( ) : void
return	void

RegisterIcon() public method

public RegisterIcon ( string key, Icon icon ) : void
key	string
icon	System.Drawing.Icon
return	void

RemoveMenuItems() public method

public RemoveMenuItems ( MenuCommands commands ) : void
commands	MenuCommands
return	void

RemovePaneIfExists() public method

public RemovePaneIfExists ( AGS.Types.ContentDocument pane ) : void
pane	AGS.Types.ContentDocument
return	void

SelectEventsTabInPropertyGrid() public method

public SelectEventsTabInPropertyGrid ( ) : bool
return	bool

SelectPropertyByName() public method

public SelectPropertyByName ( string propertyName ) : void
propertyName	string
return	void

SetMenuItemEnabled() public method

public SetMenuItemEnabled ( IEditorComponent plugin, string id, bool enabled ) : void
plugin	IEditorComponent
id	string
enabled	bool
return	void

SetPropertyGridObject() public method

public SetPropertyGridObject ( object objectToSetPropertiesOn ) : void
objectToSetPropertiesOn	object
return	void

SetPropertyGridObjectList() public method

public SetPropertyGridObjectList ( object>.Dictionary propertyObjects ) : void
propertyObjects	object>.Dictionary
return	void

SetPropertyGridObjects() public method

public SetPropertyGridObjects ( object objectsToSetPropertiesOn ) : void
objectsToSetPropertiesOn	object
return	void

SetTitleBarPrefix() public method

public SetTitleBarPrefix ( string prefix ) : void
prefix	string
return	void

ShowAutoNumberSpeechWizard() public method

public ShowAutoNumberSpeechWizard ( ) : void
return	void

ShowCallStack() public method

public ShowCallStack ( AGS.Editor.DebugCallStack callStack ) : void
callStack	AGS.Editor.DebugCallStack
return	void

ShowCheckOutDialog() public method

public ShowCheckOutDialog ( List fileNames ) : bool
fileNames	List
return	bool

ShowCheckOutDialog() public method

public ShowCheckOutDialog ( string fileName ) : bool
fileName	string
return	bool

ShowCreateRoomTemplateWizard() public method

public ShowCreateRoomTemplateWizard ( AGS.Types.UnloadedRoom room ) : void
room	AGS.Types.UnloadedRoom
return	void

ShowCreateTemplateWizard() public method

public ShowCreateTemplateWizard ( ) : void
return	void

ShowCreateVoiceActingScriptWizard() public method

public ShowCreateVoiceActingScriptWizard ( ) : void
return	void

ShowCuppit() public method

public ShowCuppit ( string helpText, string helpTextID ) : void
helpText	string
helpTextID	string
return	void

ShowCuppit() public method

public ShowCuppit ( string helpText, string helpTextID, bool modal ) : void
helpText	string
helpTextID	string
modal	bool
return	void

ShowFindSymbolResults() public method

public ShowFindSymbolResults ( List results ) : void
results	List
return	void

ShowMessage() public method

public ShowMessage ( string message, MessageBoxIcon icon ) : void
message	string
icon	MessageBoxIcon
return	void

ShowMessage() public method

public ShowMessage ( string message, MessageBoxIconType icon ) : void
message	string
icon	MessageBoxIconType
return	void

ShowOpenFileDialog() public method

public ShowOpenFileDialog ( string title, string fileFilter ) : string
title	string
fileFilter	string
return	string

ShowOpenFileDialog() public method

public ShowOpenFileDialog ( string title, string fileFilter, bool useFileImportPath ) : string
title	string
fileFilter	string
useFileImportPath	bool
return	string

ShowOpenFileDialogMultipleFiles() public method

public ShowOpenFileDialogMultipleFiles ( string title, string fileFilter ) : string[]
title	string
fileFilter	string
return	string[]

ShowOutputPanel() public method

public ShowOutputPanel ( CompileMessages errors ) : void
errors	CompileMessages
return	void

ShowPendingCheckinsDialog() public method

public ShowPendingCheckinsDialog ( ) : void
return	void

ShowPreferencesEditor() public method

public ShowPreferencesEditor ( ) : void
return	void

ShowQuestion() public method

public ShowQuestion ( string message ) : DialogResult
message	string
return	DialogResult

ShowQuestion() public method

public ShowQuestion ( string message, MessageBoxIcon icon ) : DialogResult
message	string
icon	MessageBoxIcon
return	DialogResult

ShowSaveFileDialog() public method

public ShowSaveFileDialog ( string title, string fileFilter ) : string
title	string
fileFilter	string
return	string

ShowSelectFolderOrDefaultDialog() public method

public ShowSelectFolderOrDefaultDialog ( string title, string defaultPath ) : string
title	string
defaultPath	string
return	string

ShowSelectFolderOrDefaultDialog() public method

public ShowSelectFolderOrDefaultDialog ( string title, string defaultPath, bool allowNewFolder ) : string
title	string
defaultPath	string
allowNewFolder	bool
return	string

ShowSelectFolderOrNoneDialog() public method

public ShowSelectFolderOrNoneDialog ( string title, string initialPath ) : string
title	string
initialPath	string
return	string

ShowSelectFolderOrNoneDialog() public method

public ShowSelectFolderOrNoneDialog ( string title, string initialPath, bool allowNewFolder ) : string
title	string
initialPath	string
allowNewFolder	bool
return	string

ShowWelcomeScreen() public method

public ShowWelcomeScreen ( ) : bool
return	bool

StartGUI() public method

public StartGUI ( string commandLineArguments ) : void
commandLineArguments	string
return	void

UpdateStatusBarText() public method

public UpdateStatusBarText ( string text ) : void
text	string
return	void

VerifyTemplatesDirectoryExists() public method

public VerifyTemplatesDirectoryExists ( ) : bool
return	bool

ZoomToFile() public method

public ZoomToFile ( string fileName ) : void
fileName	string
return	void

ZoomToFile() public method

public ZoomToFile ( string fileName, ZoomToFileZoomType zoomType, int zoomToPosition ) : void
fileName	string
zoomType	ZoomToFileZoomType
zoomToPosition	int
return	void

ZoomToFile() public method

public ZoomToFile ( string fileName, ZoomToFileZoomType zoomType, int zoomPosition, bool isDebugExecutionPoint ) : void
fileName	string
zoomType	ZoomToFileZoomType
zoomPosition	int
isDebugExecutionPoint	bool
return	void

ZoomToFile() public method

public ZoomToFile ( string fileName, ZoomToFileZoomType zoomType, int zoomPosition, bool isDebugExecutionPoint, bool selectWholeLine, string errorMessage, bool activateEditor ) : void
fileName	string
zoomType	ZoomToFileZoomType
zoomPosition	int
isDebugExecutionPoint	bool
selectWholeLine	bool
errorMessage	string
activateEditor	bool
return	void

ZoomToFile() public method

public ZoomToFile ( string fileName, int lineNumber ) : void
fileName	string
lineNumber	int
return	void

ZoomToFile() public method

public ZoomToFile ( string fileName, int lineNumber, bool isDebugExecutionPoint, string errorMessage ) : void
fileName	string
lineNumber	int
isDebugExecutionPoint	bool
errorMessage	string
return	void

ZoomToFile() public method

public ZoomToFile ( string fileName, string function ) : void
fileName	string
function	string
return	void

_mainForm_OnMenuClick() public method

public _mainForm_OnMenuClick ( string menuItemID ) : void
menuItemID	string
return	void

_mainForm_OnPropertyChanged() public method

public _mainForm_OnPropertyChanged ( string propertyName, object oldValue ) : void
propertyName	string
oldValue	object
return	void

_mainForm_OnPropertyObjectChanged() public method

public _mainForm_OnPropertyObjectChanged ( object newPropertyObject ) : void
newPropertyObject	object
return	void