Merge pull request #6351 from Joehuu/simplify-exit-logic-of-screens

Simplify exit logic of screens with textboxes using back button receptor

osu.Game/Graphics/UserInterface/BackButton.cs

@@ -18,7 +18,7 @@ namespace osu.Game.Graphics.UserInterface
 
         public BackButton(Receptor receptor)
         {
-            receptor.OnBackPressed = () => Action?.Invoke();
+            receptor.OnBackPressed = () => button.Click();
 
             Size = TwoLayerButton.SIZE_EXTENDED;
 

osu.Game/Graphics/UserInterface/FocusedTextBox.cs

@@ -2,22 +2,20 @@
 // See the LICENCE file in the repository root for full licence text.
 
 using osuTK.Graphics;
-using System;
 using osu.Framework.Allocation;
 using osu.Framework.Input.Events;
 using osu.Framework.Platform;
 using osu.Game.Input.Bindings;
 using osuTK.Input;
+using osu.Framework.Input.Bindings;
 
 namespace osu.Game.Graphics.UserInterface
 {
     /// <summary>
     /// A textbox which holds focus eagerly.
     /// </summary>
-    public class FocusedTextBox : OsuTextBox
+    public class FocusedTextBox : OsuTextBox, IKeyBindingHandler<GlobalAction>
     {
-        public Action Exit;
-
         private bool focus;
 
         private bool allowImmediateFocus => host?.OnScreenKeyboardOverlapsGameWindow != true;
@@ -63,12 +61,12 @@ namespace osu.Game.Graphics.UserInterface
             if (!HasFocus) return false;
 
             if (e.Key == Key.Escape)
-                return false; // disable the framework-level handling of escape key for confority (we use GlobalAction.Back).
+                return false; // disable the framework-level handling of escape key for conformity (we use GlobalAction.Back).
 
             return base.OnKeyDown(e);
         }
 
-        public override bool OnPressed(GlobalAction action)
+        public bool OnPressed(GlobalAction action)
         {
             if (action == GlobalAction.Back)
             {
@@ -79,14 +77,10 @@ namespace osu.Game.Graphics.UserInterface
                 }
             }
 
-            return base.OnPressed(action);
+            return false;
         }
 
-        protected override void KillFocus()
+        public bool OnReleased(GlobalAction action) => false;
-        {
-            base.KillFocus();
-            Exit?.Invoke();
-        }
 
         public override bool RequestsFocus => HoldFocus;
     }

osu.Game/Graphics/UserInterface/OsuTextBox.cs

@@ -8,13 +8,11 @@ using osu.Framework.Graphics.UserInterface;
 using osu.Game.Graphics.Sprites;
 using osuTK.Graphics;
 using osu.Framework.Extensions.Color4Extensions;
-using osu.Framework.Input.Bindings;
 using osu.Framework.Input.Events;
-using osu.Game.Input.Bindings;
 
 namespace osu.Game.Graphics.UserInterface
 {
-    public class OsuTextBox : TextBox, IKeyBindingHandler<GlobalAction>
+    public class OsuTextBox : TextBox
     {
         protected override float LeftRightPadding => 10;
 
@@ -57,18 +55,5 @@ namespace osu.Game.Graphics.UserInterface
         }
 
         protected override Drawable GetDrawableCharacter(char c) => new OsuSpriteText { Text = c.ToString(), Font = OsuFont.GetFont(size: CalculatedTextSize) };
-
-        public virtual bool OnPressed(GlobalAction action)
-        {
-            if (action == GlobalAction.Back)
-            {
-                KillFocus();
-                return true;
-            }
-
-            return false;
-        }
-
-        public bool OnReleased(GlobalAction action) => false;
     }
 }

osu.Game/Online/Chat/StandAloneChatDisplay.cs

@@ -21,8 +21,6 @@ namespace osu.Game.Online.Chat
     {
         public readonly Bindable<Channel> Channel = new Bindable<Channel>();
 
-        public Action Exit;
-
         private readonly FocusedTextBox textbox;
 
         protected ChannelManager ChannelManager;
@@ -66,8 +64,6 @@ namespace osu.Game.Online.Chat
                     Anchor = Anchor.BottomLeft,
                     Origin = Anchor.BottomLeft,
                 });
-
-                textbox.Exit += () => Exit?.Invoke();
             }
 
             Channel.BindValueChanged(channelChanged);

osu.Game/Overlays/Chat/Selection/ChannelSelectionOverlay.cs

@@ -119,7 +119,6 @@ namespace osu.Game.Overlays.Chat.Selection
                                 {
                                     RelativeSizeAxes = Axes.X,
                                     PlaceholderText = @"Search",
-                                    Exit = Hide,
                                 },
                             },
                         },

osu.Game/Overlays/ChatOverlay.cs

@@ -138,7 +138,6 @@ namespace osu.Game.Overlays
                                             RelativeSizeAxes = Axes.Both,
                                             Height = 1,
                                             PlaceholderText = "type your message",
-                                            Exit = Hide,
                                             OnCommit = postMessage,
                                             ReleaseFocusOnCommit = false,
                                             HoldFocus = true,

osu.Game/Overlays/Music/FilterControl.cs

@@ -31,7 +31,6 @@ namespace osu.Game.Overlays.Music
                         {
                             RelativeSizeAxes = Axes.X,
                             Height = 40,
-                            Exit = () => ExitRequested?.Invoke(),
                         },
                         new CollectionsDropdown<PlaylistCollection>
                         {
@@ -47,8 +46,6 @@ namespace osu.Game.Overlays.Music
 
         private void current_ValueChanged(ValueChangedEvent<string> e) => FilterChanged?.Invoke(e.NewValue);
 
-        public Action ExitRequested;
-
         public Action<string> FilterChanged;
 
         public class FilterTextBox : SearchTextBox

osu.Game/Overlays/Music/PlaylistOverlay.cs

@@ -63,7 +63,6 @@ namespace osu.Game.Overlays.Music
                         {
                             RelativeSizeAxes = Axes.X,
                             AutoSizeAxes = Axes.Y,
-                            ExitRequested = Hide,
                             FilterChanged = search => list.Filter(search),
                             Padding = new MarginPadding(10),
                         },

osu.Game/Overlays/SearchableList/SearchableListOverlay.cs

@@ -88,8 +88,6 @@ namespace osu.Game.Overlays.SearchableList
                     },
                 },
             };
-
-            Filter.Search.Exit = Hide;
         }
 
         protected override void Update()

osu.Game/Overlays/SettingsPanel.cs

@@ -91,7 +91,6 @@ namespace osu.Game.Overlays
                                 Top = 20,
                                 Bottom = 20
                             },
-                            Exit = Hide,
                         },
                         Footer = CreateFooter()
                     },

osu.Game/Screens/Multi/Lounge/LoungeSubScreen.cs

@@ -69,8 +69,6 @@ namespace osu.Game.Screens.Multi.Lounge
                     },
                 },
             };
-
-            Filter.Search.Exit += this.Exit;
         }
 
         protected override void UpdateAfterChildren()

osu.Game/Screens/Multi/Match/MatchSubScreen.cs

@@ -62,7 +62,6 @@ namespace osu.Game.Screens.Multi.Match
         [BackgroundDependencyLoader]
         private void load()
         {
-            MatchChatDisplay chat;
             Components.Header header;
             Info info;
             GridContainer bottomRow;
@@ -122,7 +121,7 @@ namespace osu.Game.Screens.Multi.Match
                                                 Vertical = 10,
                                             },
                                             RelativeSizeAxes = Axes.Both,
-                                            Child = chat = new MatchChatDisplay
+                                            Child = new MatchChatDisplay
                                             {
                                                 RelativeSizeAxes = Axes.Both
                                             }
@@ -159,12 +158,6 @@ namespace osu.Game.Screens.Multi.Match
                 bottomRow.FadeTo(settingsDisplayed ? 0 : 1, fade_duration, Easing.OutQuint);
             }, true);
 
-            chat.Exit += () =>
-            {
-                if (this.IsCurrentScreen())
-                    this.Exit();
-            };
-
             beatmapManager.ItemAdded += beatmapAdded;
         }
 

osu.Game/Screens/Select/FilterControl.cs

@@ -49,8 +49,6 @@ namespace osu.Game.Screens.Select
             return criteria;
         }
 
-        public Action Exit;
-
         private readonly SearchTextBox searchTextBox;
 
         public override bool ReceivePositionalInputAt(Vector2 screenSpacePos) =>
@@ -75,11 +73,7 @@ namespace osu.Game.Screens.Select
                     Origin = Anchor.TopRight,
                     Children = new Drawable[]
                     {
-                        searchTextBox = new SearchTextBox
+                        searchTextBox = new SearchTextBox { RelativeSizeAxes = Axes.X },
-                        {
-                            RelativeSizeAxes = Axes.X,
-                            Exit = () => Exit?.Invoke(),
-                        },
                         new Box
                         {
                             RelativeSizeAxes = Axes.X,

osu.Game/Screens/Select/SongSelect.cs

@@ -171,11 +171,6 @@ namespace osu.Game.Screens.Select
                                 Height = FilterControl.HEIGHT,
                                 FilterChanged = c => Carousel.Filter(c),
                                 Background = { Width = 2 },
-                                Exit = () =>
-                                {
-                                    if (this.IsCurrentScreen())
-                                        this.Exit();
-                                },
                             },
                         }
                     },