Skip to content

Commit 3040464

Browse files
authored
Merge pull request #1670 from tig/uicat_scenarios
Cleanup of UI Catalog scenarios
2 parents b8ac0dc + 32ae3cb commit 3040464

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

53 files changed

+108
-169
lines changed

UICatalog/Scenario.cs

+7-1
Original file line numberDiff line numberDiff line change
@@ -213,12 +213,18 @@ public virtual void RequestStop ()
213213
/// </summary>
214214
internal static List<string> GetAllCategories ()
215215
{
216-
List<string> categories = new List<string> () { "_All" };
216+
List<string> categories = new List<string> ();
217217
foreach (Type type in typeof (Scenario).Assembly.GetTypes ()
218218
.Where (myType => myType.IsClass && !myType.IsAbstract && myType.IsSubclassOf (typeof (Scenario)))) {
219219
List<System.Attribute> attrs = System.Attribute.GetCustomAttributes (type).ToList ();
220220
categories = categories.Union (attrs.Where (a => a is ScenarioCategory).Select (a => ((ScenarioCategory)a).Name)).ToList ();
221221
}
222+
223+
// Sort
224+
categories = categories.OrderBy (c => c).ToList ();
225+
226+
// Put "All" at the top
227+
categories.Insert (0, "All Scenarios");
222228
return categories;
223229
}
224230

UICatalog/Scenarios/AllViewsTester.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,10 @@
99
using Terminal.Gui;
1010

1111
namespace UICatalog.Scenarios {
12-
[ScenarioMetadata (Name: "All Views Tester", Description: "Provides a test UI for all classes derived from View")]
13-
[ScenarioCategory ("Layout"), ScenarioCategory ("StatusBar")]
12+
[ScenarioMetadata (Name: "All Views Tester", Description: "Provides a test UI for all classes derived from View.")]
13+
[ScenarioCategory ("Layout")]
14+
[ScenarioCategory ("Tests")]
15+
[ScenarioCategory ("Top Level Windows")]
1416
public class AllViewsTester : Scenario {
1517
Window _leftPane;
1618
ListView _classListView;

UICatalog/Scenarios/AutoSizeAndDirectionText.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
using Terminal.Gui;
22

33
namespace UICatalog.Scenarios {
4-
[ScenarioMetadata (Name: "AutoSize and Direction Text", Description: "Demonstrates the text auto-size and direction manipulation.")]
5-
[ScenarioCategory ("Text"), ScenarioCategory ("AutoSize"), ScenarioCategory ("Direction")]
4+
[ScenarioMetadata (Name: "Text Direction and AutoSize", Description: "Demos TextFormatter Direction and View AutoSize.")]
5+
[ScenarioCategory ("Text and Formatting")]
66
public class AutoSizeAndDirectionText : Scenario {
77
public override void Setup ()
88
{

UICatalog/Scenarios/BackgroundWorkerCollection.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace UICatalog.Scenarios {
99
[ScenarioMetadata (Name: "BackgroundWorker Collection", Description: "A persisting multi Toplevel BackgroundWorker threading")]
1010
[ScenarioCategory ("Threading")]
11-
[ScenarioCategory ("TopLevel")]
11+
[ScenarioCategory ("Top Level Windows")]
1212
[ScenarioCategory ("Dialogs")]
1313
[ScenarioCategory ("Controls")]
1414
public class BackgroundWorkerCollection : Scenario {

UICatalog/Scenarios/BasicColors.cs

+1
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,7 @@
33
namespace UICatalog.Scenarios {
44
[ScenarioMetadata (Name: "Basic Colors", Description: "Show all basic colors.")]
55
[ScenarioCategory ("Colors")]
6+
[ScenarioCategory ("Text and Formatting")]
67
public class BasicColors : Scenario {
78
public override void Setup ()
89
{

UICatalog/Scenarios/Borders.cs

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55

66
namespace UICatalog.Scenarios {
77
[ScenarioMetadata (Name: "Borders with/without PanelView", Description: "Demonstrate with/without PanelView borders manipulation.")]
8-
[ScenarioCategory ("Border")]
8+
[ScenarioCategory ("Layout")]
9+
[ScenarioCategory ("Borders")]
910
public class Borders : Scenario {
1011
public override void Setup ()
1112
{

UICatalog/Scenarios/BordersComparisons.cs

+2-1
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,8 @@
22

33
namespace UICatalog.Scenarios {
44
[ScenarioMetadata (Name: "Borders Comparisons", Description: "Compares Window, Toplevel and FrameView borders.")]
5-
[ScenarioCategory ("Border")]
5+
[ScenarioCategory ("Layout")]
6+
[ScenarioCategory ("Borders")]
67
public class BordersComparisons : Scenario {
78
public override void Init (Toplevel top, ColorScheme colorScheme)
89
{

UICatalog/Scenarios/BordersOnFrameView.cs

+2-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55

66
namespace UICatalog.Scenarios {
77
[ScenarioMetadata (Name: "Borders on FrameView", Description: "Demonstrate FrameView borders manipulation.")]
8-
[ScenarioCategory ("Border")]
8+
[ScenarioCategory ("Layout")]
9+
[ScenarioCategory ("Borders")]
910
public class BordersOnFrameView : Scenario {
1011
public override void Setup ()
1112
{

UICatalog/Scenarios/BordersOnToplevel.cs

+3-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
using Terminal.Gui;
55

66
namespace UICatalog.Scenarios {
7-
[ScenarioMetadata (Name: "Borders on Toplevel", Description: "Demonstrate Toplevel borders manipulation.")]
8-
[ScenarioCategory ("Border")]
7+
[ScenarioMetadata (Name: "Borders on Toplevel", Description: "Demonstrates Toplevel borders manipulation.")]
8+
[ScenarioCategory ("Layout")]
9+
[ScenarioCategory ("Borders")]
910
public class BordersOnToplevel : Scenario {
1011
public override void Setup ()
1112
{

UICatalog/Scenarios/BordersOnWindow.cs

+3-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,9 @@
44
using Terminal.Gui;
55

66
namespace UICatalog.Scenarios {
7-
[ScenarioMetadata (Name: "Borders on Window", Description: "Demonstrate Window borders manipulation.")]
8-
[ScenarioCategory ("Border")]
7+
[ScenarioMetadata (Name: "Borders on Window", Description: "Demonstrates Window borders manipulation.")]
8+
[ScenarioCategory ("Layout")]
9+
[ScenarioCategory ("Borders")]
910
public class BordersOnWindow : Scenario {
1011
public override void Setup ()
1112
{

UICatalog/Scenarios/Buttons.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66
using Terminal.Gui;
77

88
namespace UICatalog.Scenarios {
9-
[ScenarioMetadata (Name: "Buttons", Description: "Demonstrates all sorts of Buttons")]
9+
[ScenarioMetadata (Name: "Buttons", Description: "Demonstrates all sorts of Buttons.")]
1010
[ScenarioCategory ("Controls")]
1111
[ScenarioCategory ("Layout")]
1212
public class Buttons : Scenario {

UICatalog/Scenarios/CharacterMap.cs

+4-3
Original file line numberDiff line numberDiff line change
@@ -15,9 +15,10 @@ namespace UICatalog.Scenarios {
1515
/// - Helps test unicode character rendering in Terminal.Gui
1616
/// - Illustrates how to use ScrollView to do infinite scrolling
1717
/// </summary>
18-
[ScenarioMetadata (Name: "Character Map", Description: "Illustrates a custom control and Unicode")]
19-
[ScenarioCategory ("Text")]
20-
[ScenarioCategory ("Controls"), ScenarioCategory ("ScrollView")]
18+
[ScenarioMetadata (Name: "Character Map", Description: "A Unicode character set viewier built as a custom control using the ScrollView control.")]
19+
[ScenarioCategory ("Text and Formatting")]
20+
[ScenarioCategory ("Controls")]
21+
[ScenarioCategory ("ScrollView")]
2122
public class CharacterMap : Scenario {
2223
CharMap _charMap;
2324
public override void Setup ()

UICatalog/Scenarios/ClassExplorer.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
namespace UICatalog.Scenarios {
1111

12-
[ScenarioMetadata (Name: "Class Explorer", Description: "Tree view explorer for classes by namespace based on TreeView")]
12+
[ScenarioMetadata (Name: "Class Explorer", Description: "Tree view explorer for classes by namespace based on TreeView.")]
1313
[ScenarioCategory ("Controls"), ScenarioCategory ("TreeView")]
1414
public class ClassExplorer : Scenario {
1515
private TreeView<object> treeView;

UICatalog/Scenarios/Clipping.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace UICatalog.Scenarios {
55
[ScenarioMetadata (Name: "Clipping", Description: "Used to test that things clip correctly")]
6-
[ScenarioCategory ("Bug Repro")]
6+
[ScenarioCategory ("Tests")]
77

88
public class Clipping : Scenario {
99

UICatalog/Scenarios/ComputedLayout.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ namespace UICatalog.Scenarios {
1313
/// [x] - Using Dim.Fill and Dim.Pos to automatically align controls based on an initial control
1414
/// [ ] - ...
1515
/// </summary>
16-
[ScenarioMetadata (Name: "Computed Layout", Description: "Demonstrates using the Computed (Dim and Pos) Layout System")]
16+
[ScenarioMetadata (Name: "Computed Layout", Description: "Demonstrates the Computed (Dim and Pos) Layout System.")]
1717
[ScenarioCategory ("Layout")]
1818
public class ComputedLayout : Scenario {
1919

UICatalog/Scenarios/ContextMenus.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@
44
using Terminal.Gui;
55

66
namespace UICatalog.Scenarios {
7-
[ScenarioMetadata (Name: "ContextMenus", Description: "Context Menu Sample")]
8-
[ScenarioCategory ("Menu"), ScenarioCategory ("ContextMenu")]
7+
[ScenarioMetadata (Name: "ContextMenus", Description: "Context Menu Sample.")]
8+
[ScenarioCategory ("Menus")]
99
public class ContextMenus : Scenario {
1010
private ContextMenu contextMenu = new ContextMenu ();
1111
private readonly List<CultureInfo> cultureInfos = Application.SupportedCultures;

UICatalog/Scenarios/CsvEditor.cs

+5-3
Original file line numberDiff line numberDiff line change
@@ -11,12 +11,14 @@
1111

1212
namespace UICatalog.Scenarios {
1313

14-
[ScenarioMetadata (Name: "Csv Editor", Description: "Open and edit simple CSV files")]
14+
[ScenarioMetadata (Name: "Csv Editor", Description: "Open and edit simple CSV files using the TableView class.")]
15+
[ScenarioCategory ("TableView")]
1516
[ScenarioCategory ("Controls")]
1617
[ScenarioCategory ("Dialogs")]
17-
[ScenarioCategory ("Text")]
18+
[ScenarioCategory ("Text and Formatting")]
1819
[ScenarioCategory ("Dialogs")]
19-
[ScenarioCategory ("TopLevel")]
20+
[ScenarioCategory ("Top Level Windows")]
21+
[ScenarioCategory ("Files and IO")]
2022
public class CsvEditor : Scenario
2123
{
2224
TableView tableView;

UICatalog/Scenarios/Dialogs.cs

-1
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,6 @@
77

88
namespace UICatalog.Scenarios {
99
[ScenarioMetadata (Name: "Dialogs", Description: "Demonstrates how to the Dialog class")]
10-
[ScenarioCategory ("Controls")]
1110
[ScenarioCategory ("Dialogs")]
1211
public class Dialogs : Scenario {
1312
public override void Setup ()

UICatalog/Scenarios/DynamicMenuBar.cs

+3-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,9 @@
99
using Terminal.Gui;
1010

1111
namespace UICatalog.Scenarios {
12-
[ScenarioMetadata (Name: "Dynamic MenuBar", Description: "Demonstrates how to add and remove a MenuBar, Menus and change titles dynamically.")]
13-
[ScenarioCategory ("Menu")]
12+
[ScenarioMetadata (Name: "Dynamic MenuBar", Description: "Demonstrates how to change a MenuBar dynamically.")]
13+
[ScenarioCategory ("Top Level Windows")]
14+
[ScenarioCategory ("Menus")]
1415
public class DynamicMenuBar : Scenario {
1516
public override void Init (Toplevel top, ColorScheme colorScheme)
1617
{

UICatalog/Scenarios/DynamicStatusBar.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010

1111
namespace UICatalog.Scenarios {
1212
[ScenarioMetadata (Name: "Dynamic StatusBar", Description: "Demonstrates how to add and remove a StatusBar and change items dynamically.")]
13-
[ScenarioCategory ("StatusBar")]
13+
[ScenarioCategory ("Top Level Windows")]
1414
public class DynamicStatusBar : Scenario {
1515
public override void Init (Toplevel top, ColorScheme colorScheme)
1616
{

UICatalog/Scenarios/Editor.cs

+6-4
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,14 @@
88
using System.Globalization;
99

1010
namespace UICatalog.Scenarios {
11-
[ScenarioMetadata (Name: "Editor", Description: "A Terminal.Gui Text Editor via TextView")]
11+
[ScenarioMetadata (Name: "Editor", Description: "A Text Editor using the TextView control.")]
1212
[ScenarioCategory ("Controls")]
1313
[ScenarioCategory ("Dialogs")]
14-
[ScenarioCategory ("Text")]
15-
[ScenarioCategory ("Dialogs")]
16-
[ScenarioCategory ("TopLevel")]
14+
[ScenarioCategory ("Text and Formatting")]
15+
[ScenarioCategory ("Top Level Windows")]
16+
[ScenarioCategory ("Files and IO")]
17+
[ScenarioCategory ("TextView")]
18+
1719
public class Editor : Scenario {
1820
private string _fileName = "demo.txt";
1921
private TextView _textView;

UICatalog/Scenarios/GraphViewExample.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@
88

99
namespace UICatalog.Scenarios {
1010

11-
[ScenarioMetadata (Name: "Graph View", Description: "Demos GraphView control")]
12-
[ScenarioCategory ("Controls"), ScenarioCategory ("Graph")]
11+
[ScenarioMetadata (Name: "Graph View", Description: "Demos the GraphView control.")]
12+
[ScenarioCategory ("Controls")]
1313
public class GraphViewExample : Scenario {
1414

1515
GraphView graphView;

UICatalog/Scenarios/HexEditor.cs

+4-4
Original file line numberDiff line numberDiff line change
@@ -4,12 +4,12 @@
44
using Terminal.Gui;
55

66
namespace UICatalog.Scenarios {
7-
[ScenarioMetadata (Name: "HexEditor", Description: "A Terminal.Gui binary (hex) editor via HexView")]
7+
[ScenarioMetadata (Name: "HexEditor", Description: "A binary (hex) editor using the HexView control.")]
88
[ScenarioCategory ("Controls")]
99
[ScenarioCategory ("Dialogs")]
10-
[ScenarioCategory ("Text")]
11-
[ScenarioCategory ("Dialogs")]
12-
[ScenarioCategory ("TopLevel"), ScenarioCategory ("IO.Stream")]
10+
[ScenarioCategory ("Text and Formatting")]
11+
[ScenarioCategory ("Top Level Windows")]
12+
[ScenarioCategory ("Files and IO")]
1313
public class HexEditor : Scenario {
1414
private string _fileName = "demo.bin";
1515
private HexView _hexView;

UICatalog/Scenarios/InteractiveTree.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
namespace UICatalog.Scenarios {
1111

12-
[ScenarioMetadata (Name: "Interactive Tree", Description: "Create nodes and child nodes in TreeView")]
12+
[ScenarioMetadata (Name: "Interactive Tree", Description: "Create nodes and child nodes in TreeView.")]
1313
[ScenarioCategory ("Controls"), ScenarioCategory ("TreeView")]
1414
public class InteractiveTree : Scenario {
1515

UICatalog/Scenarios/InvertColors.cs

+1
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,7 @@
66
namespace UICatalog.Scenarios {
77
[ScenarioMetadata (Name: "Invert Colors", Description: "Invert the foreground and the background colors.")]
88
[ScenarioCategory ("Colors")]
9+
[ScenarioCategory ("Text and Formatting")]
910
public class InvertColors : Scenario {
1011
public override void Setup ()
1112
{

UICatalog/Scenarios/Keys.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44

55
namespace UICatalog.Scenarios {
66
[ScenarioMetadata (Name: "Keys", Description: "Shows how to handle keyboard input")]
7-
[ScenarioCategory ("Input")]
7+
[ScenarioCategory ("Mouse and Keyboard")]
88
public class Keys : Scenario {
99

1010
class TestWindow : Window {

UICatalog/Scenarios/LabelsAsButtons.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -8,7 +8,7 @@
88
namespace UICatalog.Scenarios {
99
[ScenarioMetadata (Name: "Labels As Buttons", Description: "Illustrates that Button is really just a Label++")]
1010
[ScenarioCategory ("Controls")]
11-
[ScenarioCategory ("POC")]
11+
[ScenarioCategory ("Proof of Concept")]
1212
public class LabelsAsLabels : Scenario {
1313
public override void Setup ()
1414
{

UICatalog/Scenarios/LineViewExample.cs

+2-2
Original file line numberDiff line numberDiff line change
@@ -9,8 +9,8 @@
99

1010
namespace UICatalog.Scenarios {
1111

12-
[ScenarioMetadata (Name: "Line View", Description: "Demonstrates the LineView control")]
13-
[ScenarioCategory ("Controls"), ScenarioCategory ("Lines")]
12+
[ScenarioMetadata (Name: "Line View", Description: "Demonstrates drawing lines using the LineView control.")]
13+
[ScenarioCategory ("Controls"), ScenarioCategory ("LineView")]
1414
public class LineViewExample : Scenario {
1515

1616
public override void Setup ()

UICatalog/Scenarios/MessageBoxes.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
using Terminal.Gui;
66

77
namespace UICatalog.Scenarios {
8-
[ScenarioMetadata (Name: "MessageBoxes", Description: "Demonstrates how to use MessageBoxes")]
8+
[ScenarioMetadata (Name: "MessageBoxes", Description: "Demonstrates how to use the MessageBox class.")]
99
[ScenarioCategory ("Controls")]
1010
[ScenarioCategory ("Dialogs")]
1111
public class MessageBoxes : Scenario {

UICatalog/Scenarios/Mouse.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
namespace UICatalog.Scenarios {
77
[ScenarioMetadata (Name: "Mouse", Description: "Demonstrates how to capture mouse events")]
8-
[ScenarioCategory ("Input"), ScenarioCategory ("Mouse")]
8+
[ScenarioCategory ("Mouse and Keyboard")]
99
public class Mouse : Scenario {
1010
public override void Setup ()
1111
{

UICatalog/Scenarios/MultiColouredTable.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,10 @@
44

55
namespace UICatalog.Scenarios {
66

7-
[ScenarioMetadata (Name: "MultiColouredTable", Description: "Demonstrates how to multi color cell contents")]
8-
[ScenarioCategory ("Controls"), ScenarioCategory ("Colors"), ScenarioCategory ("TableView")]
7+
[ScenarioMetadata (Name: "MultiColouredTable", Description: "Demonstrates how to multi color cell contents.")]
8+
[ScenarioCategory ("Controls")]
9+
[ScenarioCategory ("Colors")]
10+
[ScenarioCategory ("TableView")]
911
public class MultiColouredTable : Scenario {
1012
TableViewColors tableView;
1113

UICatalog/Scenarios/Notepad.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@
99

1010
namespace UICatalog.Scenarios {
1111

12-
[ScenarioMetadata (Name: "Notepad", Description: "Multi tab text editor")]
12+
[ScenarioMetadata (Name: "Notepad", Description: "Multi tab text editor uising the TabView control.")]
1313
[ScenarioCategory ("Controls"), ScenarioCategory ("TabView")]
1414
public class Notepad : Scenario {
1515

UICatalog/Scenarios/Progress.cs

+1-2
Original file line numberDiff line numberDiff line change
@@ -8,9 +8,8 @@ namespace UICatalog.Scenarios {
88
//
99
// This would be a great scenario to show of threading (Issue #471)
1010
//
11-
[ScenarioMetadata (Name: "Progress", Description: "Shows off ProgressBar and Threading")]
11+
[ScenarioMetadata (Name: "Progress", Description: "Shows off ProgressBar and Threading.")]
1212
[ScenarioCategory ("Controls")]
13-
[ScenarioCategory ("MainLoop")]
1413
[ScenarioCategory ("Threading"), ScenarioCategory ("ProgressBar")]
1514
public class Progress : Scenario {
1615

UICatalog/Scenarios/ProgressBarStyles.cs

+4-2
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,11 @@
44
using Terminal.Gui;
55

66
namespace UICatalog.Scenarios {
7-
[ScenarioMetadata (Name: "ProgressBar Styles", Description: "Shows the ProgressBar Styles")]
7+
[ScenarioMetadata (Name: "ProgressBar Styles", Description: "Shows the ProgressBar Styles.")]
88
[ScenarioCategory ("Controls")]
9-
[ScenarioCategory ("MainLoop"), ScenarioCategory ("ProgressBar")]
9+
[ScenarioCategory ("ProgressBar")]
10+
[ScenarioCategory ("Threading")]
11+
1012
public class ProgressBarStyles : Scenario {
1113
private Timer _fractionTimer;
1214
private Timer _pulseTimer;

UICatalog/Scenarios/Scrolling.cs

-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,6 @@
44
namespace UICatalog.Scenarios {
55
[ScenarioMetadata (Name: "Scrolling", Description: "Demonstrates ScrollView etc...")]
66
[ScenarioCategory ("Controls")]
7-
[ScenarioCategory ("Bug Repro")]
87
[ScenarioCategory ("ScrollView")]
98
public class Scrolling : Scenario {
109

UICatalog/Scenarios/SendKeys.cs

+1-1
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@
33

44
namespace UICatalog.Scenarios {
55
[ScenarioMetadata (Name: "SendKeys", Description: "SendKeys sample - Send key combinations.")]
6-
[ScenarioCategory ("Input")]
6+
[ScenarioCategory ("Mouse and Keyboard")]
77
public class SendKeys : Scenario {
88
public override void Setup ()
99
{

0 commit comments

Comments
 (0)