From d0af3ea3f10f9617ef5cb56bf1285d52280cd36f Mon Sep 17 00:00:00 2001 From: miguel Date: Mon, 23 Jul 2018 22:12:26 -0400 Subject: [PATCH] Doc update --- .../Mono.Terminal.IMainLoopDriver.yml | 165 ++++ .../Mono.Terminal.UnixMainLoop.Condition.yml | 193 +++++ .../Mono.Terminal.UnixMainLoop.yml | 332 ++++++++ .../api/Terminal.Gui/Terminal.Gui.HexView.yml | 748 ++++++++++++++++++ .../Mono.Terminal.IMainLoopDriver.html | 217 +++++ .../Mono.Terminal.UnixMainLoop.Condition.html | 162 ++++ .../Mono.Terminal.UnixMainLoop.html | 332 ++++++++ .../Terminal.Gui/Terminal.Gui.HexView.html | 548 +++++++++++++ docs/articles/keyboard.html | 129 +++ docs/articles/mainloop.html | 212 +++++ ecmadocs/en/Mono.Terminal/IMainLoopDriver.xml | 95 +++ .../Mono.Terminal/UnixMainLoop+Condition.xml | 120 +++ ecmadocs/en/Mono.Terminal/UnixMainLoop.xml | 167 ++++ ecmadocs/en/Terminal.Gui/HexView.xml | 222 ++++++ 14 files changed, 3642 insertions(+) create mode 100644 docfx/api/Mono.Terminal/Mono.Terminal.IMainLoopDriver.yml create mode 100644 docfx/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.yml create mode 100644 docfx/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.yml create mode 100644 docfx/api/Terminal.Gui/Terminal.Gui.HexView.yml create mode 100644 docs/api/Mono.Terminal/Mono.Terminal.IMainLoopDriver.html create mode 100644 docs/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.html create mode 100644 docs/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.html create mode 100644 docs/api/Terminal.Gui/Terminal.Gui.HexView.html create mode 100644 docs/articles/keyboard.html create mode 100644 docs/articles/mainloop.html create mode 100644 ecmadocs/en/Mono.Terminal/IMainLoopDriver.xml create mode 100644 ecmadocs/en/Mono.Terminal/UnixMainLoop+Condition.xml create mode 100644 ecmadocs/en/Mono.Terminal/UnixMainLoop.xml create mode 100644 ecmadocs/en/Terminal.Gui/HexView.xml diff --git a/docfx/api/Mono.Terminal/Mono.Terminal.IMainLoopDriver.yml b/docfx/api/Mono.Terminal/Mono.Terminal.IMainLoopDriver.yml new file mode 100644 index 000000000..0dda23019 --- /dev/null +++ b/docfx/api/Mono.Terminal/Mono.Terminal.IMainLoopDriver.yml @@ -0,0 +1,165 @@ +### YamlMime:ManagedReference +items: +- uid: Mono.Terminal.IMainLoopDriver + id: IMainLoopDriver + children: + - Mono.Terminal.IMainLoopDriver.EventsPending(System.Boolean) + - Mono.Terminal.IMainLoopDriver.MainIteration + - Mono.Terminal.IMainLoopDriver.Setup(Mono.Terminal.MainLoop) + - Mono.Terminal.IMainLoopDriver.Wakeup + langs: + - csharp + name: IMainLoopDriver + nameWithType: IMainLoopDriver + fullName: Mono.Terminal.IMainLoopDriver + type: Interface + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Public interface to create your own platform specific main loop driver. + syntax: + content: public interface IMainLoopDriver + derivedClasses: + - Mono.Terminal.UnixMainLoop + implements: [] +- uid: Mono.Terminal.IMainLoopDriver.EventsPending(System.Boolean) + id: EventsPending(System.Boolean) + parent: Mono.Terminal.IMainLoopDriver + langs: + - csharp + name: EventsPending(Boolean) + nameWithType: IMainLoopDriver.EventsPending(Boolean) + fullName: IMainLoopDriver.EventsPending(Boolean) + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Must report whether there are any events pending, or even block waiting for events. + syntax: + content: public bool EventsPending (bool wait); + parameters: + - id: wait + type: System.Boolean + description: If set to true wait until an event is available, otherwise return immediately. + return: + type: System.Boolean + description: true, if there were pending events, false otherwise. + overload: Mono.Terminal.IMainLoopDriver.EventsPending* + exceptions: [] +- uid: Mono.Terminal.IMainLoopDriver.MainIteration + id: MainIteration + parent: Mono.Terminal.IMainLoopDriver + langs: + - csharp + name: MainIteration() + nameWithType: IMainLoopDriver.MainIteration() + fullName: IMainLoopDriver.MainIteration() + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + syntax: + content: public void MainIteration (); + parameters: [] + overload: Mono.Terminal.IMainLoopDriver.MainIteration* + exceptions: [] +- uid: Mono.Terminal.IMainLoopDriver.Setup(Mono.Terminal.MainLoop) + id: Setup(Mono.Terminal.MainLoop) + parent: Mono.Terminal.IMainLoopDriver + langs: + - csharp + name: Setup(MainLoop) + nameWithType: IMainLoopDriver.Setup(MainLoop) + fullName: IMainLoopDriver.Setup(MainLoop) + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Initializes the main loop driver, gets the calling main loop for the initialization. + syntax: + content: public void Setup (Mono.Terminal.MainLoop mainLoop); + parameters: + - id: mainLoop + type: Mono.Terminal.MainLoop + description: Main loop. + overload: Mono.Terminal.IMainLoopDriver.Setup* + exceptions: [] +- uid: Mono.Terminal.IMainLoopDriver.Wakeup + id: Wakeup + parent: Mono.Terminal.IMainLoopDriver + langs: + - csharp + name: Wakeup() + nameWithType: IMainLoopDriver.Wakeup() + fullName: IMainLoopDriver.Wakeup() + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Wakes up the mainloop that might be waiting on input, must be thread safe. + syntax: + content: public void Wakeup (); + parameters: [] + overload: Mono.Terminal.IMainLoopDriver.Wakeup* + exceptions: [] +references: +- uid: Mono.Terminal.IMainLoopDriver.EventsPending(System.Boolean) + parent: Mono.Terminal.IMainLoopDriver + isExternal: false + name: EventsPending(Boolean) + nameWithType: IMainLoopDriver.EventsPending(Boolean) + fullName: IMainLoopDriver.EventsPending(Boolean) +- uid: System.Boolean + parent: System + isExternal: true + name: Boolean + nameWithType: Boolean + fullName: System.Boolean +- uid: Mono.Terminal.IMainLoopDriver.MainIteration + parent: Mono.Terminal.IMainLoopDriver + isExternal: false + name: MainIteration() + nameWithType: IMainLoopDriver.MainIteration() + fullName: IMainLoopDriver.MainIteration() +- uid: Mono.Terminal.IMainLoopDriver.Setup(Mono.Terminal.MainLoop) + parent: Mono.Terminal.IMainLoopDriver + isExternal: false + name: Setup(MainLoop) + nameWithType: IMainLoopDriver.Setup(MainLoop) + fullName: IMainLoopDriver.Setup(MainLoop) +- uid: Mono.Terminal.MainLoop + parent: Mono.Terminal + isExternal: false + name: MainLoop + nameWithType: MainLoop + fullName: Mono.Terminal.MainLoop +- uid: Mono.Terminal.IMainLoopDriver.Wakeup + parent: Mono.Terminal.IMainLoopDriver + isExternal: false + name: Wakeup() + nameWithType: IMainLoopDriver.Wakeup() + fullName: IMainLoopDriver.Wakeup() +- uid: Mono.Terminal.IMainLoopDriver.EventsPending* + parent: Mono.Terminal.IMainLoopDriver + isExternal: false + name: EventsPending + nameWithType: IMainLoopDriver.EventsPending + fullName: IMainLoopDriver.EventsPending +- uid: Mono.Terminal.IMainLoopDriver.MainIteration* + parent: Mono.Terminal.IMainLoopDriver + isExternal: false + name: MainIteration + nameWithType: IMainLoopDriver.MainIteration + fullName: IMainLoopDriver.MainIteration +- uid: Mono.Terminal.IMainLoopDriver.Setup* + parent: Mono.Terminal.IMainLoopDriver + isExternal: false + name: Setup + nameWithType: IMainLoopDriver.Setup + fullName: IMainLoopDriver.Setup +- uid: Mono.Terminal.IMainLoopDriver.Wakeup* + parent: Mono.Terminal.IMainLoopDriver + isExternal: false + name: Wakeup + nameWithType: IMainLoopDriver.Wakeup + fullName: IMainLoopDriver.Wakeup diff --git a/docfx/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.yml b/docfx/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.yml new file mode 100644 index 000000000..a568144e9 --- /dev/null +++ b/docfx/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.yml @@ -0,0 +1,193 @@ +### YamlMime:ManagedReference +items: +- uid: Mono.Terminal.UnixMainLoop.Condition + id: UnixMainLoop.Condition + children: + - Mono.Terminal.UnixMainLoop.Condition.PollErr + - Mono.Terminal.UnixMainLoop.Condition.PollHup + - Mono.Terminal.UnixMainLoop.Condition.PollIn + - Mono.Terminal.UnixMainLoop.Condition.PollNval + - Mono.Terminal.UnixMainLoop.Condition.PollOut + - Mono.Terminal.UnixMainLoop.Condition.PollPri + langs: + - csharp + name: UnixMainLoop.Condition + nameWithType: UnixMainLoop.Condition + fullName: Mono.Terminal.UnixMainLoop.Condition + type: Enum + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions. + syntax: + content: >- + [System.Flags] + + public enum UnixMainLoop.Condition + inheritance: + - System.Enum + attributes: + - type: System.Flags +- uid: Mono.Terminal.UnixMainLoop.Condition.PollErr + id: PollErr + parent: Mono.Terminal.UnixMainLoop.Condition + langs: + - csharp + name: PollErr + nameWithType: UnixMainLoop.Condition.PollErr + fullName: UnixMainLoop.Condition.PollErr + type: Field + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Error condition on output + syntax: + content: PollErr + return: + type: Mono.Terminal.UnixMainLoop+Condition + description: To be added. + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.Condition.PollHup + id: PollHup + parent: Mono.Terminal.UnixMainLoop.Condition + langs: + - csharp + name: PollHup + nameWithType: UnixMainLoop.Condition.PollHup + fullName: UnixMainLoop.Condition.PollHup + type: Field + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Hang-up on output + syntax: + content: PollHup + return: + type: Mono.Terminal.UnixMainLoop+Condition + description: To be added. + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.Condition.PollIn + id: PollIn + parent: Mono.Terminal.UnixMainLoop.Condition + langs: + - csharp + name: PollIn + nameWithType: UnixMainLoop.Condition.PollIn + fullName: UnixMainLoop.Condition.PollIn + type: Field + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: There is data to read + syntax: + content: PollIn + return: + type: Mono.Terminal.UnixMainLoop+Condition + description: To be added. + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.Condition.PollNval + id: PollNval + parent: Mono.Terminal.UnixMainLoop.Condition + langs: + - csharp + name: PollNval + nameWithType: UnixMainLoop.Condition.PollNval + fullName: UnixMainLoop.Condition.PollNval + type: Field + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: File descriptor is not open. + syntax: + content: PollNval + return: + type: Mono.Terminal.UnixMainLoop+Condition + description: To be added. + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.Condition.PollOut + id: PollOut + parent: Mono.Terminal.UnixMainLoop.Condition + langs: + - csharp + name: PollOut + nameWithType: UnixMainLoop.Condition.PollOut + fullName: UnixMainLoop.Condition.PollOut + type: Field + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Writing to the specified descriptor will not block + syntax: + content: PollOut + return: + type: Mono.Terminal.UnixMainLoop+Condition + description: To be added. + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.Condition.PollPri + id: PollPri + parent: Mono.Terminal.UnixMainLoop.Condition + langs: + - csharp + name: PollPri + nameWithType: UnixMainLoop.Condition.PollPri + fullName: UnixMainLoop.Condition.PollPri + type: Field + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: There is urgent data to read + syntax: + content: PollPri + return: + type: Mono.Terminal.UnixMainLoop+Condition + description: To be added. + exceptions: [] +references: +- uid: System.Enum + parent: System + isExternal: true + name: Enum + nameWithType: Enum + fullName: System.Enum +- uid: Mono.Terminal.UnixMainLoop.Condition.PollErr + parent: Mono.Terminal.UnixMainLoop.Condition + isExternal: false + name: PollErr + nameWithType: UnixMainLoop.Condition.PollErr + fullName: UnixMainLoop.Condition.PollErr +- uid: Mono.Terminal.UnixMainLoop + parent: Mono.Terminal + isExternal: false + name: UnixMainLoop + nameWithType: UnixMainLoop + fullName: Mono.Terminal.UnixMainLoop+Condition +- uid: Mono.Terminal.UnixMainLoop.Condition.PollHup + parent: Mono.Terminal.UnixMainLoop.Condition + isExternal: false + name: PollHup + nameWithType: UnixMainLoop.Condition.PollHup + fullName: UnixMainLoop.Condition.PollHup +- uid: Mono.Terminal.UnixMainLoop.Condition.PollIn + parent: Mono.Terminal.UnixMainLoop.Condition + isExternal: false + name: PollIn + nameWithType: UnixMainLoop.Condition.PollIn + fullName: UnixMainLoop.Condition.PollIn +- uid: Mono.Terminal.UnixMainLoop.Condition.PollNval + parent: Mono.Terminal.UnixMainLoop.Condition + isExternal: false + name: PollNval + nameWithType: UnixMainLoop.Condition.PollNval + fullName: UnixMainLoop.Condition.PollNval +- uid: Mono.Terminal.UnixMainLoop.Condition.PollOut + parent: Mono.Terminal.UnixMainLoop.Condition + isExternal: false + name: PollOut + nameWithType: UnixMainLoop.Condition.PollOut + fullName: UnixMainLoop.Condition.PollOut +- uid: Mono.Terminal.UnixMainLoop.Condition.PollPri + parent: Mono.Terminal.UnixMainLoop.Condition + isExternal: false + name: PollPri + nameWithType: UnixMainLoop.Condition.PollPri + fullName: UnixMainLoop.Condition.PollPri diff --git a/docfx/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.yml b/docfx/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.yml new file mode 100644 index 000000000..2b6fa9a3e --- /dev/null +++ b/docfx/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.yml @@ -0,0 +1,332 @@ +### YamlMime:ManagedReference +items: +- uid: Mono.Terminal.UnixMainLoop + id: UnixMainLoop + children: + - Mono.Terminal.UnixMainLoop.#ctor + - Mono.Terminal.UnixMainLoop.AddWatch(System.Int32,Mono.Terminal.UnixMainLoop.Condition,System.Func{Mono.Terminal.MainLoop,System.Boolean}) + - Mono.Terminal.UnixMainLoop.RemoveWatch(System.Object) + - Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#EventsPending(System.Boolean) + - Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#MainIteration + - Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Setup(Mono.Terminal.MainLoop) + - Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Wakeup + langs: + - csharp + name: UnixMainLoop + nameWithType: UnixMainLoop + fullName: Mono.Terminal.UnixMainLoop + type: Class + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Unix main loop, suitable for using on Posix systems + remarks: >- + In addition to the general functions of the mainloop, the Unix version + can watch file descriptors using the AddWatch methods. + syntax: + content: 'public class UnixMainLoop : Mono.Terminal.IMainLoopDriver' + inheritance: + - System.Object + implements: + - Mono.Terminal.IMainLoopDriver + inheritedMembers: [] +- uid: Mono.Terminal.UnixMainLoop.#ctor + id: '#ctor' + parent: Mono.Terminal.UnixMainLoop + langs: + - csharp + name: UnixMainLoop() + nameWithType: UnixMainLoop.UnixMainLoop() + fullName: UnixMainLoop.UnixMainLoop() + type: Constructor + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + syntax: + content: public UnixMainLoop (); + parameters: [] + overload: Mono.Terminal.UnixMainLoop.#ctor* + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.AddWatch(System.Int32,Mono.Terminal.UnixMainLoop.Condition,System.Func{Mono.Terminal.MainLoop,System.Boolean}) + id: AddWatch(System.Int32,Mono.Terminal.UnixMainLoop.Condition,System.Func{Mono.Terminal.MainLoop,System.Boolean}) + parent: Mono.Terminal.UnixMainLoop + langs: + - csharp + name: AddWatch(Int32, UnixMainLoop+Condition, Func) + nameWithType: UnixMainLoop.AddWatch(Int32, UnixMainLoop+Condition, Func) + fullName: UnixMainLoop.AddWatch(Int32, UnixMainLoop+Condition, Func) + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Watches a file descriptor for activity. + remarks: "When the condition is met, the provided callback\n is invoked. If the callback returns false, the\n watch is automatically removed.\n \n The return value is a token that represents this watch, you can\n use this token to remove the watch by calling RemoveWatch." + syntax: + content: public object AddWatch (int fileDescriptor, Mono.Terminal.UnixMainLoop.Condition condition, Func callback); + parameters: + - id: fileDescriptor + type: System.Int32 + description: To be added. + - id: condition + type: Mono.Terminal.UnixMainLoop+Condition + description: To be added. + - id: callback + type: System.Func{Mono.Terminal.MainLoop,System.Boolean} + description: To be added. + return: + type: System.Object + description: To be added. + overload: Mono.Terminal.UnixMainLoop.AddWatch* + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.RemoveWatch(System.Object) + id: RemoveWatch(System.Object) + parent: Mono.Terminal.UnixMainLoop + langs: + - csharp + name: RemoveWatch(Object) + nameWithType: UnixMainLoop.RemoveWatch(Object) + fullName: UnixMainLoop.RemoveWatch(Object) + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + summary: Removes an active watch from the mainloop. + remarks: The token parameter is the value returned from AddWatch + syntax: + content: public void RemoveWatch (object token); + parameters: + - id: token + type: System.Object + description: To be added. + overload: Mono.Terminal.UnixMainLoop.RemoveWatch* + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#EventsPending(System.Boolean) + id: Mono#Terminal#IMainLoopDriver#EventsPending(System.Boolean) + isEii: true + parent: Mono.Terminal.UnixMainLoop + langs: + - csharp + name: IMainLoopDriver.EventsPending(Boolean) + nameWithType: UnixMainLoop.IMainLoopDriver.EventsPending(Boolean) + fullName: UnixMainLoop.IMainLoopDriver.EventsPending(Boolean) + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + syntax: + content: bool IMainLoopDriver.EventsPending (bool wait); + parameters: + - id: wait + type: System.Boolean + description: To be added. + return: + type: System.Boolean + description: To be added. + overload: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#EventsPending* + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#MainIteration + id: Mono#Terminal#IMainLoopDriver#MainIteration + isEii: true + parent: Mono.Terminal.UnixMainLoop + langs: + - csharp + name: IMainLoopDriver.MainIteration() + nameWithType: UnixMainLoop.IMainLoopDriver.MainIteration() + fullName: UnixMainLoop.IMainLoopDriver.MainIteration() + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + syntax: + content: void IMainLoopDriver.MainIteration (); + parameters: [] + overload: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#MainIteration* + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Setup(Mono.Terminal.MainLoop) + id: Mono#Terminal#IMainLoopDriver#Setup(Mono.Terminal.MainLoop) + isEii: true + parent: Mono.Terminal.UnixMainLoop + langs: + - csharp + name: IMainLoopDriver.Setup(MainLoop) + nameWithType: UnixMainLoop.IMainLoopDriver.Setup(MainLoop) + fullName: UnixMainLoop.IMainLoopDriver.Setup(MainLoop) + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + syntax: + content: void IMainLoopDriver.Setup (Mono.Terminal.MainLoop mainLoop); + parameters: + - id: mainLoop + type: Mono.Terminal.MainLoop + description: To be added. + overload: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Setup* + exceptions: [] +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Wakeup + id: Mono#Terminal#IMainLoopDriver#Wakeup + isEii: true + parent: Mono.Terminal.UnixMainLoop + langs: + - csharp + name: IMainLoopDriver.Wakeup() + nameWithType: UnixMainLoop.IMainLoopDriver.Wakeup() + fullName: UnixMainLoop.IMainLoopDriver.Wakeup() + type: Method + assemblies: + - Terminal.Gui + namespace: Mono.Terminal + syntax: + content: void IMainLoopDriver.Wakeup (); + parameters: [] + overload: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Wakeup* + exceptions: [] +references: +- uid: System.Object + parent: System + isExternal: true + name: Object + nameWithType: Object + fullName: System.Object +- uid: Mono.Terminal.UnixMainLoop.#ctor + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: UnixMainLoop() + nameWithType: UnixMainLoop.UnixMainLoop() + fullName: UnixMainLoop.UnixMainLoop() +- uid: Mono.Terminal.UnixMainLoop.AddWatch(System.Int32,Mono.Terminal.UnixMainLoop.Condition,System.Func{Mono.Terminal.MainLoop,System.Boolean}) + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: AddWatch(Int32, UnixMainLoop+Condition, Func) + nameWithType: UnixMainLoop.AddWatch(Int32, UnixMainLoop+Condition, Func) + fullName: UnixMainLoop.AddWatch(Int32, UnixMainLoop+Condition, Func) +- uid: System.Int32 + parent: System + isExternal: true + name: Int32 + nameWithType: Int32 + fullName: System.Int32 +- uid: Mono.Terminal.UnixMainLoop + parent: Mono.Terminal + isExternal: false + name: UnixMainLoop + nameWithType: UnixMainLoop + fullName: Mono.Terminal.UnixMainLoop+Condition +- uid: System.Func`2 + name: Func + nameWithType: Func + fullName: System.Func +- uid: Mono.Terminal.MainLoop + name: MainLoop + nameWithType: MainLoop + fullName: Mono.Terminal.MainLoop +- uid: System.Boolean + name: Boolean + nameWithType: Boolean + fullName: System.Boolean +- uid: System.Func{Mono.Terminal.MainLoop,System.Boolean} + parent: System + isExternal: true + name: Func + nameWithType: Func + fullName: System.Func + spec.csharp: + - uid: System.Func`2 + name: Func + nameWithType: Func + fullName: System.Func + - name: < + nameWithType: < + fullName: < + - uid: Mono.Terminal.MainLoop + name: MainLoop + nameWithType: MainLoop + fullName: Mono.Terminal.MainLoop + - name: ',' + nameWithType: ',' + fullName: ',' + - uid: System.Boolean + name: Boolean + nameWithType: Boolean + fullName: System.Boolean + - name: '>' + nameWithType: '>' + fullName: '>' +- uid: Mono.Terminal.UnixMainLoop.RemoveWatch(System.Object) + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: RemoveWatch(Object) + nameWithType: UnixMainLoop.RemoveWatch(Object) + fullName: UnixMainLoop.RemoveWatch(Object) +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#EventsPending(System.Boolean) + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: IMainLoopDriver.EventsPending(Boolean) + nameWithType: UnixMainLoop.IMainLoopDriver.EventsPending(Boolean) + fullName: UnixMainLoop.IMainLoopDriver.EventsPending(Boolean) +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#MainIteration + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: IMainLoopDriver.MainIteration() + nameWithType: UnixMainLoop.IMainLoopDriver.MainIteration() + fullName: UnixMainLoop.IMainLoopDriver.MainIteration() +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Setup(Mono.Terminal.MainLoop) + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: IMainLoopDriver.Setup(MainLoop) + nameWithType: UnixMainLoop.IMainLoopDriver.Setup(MainLoop) + fullName: UnixMainLoop.IMainLoopDriver.Setup(MainLoop) +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Wakeup + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: IMainLoopDriver.Wakeup() + nameWithType: UnixMainLoop.IMainLoopDriver.Wakeup() + fullName: UnixMainLoop.IMainLoopDriver.Wakeup() +- uid: Mono.Terminal.UnixMainLoop.#ctor* + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: UnixMainLoop + nameWithType: UnixMainLoop.UnixMainLoop + fullName: UnixMainLoop.UnixMainLoop +- uid: Mono.Terminal.UnixMainLoop.AddWatch* + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: AddWatch + nameWithType: UnixMainLoop.AddWatch + fullName: UnixMainLoop.AddWatch +- uid: Mono.Terminal.UnixMainLoop.RemoveWatch* + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: RemoveWatch + nameWithType: UnixMainLoop.RemoveWatch + fullName: UnixMainLoop.RemoveWatch +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#EventsPending* + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: Mono.Terminal.IMainLoopDriver.EventsPending + nameWithType: UnixMainLoop.Mono.Terminal.IMainLoopDriver.EventsPending + fullName: UnixMainLoop.Mono.Terminal.IMainLoopDriver.EventsPending +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#MainIteration* + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: Mono.Terminal.IMainLoopDriver.MainIteration + nameWithType: UnixMainLoop.Mono.Terminal.IMainLoopDriver.MainIteration + fullName: UnixMainLoop.Mono.Terminal.IMainLoopDriver.MainIteration +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Setup* + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: Mono.Terminal.IMainLoopDriver.Setup + nameWithType: UnixMainLoop.Mono.Terminal.IMainLoopDriver.Setup + fullName: UnixMainLoop.Mono.Terminal.IMainLoopDriver.Setup +- uid: Mono.Terminal.UnixMainLoop.Mono#Terminal#IMainLoopDriver#Wakeup* + parent: Mono.Terminal.UnixMainLoop + isExternal: false + name: Mono.Terminal.IMainLoopDriver.Wakeup + nameWithType: UnixMainLoop.Mono.Terminal.IMainLoopDriver.Wakeup + fullName: UnixMainLoop.Mono.Terminal.IMainLoopDriver.Wakeup +- uid: Mono.Terminal.IMainLoopDriver + parent: Mono.Terminal + isExternal: false + name: IMainLoopDriver + nameWithType: IMainLoopDriver + fullName: Mono.Terminal.IMainLoopDriver diff --git a/docfx/api/Terminal.Gui/Terminal.Gui.HexView.yml b/docfx/api/Terminal.Gui/Terminal.Gui.HexView.yml new file mode 100644 index 000000000..3264a0869 --- /dev/null +++ b/docfx/api/Terminal.Gui/Terminal.Gui.HexView.yml @@ -0,0 +1,748 @@ +### YamlMime:ManagedReference +items: +- uid: Terminal.Gui.HexView + id: HexView + children: + - Terminal.Gui.HexView.#ctor(System.IO.Stream) + - Terminal.Gui.HexView.AllowEdits + - Terminal.Gui.HexView.ApplyEdits + - Terminal.Gui.HexView.DisplayStart + - Terminal.Gui.HexView.Edits + - Terminal.Gui.HexView.Frame + - Terminal.Gui.HexView.PositionCursor + - Terminal.Gui.HexView.ProcessKey(Terminal.Gui.KeyEvent) + - Terminal.Gui.HexView.Redraw(Terminal.Gui.Rect) + - Terminal.Gui.HexView.Source + langs: + - csharp + name: HexView + nameWithType: HexView + fullName: Terminal.Gui.HexView + type: Class + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: An Hex viewer an editor view over a System.IO.Stream + remarks: "

\n This provides a hex editor on top of a seekable stream with the left side showing an hex\n dump of the values in the stream and the right side showing the contents (filterd to \n non-control sequence ascii characters). \n

\n

\n Users can switch from one side to the other by using the tab key. \n

\n

\n If you want to enable editing, set the AllowsEdits property, once that is done, the user\n can make changes to the hexadecimal values of the stream. Any changes done are tracked\n in the Edits property which is a sorted dictionary indicating the position where the \n change was made and the new value. A convenience ApplyEdits method can be used to c\n apply the methods to the underlying stream.\n

\n

\n It is possible to control the first byte shown by setting the DisplayStart property \n to the offset that you want to start viewing.\n

" + syntax: + content: 'public class HexView : Terminal.Gui.View' + inheritance: + - System.Object + - Terminal.Gui.Responder + - Terminal.Gui.View + implements: [] + inheritedMembers: + - Terminal.Gui.Responder.CanFocus + - Terminal.Gui.Responder.MouseEvent(Terminal.Gui.MouseEvent) + - Terminal.Gui.View.Add(Terminal.Gui.View) + - Terminal.Gui.View.Add(Terminal.Gui.View[]) + - Terminal.Gui.View.AddRune(System.Int32,System.Int32,System.Rune) + - Terminal.Gui.View.Bounds + - Terminal.Gui.View.ChildNeedsDisplay + - Terminal.Gui.View.Clear + - Terminal.Gui.View.Clear(Terminal.Gui.Rect) + - Terminal.Gui.View.ClearNeedsDisplay + - Terminal.Gui.View.ClipToBounds + - Terminal.Gui.View.ColorScheme + - Terminal.Gui.View.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean) + - Terminal.Gui.View.DrawHotString(NStack.ustring,System.Boolean,Terminal.Gui.ColorScheme) + - Terminal.Gui.View.DrawHotString(NStack.ustring,Terminal.Gui.Attribute,Terminal.Gui.Attribute) + - Terminal.Gui.View.Driver + - Terminal.Gui.View.EnsureFocus + - Terminal.Gui.View.Focused + - Terminal.Gui.View.FocusFirst + - Terminal.Gui.View.FocusLast + - Terminal.Gui.View.FocusNext + - Terminal.Gui.View.FocusPrev + - Terminal.Gui.View.GetEnumerator + - Terminal.Gui.View.HasFocus + - Terminal.Gui.View.Height + - Terminal.Gui.View.Id + - Terminal.Gui.View.LayoutStyle + - Terminal.Gui.View.LayoutSubviews + - Terminal.Gui.View.MostFocused + - Terminal.Gui.View.Move(System.Int32,System.Int32) + - Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent) + - Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent) + - Terminal.Gui.View.Remove(Terminal.Gui.View) + - Terminal.Gui.View.RemoveAll + - Terminal.Gui.View.ScreenToView(System.Int32,System.Int32) + - Terminal.Gui.View.SetClip(Terminal.Gui.Rect) + - Terminal.Gui.View.SetFocus(Terminal.Gui.View) + - Terminal.Gui.View.SetNeedsDisplay + - Terminal.Gui.View.SetNeedsDisplay(Terminal.Gui.Rect) + - Terminal.Gui.View.Subviews + - Terminal.Gui.View.SuperView + - Terminal.Gui.View.ToString + - Terminal.Gui.View.WantMousePositionReports + - Terminal.Gui.View.Width + - Terminal.Gui.View.X + - Terminal.Gui.View.Y +- uid: Terminal.Gui.HexView.#ctor(System.IO.Stream) + id: '#ctor(System.IO.Stream)' + parent: Terminal.Gui.HexView + langs: + - csharp + name: HexView(Stream) + nameWithType: HexView.HexView(Stream) + fullName: HexView.HexView(Stream) + type: Constructor + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Creates and instance of the HexView that will render a seekable stream in hex on the allocated view region. + syntax: + content: public HexView (System.IO.Stream source); + parameters: + - id: source + type: System.IO.Stream + description: Source stream, this stream should support seeking, or this will raise an exceotion. + overload: Terminal.Gui.HexView.#ctor* + exceptions: [] +- uid: Terminal.Gui.HexView.AllowEdits + id: AllowEdits + parent: Terminal.Gui.HexView + langs: + - csharp + name: AllowEdits + nameWithType: HexView.AllowEdits + fullName: HexView.AllowEdits + type: Property + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Gets or sets a value indicating whether this allow editing of the contents of the underlying stream. + syntax: + content: public bool AllowEdits { get; set; } + return: + type: System.Boolean + description: true if allow edits; otherwise, false. + overload: Terminal.Gui.HexView.AllowEdits* + exceptions: [] +- uid: Terminal.Gui.HexView.ApplyEdits + id: ApplyEdits + parent: Terminal.Gui.HexView + langs: + - csharp + name: ApplyEdits() + nameWithType: HexView.ApplyEdits() + fullName: HexView.ApplyEdits() + type: Method + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: This method applies the edits to the stream and resets the contents of the Edits property + syntax: + content: public void ApplyEdits (); + parameters: [] + overload: Terminal.Gui.HexView.ApplyEdits* + exceptions: [] +- uid: Terminal.Gui.HexView.DisplayStart + id: DisplayStart + parent: Terminal.Gui.HexView + langs: + - csharp + name: DisplayStart + nameWithType: HexView.DisplayStart + fullName: HexView.DisplayStart + type: Property + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Configures the initial offset to be displayed at the top + syntax: + content: public long DisplayStart { get; set; } + return: + type: System.Int64 + description: The display start. + overload: Terminal.Gui.HexView.DisplayStart* + exceptions: [] +- uid: Terminal.Gui.HexView.Edits + id: Edits + parent: Terminal.Gui.HexView + langs: + - csharp + name: Edits + nameWithType: HexView.Edits + fullName: HexView.Edits + type: Property + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Gets a list of the edits done to the buffer which is a sorted dictionary with the positions where the edit took place and the value that was set. + syntax: + content: public System.Collections.Generic.IReadOnlyDictionary Edits { get; } + return: + type: System.Collections.Generic.IReadOnlyDictionary{System.Int64,System.Byte} + description: The edits. + overload: Terminal.Gui.HexView.Edits* + exceptions: [] +- uid: Terminal.Gui.HexView.Frame + id: Frame + parent: Terminal.Gui.HexView + langs: + - csharp + name: Frame + nameWithType: HexView.Frame + fullName: HexView.Frame + type: Property + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + syntax: + content: public override Terminal.Gui.Rect Frame { get; set; } + return: + type: Terminal.Gui.Rect + description: To be added. + overload: Terminal.Gui.HexView.Frame* + exceptions: [] +- uid: Terminal.Gui.HexView.PositionCursor + id: PositionCursor + parent: Terminal.Gui.HexView + langs: + - csharp + name: PositionCursor() + nameWithType: HexView.PositionCursor() + fullName: HexView.PositionCursor() + type: Method + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: Positions the cursor based for the hex view + syntax: + content: public override void PositionCursor (); + parameters: [] + overload: Terminal.Gui.HexView.PositionCursor* + exceptions: [] +- uid: Terminal.Gui.HexView.ProcessKey(Terminal.Gui.KeyEvent) + id: ProcessKey(Terminal.Gui.KeyEvent) + parent: Terminal.Gui.HexView + langs: + - csharp + name: ProcessKey(KeyEvent) + nameWithType: HexView.ProcessKey(KeyEvent) + fullName: HexView.ProcessKey(KeyEvent) + type: Method + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + syntax: + content: public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent); + parameters: + - id: keyEvent + type: Terminal.Gui.KeyEvent + description: To be added. + return: + type: System.Boolean + description: To be added. + overload: Terminal.Gui.HexView.ProcessKey* + exceptions: [] +- uid: Terminal.Gui.HexView.Redraw(Terminal.Gui.Rect) + id: Redraw(Terminal.Gui.Rect) + parent: Terminal.Gui.HexView + langs: + - csharp + name: Redraw(Rect) + nameWithType: HexView.Redraw(Rect) + fullName: HexView.Redraw(Rect) + type: Method + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + syntax: + content: public override void Redraw (Terminal.Gui.Rect region); + parameters: + - id: region + type: Terminal.Gui.Rect + description: To be added. + overload: Terminal.Gui.HexView.Redraw* + exceptions: [] +- uid: Terminal.Gui.HexView.Source + id: Source + parent: Terminal.Gui.HexView + langs: + - csharp + name: Source + nameWithType: HexView.Source + fullName: HexView.Source + type: Property + assemblies: + - Terminal.Gui + namespace: Terminal.Gui + summary: The source stream to display on the hex view, the stream should support seeking. + syntax: + content: public System.IO.Stream Source { get; set; } + return: + type: System.IO.Stream + description: The source. + overload: Terminal.Gui.HexView.Source* + exceptions: [] +references: +- uid: Terminal.Gui.View + parent: Terminal.Gui + isExternal: false + name: View + nameWithType: View + fullName: Terminal.Gui.View +- uid: Terminal.Gui.HexView.#ctor(System.IO.Stream) + parent: Terminal.Gui.HexView + isExternal: false + name: HexView(Stream) + nameWithType: HexView.HexView(Stream) + fullName: HexView.HexView(Stream) +- uid: System.IO.Stream + parent: System.IO + isExternal: true + name: Stream + nameWithType: Stream + fullName: System.IO.Stream +- uid: Terminal.Gui.HexView.AllowEdits + parent: Terminal.Gui.HexView + isExternal: false + name: AllowEdits + nameWithType: HexView.AllowEdits + fullName: HexView.AllowEdits +- uid: System.Boolean + parent: System + isExternal: true + name: Boolean + nameWithType: Boolean + fullName: System.Boolean +- uid: Terminal.Gui.HexView.ApplyEdits + parent: Terminal.Gui.HexView + isExternal: false + name: ApplyEdits() + nameWithType: HexView.ApplyEdits() + fullName: HexView.ApplyEdits() +- uid: Terminal.Gui.HexView.DisplayStart + parent: Terminal.Gui.HexView + isExternal: false + name: DisplayStart + nameWithType: HexView.DisplayStart + fullName: HexView.DisplayStart +- uid: System.Int64 + parent: System + isExternal: true + name: Int64 + nameWithType: Int64 + fullName: System.Int64 +- uid: Terminal.Gui.HexView.Edits + parent: Terminal.Gui.HexView + isExternal: false + name: Edits + nameWithType: HexView.Edits + fullName: HexView.Edits +- uid: System.Collections.Generic.IReadOnlyDictionary`2 + name: IReadOnlyDictionary + nameWithType: IReadOnlyDictionary + fullName: System.Collections.Generic.IReadOnlyDictionary +- uid: System.Byte + name: Byte + nameWithType: Byte + fullName: System.Byte +- uid: System.Collections.Generic.IReadOnlyDictionary{System.Int64,System.Byte} + parent: System.Collections.Generic + isExternal: true + name: IReadOnlyDictionary + nameWithType: IReadOnlyDictionary + fullName: System.Collections.Generic.IReadOnlyDictionary + spec.csharp: + - uid: System.Collections.Generic.IReadOnlyDictionary`2 + name: IReadOnlyDictionary + nameWithType: IReadOnlyDictionary + fullName: System.Collections.Generic.IReadOnlyDictionary + - name: < + nameWithType: < + fullName: < + - uid: System.Int64 + name: Int64 + nameWithType: Int64 + fullName: System.Int64 + - name: ',' + nameWithType: ',' + fullName: ',' + - uid: System.Byte + name: Byte + nameWithType: Byte + fullName: System.Byte + - name: '>' + nameWithType: '>' + fullName: '>' +- uid: Terminal.Gui.HexView.Frame + parent: Terminal.Gui.HexView + isExternal: false + name: Frame + nameWithType: HexView.Frame + fullName: HexView.Frame +- uid: Terminal.Gui.Rect + parent: Terminal.Gui + isExternal: false + name: Rect + nameWithType: Rect + fullName: Terminal.Gui.Rect +- uid: Terminal.Gui.HexView.PositionCursor + parent: Terminal.Gui.HexView + isExternal: false + name: PositionCursor() + nameWithType: HexView.PositionCursor() + fullName: HexView.PositionCursor() +- uid: Terminal.Gui.HexView.ProcessKey(Terminal.Gui.KeyEvent) + parent: Terminal.Gui.HexView + isExternal: false + name: ProcessKey(KeyEvent) + nameWithType: HexView.ProcessKey(KeyEvent) + fullName: HexView.ProcessKey(KeyEvent) +- uid: Terminal.Gui.KeyEvent + parent: Terminal.Gui + isExternal: false + name: KeyEvent + nameWithType: KeyEvent + fullName: Terminal.Gui.KeyEvent +- uid: Terminal.Gui.HexView.Redraw(Terminal.Gui.Rect) + parent: Terminal.Gui.HexView + isExternal: false + name: Redraw(Rect) + nameWithType: HexView.Redraw(Rect) + fullName: HexView.Redraw(Rect) +- uid: Terminal.Gui.HexView.Source + parent: Terminal.Gui.HexView + isExternal: false + name: Source + nameWithType: HexView.Source + fullName: HexView.Source +- uid: Terminal.Gui.HexView.#ctor* + parent: Terminal.Gui.HexView + isExternal: false + name: HexView + nameWithType: HexView.HexView + fullName: HexView.HexView +- uid: Terminal.Gui.HexView.AllowEdits* + parent: Terminal.Gui.HexView + isExternal: false + name: AllowEdits + nameWithType: HexView.AllowEdits + fullName: HexView.AllowEdits +- uid: Terminal.Gui.HexView.ApplyEdits* + parent: Terminal.Gui.HexView + isExternal: false + name: ApplyEdits + nameWithType: HexView.ApplyEdits + fullName: HexView.ApplyEdits +- uid: Terminal.Gui.HexView.DisplayStart* + parent: Terminal.Gui.HexView + isExternal: false + name: DisplayStart + nameWithType: HexView.DisplayStart + fullName: HexView.DisplayStart +- uid: Terminal.Gui.HexView.Edits* + parent: Terminal.Gui.HexView + isExternal: false + name: Edits + nameWithType: HexView.Edits + fullName: HexView.Edits +- uid: Terminal.Gui.HexView.Frame* + parent: Terminal.Gui.HexView + isExternal: false + name: Frame + nameWithType: HexView.Frame + fullName: HexView.Frame +- uid: Terminal.Gui.HexView.PositionCursor* + parent: Terminal.Gui.HexView + isExternal: false + name: PositionCursor + nameWithType: HexView.PositionCursor + fullName: HexView.PositionCursor +- uid: Terminal.Gui.HexView.ProcessKey* + parent: Terminal.Gui.HexView + isExternal: false + name: ProcessKey + nameWithType: HexView.ProcessKey + fullName: HexView.ProcessKey +- uid: Terminal.Gui.HexView.Redraw* + parent: Terminal.Gui.HexView + isExternal: false + name: Redraw + nameWithType: HexView.Redraw + fullName: HexView.Redraw +- uid: Terminal.Gui.HexView.Source* + parent: Terminal.Gui.HexView + isExternal: false + name: Source + nameWithType: HexView.Source + fullName: HexView.Source +- uid: Terminal.Gui.Responder.CanFocus + parent: Terminal.Gui.Responder + isExternal: false + name: CanFocus + nameWithType: Responder.CanFocus + fullName: Responder.CanFocus +- uid: Terminal.Gui.View.HasFocus + parent: Terminal.Gui.View + isExternal: false + name: HasFocus + nameWithType: View.HasFocus + fullName: View.HasFocus +- uid: Terminal.Gui.Responder.MouseEvent(Terminal.Gui.MouseEvent) + parent: Terminal.Gui.Responder + isExternal: false + name: MouseEvent(MouseEvent) + nameWithType: Responder.MouseEvent(MouseEvent) + fullName: Responder.MouseEvent(MouseEvent) +- uid: Terminal.Gui.View.ProcessColdKey(Terminal.Gui.KeyEvent) + parent: Terminal.Gui.View + isExternal: false + name: ProcessColdKey(KeyEvent) + nameWithType: View.ProcessColdKey(KeyEvent) + fullName: View.ProcessColdKey(KeyEvent) +- uid: Terminal.Gui.View.ProcessHotKey(Terminal.Gui.KeyEvent) + parent: Terminal.Gui.View + isExternal: false + name: ProcessHotKey(KeyEvent) + nameWithType: View.ProcessHotKey(KeyEvent) + fullName: View.ProcessHotKey(KeyEvent) +- uid: Terminal.Gui.View.Add(Terminal.Gui.View) + parent: Terminal.Gui.View + isExternal: false + name: Add(View) + nameWithType: View.Add(View) + fullName: View.Add(View) +- uid: Terminal.Gui.View.Add(Terminal.Gui.View[]) + parent: Terminal.Gui.View + isExternal: false + name: Add(View[]) + nameWithType: View.Add(View[]) + fullName: View.Add(View[]) +- uid: Terminal.Gui.View.AddRune(System.Int32,System.Int32,System.Rune) + parent: Terminal.Gui.View + isExternal: false + name: AddRune(Int32, Int32, Rune) + nameWithType: View.AddRune(Int32, Int32, Rune) + fullName: View.AddRune(Int32, Int32, Rune) +- uid: Terminal.Gui.View.Bounds + parent: Terminal.Gui.View + isExternal: false + name: Bounds + nameWithType: View.Bounds + fullName: View.Bounds +- uid: Terminal.Gui.View.ChildNeedsDisplay + parent: Terminal.Gui.View + isExternal: false + name: ChildNeedsDisplay() + nameWithType: View.ChildNeedsDisplay() + fullName: View.ChildNeedsDisplay() +- uid: Terminal.Gui.View.Clear + parent: Terminal.Gui.View + isExternal: false + name: Clear() + nameWithType: View.Clear() + fullName: View.Clear() +- uid: Terminal.Gui.View.Clear(Terminal.Gui.Rect) + parent: Terminal.Gui.View + isExternal: false + name: Clear(Rect) + nameWithType: View.Clear(Rect) + fullName: View.Clear(Rect) +- uid: Terminal.Gui.View.ClearNeedsDisplay + parent: Terminal.Gui.View + isExternal: false + name: ClearNeedsDisplay() + nameWithType: View.ClearNeedsDisplay() + fullName: View.ClearNeedsDisplay() +- uid: Terminal.Gui.View.ClipToBounds + parent: Terminal.Gui.View + isExternal: false + name: ClipToBounds() + nameWithType: View.ClipToBounds() + fullName: View.ClipToBounds() +- uid: Terminal.Gui.View.ColorScheme + parent: Terminal.Gui.View + isExternal: false + name: ColorScheme + nameWithType: View.ColorScheme + fullName: View.ColorScheme +- uid: Terminal.Gui.View.DrawFrame(Terminal.Gui.Rect,System.Int32,System.Boolean) + parent: Terminal.Gui.View + isExternal: false + name: DrawFrame(Rect, Int32, Boolean) + nameWithType: View.DrawFrame(Rect, Int32, Boolean) + fullName: View.DrawFrame(Rect, Int32, Boolean) +- uid: Terminal.Gui.View.DrawHotString(NStack.ustring,System.Boolean,Terminal.Gui.ColorScheme) + parent: Terminal.Gui.View + isExternal: false + name: DrawHotString(ustring, Boolean, ColorScheme) + nameWithType: View.DrawHotString(ustring, Boolean, ColorScheme) + fullName: View.DrawHotString(ustring, Boolean, ColorScheme) +- uid: Terminal.Gui.View.DrawHotString(NStack.ustring,Terminal.Gui.Attribute,Terminal.Gui.Attribute) + parent: Terminal.Gui.View + isExternal: false + name: DrawHotString(ustring, Attribute, Attribute) + nameWithType: View.DrawHotString(ustring, Attribute, Attribute) + fullName: View.DrawHotString(ustring, Attribute, Attribute) +- uid: Terminal.Gui.View.Driver + parent: Terminal.Gui.View + isExternal: false + name: Driver + nameWithType: View.Driver + fullName: View.Driver +- uid: Terminal.Gui.View.EnsureFocus + parent: Terminal.Gui.View + isExternal: false + name: EnsureFocus() + nameWithType: View.EnsureFocus() + fullName: View.EnsureFocus() +- uid: Terminal.Gui.View.Focused + parent: Terminal.Gui.View + isExternal: false + name: Focused + nameWithType: View.Focused + fullName: View.Focused +- uid: Terminal.Gui.View.FocusFirst + parent: Terminal.Gui.View + isExternal: false + name: FocusFirst() + nameWithType: View.FocusFirst() + fullName: View.FocusFirst() +- uid: Terminal.Gui.View.FocusLast + parent: Terminal.Gui.View + isExternal: false + name: FocusLast() + nameWithType: View.FocusLast() + fullName: View.FocusLast() +- uid: Terminal.Gui.View.FocusNext + parent: Terminal.Gui.View + isExternal: false + name: FocusNext() + nameWithType: View.FocusNext() + fullName: View.FocusNext() +- uid: Terminal.Gui.View.FocusPrev + parent: Terminal.Gui.View + isExternal: false + name: FocusPrev() + nameWithType: View.FocusPrev() + fullName: View.FocusPrev() +- uid: Terminal.Gui.View.GetEnumerator + parent: Terminal.Gui.View + isExternal: false + name: GetEnumerator() + nameWithType: View.GetEnumerator() + fullName: View.GetEnumerator() +- uid: Terminal.Gui.View.Height + parent: Terminal.Gui.View + isExternal: false + name: Height + nameWithType: View.Height + fullName: View.Height +- uid: Terminal.Gui.View.Id + parent: Terminal.Gui.View + isExternal: false + name: Id + nameWithType: View.Id + fullName: View.Id +- uid: Terminal.Gui.View.LayoutStyle + parent: Terminal.Gui.View + isExternal: false + name: LayoutStyle + nameWithType: View.LayoutStyle + fullName: View.LayoutStyle +- uid: Terminal.Gui.View.LayoutSubviews + parent: Terminal.Gui.View + isExternal: false + name: LayoutSubviews() + nameWithType: View.LayoutSubviews() + fullName: View.LayoutSubviews() +- uid: Terminal.Gui.View.MostFocused + parent: Terminal.Gui.View + isExternal: false + name: MostFocused + nameWithType: View.MostFocused + fullName: View.MostFocused +- uid: Terminal.Gui.View.Move(System.Int32,System.Int32) + parent: Terminal.Gui.View + isExternal: false + name: Move(Int32, Int32) + nameWithType: View.Move(Int32, Int32) + fullName: View.Move(Int32, Int32) +- uid: Terminal.Gui.View.Remove(Terminal.Gui.View) + parent: Terminal.Gui.View + isExternal: false + name: Remove(View) + nameWithType: View.Remove(View) + fullName: View.Remove(View) +- uid: Terminal.Gui.View.RemoveAll + parent: Terminal.Gui.View + isExternal: false + name: RemoveAll() + nameWithType: View.RemoveAll() + fullName: View.RemoveAll() +- uid: Terminal.Gui.View.ScreenToView(System.Int32,System.Int32) + parent: Terminal.Gui.View + isExternal: false + name: ScreenToView(Int32, Int32) + nameWithType: View.ScreenToView(Int32, Int32) + fullName: View.ScreenToView(Int32, Int32) +- uid: Terminal.Gui.View.SetClip(Terminal.Gui.Rect) + parent: Terminal.Gui.View + isExternal: false + name: SetClip(Rect) + nameWithType: View.SetClip(Rect) + fullName: View.SetClip(Rect) +- uid: Terminal.Gui.View.SetFocus(Terminal.Gui.View) + parent: Terminal.Gui.View + isExternal: false + name: SetFocus(View) + nameWithType: View.SetFocus(View) + fullName: View.SetFocus(View) +- uid: Terminal.Gui.View.SetNeedsDisplay + parent: Terminal.Gui.View + isExternal: false + name: SetNeedsDisplay() + nameWithType: View.SetNeedsDisplay() + fullName: View.SetNeedsDisplay() +- uid: Terminal.Gui.View.SetNeedsDisplay(Terminal.Gui.Rect) + parent: Terminal.Gui.View + isExternal: false + name: SetNeedsDisplay(Rect) + nameWithType: View.SetNeedsDisplay(Rect) + fullName: View.SetNeedsDisplay(Rect) +- uid: Terminal.Gui.View.Subviews + parent: Terminal.Gui.View + isExternal: false + name: Subviews + nameWithType: View.Subviews + fullName: View.Subviews +- uid: Terminal.Gui.View.SuperView + parent: Terminal.Gui.View + isExternal: false + name: SuperView + nameWithType: View.SuperView + fullName: View.SuperView +- uid: Terminal.Gui.View.ToString + parent: Terminal.Gui.View + isExternal: false + name: ToString() + nameWithType: View.ToString() + fullName: View.ToString() +- uid: Terminal.Gui.View.WantMousePositionReports + parent: Terminal.Gui.View + isExternal: false + name: WantMousePositionReports + nameWithType: View.WantMousePositionReports + fullName: View.WantMousePositionReports +- uid: Terminal.Gui.View.Width + parent: Terminal.Gui.View + isExternal: false + name: Width + nameWithType: View.Width + fullName: View.Width +- uid: Terminal.Gui.View.X + parent: Terminal.Gui.View + isExternal: false + name: X + nameWithType: View.X + fullName: View.X +- uid: Terminal.Gui.View.Y + parent: Terminal.Gui.View + isExternal: false + name: Y + nameWithType: View.Y + fullName: View.Y diff --git a/docs/api/Mono.Terminal/Mono.Terminal.IMainLoopDriver.html b/docs/api/Mono.Terminal/Mono.Terminal.IMainLoopDriver.html new file mode 100644 index 000000000..f789cde20 --- /dev/null +++ b/docs/api/Mono.Terminal/Mono.Terminal.IMainLoopDriver.html @@ -0,0 +1,217 @@ + + + + + + + + Interface IMainLoopDriver + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Interface IMainLoopDriver +

+

Public interface to create your own platform specific main loop driver.

+
+
+
UnixMainLoop
+
Namespace: Mono.Terminal
+
Assembly: Terminal.Gui.dll
+
Syntax
+
+ 
public interface IMainLoopDriver
+
+

Methods +

+ + + +

EventsPending(Boolean)

+

Must report whether there are any events pending, or even block waiting for events.

+
+
+
Declaration
+
+ 
public bool EventsPending (bool wait);
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.Booleanwait

If set to true wait until an event is available, otherwise return immediately.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

true, if there were pending events, false otherwise.

+
+ + + +

MainIteration()

+
+
+
Declaration
+
+ 
public void MainIteration ();
+
+ + + +

Setup(MainLoop)

+

Initializes the main loop driver, gets the calling main loop for the initialization.

+
+
+
Declaration
+
+ 
public void Setup (Mono.Terminal.MainLoop mainLoop);
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
MainLoopmainLoop

Main loop.

+
+ + + +

Wakeup()

+

Wakes up the mainloop that might be waiting on input, must be thread safe.

+
+
+
Declaration
+
+ 
public void Wakeup ();
+
+
+
+ + +
+
+ +
+
+
+
+ + Back to top + + + Copyright © 2015-2017 Microsoft
Generated by DocFX +
+
+
+
+ + + + + + diff --git a/docs/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.html b/docs/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.html new file mode 100644 index 000000000..e85b3438a --- /dev/null +++ b/docs/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.Condition.html @@ -0,0 +1,162 @@ + + + + + + + + Enum UnixMainLoop.Condition + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Enum UnixMainLoop.Condition +

+

Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions.

+
+
+
Namespace: Mono.Terminal
+
Assembly: Terminal.Gui.dll
+
Syntax
+
+ 
[System.Flags]
+public enum UnixMainLoop.Condition
+
+

Fields +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameDescription
PollErr

Error condition on output

+
PollHup

Hang-up on output

+
PollIn

There is data to read

+
PollNval

File descriptor is not open.

+
PollOut

Writing to the specified descriptor will not block

+
PollPri

There is urgent data to read

+
+
+
+ + +
+
+ +
+
+
+
+ + Back to top + + + Copyright © 2015-2017 Microsoft
Generated by DocFX +
+
+
+
+ + + + + + diff --git a/docs/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.html b/docs/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.html new file mode 100644 index 000000000..54183c31d --- /dev/null +++ b/docs/api/Mono.Terminal/Mono.Terminal.UnixMainLoop.html @@ -0,0 +1,332 @@ + + + + + + + + Class UnixMainLoop + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class UnixMainLoop +

+

Unix main loop, suitable for using on Posix systems

+
+
+
+
Inheritance
+
System.Object
+
UnixMainLoop
+
+
Namespace: Mono.Terminal
+
Assembly: Terminal.Gui.dll
+
Syntax
+
+ 
public class UnixMainLoop : Mono.Terminal.IMainLoopDriver
+
+
Remarks
+

In addition to the general functions of the mainloop, the Unix version + can watch file descriptors using the AddWatch methods.

+
+

Constructors +

+ + + +

UnixMainLoop()

+
+
+
Declaration
+
+ 
public UnixMainLoop ();
+
+

Methods +

+ + + +

AddWatch(Int32, UnixMainLoop+Condition, Func<MainLoop,Boolean>)

+

Watches a file descriptor for activity.

+
+
+
Declaration
+
+ 
public object AddWatch (int fileDescriptor, Mono.Terminal.UnixMainLoop.Condition condition, Func<Mono.Terminal.MainLoop,bool> callback);
+
+
Parameters
+ + + + + + + + + + + + + + + + + + + + + + + + + +
TypeNameDescription
System.Int32fileDescriptor

To be added.

+
condition

To be added.

+
System.Func<MainLoop,System.Boolean>callback

To be added.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Object

To be added.

+
+
Remarks
+

When the condition is met, the provided callback + is invoked. If the callback returns false, the + watch is automatically removed.

+
          The return value is a token that represents this watch, you can
+          use this token to remove the watch by calling RemoveWatch.
+
+ + + +

RemoveWatch(Object)

+

Removes an active watch from the mainloop.

+
+
+
Declaration
+
+ 
public void RemoveWatch (object token);
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.Objecttoken

To be added.

+
+
Remarks
+

The token parameter is the value returned from AddWatch

+
+

Explicit Interface Implementations +

+ + + +

IMainLoopDriver.EventsPending(Boolean)

+
+
+
Declaration
+
+ 
bool IMainLoopDriver.EventsPending (bool wait);
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.Booleanwait

To be added.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

To be added.

+
+ + + +

IMainLoopDriver.MainIteration()

+
+
+
Declaration
+
+ 
void IMainLoopDriver.MainIteration ();
+
+ + + +

IMainLoopDriver.Setup(MainLoop)

+
+
+
Declaration
+
+ 
void IMainLoopDriver.Setup (Mono.Terminal.MainLoop mainLoop);
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
MainLoopmainLoop

To be added.

+
+ + + +

IMainLoopDriver.Wakeup()

+
+
+
Declaration
+
+ 
void IMainLoopDriver.Wakeup ();
+
+
+
+ + +
+
+ +
+
+
+
+ + Back to top + + + Copyright © 2015-2017 Microsoft
Generated by DocFX +
+
+
+
+ + + + + + diff --git a/docs/api/Terminal.Gui/Terminal.Gui.HexView.html b/docs/api/Terminal.Gui/Terminal.Gui.HexView.html new file mode 100644 index 000000000..5d545d8f5 --- /dev/null +++ b/docs/api/Terminal.Gui/Terminal.Gui.HexView.html @@ -0,0 +1,548 @@ + + + + + + + + Class HexView + + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+ +
+ +
+
+
+
+
+
+
+ + +

Class HexView +

+

An Hex viewer an editor view over a System.IO.Stream

+
+
+
+
Inheritance
+
System.Object
+
Responder
+
View
+
HexView
+
+
+
Inherited Members
+ + + + + + + + + + + + + + + + + + + + + + + + + +
+ View.Id +
+ + + + + + + + + + + + + + + + + + +
+ View.X +
+
+ View.Y +
+
+
Namespace: Terminal.Gui
+
Assembly: Terminal.Gui.dll
+
Syntax
+
+ 
public class HexView : Terminal.Gui.View
+
+
Remarks
+

+ This provides a hex editor on top of a seekable stream with the left side showing an hex + dump of the values in the stream and the right side showing the contents (filterd to + non-control sequence ascii characters).

+

+ Users can switch from one side to the other by using the tab key.

+

+ If you want to enable editing, set the AllowsEdits property, once that is done, the user + can make changes to the hexadecimal values of the stream. Any changes done are tracked + in the Edits property which is a sorted dictionary indicating the position where the + change was made and the new value. A convenience ApplyEdits method can be used to c + apply the methods to the underlying stream. +

+

+ It is possible to control the first byte shown by setting the DisplayStart property + to the offset that you want to start viewing. +

+

Constructors +

+ + + +

HexView(Stream)

+

Creates and instance of the HexView that will render a seekable stream in hex on the allocated view region.

+
+
+
Declaration
+
+ 
public HexView (System.IO.Stream source);
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
System.IO.Streamsource

Source stream, this stream should support seeking, or this will raise an exceotion.

+
+

Properties +

+ + + +

AllowEdits

+

Gets or sets a value indicating whether this HexView allow editing of the contents of the underlying stream.

+
+
+
Declaration
+
+ 
public bool AllowEdits { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

true if allow edits; otherwise, false.

+
+ + + +

DisplayStart

+

Configures the initial offset to be displayed at the top

+
+
+
Declaration
+
+ 
public long DisplayStart { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Int64

The display start.

+
+ + + +

Edits

+

Gets a list of the edits done to the buffer which is a sorted dictionary with the positions where the edit took place and the value that was set.

+
+
+
Declaration
+
+ 
public System.Collections.Generic.IReadOnlyDictionary<long,byte> Edits { get; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.Collections.Generic.IReadOnlyDictionary<System.Int64,System.Byte>

The edits.

+
+ + + +

Frame

+
+
+
Declaration
+
+ 
public override Terminal.Gui.Rect Frame { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
Rect

To be added.

+
+ + + +

Source

+

The source stream to display on the hex view, the stream should support seeking.

+
+
+
Declaration
+
+ 
public System.IO.Stream Source { get; set; }
+
+
Property Value
+ + + + + + + + + + + + + +
TypeDescription
System.IO.Stream

The source.

+
+

Methods +

+ + + +

ApplyEdits()

+

This method applies the edits to the stream and resets the contents of the Edits property

+
+
+
Declaration
+
+ 
public void ApplyEdits ();
+
+ + + +

PositionCursor()

+

Positions the cursor based for the hex view

+
+
+
Declaration
+
+ 
public override void PositionCursor ();
+
+ + + +

ProcessKey(KeyEvent)

+
+
+
Declaration
+
+ 
public override bool ProcessKey (Terminal.Gui.KeyEvent keyEvent);
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
KeyEventkeyEvent

To be added.

+
+
Returns
+ + + + + + + + + + + + + +
TypeDescription
System.Boolean

To be added.

+
+ + + +

Redraw(Rect)

+
+
+
Declaration
+
+ 
public override void Redraw (Terminal.Gui.Rect region);
+
+
Parameters
+ + + + + + + + + + + + + + + +
TypeNameDescription
Rectregion

To be added.

+
+
+
+ + +
+
+ +
+
+
+
+ + Back to top + + + Copyright © 2015-2017 Microsoft
Generated by DocFX +
+
+
+
+ + + + + + diff --git a/docs/articles/keyboard.html b/docs/articles/keyboard.html new file mode 100644 index 000000000..aa825731e --- /dev/null +++ b/docs/articles/keyboard.html @@ -0,0 +1,129 @@ + + + + + + + + Keyboard Event Processing + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+
+
+
+

Keyboard Event Processing

+ +

Keyboard events are sent by the Main Loop to the +Application class for processing. The keyboard events are sent +exclusively to the current Toplevel, this being either the default +that is created when you call Application.Init, or one that you +created an passed to Application.Run(Toplevel).

+

Flow

+

Keystrokes are first processes as hotkeys, then as regular keys, and +there is a final cold post-processing event that is invoked if no view +processed the key.

+

HotKey Processing

+

Events are first send to all views as a "HotKey", this means that the +View.ProcessHotKey method is invoked on the current toplevel, which +in turns propagates this to all the views in the hierarchy. If any +view decides to process the event, no further processing takes place.

+

This is how hotkeys for buttons are implemented. For example, the +keystroke "Alt-A" is handled by Buttons that have a hot-letter "A" to +activate the button.

+

Regular Processing

+

Unlike the hotkey processing, the regular processing is only sent to +the currently focused view in the focus chain.

+

The regular key processing is only invoked if no hotkey was caught.

+

Cold-key Processing

+

This stage only is executed if the focused view did not process the +event, and is broadcast to all the views in the Toplevel.

+

This method can be overwritten by views that want to provide +accelerator functionality (Alt-key for example), but without +interefering with normal ProcessKey behavior.

+
+
+ + +
+
+ +
+
+
+
+ + Back to top + + + Copyright © 2015-2017 Microsoft
Generated by DocFX +
+
+
+
+ + + + + + diff --git a/docs/articles/mainloop.html b/docs/articles/mainloop.html new file mode 100644 index 000000000..4bc0da7db --- /dev/null +++ b/docs/articles/mainloop.html @@ -0,0 +1,212 @@ + + + + + + + + Event Processing and the Application Main Loop + + + + + + + + + + + + + + +
+
+ + + +
+ +
+
+
+
+
+
+

Event Processing and the Application Main Loop

+ +

The method Application.Run that we covered before will wait for +events from either the keyboard or mouse and route those events to the +proper view.

+

The job of waiting for events and dispatching them in the +Application is implemented by an instance of the +MainLoop +class.

+

Mainloops are a common idiom in many user interface toolkits so many +of the concepts will be familiar to you if you have used other +toolkits before.

+

This class provides the following capabilities:

+
    +
  • Keyboard and mouse processing
    • +
  • .NET Async support
    • +
  • Timers processing
    • +
  • Invoking of UI code from a background thread
    • +
  • Idle processing handlers
    • +
  • Possibility of integration with other mainloops.
    • +
  • On Unix systems, it can monitor file descriptors for readability or writability.
    • +
+

The MainLoop property in the the +Application +provides access to these functions.

+

When your code invokes Application.Run (Toplevel), the application +will prepare the current +Toplevel[../api/Terminal.Gui/Terminal.Gui.Toplevel.html] instance by +redrawing the screen appropriately and then calling the mainloop to +run.

+

You can configure the Mainloop before calling Application.Run, or you +can configure the MainLoop in response to events during the execution.

+

The keyboard inputs is dispatched by the application class to the +current TopLevel window this is covered in more detail in the +Keyboard Event Processing document.

+

Async Execution

+

On startup, the Application class configured the .NET Asynchronous +machinery to allow you to use the await keyword to run tasks in the +background and have the execution of those tasks resume on the context +of the main thread running the main loop.

+

Once you invoke Application.Main the async machinery will be ready +to use, and you can merely call methods using await from your main +thread, and the awaited code will resume execution on the main +thread.

+

Timers Processing

+

You can register timers to be executed at specified intervals by +calling the AddTimeout method, like this:

+
void UpdateTimer ()
+{
+    time.Text = DateTime.Now.ToString ();
+}
+
+var token = Application.MainLoop.AddTimeout (TimeSpan.FromSeconds (20), UpdateTimer);
+

The return value from AddTimeout is a token value that you can use if +you desire to cancel the timer before it runs:

+
Application.MainLoop.RemoveTimeout (token);
+

Idle Handlers

+

You can register code to be executed when the application is idling +and there are no events to process by calling the +AddIdle +method. This method takes as a parameter a function that will be +invoked when the application is idling.

+

Idle functions should return true if they should be invoked again, +and false if the idle invocations should stop.

+

Like the timer APIs, the return value is a token that can be used to +cancel the scheduled idle function from being executed.

+

Threading

+

Like other UI toolkits, Terminal.Gui is generally not thread safe. +You should avoid calling methods in the UI classes from a background +thread as there is no guarantee that they will not corrupt the state +of the UI application.

+

Generally, as there is not much state, you will get lucky, but the +application will not behave properly.

+

You will be served better off by using C# async machinery and the +various APIs in the System.Threading.Tasks.Task APIs. But if you +absolutely must work with threads on your own you should only invoke +APIs in Terminal.Gui from the main thread.

+

To make this simple, you can use the Application.MainLoop.Invoke +method and pass an Action. This action will be queued for execution +on the main thread at an appropriate time and will run your code +there.

+

For example, the following shows how to properly update a label from a +background thread:

+
void BackgroundThreadUpdateProgress ()
+{
+    Application.MainLoop.Invoke (() => {
+        progress.Text = $"Progress: {bytesDownloaded/totalBytes}";
+        });
+}
+

Integration With Other Main Loop Drivers

+

It is possible to run the main loop in a way that it does not take +over control of your application, but rather in a cooperative way.

+

To do this, you must use the lower-level APIs in Application: the +Begin method to prepare a toplevel for execution, followed by calls +to MainLoop.EventsPending to determine whether the events must be +processed, and in that case, calling RunLoop method and finally +completing the process by calling End.

+

The method Run is implemented like this:

+
void Run (Toplevel top)
+{
+    var runToken = Begin (view);
+    RunLoop (runToken);
+    End (runToken);
+}
+

Unix File Descriptor Monitoring

+

On Unix, it is possible to monitor file descriptors for input being +available, or for the file descriptor being available for data to be +written without blocking the application.

+

To do this, you on Unix, you can cast the MainLoop instance to a +UnixMainLoop +and use the AddWatch method to register an interest on a particular +condition.

+
+
+ + +
+
+ +
+
+
+
+ + Back to top + + + Copyright © 2015-2017 Microsoft
Generated by DocFX +
+
+
+
+ + + + + + diff --git a/ecmadocs/en/Mono.Terminal/IMainLoopDriver.xml b/ecmadocs/en/Mono.Terminal/IMainLoopDriver.xml new file mode 100644 index 000000000..534e7e50a --- /dev/null +++ b/ecmadocs/en/Mono.Terminal/IMainLoopDriver.xml @@ -0,0 +1,95 @@ + + + + + Terminal.Gui + 1.0.0.0 + + + + + Public interface to create your own platform specific main loop driver. + + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Boolean + + + + + + If set to true wait until an event is available, otherwise return immediately. + + Must report whether there are any events pending, or even block waiting for events. + + + true, if there were pending events, false otherwise. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + + + Main loop. + + Initializes the main loop driver, gets the calling main loop for the initialization. + + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + + Wakes up the mainloop that might be waiting on input, must be thread safe. + + To be added. + + + + diff --git a/ecmadocs/en/Mono.Terminal/UnixMainLoop+Condition.xml b/ecmadocs/en/Mono.Terminal/UnixMainLoop+Condition.xml new file mode 100644 index 000000000..798ffdb16 --- /dev/null +++ b/ecmadocs/en/Mono.Terminal/UnixMainLoop+Condition.xml @@ -0,0 +1,120 @@ + + + + + Terminal.Gui + 1.0.0.0 + + + System.Enum + + + + System.Flags + + + + + Condition on which to wake up from file descriptor activity. These match the Linux/BSD poll definitions. + + To be added. + + + + + + Field + + 1.0.0.0 + + + Mono.Terminal.UnixMainLoop+Condition + + + + Error condition on output + + + + + + + Field + + 1.0.0.0 + + + Mono.Terminal.UnixMainLoop+Condition + + + + Hang-up on output + + + + + + + Field + + 1.0.0.0 + + + Mono.Terminal.UnixMainLoop+Condition + + + + There is data to read + + + + + + + Field + + 1.0.0.0 + + + Mono.Terminal.UnixMainLoop+Condition + + + + File descriptor is not open. + + + + + + + Field + + 1.0.0.0 + + + Mono.Terminal.UnixMainLoop+Condition + + + + Writing to the specified descriptor will not block + + + + + + + Field + + 1.0.0.0 + + + Mono.Terminal.UnixMainLoop+Condition + + + + There is urgent data to read + + + + + diff --git a/ecmadocs/en/Mono.Terminal/UnixMainLoop.xml b/ecmadocs/en/Mono.Terminal/UnixMainLoop.xml new file mode 100644 index 000000000..1bf7da89a --- /dev/null +++ b/ecmadocs/en/Mono.Terminal/UnixMainLoop.xml @@ -0,0 +1,167 @@ + + + + + Terminal.Gui + 1.0.0.0 + + + System.Object + + + + Mono.Terminal.IMainLoopDriver + + + + + Unix main loop, suitable for using on Posix systems + + + In addition to the general functions of the mainloop, the Unix version + can watch file descriptors using the AddWatch methods. + + + + + + + Constructor + + 1.0.0.0 + + + + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Object + + + + + + + + To be added. + To be added. + To be added. + + Watches a file descriptor for activity. + + To be added. + + When the condition is met, the provided callback + is invoked. If the callback returns false, the + watch is automatically removed. + + The return value is a token that represents this watch, you can + use this token to remove the watch by calling RemoveWatch. + + + + + + + Method + + 1.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + + + To be added. + + Removes an active watch from the mainloop. + + + The token parameter is the value returned from AddWatch + + + + + diff --git a/ecmadocs/en/Terminal.Gui/HexView.xml b/ecmadocs/en/Terminal.Gui/HexView.xml new file mode 100644 index 000000000..af8244786 --- /dev/null +++ b/ecmadocs/en/Terminal.Gui/HexView.xml @@ -0,0 +1,222 @@ + + + + + Terminal.Gui + 1.0.0.0 + + + Terminal.Gui.View + + + + + An Hex viewer an editor view over a System.IO.Stream + + + + This provides a hex editor on top of a seekable stream with the left side showing an hex + dump of the values in the stream and the right side showing the contents (filterd to + non-control sequence ascii characters). + + + Users can switch from one side to the other by using the tab key. + + + If you want to enable editing, set the AllowsEdits property, once that is done, the user + can make changes to the hexadecimal values of the stream. Any changes done are tracked + in the Edits property which is a sorted dictionary indicating the position where the + change was made and the new value. A convenience ApplyEdits method can be used to c + apply the methods to the underlying stream. + + + It is possible to control the first byte shown by setting the DisplayStart property + to the offset that you want to start viewing. + + + + + + + + Constructor + + 1.0.0.0 + + + + + + Source stream, this stream should support seeking, or this will raise an exceotion. + + Creates and instance of the HexView that will render a seekable stream in hex on the allocated view region. + + To be added. + + + + + + Property + + 1.0.0.0 + + + System.Boolean + + + + Gets or sets a value indicating whether this allow editing of the contents of the underlying stream. + + + true if allow edits; otherwise, false. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + + This method applies the edits to the stream and resets the contents of the Edits property + + To be added. + + + + + + Property + + 1.0.0.0 + + + System.Int64 + + + + Configures the initial offset to be displayed at the top + + The display start. + To be added. + + + + + + Property + + 1.0.0.0 + + + System.Collections.Generic.IReadOnlyDictionary<System.Int64,System.Byte> + + + + Gets a list of the edits done to the buffer which is a sorted dictionary with the positions where the edit took place and the value that was set. + + The edits. + To be added. + + + + + + Property + + 1.0.0.0 + + + Terminal.Gui.Rect + + + To be added. + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + + Positions the cursor based for the hex view + + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Boolean + + + + + + To be added. + To be added. + To be added. + To be added. + + + + + + Method + + 1.0.0.0 + + + System.Void + + + + + + To be added. + To be added. + To be added. + + + + + + Property + + 1.0.0.0 + + + System.IO.Stream + + + + The source stream to display on the hex view, the stream should support seeking. + + The source. + To be added. + + + +