mirror of
https://github.com/gui-cs/Terminal.Gui.git
synced 2026-01-01 00:46:39 +01:00
Updated docfx and fixed most warnings
This commit is contained in:
@@ -2,7 +2,7 @@
|
||||
|
||||
Paste these commands into your favorite terminal on Windows, Mac, or Linux. This will install the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.templates), create a new "Hello World" TUI app, and run it.
|
||||
|
||||
(Press `CTRL-Q` to exit the app)
|
||||
(Press `Esc` to exit the app)
|
||||
|
||||
```ps1
|
||||
dotnet new --install Terminal.Gui.templates
|
||||
@@ -25,79 +25,9 @@ Use the [Terminal.Gui.Templates](https://github.com/gui-cs/Terminal.Gui.template
|
||||
|
||||
## Sample Usage in C#
|
||||
|
||||
The following example shows a basic Terminal.Gui application in C#:
|
||||
The following example shows a basic Terminal.Gui application in C# (this is `./Example/Example.cs`):
|
||||
|
||||
```csharp
|
||||
// A simple Terminal.Gui example in C# - using C# 9.0 Top-level statements
|
||||
|
||||
using Terminal.Gui;
|
||||
|
||||
Application.Run<ExampleWindow> ();
|
||||
|
||||
System.Console.WriteLine ($"Username: {((ExampleWindow)Application.Top).usernameText.Text}");
|
||||
|
||||
// Before the application exits, reset Terminal.Gui for clean shutdown
|
||||
Application.Shutdown ();
|
||||
|
||||
// Defines a top-level window with border and title
|
||||
public class ExampleWindow : Window {
|
||||
public TextField usernameText;
|
||||
|
||||
public ExampleWindow ()
|
||||
{
|
||||
Title = "Example App (Ctrl+Q to quit)";
|
||||
|
||||
// Create input components and labels
|
||||
var usernameLabel = new Label () {
|
||||
Text = "Username:"
|
||||
};
|
||||
|
||||
usernameText = new TextField ("") {
|
||||
// Position text field adjacent to the label
|
||||
X = Pos.Right (usernameLabel) + 1,
|
||||
|
||||
// Fill remaining horizontal space
|
||||
Width = Dim.Fill (),
|
||||
};
|
||||
|
||||
var passwordLabel = new Label () {
|
||||
Text = "Password:",
|
||||
X = Pos.Left (usernameLabel),
|
||||
Y = Pos.Bottom (usernameLabel) + 1
|
||||
};
|
||||
|
||||
var passwordText = new TextField ("") {
|
||||
Secret = true,
|
||||
// align with the text box above
|
||||
X = Pos.Left (usernameText),
|
||||
Y = Pos.Top (passwordLabel),
|
||||
Width = Dim.Fill (),
|
||||
};
|
||||
|
||||
// Create login button
|
||||
var btnLogin = new Button () {
|
||||
Text = "Login",
|
||||
Y = Pos.Bottom(passwordLabel) + 1,
|
||||
// center the login button horizontally
|
||||
X = Pos.Center (),
|
||||
IsDefault = true,
|
||||
};
|
||||
|
||||
// When login button is clicked display a message popup
|
||||
btnLogin.Clicked += () => {
|
||||
if (usernameText.Text == "admin" && passwordText.Text == "password") {
|
||||
MessageBox.Query ("Logging In", "Login Successful", "Ok");
|
||||
Application.RequestStop ();
|
||||
} else {
|
||||
MessageBox.ErrorQuery ("Logging In", "Incorrect username or password", "Ok");
|
||||
}
|
||||
};
|
||||
|
||||
// Add the views to the Window
|
||||
Add (usernameLabel, usernameText, passwordLabel, passwordText, btnLogin);
|
||||
}
|
||||
}
|
||||
```
|
||||
[!code-csharp[Program.cs](../../Example/Example.cs)]
|
||||
|
||||
When run the application looks as follows:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user