diff --git a/ShiftOS.Updater.exe/App.config b/ShiftOS.Updater.exe/App.config deleted file mode 100644 index 88fa402..0000000 --- a/ShiftOS.Updater.exe/App.config +++ /dev/null @@ -1,6 +0,0 @@ - - - - - - \ No newline at end of file diff --git a/ShiftOS.Updater.exe/Program.cs b/ShiftOS.Updater.exe/Program.cs deleted file mode 100644 index aa87901..0000000 --- a/ShiftOS.Updater.exe/Program.cs +++ /dev/null @@ -1,15 +0,0 @@ -using System; -using System.Collections.Generic; -using System.Linq; -using System.Text; -using System.Threading.Tasks; - -namespace ShiftOS.Updater.exe -{ - class Program - { - static void Main(string[] args) - { - } - } -} diff --git a/ShiftOS.Updater.exe/Properties/AssemblyInfo.cs b/ShiftOS.Updater.exe/Properties/AssemblyInfo.cs deleted file mode 100644 index 69ba9c9..0000000 --- a/ShiftOS.Updater.exe/Properties/AssemblyInfo.cs +++ /dev/null @@ -1,36 +0,0 @@ -using System.Reflection; -using System.Runtime.CompilerServices; -using System.Runtime.InteropServices; - -// General Information about an assembly is controlled through the following -// set of attributes. Change these attribute values to modify the information -// associated with an assembly. -[assembly: AssemblyTitle("ShiftOS.Updater.exe")] -[assembly: AssemblyDescription("")] -[assembly: AssemblyConfiguration("")] -[assembly: AssemblyCompany("")] -[assembly: AssemblyProduct("ShiftOS.Updater.exe")] -[assembly: AssemblyCopyright("Copyright © 2017")] -[assembly: AssemblyTrademark("")] -[assembly: AssemblyCulture("")] - -// Setting ComVisible to false makes the types in this assembly not visible -// to COM components. If you need to access a type in this assembly from -// COM, set the ComVisible attribute to true on that type. -[assembly: ComVisible(false)] - -// The following GUID is for the ID of the typelib if this project is exposed to COM -[assembly: Guid("8031adf5-caf0-4210-bec0-964a9db130a9")] - -// Version information for an assembly consists of the following four values: -// -// Major Version -// Minor Version -// Build Number -// Revision -// -// You can specify all the values or you can default the Build and Revision Numbers -// by using the '*' as shown below: -// [assembly: AssemblyVersion("1.0.*")] -[assembly: AssemblyVersion("1.0.0.0")] -[assembly: AssemblyFileVersion("1.0.0.0")] diff --git a/ShiftOS.Updater.exe/ShiftOS.Updater.exe.csproj b/ShiftOS.Updater.exe/ShiftOS.Updater.exe.csproj deleted file mode 100644 index 6142844..0000000 --- a/ShiftOS.Updater.exe/ShiftOS.Updater.exe.csproj +++ /dev/null @@ -1,60 +0,0 @@ - - - - - Debug - AnyCPU - {8031ADF5-CAF0-4210-BEC0-964A9DB130A9} - Exe - Properties - ShiftOS.Updater.exe - ShiftOS.Updater.exe - v4.5.2 - 512 - true - - - AnyCPU - true - full - false - bin\Debug\ - DEBUG;TRACE - prompt - 4 - - - AnyCPU - pdbonly - true - bin\Release\ - TRACE - prompt - 4 - - - - - - - - - - - - - - - - - - - - - \ No newline at end of file diff --git a/ShiftOS_TheReturn/AppearanceManager.cs b/ShiftOS_TheReturn/AppearanceManager.cs index dc88092..4c1754e 100644 --- a/ShiftOS_TheReturn/AppearanceManager.cs +++ b/ShiftOS_TheReturn/AppearanceManager.cs @@ -38,6 +38,9 @@ using static ShiftOS.Engine.SaveSystem; namespace ShiftOS.Engine { + /// + /// Provides functionality for managing windows within ShiftOS. + /// public static class AppearanceManager { [Obsolete("Please use Localization.GetAllLanguages().")] @@ -46,38 +49,16 @@ namespace ShiftOS.Engine return Localization.GetAllLanguages(); } - public static void AddFocusEvents(Control ctrl, Control child) - { - child.Enter += (o, a) => - { - ctrl.BringToFront(); - }; - child.MouseDown += (o, a) => - { - ctrl.BringToFront(); - }; - - foreach (Control c in child.Controls) - { - c.Enter += (o, a) => - { - ctrl.BringToFront(); - }; - c.MouseDown += (o, a) => - { - ctrl.BringToFront(); - }; - - try - { - AddFocusEvents(ctrl, c); - } - catch { } - } - } - + /// + /// Sets the title text of the specified window. + /// + /// The window to modify + /// The title text to use + /// Thrown if the window is null. public static void SetWindowTitle(IShiftOSWindow window, string title) { + if (window == null) + throw new ArgumentNullException("window", "The window cannot be null."); winmgr.SetTitle(window, title); } @@ -103,8 +84,16 @@ namespace ShiftOS.Engine return types; } + /// + /// Returns the default window title for a specified -inheriting type. + /// + /// The type to scan + /// The default title + /// Thrown if is null. public static string GetDefaultTitle(Type winType) { + if (winType == null) + throw new ArgumentNullException("winType"); foreach(var attrib in winType.GetCustomAttributes(false)) { if(attrib is DefaultTitleAttribute) @@ -115,78 +104,123 @@ namespace ShiftOS.Engine return winType.Name; } - public static string LastTerminalText { get; set; } + /// + /// Current cursor position of the console + /// public static int CurrentPosition { get; set; } + + /// + /// We don't know what this does. It may be gone if it does nothing. + /// public static int LastLength { get; set; } + /// + /// Minimize a window. + /// + /// The window border to minimize. + /// Thrown if is null. + /// Thrown if this part of the engine hasn't been enabled. public static void Minimize(IWindowBorder form) { + if (form == null) + throw new ArgumentNullException("form"); + if (winmgr == null) + throw new EngineModuleDisabledException(); winmgr.Minimize(form); } + /// + /// Maximizes a window. + /// + /// The window border to maximize. + /// Thrown if is null. + /// Thrown if this engine module hasn't been enabled. public static void Maximize(IWindowBorder form) { + if (form == null) + throw new ArgumentNullException("form"); + if (winmgr == null) + throw new EngineModuleDisabledException(); winmgr.Maximize(form); } - + /// + /// Provides a list of all open ShiftOS windows. + /// public static List OpenForms = new List(); - public static bool CanOpenWindow(IShiftOSWindow form) - { -#if !MUD_RAPIDDEV - if (ServerManager.IsSingleplayer) - { - foreach (var attr in form.GetType().GetCustomAttributes(false)) - { - if (attr is MultiplayerOnlyAttribute) - return false; - } - } -#endif - return true; - } - + /// + /// Decorates a window with a border, then shows the window. + /// + /// The window to decorate and show. + /// Thrown if is null. + /// Thrown if this engine module has not been initiated yet. public static void SetupWindow(IShiftOSWindow form) { + if (form == null) + throw new ArgumentNullException("form"); + if (winmgr == null) + throw new EngineModuleDisabledException(); winmgr.SetupWindow(form); Desktop.ResetPanelButtons(); } + /// + /// Closes the specified window. + /// + /// The window to close. + /// Thrown if is null. + /// Thrown if this engine module has not been initiated yet. public static void Close(IShiftOSWindow win) { + if (win == null) + throw new ArgumentNullException("win"); + if (winmgr == null) + throw new EngineModuleDisabledException(); winmgr.Close(win); Desktop.ResetPanelButtons(); } + /// + /// Decorates a window with a border, then shows the window, as a dialog box. + /// + /// The window to decorate and show. + /// Thrown if is null. + /// Thrown if this engine module has not been initiated yet. public static void SetupDialog(IShiftOSWindow form) { + if (form == null) + throw new ArgumentNullException("form"); + if (winmgr == null) + throw new EngineModuleDisabledException(); winmgr.SetupDialog(form); Desktop.ResetPanelButtons(); } + /// + /// The underlying window manager for this engine module + /// private static WindowManager winmgr = null; - public static double Measure(this string text, Font font) - { - return Graphics.FromImage(new Bitmap(1, 1)).MeasureString(text, font).Width; - } - + /// + /// Initiate this engine module, and perform mandatory configuration. + /// + /// A working, configured to use as a backend for this module public static void Initiate(WindowManager mgr) { winmgr = mgr; } - [Obsolete("This is a stub.")] - public static void DoWinformsSkinningMagicOnWpf(this UserControl ctrl) - { - //SetupControls(ctrl); - } - + /// + /// Raised when the engine is entering its shutdown phase. Save your work! + /// public static event EmptyEventHandler OnExit; + /// + /// Starts the engine's exit routine, firing the OnExit event. + /// internal static void Exit() { OnExit?.Invoke(); @@ -194,61 +228,133 @@ namespace ShiftOS.Engine ServerManager.Disconnect(); } - - internal static bool BordersHidden(Form frm) - { - string t = frm.Tag as string; - if (t == null) - return false; - - return t.Contains("hidden"); - } - + /// + /// The current terminal body control. + /// public static ITerminalWidget ConsoleOut { get; set; } + /// + /// Redirects the .NET to a new instance. + /// public static void StartConsoleOut() { Console.SetOut(new TerminalTextWriter()); } + /// + /// Invokes an action on the window management thread. + /// + /// The action to invoke public static void Invoke(Action act) { winmgr.InvokeAction(act); } } + /// + /// Provides the base functionality for a ShiftOS terminal. + /// public interface ITerminalWidget { + /// + /// Write text to this Terminal. + /// + /// Text to write void Write(string text); + /// + /// Write text to this Terminal, followed by a newline. + /// + /// Text to write. void WriteLine(string text); + /// + /// Clear the contents of this Terminal. + /// void Clear(); + /// + /// Move the cursor to the last character in the Terminal. + /// void SelectBottom(); } + /// + /// Provides the base functionality for a ShiftOS window manager. + /// public abstract class WindowManager { + /// + /// Minimizes a window + /// + /// The window border to minimize public abstract void Minimize(IWindowBorder border); + + /// + /// Maximizes a window + /// + /// The window border to maximize public abstract void Maximize(IWindowBorder border); + /// + /// Closes a window + /// + /// The window to close public abstract void Close(IShiftOSWindow win); + /// + /// Decorates a window with a window border, then shows it to the user. + /// + /// The window to decorate. public abstract void SetupWindow(IShiftOSWindow win); + + /// + /// Decorates a window with a border, then shows it to the user as a dialog box. + /// + /// The window to decorate public abstract void SetupDialog(IShiftOSWindow win); + /// + /// Invokes an action on the window management thread. + /// + /// The action to invoke. public abstract void InvokeAction(Action act); + /// + /// Sets the title text of a window. + /// + /// The window to modify. + /// The new title text. public abstract void SetTitle(IShiftOSWindow win, string title); } + /// + /// Provides the base functionality for a typical ShiftOS window border. + /// public interface IWindowBorder { + /// + /// Closes the border along with its window. Unload events should be invoked here. + /// void Close(); + + /// + /// Gets or sets the title text for the window border. + /// string Text { get; set; } + + /// + /// Gets or sets the underlying for this border. + /// IShiftOSWindow ParentWindow { get; set; } } + /// + /// Provides a way of setting default title text for classes. + /// public class DefaultTitleAttribute : Attribute { + /// + /// Creates a new instance of the . + /// + /// A default title to associate with this attribute. public DefaultTitleAttribute(string title) { Title = title; @@ -257,4 +363,17 @@ namespace ShiftOS.Engine public string Title { get; private set; } } + /// + /// An exception that is thrown when mandatory configuration to run a specific method or module hasn't been done yet. + /// + public class EngineModuleDisabledException : Exception + { + /// + /// Initializes a new instance of the . + /// + public EngineModuleDisabledException() : base("This engine module has not yet been enabled.") + { + + } + } }