AlphaFramework API  1.0.3
 All Classes Namespaces Functions Variables Enumerations Enumerator Properties Events
Public Member Functions | Static Public Member Functions | Protected Member Functions | List of all members
AlphaFramework.Editor.FileSelectorDialog Class Reference

Allows the user to select a file for the Mod (stored in an Archive or a real file) More...

Inheritance diagram for AlphaFramework.Editor.FileSelectorDialog:

Public Member Functions

 FileSelectorDialog ()
 

Static Public Member Functions

static bool TryGetPath (string type, string extension, out string path, out bool overwrite)
 Gets the file path for a game-content file (allowing the user to create a new file) More...
 
static bool TryGetPath (string type, string extension, out string path)
 Gets the file path for a game-content file (not allowing the user to create a new file) More...
 

Protected Member Functions

override void Dispose (bool disposing)
 Clean up any resources being used. More...
 

Detailed Description

Allows the user to select a file for the Mod (stored in an Archive or a real file)

Member Function Documentation

override void AlphaFramework.Editor.FileSelectorDialog.Dispose ( bool  disposing)
inlineprotected

Clean up any resources being used.

Parameters
disposingtrue if managed resources should be disposed; otherwise, false.
static bool AlphaFramework.Editor.FileSelectorDialog.TryGetPath ( string  type,
string  extension,
out string  path,
out bool  overwrite 
)
inlinestatic

Gets the file path for a game-content file (allowing the user to create a new file)

Parameters
typeThe type of file you want (e.g. Textures, Sounds, ...)
extensionThe file extension of the file type with a dot, but without a asterisk (e.g. .xml, .png, ...)
pathThe absolute path to the requested content file
overwriteReturns whether the user wants an existing file to be overwritten
Returns
true if a file was selected, false if none was selected
Exceptions
InvalidOperationExceptionThe user didn't select a file.
static bool AlphaFramework.Editor.FileSelectorDialog.TryGetPath ( string  type,
string  extension,
out string  path 
)
inlinestatic

Gets the file path for a game-content file (not allowing the user to create a new file)

Parameters
typeThe type of file you want (e.g. Textures, Sounds, ...)
extensionThe file extension of the file type with a dot, but without a asterisk (e.g. .xml, .png, ...)
pathThe absolute path to the requested content file
Returns
true if a file was selected, false if none was selected
Exceptions
InvalidOperationExceptionThe user didn't select a file.

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