Slider.cs 58 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864
  1. using System.Transactions;
  2. namespace Terminal.Gui;
  3. /// <summary>Slider control.</summary>
  4. public class Slider : Slider<object>
  5. {
  6. /// <summary>Initializes a new instance of the <see cref="Slider"/> class.</summary>
  7. public Slider () { }
  8. /// <summary>Initializes a new instance of the <see cref="Slider"/> class.</summary>
  9. /// <param name="options">Initial slider options.</param>
  10. /// <param name="orientation">Initial slider options.</param>
  11. public Slider (List<object> options, Orientation orientation = Orientation.Horizontal) :
  12. base (options, orientation)
  13. { }
  14. }
  15. /// <summary>
  16. /// Provides a slider control letting the user navigate from a set of typed options in a linear manner using the
  17. /// keyboard or mouse.
  18. /// </summary>
  19. /// <typeparam name="T"></typeparam>
  20. public class Slider<T> : View, IOrientation
  21. {
  22. private readonly SliderConfiguration _config = new ();
  23. // List of the current set options.
  24. private readonly List<int> _setOptions = new ();
  25. // Options
  26. private List<SliderOption<T>> _options;
  27. private OrientationHelper _orientationHelper;
  28. #region Initialize
  29. private void SetInitialProperties (
  30. List<SliderOption<T>> options,
  31. Orientation orientation = Orientation.Horizontal
  32. )
  33. {
  34. Width = Dim.Auto (DimAutoStyle.Content);
  35. Height = Dim.Auto (DimAutoStyle.Content);
  36. CanFocus = true;
  37. CursorVisibility = CursorVisibility.Default;
  38. _options = options ?? new List<SliderOption<T>> ();
  39. _orientationHelper = new (this);
  40. _orientationHelper.Orientation = _config._sliderOrientation = orientation;
  41. _orientationHelper.OrientationChanging += (sender, e) => OrientationChanging?.Invoke (this, e);
  42. _orientationHelper.OrientationChanged += (sender, e) => OrientationChanged?.Invoke (this, e);
  43. SetDefaultStyle ();
  44. SetCommands ();
  45. SetContentSize ();
  46. // BUGBUG: This should not be needed - Need to ensure SetRelativeLayout gets called during EndInit
  47. Initialized += (s, e) => { SetContentSize (); };
  48. LayoutStarted += (s, e) => { SetContentSize (); };
  49. }
  50. // TODO: Make configurable via ConfigurationManager
  51. private void SetDefaultStyle ()
  52. {
  53. _config._showLegends = true;
  54. switch (_config._sliderOrientation)
  55. {
  56. case Orientation.Horizontal:
  57. Style.SpaceChar = new () { Rune = Glyphs.HLine }; // '─'
  58. Style.OptionChar = new () { Rune = Glyphs.BlackCircle }; // '┼●🗹□⏹'
  59. break;
  60. case Orientation.Vertical:
  61. Style.SpaceChar = new () { Rune = Glyphs.VLine };
  62. Style.OptionChar = new () { Rune = Glyphs.BlackCircle };
  63. break;
  64. }
  65. // TODO(jmperricone) Wide Vertical ???
  66. /*
  67. ┼─ 40
  68. ███ 30
  69. ▒▒▒
  70. ▒▒▒
  71. ▒▒▒ 20
  72. ▒▒▒
  73. ▒▒▒
  74. ███ 10
  75. ─●─ 0
  76. */
  77. _config._legendsOrientation = _config._sliderOrientation;
  78. Style.EmptyChar = new () { Rune = new (' ') };
  79. Style.SetChar = new () { Rune = Glyphs.ContinuousMeterSegment }; // ■
  80. Style.RangeChar = new () { Rune = Glyphs.Stipple }; // ░ ▒ ▓ // Medium shade not blinking on curses.
  81. Style.StartRangeChar = new () { Rune = Glyphs.ContinuousMeterSegment };
  82. Style.EndRangeChar = new () { Rune = Glyphs.ContinuousMeterSegment };
  83. Style.DragChar = new () { Rune = Glyphs.Diamond };
  84. // TODO: Support left & right (top/bottom)
  85. // First = '├',
  86. // Last = '┤',
  87. }
  88. #endregion
  89. #region Constructors
  90. /// <summary>Initializes a new instance of the <see cref="Slider"/> class.</summary>
  91. public Slider () : this (new ()) { }
  92. /// <summary>Initializes a new instance of the <see cref="Slider"/> class.</summary>
  93. /// <param name="options">Initial slider options.</param>
  94. /// <param name="orientation">Initial slider orientation.</param>
  95. public Slider (List<T> options, Orientation orientation = Orientation.Horizontal)
  96. {
  97. if (options is null)
  98. {
  99. SetInitialProperties (null, orientation);
  100. }
  101. else
  102. {
  103. SetInitialProperties (
  104. options.Select (
  105. e =>
  106. {
  107. var legend = e.ToString ();
  108. return new SliderOption<T>
  109. {
  110. Data = e,
  111. Legend = legend,
  112. LegendAbbr =
  113. (Rune)(legend?.Length > 0 ? legend [0] : ' ')
  114. };
  115. }
  116. )
  117. .ToList (),
  118. orientation
  119. );
  120. }
  121. }
  122. #endregion
  123. #region Properties
  124. /// <summary>
  125. /// Setting the Text of a slider is a shortcut to setting options. The text is a CSV string of the options.
  126. /// </summary>
  127. public override string Text
  128. {
  129. get
  130. {
  131. if (_options.Count == 0)
  132. {
  133. return string.Empty;
  134. }
  135. // Return labels as a CSV string
  136. return string.Join (",", _options);
  137. }
  138. set
  139. {
  140. if (string.IsNullOrEmpty (value))
  141. {
  142. Options = [];
  143. }
  144. else
  145. {
  146. IEnumerable<string> list = value.Split (',').Select (x => x.Trim ());
  147. Options = list.Select (x => new SliderOption<T> { Legend = x }).ToList ();
  148. }
  149. }
  150. }
  151. /// <summary>Allow no selection.</summary>
  152. public bool AllowEmpty
  153. {
  154. get => _config._allowEmpty;
  155. set
  156. {
  157. _config._allowEmpty = value;
  158. if (!value && _options.Count > 0 && _setOptions.Count == 0)
  159. {
  160. SetOption (0);
  161. }
  162. }
  163. }
  164. /// <summary>Gets or sets the minimum number of rows/columns between <see cref="Options"/>. The default is 1.</summary>
  165. public int MinimumInnerSpacing
  166. {
  167. get => _config._minInnerSpacing;
  168. set
  169. {
  170. _config._minInnerSpacing = value;
  171. SetContentSize ();
  172. }
  173. }
  174. /// <summary>Slider Type. <see cref="SliderType"></see></summary>
  175. public SliderType Type
  176. {
  177. get => _config._type;
  178. set
  179. {
  180. _config._type = value;
  181. // Todo: Custom logic to preserve options.
  182. _setOptions.Clear ();
  183. SetNeedsDisplay ();
  184. }
  185. }
  186. /// <summary>
  187. /// Gets or sets the <see cref="Orientation"/>. The default is <see cref="Orientation.Horizontal"/>.
  188. /// </summary>
  189. public Orientation Orientation
  190. {
  191. get => _orientationHelper.Orientation;
  192. set => _orientationHelper.Orientation = value;
  193. }
  194. #region IOrientation members
  195. /// <inheritdoc />
  196. public event EventHandler<CancelEventArgs<Orientation>> OrientationChanging;
  197. /// <inheritdoc />
  198. public event EventHandler<EventArgs<Orientation>> OrientationChanged;
  199. /// <inheritdoc />
  200. public void OnOrientationChanged (Orientation newOrientation)
  201. {
  202. _config._sliderOrientation = newOrientation;
  203. switch (_config._sliderOrientation)
  204. {
  205. case Orientation.Horizontal:
  206. Style.SpaceChar = new () { Rune = Glyphs.HLine }; // '─'
  207. break;
  208. case Orientation.Vertical:
  209. Style.SpaceChar = new () { Rune = Glyphs.VLine };
  210. break;
  211. }
  212. SetKeyBindings ();
  213. SetContentSize ();
  214. }
  215. #endregion
  216. /// <summary>Legends Orientation. <see cref="Gui.Orientation"></see></summary>
  217. public Orientation LegendsOrientation
  218. {
  219. get => _config._legendsOrientation;
  220. set
  221. {
  222. _config._legendsOrientation = value;
  223. SetContentSize ();
  224. }
  225. }
  226. /// <summary>Slider styles. <see cref="SliderStyle"></see></summary>
  227. public SliderStyle Style { get; set; } = new ();
  228. /// <summary>Set the slider options.</summary>
  229. public List<SliderOption<T>> Options
  230. {
  231. get =>
  232. _options;
  233. set
  234. {
  235. // _options should never be null
  236. _options = value ?? throw new ArgumentNullException (nameof (value));
  237. if (_options.Count == 0)
  238. {
  239. return;
  240. }
  241. SetContentSize ();
  242. }
  243. }
  244. /// <summary>Allow range start and end be in the same option, as a single option.</summary>
  245. public bool RangeAllowSingle
  246. {
  247. get => _config._rangeAllowSingle;
  248. set => _config._rangeAllowSingle = value;
  249. }
  250. /// <summary>Show/Hide spacing before and after the first and last option.</summary>
  251. public bool ShowEndSpacing
  252. {
  253. get => _config._showEndSpacing;
  254. set
  255. {
  256. _config._showEndSpacing = value;
  257. SetContentSize ();
  258. }
  259. }
  260. /// <summary>Show/Hide the options legends.</summary>
  261. public bool ShowLegends
  262. {
  263. get => _config._showLegends;
  264. set
  265. {
  266. _config._showLegends = value;
  267. SetContentSize ();
  268. }
  269. }
  270. /// <summary>
  271. /// Gets or sets whether the minimum or ideal size will be used when calculating the size of the slider.
  272. /// </summary>
  273. public bool UseMinimumSize
  274. {
  275. get => _config._useMinimumSize;
  276. set
  277. {
  278. _config._useMinimumSize = value;
  279. SetContentSize ();
  280. }
  281. }
  282. #endregion
  283. #region Events
  284. /// <summary>Event raised when the slider option/s changed. The dictionary contains: key = option index, value = T</summary>
  285. public event EventHandler<SliderEventArgs<T>> OptionsChanged;
  286. /// <summary>Overridable method called when the slider options have changed. Raises the <see cref="OptionsChanged"/> event.</summary>
  287. public virtual void OnOptionsChanged ()
  288. {
  289. OptionsChanged?.Invoke (this, new (GetSetOptionDictionary ()));
  290. SetNeedsDisplay ();
  291. }
  292. /// <summary>Event raised When the option is hovered with the keys or the mouse.</summary>
  293. public event EventHandler<SliderEventArgs<T>> OptionFocused;
  294. private int
  295. _lastFocusedOption; // for Range type; the most recently focused option. Used to determine shrink direction
  296. /// <summary>Overridable function that fires the <see cref="OptionFocused"/> event.</summary>
  297. /// <param name="args"></param>
  298. /// <returns><see langword="true"/> if the focus change was cancelled.</returns>
  299. /// <param name="newFocusedOption"></param>
  300. public virtual bool OnOptionFocused (int newFocusedOption, SliderEventArgs<T> args)
  301. {
  302. if (newFocusedOption > _options.Count - 1 || newFocusedOption < 0)
  303. {
  304. return true;
  305. }
  306. OptionFocused?.Invoke (this, args);
  307. if (!args.Cancel)
  308. {
  309. _lastFocusedOption = FocusedOption;
  310. FocusedOption = newFocusedOption;
  311. //PositionCursor ();
  312. }
  313. return args.Cancel;
  314. }
  315. #endregion Events
  316. #region Public Methods
  317. /// <summary>The focused option (has the cursor).</summary>
  318. public int FocusedOption { get; set; }
  319. /// <summary>Causes the specified option to be set and be focused.</summary>
  320. public bool SetOption (int optionIndex)
  321. {
  322. // TODO: Handle range type.
  323. // Note: Maybe return false only when optionIndex doesn't exist, otherwise true.
  324. if (!_setOptions.Contains (optionIndex) && optionIndex >= 0 && optionIndex < _options.Count)
  325. {
  326. FocusedOption = optionIndex;
  327. SetFocusedOption ();
  328. return true;
  329. }
  330. return false;
  331. }
  332. /// <summary>Causes the specified option to be un-set and be focused.</summary>
  333. public bool UnSetOption (int optionIndex)
  334. {
  335. if (!AllowEmpty && _setOptions.Count > 2 && _setOptions.Contains (optionIndex))
  336. {
  337. FocusedOption = optionIndex;
  338. SetFocusedOption ();
  339. return true;
  340. }
  341. return false;
  342. }
  343. /// <summary>Get the indexes of the set options.</summary>
  344. public List<int> GetSetOptions ()
  345. {
  346. // Copy
  347. return _setOptions.OrderBy (e => e).ToList ();
  348. }
  349. #endregion Public Methods
  350. #region Helpers
  351. private void MoveAndAdd (int x, int y, Rune rune)
  352. {
  353. Move (x, y);
  354. Driver?.AddRune (rune);
  355. }
  356. private void MoveAndAdd (int x, int y, string str)
  357. {
  358. Move (x, y);
  359. Driver?.AddStr (str);
  360. }
  361. /// <summary>Sets the dimensions of the Slider to the ideal values.</summary>
  362. private void SetContentSize ()
  363. {
  364. if (_options.Count == 0)
  365. {
  366. return;
  367. }
  368. bool horizontal = _config._sliderOrientation == Orientation.Horizontal;
  369. if (UseMinimumSize)
  370. {
  371. CalcSpacingConfig (CalcMinLength ());
  372. }
  373. else
  374. {
  375. CalcSpacingConfig (horizontal ? Viewport.Width : Viewport.Height);
  376. }
  377. SetContentSize (new (GetIdealWidth (), GetIdealHeight ()));
  378. return;
  379. void CalcSpacingConfig (int size)
  380. {
  381. _config._cachedInnerSpacing = 0;
  382. _config._startSpacing = 0;
  383. _config._endSpacing = 0;
  384. int maxLegend; // Because the legends are centered, the longest one determines inner spacing
  385. if (_config._sliderOrientation == _config._legendsOrientation)
  386. {
  387. maxLegend = int.Max (_options.Max (s => s.Legend?.GetColumns () ?? 1), 1);
  388. }
  389. else
  390. {
  391. maxLegend = 1;
  392. }
  393. int minSizeThatFitsLegends = _options.Count == 1 ? maxLegend : _options.Sum (o => o.Legend.GetColumns ());
  394. string first;
  395. string last;
  396. if (minSizeThatFitsLegends > size)
  397. {
  398. _config._showLegendsAbbr = false;
  399. if (_config._sliderOrientation == _config._legendsOrientation)
  400. {
  401. _config._showLegendsAbbr = true;
  402. foreach (SliderOption<T> o in _options.Where (op => op.LegendAbbr == default (Rune)))
  403. {
  404. o.LegendAbbr = (Rune)(o.Legend?.GetColumns () > 0 ? o.Legend [0] : ' ');
  405. }
  406. }
  407. first = "x";
  408. last = "x";
  409. }
  410. else
  411. {
  412. _config._showLegendsAbbr = false;
  413. first = _options.First ().Legend;
  414. last = _options.Last ().Legend;
  415. }
  416. // --o--
  417. // Hello
  418. // Left = He
  419. // Right = lo
  420. int firstLeft = (first.Length - 1) / 2; // Chars count of the first option to the left.
  421. int lastRight = last.Length / 2; // Chars count of the last option to the right.
  422. if (_config._sliderOrientation != _config._legendsOrientation)
  423. {
  424. firstLeft = 0;
  425. lastRight = 0;
  426. }
  427. // -1 because it's better to have an extra space at right than to clip
  428. int width = size - firstLeft - lastRight - 1;
  429. _config._startSpacing = firstLeft;
  430. if (_options.Count == 1)
  431. {
  432. _config._cachedInnerSpacing = maxLegend;
  433. }
  434. else
  435. {
  436. _config._cachedInnerSpacing = Math.Max (0, (int)Math.Floor ((double)width / (_options.Count - 1)) - 1);
  437. }
  438. _config._cachedInnerSpacing = Math.Max (_config._minInnerSpacing, _config._cachedInnerSpacing);
  439. _config._endSpacing = lastRight;
  440. }
  441. }
  442. /// <summary>Calculates the min dimension required for all options and inner spacing with abbreviated legends</summary>
  443. /// <returns></returns>
  444. private int CalcMinLength ()
  445. {
  446. if (_options.Count == 0)
  447. {
  448. return 0;
  449. }
  450. var length = 0;
  451. length += _config._startSpacing + _config._endSpacing;
  452. length += _options.Count;
  453. length += (_options.Count - 1) * _config._minInnerSpacing;
  454. return length;
  455. }
  456. /// <summary>
  457. /// Gets the ideal width of the slider. The ideal width is the minimum width required to display all options and inner
  458. /// spacing.
  459. /// </summary>
  460. /// <returns></returns>
  461. public int GetIdealWidth ()
  462. {
  463. if (UseMinimumSize)
  464. {
  465. return Orientation == Orientation.Horizontal ? CalcMinLength () : CalcIdealThickness ();
  466. }
  467. return Orientation == Orientation.Horizontal ? CalcIdealLength () : CalcIdealThickness ();
  468. }
  469. /// <summary>
  470. /// Gets the ideal height of the slider. The ideal height is the minimum height required to display all options and
  471. /// inner spacing.
  472. /// </summary>
  473. /// <returns></returns>
  474. public int GetIdealHeight ()
  475. {
  476. if (UseMinimumSize)
  477. {
  478. return Orientation == Orientation.Horizontal ? CalcIdealThickness () : CalcMinLength ();
  479. }
  480. return Orientation == Orientation.Horizontal ? CalcIdealThickness () : CalcIdealLength ();
  481. }
  482. /// <summary>
  483. /// Calculates the ideal dimension required for all options, inner spacing, and legends (non-abbreviated, with one
  484. /// space between).
  485. /// </summary>
  486. /// <returns></returns>
  487. private int CalcIdealLength ()
  488. {
  489. if (_options.Count == 0)
  490. {
  491. return 0;
  492. }
  493. bool isVertical = Orientation == Orientation.Vertical;
  494. var length = 0;
  495. if (_config._showLegends)
  496. {
  497. if (_config._legendsOrientation == _config._sliderOrientation && _options.Count > 0)
  498. {
  499. // Each legend should be centered in a space the width of the longest legend, with one space between.
  500. // Calculate the total length required for all legends.
  501. //if (!isVertical)
  502. {
  503. int maxLegend = int.Max (_options.Max (s => s.Legend?.GetColumns () ?? 1), 1);
  504. length = maxLegend * _options.Count + (_options.Count - 1);
  505. }
  506. //
  507. //{
  508. // length = CalcMinLength ();
  509. //}
  510. }
  511. else
  512. {
  513. length = CalcMinLength ();
  514. }
  515. }
  516. return Math.Max (length, CalcMinLength ());
  517. }
  518. /// <summary>
  519. /// Calculates the minimum dimension required for the slider and legends.
  520. /// </summary>
  521. /// <returns></returns>
  522. private int CalcIdealThickness ()
  523. {
  524. var thickness = 1; // Always show the slider.
  525. if (_config._showLegends)
  526. {
  527. if (_config._legendsOrientation != _config._sliderOrientation && _options.Count > 0)
  528. {
  529. thickness += _options.Max (s => s.Legend?.GetColumns () ?? 0);
  530. }
  531. else
  532. {
  533. thickness += 1;
  534. }
  535. }
  536. return thickness;
  537. }
  538. #endregion Helpers
  539. #region Cursor and Position
  540. internal bool TryGetPositionByOption (int option, out (int x, int y) position)
  541. {
  542. position = (-1, -1);
  543. if (option < 0 || option >= _options.Count ())
  544. {
  545. return false;
  546. }
  547. var offset = 0;
  548. offset += _config._startSpacing;
  549. offset += option * (_config._cachedInnerSpacing + 1);
  550. if (_config._sliderOrientation == Orientation.Vertical)
  551. {
  552. position = (0, offset);
  553. }
  554. else
  555. {
  556. position = (offset, 0);
  557. }
  558. return true;
  559. }
  560. /// <summary>Tries to get the option index by the position.</summary>
  561. /// <param name="x"></param>
  562. /// <param name="y"></param>
  563. /// <param name="threshold"></param>
  564. /// <param name="optionIdx"></param>
  565. /// <returns></returns>
  566. internal bool TryGetOptionByPosition (int x, int y, int threshold, out int optionIdx)
  567. {
  568. // Fix(jmperricone): Not working.
  569. optionIdx = -1;
  570. if (Orientation == Orientation.Horizontal)
  571. {
  572. if (y != 0)
  573. {
  574. return false;
  575. }
  576. for (int xx = x - threshold; xx < x + threshold + 1; xx++)
  577. {
  578. int cx = xx;
  579. cx -= _config._startSpacing;
  580. int option = cx / (_config._cachedInnerSpacing + 1);
  581. bool valid = cx % (_config._cachedInnerSpacing + 1) == 0;
  582. if (!valid || option < 0 || option > _options.Count - 1)
  583. {
  584. continue;
  585. }
  586. optionIdx = option;
  587. return true;
  588. }
  589. }
  590. else
  591. {
  592. if (x != 0)
  593. {
  594. return false;
  595. }
  596. for (int yy = y - threshold; yy < y + threshold + 1; yy++)
  597. {
  598. int cy = yy;
  599. cy -= _config._startSpacing;
  600. int option = cy / (_config._cachedInnerSpacing + 1);
  601. bool valid = cy % (_config._cachedInnerSpacing + 1) == 0;
  602. if (!valid || option < 0 || option > _options.Count - 1)
  603. {
  604. continue;
  605. }
  606. optionIdx = option;
  607. return true;
  608. }
  609. }
  610. return false;
  611. }
  612. /// <inheritdoc/>
  613. public override Point? PositionCursor ()
  614. {
  615. if (TryGetPositionByOption (FocusedOption, out (int x, int y) position))
  616. {
  617. if (IsInitialized && Viewport.Contains (position.x, position.y))
  618. {
  619. Move (position.x, position.y);
  620. return new (position.x, position.y);
  621. }
  622. }
  623. return base.PositionCursor ();
  624. }
  625. #endregion Cursor and Position
  626. #region Drawing
  627. /// <inheritdoc/>
  628. public override void OnDrawContent (Rectangle viewport)
  629. {
  630. // TODO: make this more surgical to reduce repaint
  631. if (_options is null || _options.Count == 0)
  632. {
  633. return;
  634. }
  635. // Draw Slider
  636. DrawSlider ();
  637. // Draw Legends.
  638. if (_config._showLegends)
  639. {
  640. DrawLegends ();
  641. }
  642. if (_dragPosition.HasValue && _moveRenderPosition.HasValue)
  643. {
  644. AddRune (_moveRenderPosition.Value.X, _moveRenderPosition.Value.Y, Style.DragChar.Rune);
  645. }
  646. }
  647. private string AlignText (string text, int width, Alignment alignment)
  648. {
  649. if (text is null)
  650. {
  651. return "";
  652. }
  653. if (text.Length > width)
  654. {
  655. text = text [..width];
  656. }
  657. int w = width - text.Length;
  658. string s1 = new (' ', w / 2);
  659. string s2 = new (' ', w % 2);
  660. // Note: The formatter doesn't handle all of this ???
  661. switch (alignment)
  662. {
  663. case Alignment.Fill:
  664. return TextFormatter.Justify (text, width);
  665. case Alignment.Start:
  666. return text + s1 + s1 + s2;
  667. case Alignment.Center:
  668. if (text.Length % 2 != 0)
  669. {
  670. return s1 + text + s1 + s2;
  671. }
  672. return s1 + s2 + text + s1;
  673. case Alignment.End:
  674. return s1 + s1 + s2 + text;
  675. default:
  676. return text;
  677. }
  678. }
  679. private void DrawSlider ()
  680. {
  681. // TODO: be more surgical on clear
  682. Clear ();
  683. // Attributes
  684. var normalAttr = new Attribute (Color.White, Color.Black);
  685. var setAttr = new Attribute (Color.Black, Color.White);
  686. if (IsInitialized)
  687. {
  688. normalAttr = ColorScheme?.Normal ?? Application.Top.ColorScheme.Normal;
  689. setAttr = Style.SetChar.Attribute ?? ColorScheme!.HotNormal;
  690. }
  691. bool isVertical = _config._sliderOrientation == Orientation.Vertical;
  692. bool isLegendsVertical = _config._legendsOrientation == Orientation.Vertical;
  693. bool isReverse = _config._sliderOrientation != _config._legendsOrientation;
  694. var x = 0;
  695. var y = 0;
  696. bool isSet = _setOptions.Count > 0;
  697. // Left Spacing
  698. if (_config._showEndSpacing && _config._startSpacing > 0)
  699. {
  700. Driver?.SetAttribute (
  701. isSet && _config._type == SliderType.LeftRange
  702. ? Style.RangeChar.Attribute ?? normalAttr
  703. : Style.SpaceChar.Attribute ?? normalAttr
  704. );
  705. Rune rune = isSet && _config._type == SliderType.LeftRange ? Style.RangeChar.Rune : Style.SpaceChar.Rune;
  706. for (var i = 0; i < _config._startSpacing; i++)
  707. {
  708. MoveAndAdd (x, y, rune);
  709. if (isVertical)
  710. {
  711. y++;
  712. }
  713. else
  714. {
  715. x++;
  716. }
  717. }
  718. }
  719. else
  720. {
  721. Driver?.SetAttribute (Style.EmptyChar.Attribute ?? normalAttr);
  722. for (var i = 0; i < _config._startSpacing; i++)
  723. {
  724. MoveAndAdd (x, y, Style.EmptyChar.Rune);
  725. if (isVertical)
  726. {
  727. y++;
  728. }
  729. else
  730. {
  731. x++;
  732. }
  733. }
  734. }
  735. // Slider
  736. if (_options.Count > 0)
  737. {
  738. for (var i = 0; i < _options.Count; i++)
  739. {
  740. var drawRange = false;
  741. if (isSet)
  742. {
  743. switch (_config._type)
  744. {
  745. case SliderType.LeftRange when i <= _setOptions [0]:
  746. drawRange = i < _setOptions [0];
  747. break;
  748. case SliderType.RightRange when i >= _setOptions [0]:
  749. drawRange = i >= _setOptions [0];
  750. break;
  751. case SliderType.Range when _setOptions.Count == 1:
  752. drawRange = false;
  753. break;
  754. case SliderType.Range when _setOptions.Count == 2:
  755. if ((i >= _setOptions [0] && i <= _setOptions [1])
  756. || (i >= _setOptions [1] && i <= _setOptions [0]))
  757. {
  758. drawRange = (i >= _setOptions [0] && i < _setOptions [1])
  759. || (i >= _setOptions [1] && i < _setOptions [0]);
  760. }
  761. break;
  762. }
  763. }
  764. // Draw Option
  765. Driver?.SetAttribute (
  766. isSet && _setOptions.Contains (i) ? Style.SetChar.Attribute ?? setAttr :
  767. drawRange ? Style.RangeChar.Attribute ?? setAttr : Style.OptionChar.Attribute ?? normalAttr
  768. );
  769. Rune rune = drawRange ? Style.RangeChar.Rune : Style.OptionChar.Rune;
  770. if (isSet)
  771. {
  772. if (_setOptions [0] == i)
  773. {
  774. rune = Style.StartRangeChar.Rune;
  775. }
  776. else if (_setOptions.Count > 1 && _setOptions [1] == i)
  777. {
  778. rune = Style.EndRangeChar.Rune;
  779. }
  780. else if (_setOptions.Contains (i))
  781. {
  782. rune = Style.SetChar.Rune;
  783. }
  784. }
  785. MoveAndAdd (x, y, rune);
  786. if (isVertical)
  787. {
  788. y++;
  789. }
  790. else
  791. {
  792. x++;
  793. }
  794. // Draw Spacing
  795. if (_config._showEndSpacing || i < _options.Count - 1)
  796. {
  797. // Skip if is the Last Spacing.
  798. Driver?.SetAttribute (
  799. drawRange && isSet
  800. ? Style.RangeChar.Attribute ?? setAttr
  801. : Style.SpaceChar.Attribute ?? normalAttr
  802. );
  803. for (var s = 0; s < _config._cachedInnerSpacing; s++)
  804. {
  805. MoveAndAdd (x, y, drawRange && isSet ? Style.RangeChar.Rune : Style.SpaceChar.Rune);
  806. if (isVertical)
  807. {
  808. y++;
  809. }
  810. else
  811. {
  812. x++;
  813. }
  814. }
  815. }
  816. }
  817. }
  818. int remaining = isVertical ? Viewport.Height - y : Viewport.Width - x;
  819. // Right Spacing
  820. if (_config._showEndSpacing)
  821. {
  822. Driver?.SetAttribute (
  823. isSet && _config._type == SliderType.RightRange
  824. ? Style.RangeChar.Attribute ?? normalAttr
  825. : Style.SpaceChar.Attribute ?? normalAttr
  826. );
  827. Rune rune = isSet && _config._type == SliderType.RightRange ? Style.RangeChar.Rune : Style.SpaceChar.Rune;
  828. for (var i = 0; i < remaining; i++)
  829. {
  830. MoveAndAdd (x, y, rune);
  831. if (isVertical)
  832. {
  833. y++;
  834. }
  835. else
  836. {
  837. x++;
  838. }
  839. }
  840. }
  841. else
  842. {
  843. Driver?.SetAttribute (Style.EmptyChar.Attribute ?? normalAttr);
  844. for (var i = 0; i < remaining; i++)
  845. {
  846. MoveAndAdd (x, y, Style.EmptyChar.Rune);
  847. if (isVertical)
  848. {
  849. y++;
  850. }
  851. else
  852. {
  853. x++;
  854. }
  855. }
  856. }
  857. }
  858. private void DrawLegends ()
  859. {
  860. // Attributes
  861. var normalAttr = new Attribute (Color.White, Color.Black);
  862. var setAttr = new Attribute (Color.Black, Color.White);
  863. Attribute spaceAttr = normalAttr;
  864. if (IsInitialized)
  865. {
  866. normalAttr = Style.LegendAttributes.NormalAttribute ?? ColorScheme?.Normal ?? ColorScheme.Disabled;
  867. setAttr = Style.LegendAttributes.SetAttribute ?? ColorScheme?.HotNormal ?? ColorScheme.Normal;
  868. spaceAttr = Style.LegendAttributes.EmptyAttribute ?? normalAttr;
  869. }
  870. bool isTextVertical = _config._legendsOrientation == Orientation.Vertical;
  871. bool isSet = _setOptions.Count > 0;
  872. var x = 0;
  873. var y = 0;
  874. Move (x, y);
  875. if (_config._sliderOrientation == Orientation.Horizontal
  876. && _config._legendsOrientation == Orientation.Vertical)
  877. {
  878. x += _config._startSpacing;
  879. }
  880. if (_config._sliderOrientation == Orientation.Vertical
  881. && _config._legendsOrientation == Orientation.Horizontal)
  882. {
  883. y += _config._startSpacing;
  884. }
  885. if (_config._sliderOrientation == Orientation.Horizontal)
  886. {
  887. y += 1;
  888. }
  889. else
  890. {
  891. // Vertical
  892. x += 1;
  893. }
  894. for (var i = 0; i < _options.Count; i++)
  895. {
  896. var isOptionSet = false;
  897. // Check if the Option is Set.
  898. switch (_config._type)
  899. {
  900. case SliderType.Single:
  901. case SliderType.Multiple:
  902. if (isSet && _setOptions.Contains (i))
  903. {
  904. isOptionSet = true;
  905. }
  906. break;
  907. case SliderType.LeftRange:
  908. if (isSet && i <= _setOptions [0])
  909. {
  910. isOptionSet = true;
  911. }
  912. break;
  913. case SliderType.RightRange:
  914. if (isSet && i >= _setOptions [0])
  915. {
  916. isOptionSet = true;
  917. }
  918. break;
  919. case SliderType.Range when _setOptions.Count == 1:
  920. if (isSet && i == _setOptions [0])
  921. {
  922. isOptionSet = true;
  923. }
  924. break;
  925. case SliderType.Range:
  926. if (isSet
  927. && ((i >= _setOptions [0] && i <= _setOptions [1])
  928. || (i >= _setOptions [1] && i <= _setOptions [0])))
  929. {
  930. isOptionSet = true;
  931. }
  932. break;
  933. }
  934. // Text || Abbreviation
  935. var text = string.Empty;
  936. if (_config._showLegendsAbbr)
  937. {
  938. text = _options [i].LegendAbbr.ToString () ?? new Rune (_options [i].Legend.First ()).ToString ();
  939. }
  940. else
  941. {
  942. text = _options [i].Legend;
  943. }
  944. switch (_config._sliderOrientation)
  945. {
  946. case Orientation.Horizontal:
  947. switch (_config._legendsOrientation)
  948. {
  949. case Orientation.Horizontal:
  950. text = AlignText (text, _config._cachedInnerSpacing + 1, Alignment.Center);
  951. break;
  952. case Orientation.Vertical:
  953. y = 1;
  954. break;
  955. }
  956. break;
  957. case Orientation.Vertical:
  958. switch (_config._legendsOrientation)
  959. {
  960. case Orientation.Horizontal:
  961. x = 1;
  962. break;
  963. case Orientation.Vertical:
  964. text = AlignText (text, _config._cachedInnerSpacing + 1, Alignment.Center);
  965. break;
  966. }
  967. break;
  968. }
  969. // Text
  970. int legendLeftSpacesCount = text.TakeWhile (e => e == ' ').Count ();
  971. int legendRightSpacesCount = text.Reverse ().TakeWhile (e => e == ' ').Count ();
  972. text = text.Trim ();
  973. // TODO(jmperricone): Improve the Orientation check.
  974. // Calculate Start Spacing
  975. if (_config._sliderOrientation == _config._legendsOrientation)
  976. {
  977. if (i == 0)
  978. {
  979. // The spacing for the slider use the StartSpacing but...
  980. // The spacing for the legends is the StartSpacing MINUS the total chars to the left of the first options.
  981. // ●────●────●
  982. // Hello Bye World
  983. //
  984. // chars_left is 2 for Hello => (5 - 1) / 2
  985. //
  986. // then the spacing is 2 for the slider but 0 for the legends.
  987. int charsLeft = (text.Length - 1) / 2;
  988. legendLeftSpacesCount = _config._startSpacing - charsLeft;
  989. }
  990. // Option Left Spacing
  991. if (isTextVertical)
  992. {
  993. y += legendLeftSpacesCount;
  994. }
  995. else
  996. {
  997. x += legendLeftSpacesCount;
  998. }
  999. //Move (x, y);
  1000. }
  1001. // Legend
  1002. Driver?.SetAttribute (isOptionSet ? setAttr : normalAttr);
  1003. foreach (Rune c in text.EnumerateRunes ())
  1004. {
  1005. MoveAndAdd (x, y, c);
  1006. //Driver.AddRune (c);
  1007. if (isTextVertical)
  1008. {
  1009. y += 1;
  1010. }
  1011. else
  1012. {
  1013. x += 1;
  1014. }
  1015. }
  1016. // Calculate End Spacing
  1017. if (i == _options.Count () - 1)
  1018. {
  1019. // See Start Spacing explanation.
  1020. int charsRight = text.Length / 2;
  1021. legendRightSpacesCount = _config._endSpacing - charsRight;
  1022. }
  1023. // Option Right Spacing of Option
  1024. Driver?.SetAttribute (spaceAttr);
  1025. if (isTextVertical)
  1026. {
  1027. y += legendRightSpacesCount;
  1028. }
  1029. else
  1030. {
  1031. x += legendRightSpacesCount;
  1032. }
  1033. if (_config._sliderOrientation == Orientation.Horizontal
  1034. && _config._legendsOrientation == Orientation.Vertical)
  1035. {
  1036. x += _config._cachedInnerSpacing + 1;
  1037. }
  1038. else if (_config._sliderOrientation == Orientation.Vertical
  1039. && _config._legendsOrientation == Orientation.Horizontal)
  1040. {
  1041. y += _config._cachedInnerSpacing + 1;
  1042. }
  1043. }
  1044. }
  1045. #endregion Drawing
  1046. #region Keys and Mouse
  1047. // Mouse coordinates of current drag
  1048. private Point? _dragPosition;
  1049. // Coordinates of where the "move cursor" is drawn (in OnDrawContent)
  1050. private Point? _moveRenderPosition;
  1051. /// <inheritdoc/>
  1052. protected override bool OnMouseEvent (MouseEventArgs mouseEvent)
  1053. {
  1054. // Note(jmperricone): Maybe we click to focus the cursor, and on next click we set the option.
  1055. // That will make OptionFocused Event more relevant.
  1056. // (tig: I don't think so. Maybe an option if someone really wants it, but for now that
  1057. // adds too much friction to UI.
  1058. // TODO(jmperricone): Make Range Type work with mouse.
  1059. if (!(mouseEvent.Flags.HasFlag (MouseFlags.Button1Clicked)
  1060. || mouseEvent.Flags.HasFlag (MouseFlags.Button1Pressed)
  1061. || mouseEvent.Flags.HasFlag (MouseFlags.ReportMousePosition)
  1062. || mouseEvent.Flags.HasFlag (MouseFlags.Button1Released)))
  1063. {
  1064. return false;
  1065. }
  1066. SetFocus ();
  1067. if (!_dragPosition.HasValue && mouseEvent.Flags.HasFlag (MouseFlags.Button1Pressed))
  1068. {
  1069. if (mouseEvent.Flags.HasFlag (MouseFlags.ReportMousePosition))
  1070. {
  1071. _dragPosition = mouseEvent.Position;
  1072. _moveRenderPosition = ClampMovePosition ((Point)_dragPosition);
  1073. Application.GrabMouse (this);
  1074. }
  1075. SetNeedsDisplay ();
  1076. return true;
  1077. }
  1078. if (_dragPosition.HasValue
  1079. && mouseEvent.Flags.HasFlag (MouseFlags.ReportMousePosition)
  1080. && mouseEvent.Flags.HasFlag (MouseFlags.Button1Pressed))
  1081. {
  1082. // Continue Drag
  1083. _dragPosition = mouseEvent.Position;
  1084. _moveRenderPosition = ClampMovePosition ((Point)_dragPosition);
  1085. var success = false;
  1086. var option = 0;
  1087. // how far has user dragged from original location?
  1088. if (Orientation == Orientation.Horizontal)
  1089. {
  1090. success = TryGetOptionByPosition (mouseEvent.Position.X, 0, Math.Max (0, _config._cachedInnerSpacing / 2), out option);
  1091. }
  1092. else
  1093. {
  1094. success = TryGetOptionByPosition (0, mouseEvent.Position.Y, Math.Max (0, _config._cachedInnerSpacing / 2), out option);
  1095. }
  1096. if (!_config._allowEmpty && success)
  1097. {
  1098. if (!OnOptionFocused (option, new (GetSetOptionDictionary (), FocusedOption)))
  1099. {
  1100. SetFocusedOption ();
  1101. }
  1102. }
  1103. SetNeedsDisplay ();
  1104. return true;
  1105. }
  1106. if ((_dragPosition.HasValue && mouseEvent.Flags.HasFlag (MouseFlags.Button1Released))
  1107. || mouseEvent.Flags.HasFlag (MouseFlags.Button1Clicked))
  1108. {
  1109. // End Drag
  1110. Application.UngrabMouse ();
  1111. _dragPosition = null;
  1112. _moveRenderPosition = null;
  1113. // TODO: Add func to calc distance between options to use as the MouseClickXOptionThreshold
  1114. var success = false;
  1115. var option = 0;
  1116. if (Orientation == Orientation.Horizontal)
  1117. {
  1118. success = TryGetOptionByPosition (mouseEvent.Position.X, 0, Math.Max (0, _config._cachedInnerSpacing / 2), out option);
  1119. }
  1120. else
  1121. {
  1122. success = TryGetOptionByPosition (0, mouseEvent.Position.Y, Math.Max (0, _config._cachedInnerSpacing / 2), out option);
  1123. }
  1124. if (success)
  1125. {
  1126. if (!OnOptionFocused (option, new (GetSetOptionDictionary (), FocusedOption)))
  1127. {
  1128. SetFocusedOption ();
  1129. }
  1130. }
  1131. SetNeedsDisplay ();
  1132. mouseEvent.Handled = true;
  1133. }
  1134. return mouseEvent.Handled;
  1135. Point ClampMovePosition (Point position)
  1136. {
  1137. int Clamp (int value, int min, int max) { return Math.Max (min, Math.Min (max, value)); }
  1138. if (Orientation == Orientation.Horizontal)
  1139. {
  1140. int left = _config._startSpacing;
  1141. int width = _options.Count + (_options.Count - 1) * _config._cachedInnerSpacing;
  1142. int right = left + width - 1;
  1143. int clampedX = Clamp (position.X, left, right);
  1144. position = new (clampedX, 0);
  1145. }
  1146. else
  1147. {
  1148. int top = _config._startSpacing;
  1149. int height = _options.Count + (_options.Count - 1) * _config._cachedInnerSpacing;
  1150. int bottom = top + height - 1;
  1151. int clampedY = Clamp (position.Y, top, bottom);
  1152. position = new (0, clampedY);
  1153. }
  1154. return position;
  1155. }
  1156. }
  1157. private void SetCommands ()
  1158. {
  1159. AddCommand (Command.Right, () => MovePlus ());
  1160. AddCommand (Command.Down, () => MovePlus ());
  1161. AddCommand (Command.Left, () => MoveMinus ());
  1162. AddCommand (Command.Up, () => MoveMinus ());
  1163. AddCommand (Command.LeftStart, () => MoveStart ());
  1164. AddCommand (Command.RightEnd, () => MoveEnd ());
  1165. AddCommand (Command.RightExtend, () => ExtendPlus ());
  1166. AddCommand (Command.LeftExtend, () => ExtendMinus ());
  1167. AddCommand (Command.Select, () => Select ());
  1168. AddCommand (Command.Accept, (ctx) => Accept (ctx));
  1169. SetKeyBindings ();
  1170. }
  1171. // This is called during initialization and anytime orientation changes
  1172. private void SetKeyBindings ()
  1173. {
  1174. if (_config._sliderOrientation == Orientation.Horizontal)
  1175. {
  1176. KeyBindings.Add (Key.CursorRight, Command.Right);
  1177. KeyBindings.Remove (Key.CursorDown);
  1178. KeyBindings.Add (Key.CursorLeft, Command.Left);
  1179. KeyBindings.Remove (Key.CursorUp);
  1180. KeyBindings.Add (Key.CursorRight.WithCtrl, Command.RightExtend);
  1181. KeyBindings.Remove (Key.CursorDown.WithCtrl);
  1182. KeyBindings.Add (Key.CursorLeft.WithCtrl, Command.LeftExtend);
  1183. KeyBindings.Remove (Key.CursorUp.WithCtrl);
  1184. }
  1185. else
  1186. {
  1187. KeyBindings.Remove (Key.CursorRight);
  1188. KeyBindings.Add (Key.CursorDown, Command.Down);
  1189. KeyBindings.Remove (Key.CursorLeft);
  1190. KeyBindings.Add (Key.CursorUp, Command.Up);
  1191. KeyBindings.Remove (Key.CursorRight.WithCtrl);
  1192. KeyBindings.Add (Key.CursorDown.WithCtrl, Command.RightExtend);
  1193. KeyBindings.Remove (Key.CursorLeft.WithCtrl);
  1194. KeyBindings.Add (Key.CursorUp.WithCtrl, Command.LeftExtend);
  1195. }
  1196. KeyBindings.Remove (Key.Home);
  1197. KeyBindings.Add (Key.Home, Command.LeftStart);
  1198. KeyBindings.Remove (Key.End);
  1199. KeyBindings.Add (Key.End, Command.RightEnd);
  1200. KeyBindings.Remove (Key.Enter);
  1201. KeyBindings.Add (Key.Enter, Command.Accept);
  1202. KeyBindings.Remove (Key.Space);
  1203. KeyBindings.Add (Key.Space, Command.Select);
  1204. }
  1205. private Dictionary<int, SliderOption<T>> GetSetOptionDictionary () { return _setOptions.ToDictionary (e => e, e => _options [e]); }
  1206. /// <summary>
  1207. /// Sets or unsets <paramref name="optionIndex"/> based on <paramref name="set"/>.
  1208. /// </summary>
  1209. /// <param name="optionIndex">The option to change.</param>
  1210. /// <param name="set">If <see langword="true"/>, sets the option. Unsets it otherwise.</param>
  1211. public void ChangeOption (int optionIndex, bool set)
  1212. {
  1213. if (set)
  1214. {
  1215. if (!_setOptions.Contains (optionIndex))
  1216. {
  1217. _setOptions.Add (optionIndex);
  1218. _options [optionIndex].OnSet ();
  1219. }
  1220. }
  1221. else
  1222. {
  1223. if (_setOptions.Contains (optionIndex))
  1224. {
  1225. _setOptions.Remove (optionIndex);
  1226. _options [optionIndex].OnUnSet ();
  1227. }
  1228. }
  1229. // Raise slider changed event.
  1230. OnOptionsChanged ();
  1231. }
  1232. private bool SetFocusedOption ()
  1233. {
  1234. if (_options.Count == 0)
  1235. {
  1236. return false;
  1237. }
  1238. bool changed = false;
  1239. switch (_config._type)
  1240. {
  1241. case SliderType.Single:
  1242. case SliderType.LeftRange:
  1243. case SliderType.RightRange:
  1244. if (_setOptions.Count == 1)
  1245. {
  1246. int prev = _setOptions [0];
  1247. if (!_config._allowEmpty && prev == FocusedOption)
  1248. {
  1249. break;
  1250. }
  1251. _setOptions.Clear ();
  1252. _options [FocusedOption].OnUnSet ();
  1253. if (FocusedOption != prev)
  1254. {
  1255. _setOptions.Add (FocusedOption);
  1256. _options [FocusedOption].OnSet ();
  1257. }
  1258. }
  1259. else
  1260. {
  1261. _setOptions.Add (FocusedOption);
  1262. _options [FocusedOption].OnSet ();
  1263. }
  1264. // Raise slider changed event.
  1265. OnOptionsChanged ();
  1266. changed = true;
  1267. break;
  1268. case SliderType.Multiple:
  1269. if (_setOptions.Contains (FocusedOption))
  1270. {
  1271. if (!_config._allowEmpty && _setOptions.Count () == 1)
  1272. {
  1273. break;
  1274. }
  1275. _setOptions.Remove (FocusedOption);
  1276. _options [FocusedOption].OnUnSet ();
  1277. }
  1278. else
  1279. {
  1280. _setOptions.Add (FocusedOption);
  1281. _options [FocusedOption].OnSet ();
  1282. }
  1283. OnOptionsChanged ();
  1284. changed = true;
  1285. break;
  1286. case SliderType.Range:
  1287. if (_config._rangeAllowSingle)
  1288. {
  1289. if (_setOptions.Count == 1)
  1290. {
  1291. int prev = _setOptions [0];
  1292. if (!_config._allowEmpty && prev == FocusedOption)
  1293. {
  1294. break;
  1295. }
  1296. if (FocusedOption == prev)
  1297. {
  1298. // un-set
  1299. _setOptions.Clear ();
  1300. _options [FocusedOption].OnUnSet ();
  1301. }
  1302. else
  1303. {
  1304. _setOptions [0] = FocusedOption;
  1305. _setOptions.Add (prev);
  1306. _setOptions.Sort ();
  1307. _options [FocusedOption].OnSet ();
  1308. }
  1309. }
  1310. else if (_setOptions.Count == 0)
  1311. {
  1312. _setOptions.Add (FocusedOption);
  1313. _options [FocusedOption].OnSet ();
  1314. }
  1315. else
  1316. {
  1317. // Extend/Shrink
  1318. if (FocusedOption < _setOptions [0])
  1319. {
  1320. // extend left
  1321. _options [_setOptions [0]].OnUnSet ();
  1322. _setOptions [0] = FocusedOption;
  1323. }
  1324. else if (FocusedOption > _setOptions [1])
  1325. {
  1326. // extend right
  1327. _options [_setOptions [1]].OnUnSet ();
  1328. _setOptions [1] = FocusedOption;
  1329. }
  1330. else if (FocusedOption >= _setOptions [0] && FocusedOption <= _setOptions [1])
  1331. {
  1332. if (FocusedOption < _lastFocusedOption)
  1333. {
  1334. // shrink to the left
  1335. _options [_setOptions [1]].OnUnSet ();
  1336. _setOptions [1] = FocusedOption;
  1337. }
  1338. else if (FocusedOption > _lastFocusedOption)
  1339. {
  1340. // shrink to the right
  1341. _options [_setOptions [0]].OnUnSet ();
  1342. _setOptions [0] = FocusedOption;
  1343. }
  1344. if (_setOptions.Count > 1 && _setOptions [0] == _setOptions [1])
  1345. {
  1346. _setOptions.Clear ();
  1347. _setOptions.Add (FocusedOption);
  1348. }
  1349. }
  1350. }
  1351. }
  1352. else
  1353. {
  1354. if (_setOptions.Count == 1)
  1355. {
  1356. int prev = _setOptions [0];
  1357. if (!_config._allowEmpty && prev == FocusedOption)
  1358. {
  1359. break;
  1360. }
  1361. _setOptions [0] = FocusedOption;
  1362. _setOptions.Add (prev);
  1363. _setOptions.Sort ();
  1364. _options [FocusedOption].OnSet ();
  1365. }
  1366. else if (_setOptions.Count == 0)
  1367. {
  1368. _setOptions.Add (FocusedOption);
  1369. _options [FocusedOption].OnSet ();
  1370. int next = FocusedOption < _options.Count - 1 ? FocusedOption + 1 : FocusedOption - 1;
  1371. _setOptions.Add (next);
  1372. _options [next].OnSet ();
  1373. }
  1374. else
  1375. {
  1376. // Extend/Shrink
  1377. if (FocusedOption < _setOptions [0])
  1378. {
  1379. // extend left
  1380. _options [_setOptions [0]].OnUnSet ();
  1381. _setOptions [0] = FocusedOption;
  1382. }
  1383. else if (FocusedOption > _setOptions [1])
  1384. {
  1385. // extend right
  1386. _options [_setOptions [1]].OnUnSet ();
  1387. _setOptions [1] = FocusedOption;
  1388. }
  1389. else if (FocusedOption >= _setOptions [0]
  1390. && FocusedOption <= _setOptions [1]
  1391. && _setOptions [1] - _setOptions [0] > 1)
  1392. {
  1393. if (FocusedOption < _lastFocusedOption)
  1394. {
  1395. // shrink to the left
  1396. _options [_setOptions [1]].OnUnSet ();
  1397. _setOptions [1] = FocusedOption;
  1398. }
  1399. else if (FocusedOption > _lastFocusedOption)
  1400. {
  1401. // shrink to the right
  1402. _options [_setOptions [0]].OnUnSet ();
  1403. _setOptions [0] = FocusedOption;
  1404. }
  1405. }
  1406. }
  1407. }
  1408. // Raise Slider Option Changed Event.
  1409. OnOptionsChanged ();
  1410. changed = true;
  1411. break;
  1412. default:
  1413. throw new ArgumentOutOfRangeException (_config._type.ToString ());
  1414. }
  1415. return changed;
  1416. }
  1417. internal bool ExtendPlus ()
  1418. {
  1419. int next = FocusedOption < _options.Count - 1 ? FocusedOption + 1 : FocusedOption;
  1420. if (next != FocusedOption
  1421. && !OnOptionFocused (
  1422. next,
  1423. new (
  1424. GetSetOptionDictionary (),
  1425. FocusedOption
  1426. )
  1427. ))
  1428. {
  1429. SetFocusedOption ();
  1430. }
  1431. return true;
  1432. //// TODO: Support RangeMultiple
  1433. //if (_setOptions.Contains (FocusedOption)) {
  1434. // var next = FocusedOption < _options.Count - 1 ? FocusedOption + 1 : FocusedOption;
  1435. // if (!_setOptions.Contains (next)) {
  1436. // if (_config._type == SliderType.Range) {
  1437. // if (_setOptions.Count == 1) {
  1438. // if (!OnOptionFocused (next, new SliderEventArgs<T> (GetSetOptionDictionary (), FocusedOption))) {
  1439. // _setOptions.Add (FocusedOption);
  1440. // _setOptions.Sort (); // Range Type
  1441. // OnOptionsChanged ();
  1442. // }
  1443. // } else if (_setOptions.Count == 2) {
  1444. // if (!OnOptionFocused (next, new SliderEventArgs<T> (GetSetOptionDictionary (), FocusedOption))) {
  1445. // _setOptions [1] = FocusedOption;
  1446. // _setOptions.Sort (); // Range Type
  1447. // OnOptionsChanged ();
  1448. // }
  1449. // }
  1450. // } else {
  1451. // _setOptions.Remove (FocusedOption);
  1452. // // Note(jmperricone): We are setting the option here, do we send the OptionFocused Event too ?
  1453. // if (!OnOptionFocused (next, new SliderEventArgs<T> (GetSetOptionDictionary (), FocusedOption))) {
  1454. // _setOptions.Add (FocusedOption);
  1455. // _setOptions.Sort (); // Range Type
  1456. // OnOptionsChanged ();
  1457. // }
  1458. // }
  1459. // } else {
  1460. // if (_config._type == SliderType.Range) {
  1461. // if (!OnOptionFocused (next, new SliderEventArgs<T> (GetSetOptionDictionary (), FocusedOption))) {
  1462. // _setOptions.Clear();
  1463. // _setOptions.Add (FocusedOption);
  1464. // OnOptionsChanged ();
  1465. // }
  1466. // } else if (/*_settingRange == true ||*/ !AllowEmpty) {
  1467. // SetFocusedOption ();
  1468. // }
  1469. // }
  1470. //}
  1471. //return true;
  1472. }
  1473. internal bool ExtendMinus ()
  1474. {
  1475. int prev = FocusedOption > 0 ? FocusedOption - 1 : FocusedOption;
  1476. if (prev != FocusedOption
  1477. && !OnOptionFocused (
  1478. prev,
  1479. new (
  1480. GetSetOptionDictionary (),
  1481. FocusedOption
  1482. )
  1483. ))
  1484. {
  1485. SetFocusedOption ();
  1486. }
  1487. return true;
  1488. }
  1489. internal bool Select ()
  1490. {
  1491. return SetFocusedOption ();
  1492. }
  1493. internal bool Accept (CommandContext ctx)
  1494. {
  1495. SetFocusedOption ();
  1496. return RaiseAccepting (ctx) == true;
  1497. }
  1498. internal bool MovePlus ()
  1499. {
  1500. bool cancelled = OnOptionFocused (
  1501. FocusedOption + 1,
  1502. new (GetSetOptionDictionary (), FocusedOption)
  1503. );
  1504. if (cancelled)
  1505. {
  1506. return false;
  1507. }
  1508. if (!AllowEmpty)
  1509. {
  1510. SetFocusedOption ();
  1511. }
  1512. return true;
  1513. }
  1514. internal bool MoveMinus ()
  1515. {
  1516. bool cancelled = OnOptionFocused (
  1517. FocusedOption - 1,
  1518. new (GetSetOptionDictionary (), FocusedOption)
  1519. );
  1520. if (cancelled)
  1521. {
  1522. return false;
  1523. }
  1524. if (!AllowEmpty)
  1525. {
  1526. SetFocusedOption ();
  1527. }
  1528. return true;
  1529. }
  1530. internal bool MoveStart ()
  1531. {
  1532. if (OnOptionFocused (0, new (GetSetOptionDictionary (), FocusedOption)))
  1533. {
  1534. return false;
  1535. }
  1536. if (!AllowEmpty)
  1537. {
  1538. SetFocusedOption ();
  1539. }
  1540. return true;
  1541. }
  1542. internal bool MoveEnd ()
  1543. {
  1544. if (OnOptionFocused (_options.Count - 1, new (GetSetOptionDictionary (), FocusedOption)))
  1545. {
  1546. return false;
  1547. }
  1548. if (!AllowEmpty)
  1549. {
  1550. SetFocusedOption ();
  1551. }
  1552. return true;
  1553. }
  1554. #endregion
  1555. }