ColorPicker.cs 8.4 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  1. #nullable enable
  2. using System;
  3. namespace Terminal.Gui;
  4. /// <summary>
  5. /// True color picker using HSL
  6. /// </summary>
  7. public class ColorPicker : View
  8. {
  9. /// <summary>
  10. /// Creates a new instance of <see cref="ColorPicker"/>. Use
  11. /// <see cref="Style"/> to change color model. Use <see cref="SelectedColor"/>
  12. /// to change initial <see cref="Color"/>.
  13. /// </summary>
  14. public ColorPicker ()
  15. {
  16. CanFocus = true;
  17. TabStop = TabBehavior.TabStop;
  18. Height = Dim.Auto ();
  19. Width = Dim.Auto ();
  20. ApplyStyleChanges ();
  21. }
  22. private readonly Dictionary<IColorBar, TextField> _textFields = new ();
  23. private readonly ColorModelStrategy _strategy = new ();
  24. private TextField? _tfHex;
  25. private Label? _lbHex;
  26. private TextField? _tfName;
  27. private Label? _lbName;
  28. private Color _selectedColor = Color.Black;
  29. // TODO: Add interface
  30. private readonly IColorNameResolver _colorNameResolver = new W3CColors ();
  31. private List<IColorBar> _bars = new ();
  32. /// <summary>
  33. /// Rebuild the user interface to reflect the new state of <see cref="Style"/>.
  34. /// </summary>
  35. public void ApplyStyleChanges ()
  36. {
  37. Color oldValue = _selectedColor;
  38. DisposeOldViews ();
  39. var y = 0;
  40. const int textFieldWidth = 4;
  41. foreach (ColorBar bar in _strategy.CreateBars (Style.ColorModel))
  42. {
  43. bar.Y = y;
  44. bar.Width = Dim.Fill (Style.ShowTextFields ? textFieldWidth : 0);
  45. TextField? tfValue = null;
  46. if (Style.ShowTextFields)
  47. {
  48. tfValue = new TextField
  49. {
  50. X = Pos.AnchorEnd (textFieldWidth),
  51. Y = y,
  52. Width = textFieldWidth
  53. };
  54. tfValue.HasFocusChanged += UpdateSingleBarValueFromTextField;
  55. _textFields.Add (bar, tfValue);
  56. }
  57. y++;
  58. bar.ValueChanged += RebuildColorFromBar;
  59. _bars.Add (bar);
  60. Add (bar);
  61. if (tfValue is { })
  62. {
  63. Add (tfValue);
  64. }
  65. }
  66. if (Style.ShowColorName)
  67. {
  68. CreateNameField ();
  69. }
  70. CreateTextField ();
  71. SelectedColor = oldValue;
  72. if (IsInitialized)
  73. {
  74. LayoutSubviews ();
  75. }
  76. }
  77. /// <summary>
  78. /// Fired when color is changed.
  79. /// </summary>
  80. public event EventHandler<ColorEventArgs>? ColorChanged;
  81. /// <inheritdoc/>
  82. public override void OnDrawContent (Rectangle viewport)
  83. {
  84. base.OnDrawContent (viewport);
  85. Attribute normal = GetNormalColor ();
  86. Driver.SetAttribute (new (SelectedColor, normal.Background));
  87. int y = _bars.Count + (Style.ShowColorName ? 1 : 0);
  88. AddRune (13, y, (Rune)'■');
  89. }
  90. /// <summary>
  91. /// The color selected in the picker
  92. /// </summary>
  93. public Color SelectedColor
  94. {
  95. get => _selectedColor;
  96. set => SetSelectedColor (value, true);
  97. }
  98. /// <summary>
  99. /// Style settings for the color picker. After making changes ensure you call
  100. /// <see cref="ApplyStyleChanges"/>.
  101. /// </summary>
  102. public ColorPickerStyle Style { get; set; } = new ();
  103. private void CreateNameField ()
  104. {
  105. _lbName = new ()
  106. {
  107. Text = "Name:",
  108. X = 0,
  109. Y = 3
  110. };
  111. _tfName = new ()
  112. {
  113. Y = 3,
  114. X = 6,
  115. Width = 20 // width of "LightGoldenRodYellow" - the longest w3c color name
  116. };
  117. Add (_lbName);
  118. Add (_tfName);
  119. var auto = new AppendAutocomplete (_tfName);
  120. auto.SuggestionGenerator = new SingleWordSuggestionGenerator
  121. {
  122. AllSuggestions = _colorNameResolver.GetColorNames ().ToList ()
  123. };
  124. _tfName.Autocomplete = auto;
  125. _tfName.HasFocusChanged += UpdateValueFromName;
  126. }
  127. private void CreateTextField ()
  128. {
  129. int y = _bars.Count;
  130. if (Style.ShowColorName)
  131. {
  132. y++;
  133. }
  134. _lbHex = new ()
  135. {
  136. Text = "Hex:",
  137. X = 0,
  138. Y = y
  139. };
  140. _tfHex = new ()
  141. {
  142. Y = y,
  143. X = 4,
  144. Width = 8,
  145. };
  146. Add (_lbHex);
  147. Add (_tfHex);
  148. _tfHex.HasFocusChanged += UpdateValueFromTextField;
  149. }
  150. private void DisposeOldViews ()
  151. {
  152. foreach (ColorBar bar in _bars.Cast<ColorBar> ())
  153. {
  154. bar.ValueChanged -= RebuildColorFromBar;
  155. if (_textFields.TryGetValue (bar, out TextField? tf))
  156. {
  157. tf.HasFocusChanged -= UpdateSingleBarValueFromTextField;
  158. Remove (tf);
  159. tf.Dispose ();
  160. }
  161. Remove (bar);
  162. bar.Dispose ();
  163. }
  164. _bars = new ();
  165. _textFields.Clear ();
  166. if (_lbHex != null)
  167. {
  168. Remove (_lbHex);
  169. _lbHex.Dispose ();
  170. _lbHex = null;
  171. }
  172. if (_tfHex != null)
  173. {
  174. Remove (_tfHex);
  175. _tfHex.HasFocusChanged -= UpdateValueFromTextField;
  176. _tfHex.Dispose ();
  177. _tfHex = null;
  178. }
  179. if (_lbName != null)
  180. {
  181. Remove (_lbName);
  182. _lbName.Dispose ();
  183. _lbName = null;
  184. }
  185. if (_tfName != null)
  186. {
  187. Remove (_tfName);
  188. _tfName.HasFocusChanged -= UpdateValueFromName;
  189. _tfName.Dispose ();
  190. _tfName = null;
  191. }
  192. }
  193. private void RebuildColorFromBar (object? sender, EventArgs<int> e) { SetSelectedColor (_strategy.GetColorFromBars (_bars, Style.ColorModel), false); }
  194. private void SetSelectedColor (Color value, bool syncBars)
  195. {
  196. if (_selectedColor != value)
  197. {
  198. Color old = _selectedColor;
  199. _selectedColor = value;
  200. ColorChanged?.Invoke (
  201. this,
  202. new (value));
  203. }
  204. SyncSubViewValues (syncBars);
  205. }
  206. private void SyncSubViewValues (bool syncBars)
  207. {
  208. if (syncBars)
  209. {
  210. _strategy.SetBarsToColor (_bars, _selectedColor, Style.ColorModel);
  211. }
  212. foreach (KeyValuePair<IColorBar, TextField> kvp in _textFields)
  213. {
  214. kvp.Value.Text = kvp.Key.Value.ToString ();
  215. }
  216. var colorHex = _selectedColor.ToString ($"#{SelectedColor.R:X2}{SelectedColor.G:X2}{SelectedColor.B:X2}");
  217. if (_tfName != null)
  218. {
  219. _tfName.Text = _colorNameResolver.TryNameColor (_selectedColor, out string name) ? name : string.Empty;
  220. }
  221. if (_tfHex != null)
  222. {
  223. _tfHex.Text = colorHex;
  224. }
  225. }
  226. private void UpdateSingleBarValueFromTextField (object? sender, HasFocusEventArgs e)
  227. {
  228. if (e.NewValue)
  229. {
  230. return;
  231. }
  232. foreach (KeyValuePair<IColorBar, TextField> kvp in _textFields)
  233. {
  234. if (kvp.Value == sender)
  235. {
  236. if (int.TryParse (kvp.Value.Text, out int v))
  237. {
  238. kvp.Key.Value = v;
  239. }
  240. }
  241. }
  242. }
  243. private void UpdateValueFromName (object? sender, HasFocusEventArgs e)
  244. {
  245. if (e.NewValue)
  246. {
  247. return;
  248. }
  249. if (_tfName == null)
  250. {
  251. return;
  252. }
  253. if (_colorNameResolver.TryParseColor (_tfName.Text, out Color newColor))
  254. {
  255. SelectedColor = newColor;
  256. }
  257. else
  258. {
  259. // value is invalid, revert the value in the text field back to current state
  260. SyncSubViewValues (false);
  261. }
  262. }
  263. private void UpdateValueFromTextField (object? sender, HasFocusEventArgs e)
  264. {
  265. if (e.NewValue)
  266. {
  267. return;
  268. }
  269. if (_tfHex == null)
  270. {
  271. return;
  272. }
  273. if (Color.TryParse (_tfHex.Text, out Color? newColor))
  274. {
  275. SelectedColor = newColor.Value;
  276. }
  277. else
  278. {
  279. // value is invalid, revert the value in the text field back to current state
  280. SyncSubViewValues (false);
  281. }
  282. }
  283. protected override void Dispose (bool disposing)
  284. {
  285. DisposeOldViews ();
  286. base.Dispose (disposing);
  287. }
  288. }